## gnome-db-config

gnome-db-config —

##

# Synopsis

    enum        GnomeDbComponentType;
    struct      GnomeDbComponentInfo;
    GList*      gnome_db_config_get_component_list
                                                (const gchar *query);
    void        gnome_db_config_free_component_list
                                                (GList *list);
    GdaDataModel* gnome_db_config_get_component_data_model
                                                (const gchar *query);
    gchar*      gnome_db_config_get_string      (const gchar *path);
    gint        gnome_db_config_get_int         (const gchar *path);
    gdouble     gnome_db_config_get_float       (const gchar *path);
    gboolean    gnome_db_config_get_boolean     (const gchar *path);
    void        gnome_db_config_set_string      (const gchar *path,
                                                 const gchar *new_value);
    void        gnome_db_config_set_int         (const gchar *path,
                                                 gint new_value);
    void        gnome_db_config_set_float       (const gchar *path,
                                                 gdouble new_value);
    void        gnome_db_config_set_boolean     (const gchar *path,
                                                 gboolean new_value);
    void        gnome_db_config_remove_section  (const gchar *path);
    void        gnome_db_config_remove_key      (const gchar *path);
    gboolean    gnome_db_config_has_section     (const gchar *path);
    gboolean    gnome_db_config_has_key         (const gchar *path);
    GList*      gnome_db_config_list_sections   (const gchar *path);
    GList*      gnome_db_config_list_keys       (const gchar *path);
    void        gnome_db_config_free_list       (GList *list);
    GList*      gnome_db_config_get_data_source_list
                                                (void);
    GdaDataSourceInfo* gnome_db_config_find_data_source
                                                (const gchar *name);
    GdaDataSourceInfo* gnome_db_config_copy_data_source_info
                                                (GdaDataSourceInfo *src);
    void        gnome_db_config_free_data_source_info
                                                (GdaDataSourceInfo *info);
    void        gnome_db_config_free_data_source_list
                                                (GList *list);
    void        gnome_db_config_remove_data_source
                                                (const gchar *name);
    void        gnome_db_config_save_data_source
                                                (const gchar *name,
                                                 const gchar *provider,
                                                 const gchar *cnc_string,
                                                 const gchar *description,
                                                 const gchar *username,
                                                 const gchar *password);
    guint       gnome_db_config_add_listener    (const gchar *path,
                                                 GConfClientNotifyFunc func,
                                                 gpointer user_data);
    void        gnome_db_config_remove_listener (guint id);
    #define     GNOME_DB_CONFIG_KEY_BROWSER_PANED_POSITION
    #define     GNOME_DB_CONFIG_KEY_EDITOR_HIGHLIGHT
    #define     GNOME_DB_CONFIG_KEY_EDITOR_SHOW_LINE_NUMBERS
    #define     GNOME_DB_CONFIG_KEY_EDITOR_TAB_STOP

## Description

## Details

### enum GnomeDbComponentType

    typedef enum {
    	GNOME_DB_COMPONENT_TYPE_INVALID = -1,
    	GNOME_DB_COMPONENT_TYPE_EXE,
    	GNOME_DB_COMPONENT_TYPE_SHLIB,
    	GNOME_DB_COMPONENT_TYPE_FACTORY
    } GnomeDbComponentType;

### struct GnomeDbComponentInfo

    struct GnomeDbComponentInfo {

    	gchar *id;
    	gchar *location;
    	GnomeDbComponentType type;
    	gchar *description;
    	GList *repo_ids;
    	gchar *username;
    	gchar *hostname;
    	gchar *domain;
    	GdaParameterList *properties;
    };

### gnome_db_config_get_component_list ()

    GList*      gnome_db_config_get_component_list
                                                (const gchar *query);

Return a list of all components currently installed in the system that match the given query (see BonoboActivation documentation). Each of the nodes in the returned GList is a GnomeDbComponentInfo. To free the returned list, call the gnome_db_config_free_component_list function.

`query` : | condition for components to be retrieved.
Returns : | a GList of GnomeDbComponentInfo structures.

### gnome_db_config_free_component_list ()

    void        gnome_db_config_free_component_list
                                                (GList *list);

`list` : |

### gnome_db_config_get_component_data_model ()

    GdaDataModel* gnome_db_config_get_component_data_model
                                                (const gchar *query);

Return a list of all components currently installed in the system that match the given query (see BonoboActivation documentation).

`query` : | condition for components to be retrieved.
Returns : | a GdaDataModel object, or `NULL` on failure.

### gnome_db_config_get_string ()

    gchar*      gnome_db_config_get_string      (const gchar *path);

Gets the value of the specified configuration entry as a string. You are then responsible to free the returned string

`path` : | path to the configuration entry
Returns : | the value stored at the given entry

### gnome_db_config_get_int ()

    gint        gnome_db_config_get_int         (const gchar *path);

Gets the value of the specified configuration entry as an integer

`path` : | path to the configuration entry
Returns : | the value stored at the given entry

### gnome_db_config_get_float ()

    gdouble     gnome_db_config_get_float       (const gchar *path);

Gets the value of the specified configuration entry as a float

`path` : | path to the configuration entry
Returns : | the value stored at the given entry

### gnome_db_config_get_boolean ()

    gboolean    gnome_db_config_get_boolean     (const gchar *path);

Gets the value of the specified configuration entry as a boolean

`path` : | path to the configuration entry
Returns : | the value stored at the given entry

### gnome_db_config_set_string ()

    void        gnome_db_config_set_string      (const gchar *path,
                                                 const gchar *new_value);

Sets the given configuration entry to contain a string

`path` : | path to the configuration entry
`new_value` : | new value

### gnome_db_config_set_int ()

    void        gnome_db_config_set_int         (const gchar *path,
                                                 gint new_value);

Sets the given configuration entry to contain an integer

`path` : | path to the configuration entry
`new_value` : | new value

### gnome_db_config_set_float ()

    void        gnome_db_config_set_float       (const gchar *path,
                                                 gdouble new_value);

Sets the given configuration entry to contain a float

`path` : | path to the configuration entry
`new_value` : | new value

### gnome_db_config_set_boolean ()

    void        gnome_db_config_set_boolean     (const gchar *path,
                                                 gboolean new_value);

Sets the given configuration entry to contain a boolean

`path` : | path to the configuration entry
`new_value` : | new value

### gnome_db_config_remove_section ()

    void        gnome_db_config_remove_section  (const gchar *path);

Remove the given section from the configuration database

`path` : | path to the configuration section

### gnome_db_config_remove_key ()

    void        gnome_db_config_remove_key      (const gchar *path);

Remove the given entry from the configuration database

`path` : | path to the configuration entry

### gnome_db_config_has_section ()

    gboolean    gnome_db_config_has_section     (const gchar *path);

Checks whether the given section exists in the configuration system

`path` : | path to the configuration section
Returns : | TRUE if the section exists, FALSE otherwise

### gnome_db_config_has_key ()

    gboolean    gnome_db_config_has_key         (const gchar *path);

Check whether the given key exists in the configuration system

`path` : | path to the configuration key
Returns : | TRUE if the entry exists, FALSE otherwise

### gnome_db_config_list_sections ()

    GList*      gnome_db_config_list_sections   (const gchar *path);

Return a GList containing the names of all the sections available under the given root directory.

To free the returned value, you can use gnome_db_config_free_list

`path` : | path for root dir
Returns : | a list containing all the section names

### gnome_db_config_list_keys ()

    GList*      gnome_db_config_list_keys       (const gchar *path);

Returns a list of all keys that exist under the given path.

To free the returned value, you can use gnome_db_config_free_list

`path` : | path for root dir
Returns : | a list containing all the key names

### gnome_db_config_free_list ()

    void        gnome_db_config_free_list       (GList *list);

Free all memory used by the given GList, which must be the return value from either gnome_db_config_list_sections and gnome_db_config_list_keys

`list` : | list to be freed

### gnome_db_config_get_data_source_list ()

    GList*      gnome_db_config_get_data_source_list
                                                (void);

Retrieves information about available data sources.

Returns : | a GList of GdaDatasourceInfo structures.

### gnome_db_config_find_data_source ()

    GdaDataSourceInfo* gnome_db_config_find_data_source
                                                (const gchar *name);

Looks for a data source given its name. The search is case insensitive.

`name` : | name of the data source to look for.
Returns : | a GdaDatasourceInfo structure.

### gnome_db_config_copy_data_source_info ()

    GdaDataSourceInfo* gnome_db_config_copy_data_source_info
                                                (GdaDataSourceInfo *src);

Copies a GdaDataSourceInfo structure.

`src` : | GdaDataSourceInfo to copy
Returns : | a copy of `src`.

### gnome_db_config_free_data_source_info ()

    void        gnome_db_config_free_data_source_info
                                                (GdaDataSourceInfo *info);

Frees the resources allocated by a GdaDataSourceInfo.

`info` : | the struture to deallocate.

### gnome_db_config_free_data_source_list ()

    void        gnome_db_config_free_data_source_list
                                                (GList *list);

Frees the `list`.

`list` : | a GList returned by gnome_db_config_get_data_source_list.

### gnome_db_config_remove_data_source ()

    void        gnome_db_config_remove_data_source
                                                (const gchar *name);

Removes the given data source from the GDA configuration.

`name` : | Name for the data source to be removed.

### gnome_db_config_save_data_source ()

    void        gnome_db_config_save_data_source
                                                (const gchar *name,
                                                 const gchar *provider,
                                                 const gchar *cnc_string,
                                                 const gchar *description,
                                                 const gchar *username,
                                                 const gchar *password);

Adds a new data source (or update an existing one) to the GDA configuration, based on the parameters given.

`name` : | Name for the data source to be saved.
`provider` : | Provider ID for the new data source.
`cnc_string` : | Connection string for the new data source.
`description` : | Description for the new data source.
`username` : | User name for the new data source.
`password` : | Password to use when authenticating `username`.

### gnome_db_config_add_listener ()

    guint       gnome_db_config_add_listener    (const gchar *path,
                                                 GConfClientNotifyFunc func,
                                                 gpointer user_data);

Installs a configuration listener, which is a callback function which will be called every time a change occurs on a given configuration entry.

`path` : | configuration path to listen to.
`func` : | callback function.
`user_data` : | data to be passed to the callback function.
Returns : | the ID of the listener, which you will need for calling gda_config_remove_listener. If an error occurs, 0 is returned.

### gnome_db_config_remove_listener ()

    void        gnome_db_config_remove_listener (guint id);

Removes a previously installed configuration listener.

`id` : | the value returned from the call to gnome_db_config_add_listener

### GNOME_DB_CONFIG_KEY_BROWSER_PANED_POSITION

    #define GNOME_DB_CONFIG_KEY_BROWSER_PANED_POSITION   "/apps/gnome-db/Browser/PanedPosition"

### GNOME_DB_CONFIG_KEY_EDITOR_HIGHLIGHT

    #define GNOME_DB_CONFIG_KEY_EDITOR_HIGHLIGHT         "/apps/gnome-db/Editor/Highlight"

### GNOME_DB_CONFIG_KEY_EDITOR_SHOW_LINE_NUMBERS

    #define GNOME_DB_CONFIG_KEY_EDITOR_SHOW_LINE_NUMBERS "/apps/gnome-db/Editor/ShowLineNumbers"

### GNOME_DB_CONFIG_KEY_EDITOR_TAB_STOP

    #define GNOME_DB_CONFIG_KEY_EDITOR_TAB_STOP          "/apps/gnome-db/Editor/TabStop"