PrevUpHomeGNOME-DB API referenceNext

GnomeDbBrowser

Name

GnomeDbBrowser -- A database browser widget

Synopsis



struct      GnomeDbBrowserPrivate;
GtkWidget*  gnome_db_browser_new            (GdaConnection *cnc);
GdaConnection* gnome_db_browser_get_connection
                                            (GnomeDbBrowser *browser);
void        gnome_db_browser_set_connection (GnomeDbBrowser *browser,
                                             GdaConnection *cnc);
void        gnome_db_browser_show_of_type   (GnomeDbBrowser *browser,
                                             GDA_Connection_QType qtype);
void        gnome_db_browser_refresh        (GnomeDbBrowser *browser);

Description

The GnomeDbBrowser widget is a self-contained widget that lets the user easily navigate throughout the strucutre of a database. It allows the view of tables, views, sequences, stored procedures, etc, as well as detailed information about each object.

The way the GnomeDbBrowser widget works is straightforward: you just have to associate a valid GdaConnection object to it, and then, it will manage everything (that is, user interaction) for you. It also offers some "low-level" methods that let you manipulate a bit how the widget looks on screen or reacts.

Details

struct GnomeDbBrowserPrivate

struct GnomeDbBrowserPrivate;

gnome_db_browser_new ()

GtkWidget*  gnome_db_browser_new            (GdaConnection *cnc);

Creates a new GnomeDbBrowser widget. You can associate a connection to the widget at creation time by calling this function with an already established connection as the cnc parameter. You can also associate later on another connection to the GnomeDbBrowser widget by calling gnome_db_browser_set_connection.

cnc :

a GdaConnection

Returns :

the newly created browser widget

gnome_db_browser_get_connection ()

GdaConnection* gnome_db_browser_get_connection
                                            (GnomeDbBrowser *browser);

Gets the GdaConnection associated with the given browser widget.

browser :

a GnomeDbBrowser widget

Returns :

the connection being used by the browser widget

gnome_db_browser_set_connection ()

void        gnome_db_browser_set_connection (GnomeDbBrowser *browser,
                                             GdaConnection *cnc);

Associates a GdaConnection object with the given GnomeDbBrowser widget. By doing so, the browser widget will react accordingly by refreshing all the information it is showing, so that it reflects the structure of the new connection.

browser :

a GnomeDbBrowser widget

cnc :

a GdaConnection

gnome_db_browser_show_of_type ()

void        gnome_db_browser_show_of_type   (GnomeDbBrowser *browser,
                                             GDA_Connection_QType qtype);

Activates, in the given GnomeDbBrowser widget, the list of objects for the given type. For a list of valid types, the GDA schemas constraint type is used (GDA_Connection_QType), so any valid constraint type can be passed to this function.

Note, however, that the GnomeDbBrowser does not know how to show all kinds of objects, so this may not work for some schema types.

browser :

A GnomeDbBrowser widget

qtype :

The type of the objects to show

gnome_db_browser_refresh ()

void        gnome_db_browser_refresh        (GnomeDbBrowser *browser);

Refreshes all the information being displayed by the given GnomeDbBrowser widget

browser :

a GnomeDbBrowser widget

<<< GNOME-DB widgetsGnomeDbCombo >>>