gnome-db-config

Name

gnome-db-config -- Routines for accessing GNOME-DB configuration

Synopsis



GList*      gnome_db_config_get_saved_sql_queries
                                            (void);
GList*      gnome_db_config_get_saved_xml_queries
                                            (void);
struct      GnomeDbConfigComponent;
#define     gnome_db_config_component_get_name(_com_)
#define     gnome_db_config_component_get_location(_com_)
#define     gnome_db_config_component_get_description(_com_)
#define     gnome_db_config_component_get_repo_ids(_com_)
#define     gnome_db_config_component_get_type(_com_)
#define     gnome_db_config_component_get_icon(_com_)
GnomeDbConfigComponent* gnome_db_config_component_new
                                            (void);
void        gnome_db_config_component_free  (GnomeDbConfigComponent *component);
void        gnome_db_config_component_set_name
                                            (GnomeDbConfigComponent *component,
                                             const gchar *name);
void        gnome_db_config_component_set_location
                                            (GnomeDbConfigComponent *component,
                                             const gchar *location);
void        gnome_db_config_component_set_description
                                            (GnomeDbConfigComponent *component,
                                             const gchar *desc);
void        gnome_db_config_component_set_repo_ids
                                            (GnomeDbConfigComponent *component,
                                             const gchar *repo_ids);
void        gnome_db_config_component_set_type
                                            (GnomeDbConfigComponent *component,
                                             const gchar *type);
void        gnome_db_config_component_set_icon
                                            (GnomeDbConfigComponent *component,
                                             const gchar *icon);
GList*      gnome_db_config_get_all_components
                                            (void);
GList*      gnome_db_config_get_shell_components
                                            (void);
void        gnome_db_config_component_free_list
                                            (GList *list);
#define     GNOME_DB_CONFIG_SECTION_DESIGNER
#define     GNOME_DB_CONFIG_SECTION_HELP_VIEWER
#define     GNOME_DB_CONFIG_SECTION_HELP_VIEWER_DOCS
#define     GNOME_DB_CONFIG_SECTION_LAST_COMMANDS
#define     GNOME_DB_CONFIG_SECTION_SAVED_SQL_QUERIES
#define     GNOME_DB_CONFIG_SECTION_SAVED_XML_QUERIES
#define     GNOME_DB_CONFIG_SECTION_SAVED_BATCH_JOBS
#define     GNOME_DB_CONFIG_KEY_SHOW_TOOLTIPS
#define     GNOME_DB_REPO_CONTROL
#define     GNOME_DB_OAFIID_BUILDER_FACTORY
#define     GNOME_DB_OAFIID_COMPONENT_FACTORY
#define     GNOME_DB_OAFIID_MANAGER_FACTORY
#define     GNOME_DB_OAFIID_MONIKER_FACTORY
#define     GNOME_DB_OAFIID_BUILDER
#define     GNOME_DB_OAFIID_CONNECTION
#define     GNOME_DB_OAFIID_DESIGNER
#define     GNOME_DB_OAFIID_EXPORT
#define     GNOME_DB_OAFIID_IMPORT
#define     GNOME_DB_OAFIID_LOG_VIEWER
#define     GNOME_DB_OAFIID_MANAGER
#define     GNOME_DB_OAFIID_MONIKER_DATABASE

Description

This module contains lots of functions that let you access/modify the GNOME-DB configuration.

Details

gnome_db_config_get_saved_sql_queries ()

GList*      gnome_db_config_get_saved_sql_queries
                                            (void);

Returns the names of all the saved SQL queries for the current user. To free the returned GList, use gda_config_free_list

Returns :

a GList containing the names of all saved SQL queries.


gnome_db_config_get_saved_xml_queries ()

GList*      gnome_db_config_get_saved_xml_queries
                                            (void);

Returns the names of all the saved XML queries for the current user. To free the returned GList, use gda_config_free_list

Returns :

a GList containing the names of all saved XML queries.


struct GnomeDbConfigComponent

struct GnomeDbConfigComponent {

	gchar* name;
	gchar* location;
	gchar* description;
	gchar* repo_ids;
	gchar* type;
	gchar* icon;
};


gnome_db_config_component_get_name()

#define     gnome_db_config_component_get_name(_com_)

_com_ :


gnome_db_config_component_get_location()

#define     gnome_db_config_component_get_location(_com_)

_com_ :


gnome_db_config_component_get_description()

#define     gnome_db_config_component_get_description(_com_)

_com_ :


gnome_db_config_component_get_repo_ids()

#define     gnome_db_config_component_get_repo_ids(_com_)

_com_ :


gnome_db_config_component_get_type()

#define     gnome_db_config_component_get_type(_com_)

_com_ :


gnome_db_config_component_get_icon()

#define     gnome_db_config_component_get_icon(_com_)

_com_ :


gnome_db_config_component_new ()

GnomeDbConfigComponent* gnome_db_config_component_new
                                            (void);

Creates a new GnomeDbConfigComponent structure. This structure is used to represent the information stored in the configuration database about a component.

You would almost never want to use this routine directly, since the GnomeDbConfigComponent are created internally in the GNOME-DB library, and just returned to the programmer.

Returns :

the newly-created structure


gnome_db_config_component_free ()

void        gnome_db_config_component_free  (GnomeDbConfigComponent *component);

Frees all memory used by the given GnomeDbConfigComponent structure.

component :


gnome_db_config_component_set_name ()

void        gnome_db_config_component_set_name
                                            (GnomeDbConfigComponent *component,
                                             const gchar *name);

Sets the 'name' field in the given GnomeDbConfigComponent structure

component :

a GnomeDbConfigComponent structure name: the new name for the component

name :


gnome_db_config_component_set_location ()

void        gnome_db_config_component_set_location
                                            (GnomeDbConfigComponent *component,
                                             const gchar *location);

Sets the 'location' field in the given GnomeDbConfigComponent structure

component :

a GnomeDbConfigComponent structure

location :

new location for the component


gnome_db_config_component_set_description ()

void        gnome_db_config_component_set_description
                                            (GnomeDbConfigComponent *component,
                                             const gchar *desc);

Sets the 'description' field in the given GnomeDbConfigComponent structure

component :

a GnomeDbConfigComponent structure

desc :


gnome_db_config_component_set_repo_ids ()

void        gnome_db_config_component_set_repo_ids
                                            (GnomeDbConfigComponent *component,
                                             const gchar *repo_ids);

Sets the 'repo_ids' field in the given GnomeDbConfigComponent structure

component :

a GnomeDbConfigComponent structure

repo_ids :

new repository IDs for the component


gnome_db_config_component_set_type ()

void        gnome_db_config_component_set_type
                                            (GnomeDbConfigComponent *component,
                                             const gchar *type);

Sets the 'type' field in the given GnomeDbConfigComponent structure

component :

a GnomeDbConfigComponent structure

type :

new type for the component


gnome_db_config_component_set_icon ()

void        gnome_db_config_component_set_icon
                                            (GnomeDbConfigComponent *component,
                                             const gchar *icon);

Sets the 'icon' field in the given GnomeDbConfigComponent structure

component :

a GnomeDbConfigComponent structure

icon :

new icon for the component


gnome_db_config_get_all_components ()

GList*      gnome_db_config_get_all_components
                                            (void);

Returns :


gnome_db_config_get_shell_components ()

GList*      gnome_db_config_get_shell_components
                                            (void);

Return a list of all registered components that can be used in the gnome-db frontend. It's up to the programmer to free the returned list, which can be easily done by calling gnome_db_config_component_free_list.

Returns :

a GList of GnomeDbConfigComponent structures.


gnome_db_config_component_free_list ()

void        gnome_db_config_component_free_list
                                            (GList *list);

Frees the given list, which should be a GList of GnomeDbConfigComponent structures, as returned by gnome_db_config_get_shell_components or gnome_db_config_get_components.

list :

the list to be freed


GNOME_DB_CONFIG_SECTION_DESIGNER

#define GNOME_DB_CONFIG_SECTION_DESIGNER          "/apps/gnome-db/Designer"


GNOME_DB_CONFIG_SECTION_HELP_VIEWER

#define GNOME_DB_CONFIG_SECTION_HELP_VIEWER       "/apps/gnome-db/HelpViewer"


GNOME_DB_CONFIG_SECTION_HELP_VIEWER_DOCS

#define GNOME_DB_CONFIG_SECTION_HELP_VIEWER_DOCS  "/apps/gnome-db/HelpViewer/Docs"


GNOME_DB_CONFIG_SECTION_LAST_COMMANDS

#define GNOME_DB_CONFIG_SECTION_LAST_COMMANDS     "/apps/gnome-db/LastCommands"


GNOME_DB_CONFIG_SECTION_SAVED_SQL_QUERIES

#define GNOME_DB_CONFIG_SECTION_SAVED_SQL_QUERIES "/apps/gnome-db/SavedQueries/SQL"


GNOME_DB_CONFIG_SECTION_SAVED_XML_QUERIES

#define GNOME_DB_CONFIG_SECTION_SAVED_XML_QUERIES "/apps/gnome-db/SavedQueries/XML"


GNOME_DB_CONFIG_SECTION_SAVED_BATCH_JOBS

#define GNOME_DB_CONFIG_SECTION_SAVED_BATCH_JOBS  "/apps/gnome-db/SavedBatchJobs"


GNOME_DB_CONFIG_KEY_SHOW_TOOLTIPS

#define GNOME_DB_CONFIG_KEY_SHOW_TOOLTIPS         "/apps/gnome-db/Widgets/ShowTooltips"


GNOME_DB_REPO_CONTROL

#define GNOME_DB_REPO_CONTROL "IDL:GNOME/Database/UIControl:1.0"


GNOME_DB_OAFIID_BUILDER_FACTORY

#define GNOME_DB_OAFIID_BUILDER_FACTORY   "OAFIID:GNOME_Database_UIBuilderFactory"


GNOME_DB_OAFIID_COMPONENT_FACTORY

#define GNOME_DB_OAFIID_COMPONENT_FACTORY "OAFIID:GNOME_Database_UIComponentFactory"


GNOME_DB_OAFIID_MANAGER_FACTORY

#define GNOME_DB_OAFIID_MANAGER_FACTORY   "OAFIID:GNOME_Database_UIManagerFactory"


GNOME_DB_OAFIID_MONIKER_FACTORY

#define GNOME_DB_OAFIID_MONIKER_FACTORY   "OAFIID:GNOME_Database_UIMonikerFactory"


GNOME_DB_OAFIID_BUILDER

#define GNOME_DB_OAFIID_BUILDER          "OAFIID:GNOME_Database_UIBuilder_Control"


GNOME_DB_OAFIID_CONNECTION

#define GNOME_DB_OAFIID_CONNECTION       "OAFIID:GNOME_Database_UIConnection_Control"


GNOME_DB_OAFIID_DESIGNER

#define GNOME_DB_OAFIID_DESIGNER         "OAFIID:GNOME_Database_UIDesigner_Control"


GNOME_DB_OAFIID_EXPORT

#define GNOME_DB_OAFIID_EXPORT           "OAFIID:GNOME_Database_UIExport_Control"


GNOME_DB_OAFIID_IMPORT

#define GNOME_DB_OAFIID_IMPORT           "OAFIID:GNOME_Database_UIImport_Control"


GNOME_DB_OAFIID_LOG_VIEWER

#define GNOME_DB_OAFIID_LOG_VIEWER       "OAFIID:GNOME_Database_UILogViewer_Control"


GNOME_DB_OAFIID_MANAGER

#define GNOME_DB_OAFIID_MANAGER          "OAFIID:GNOME_Database_UIManager_Control"


GNOME_DB_OAFIID_MONIKER_DATABASE

#define GNOME_DB_OAFIID_MONIKER_DATABASE "OAFIID:GNOME_Database_UIMoniker_Database"

See Also

GnomeDbDsnConfig GnomeDbDsnConfigDruid