application-registry.h

Go to the documentation of this file.

/* $Id: application-registry.h 2019 2009-01-27 08:29:42Z murrayc $ */
 
/* Copyright 2003 gnome-vfsmm Development Team
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
 
 
#ifndef _LIBGNOMEVFSMM_APPLICATION_REGISTRY_H
#define _LIBGNOMEVFSMM_APPLICATION_REGISTRY_H
 
#include <glibmm.h>
 
#include <libgnomevfsmm/enums.h>
#include <libgnomevfsmm/exception.h>
#include <libgnomevfsmm/mime-application.h>
#include <libgnomevfs/gnome-vfs-application-registry.h>
 
 
namespace Gnome
{
 
namespace Vfs
{
 
//TODO: Some explanation of how/when this might be used.
//TODO: There seems to be some duplication of functinoality between here and the Mime namespace.
//At first glance it seems like something that would be used by the GNOME file-types control panel, and nothing else. Murray.
namespace ApplicationRegistry
{
 
typedef Glib::ListHandle<Glib::ustring> ListHandleStrings;
 
 
bool exists(const Glib::ustring& app_id);
 
//TODO: Explain what a key is? Why does each application have keys? Murray.
 
ListHandleStrings get_keys(const Glib::ustring& app_id);
 
Glib::ustring peek_value(const Glib::ustring& app_id, const Glib::ustring& key);
 
//TODO: "the structure pointed to by @a app_id" doesn't make much sense here. Is it an application or a structure? Murray.
//TODO: This looks like a simple convenience method. If so, it should say so.
//TODO: Why does this have the got_key() method, but peek_value() doesn't.
//TODO: Should peek_value() be called get_value()?
bool get_bool_value(const Glib::ustring& app_id, const Glib::ustring& key, bool& got_key);
 
void remove_application(const Glib::ustring& app_id);
 
void set_value(const Glib::ustring& app_id, const Glib::ustring& key, const Glib::ustring& value);
 
//TODO: Consider calling sync() automatically - we need to investigate possible performance problems of doing this. Murray.
//TODO: The default argument here is only appropriate if a bool is more likely to be used than any other type,
//      and if so we should have bool get_value() and string get_string_value().
void set_value(const Glib::ustring& app_id, const Glib::ustring& key, bool value = true);
 
//TODO: Say what would happen when get_value() is then used.
void unset_key(const Glib::ustring& app_id, const Glib::ustring& key);
 
/*
 * Query functions
 */
 
ListHandleStrings get_applications(const Glib::ustring& mime_type);
 
ListHandleStrings get_mime_types(const Glib::ustring& app_id);
 
bool supports_mime_type(const Glib::ustring& app_id, const Glib::ustring& mime_type);
 
bool supports_uri_scheme(const Glib::ustring& app_id, const Glib::ustring& uri_scheme);
 
/*
 * Mime type functions
 * Note that mime_type can be a specific(image/png) or generic (image/<star>) type
 */
 
void clear_mime_types(const Glib::ustring& app_id);
 
void add_mime_type(const Glib::ustring& app_id, const Glib::ustring& mime_type);
 
void remove_mime_type(const Glib::ustring& app_id, const Glib::ustring& mime_type);
 
 
#ifdef GLIBMM_EXCEPTIONS_ENABLED
void sync() throw(exception);
#else
void sync(std::auto_ptr<Gnome::Vfs::exception>& error);
#endif
 
//TODO: What does "free resources" mean. Are we blocking another application from doing the same thing?
//      How is this different to sync()? Do we need to do both? Murray
void shutdown();
 
//TODO: So, when would we need to call this? Murray.
void reload();
 
/*
 * Integrating with gnome-vfs-mime-handlers
 */
 
//TODO: How is a MimeApplication different to an Application? Murray.
MimeApplication get_mime_application(const Glib::ustring& app_id);
 
void save_mime_application(const MimeApplication& application);
 
} //namespace ApplicationRegistry
 
} // namespace Vfs
} // namespace Gnome
 
 
 
 
#endif /* _LIBGNOMEVFSMM_APPLICATION_REGISTRY_H */