GnomeDbControl

GnomeDbControl — Bonobo control implementation wrapper

Synopsis




            GnomeDbControlPrivate;
GnomeDbControl* gnome_db_control_construct  (GnomeDbControl *control,
                                             GtkWidget *widget);
GnomeDbControl* gnome_db_control_new        (GtkWidget *widget);
void        gnome_db_control_set_ui         (GnomeDbControl *control,
                                             const gchar *app_prefix,
                                             const gchar *ui_xml_file,
                                             BonoboUIVerb *verbs,
                                             gpointer user_data);
void        gnome_db_control_activate       (GnomeDbControl *control);
void        gnome_db_control_deactivate     (GnomeDbControl *control);
void        gnome_db_control_set_status     (GnomeDbControl *control,
                                             const gchar *msg);

Description

Details

GnomeDbControlPrivate

typedef struct _GnomeDbControlPrivate GnomeDbControlPrivate;


gnome_db_control_construct ()

GnomeDbControl* gnome_db_control_construct  (GnomeDbControl *control,
                                             GtkWidget *widget);

control :
widget :
Returns :

gnome_db_control_new ()

GnomeDbControl* gnome_db_control_new        (GtkWidget *widget);

Creates a new GnomeDbControl object, which is an instance of the Bonobo::Control CORBA interface, with some useful additions.

When calling this function, you must specify an already created GtkWidget, which is the one that will be used for creating the Bonobo control. You should use this class if you intend to write your own Bonobo controls.

widget : the widget to be wrapped by the control
Returns : the newly created GnomeDbControl object.

gnome_db_control_set_ui ()

void        gnome_db_control_set_ui         (GnomeDbControl *control,
                                             const gchar *app_prefix,
                                             const gchar *ui_xml_file,
                                             BonoboUIVerb *verbs,
                                             gpointer user_data);

Sets the UI for the given GnomeDbControl object. This is done by specifying a file that contains the description of the UI (see Bonobo documentation) and a set of verbs and their corresponding actions.

control : a GnomeDbControl object
app_prefix : the prefix where your application data is installed. This is used by the underlying Bonobo code, which searches for the given file in that directory
ui_xml_file : name of the file in app_prefix that contains the XML description of the component's UI
verbs : list of verbs and corresponding actions
user_data : data to be passed to the verb callback functions

gnome_db_control_activate ()

void        gnome_db_control_activate       (GnomeDbControl *control);

Activates the given GnomeDbControl object. This means that the UI for this control is merged with the UI of the container.

control : a GnomeDbControl object

gnome_db_control_deactivate ()

void        gnome_db_control_deactivate     (GnomeDbControl *control);

Deactivates the given GnomeDbControl object, which means that the control's UI is removed from the container's.

control : a GnomeDbControl object

gnome_db_control_set_status ()

void        gnome_db_control_set_status     (GnomeDbControl *control,
                                             const gchar *msg);

Displays the given message on the container's status bar. If you use GnomeDbWindow for your containers, you automatically have a status bar on your window, and, with this function, you can set the message to be displayed on that status bar from the components.

control : a GnomeDbControl object
msg : message to show on the status bar