PrevUpHomeGNOME-DB API referenceNext

GnomeDbControlWidget

Name

GnomeDbControlWidget -- Client side of the GNOME-DB Bonobo controls

Synopsis



GtkWidget*  gnome_db_control_widget_new     (const gchar *id,
                                             Bonobo_UIContainer uic);
gboolean    gnome_db_control_widget_supported
                                            (const gchar *goad_id);
gboolean    gnome_db_control_widget_is_alive
                                            (GnomeDbControlWidget *wid);
void        gnome_db_control_widget_activate
                                            (GnomeDbControlWidget *wid);
void        gnome_db_control_widget_deactivate
                                            (GnomeDbControlWidget *wid);
#define     gnome_db_control_widget_get_repo_id(_wid_)
gboolean    gnome_db_control_widget_prop_supported
                                            (GnomeDbControlWidget *wid,
                                             const gchar *prop_name);
void        gnome_db_control_widget_get_prop
                                            (GnomeDbControlWidget *wid,
                                             const gchar *prop_name,
                                             gpointer *value);
void        gnome_db_control_widget_set_prop_ptr
                                            (GnomeDbControlWidget *wid,
                                             const gchar *prop_name,
                                             gconstpointer value);
void        gnome_db_control_widget_set_prop
                                            (GnomeDbControlWidget *wid,
                                             const gchar *prop_name,
                                             ...);
gchar*      gnome_db_control_widget_get_version
                                            (GnomeDbControlWidget *wid);
gchar*      gnome_db_control_widget_get_authors
                                            (GnomeDbControlWidget *wid);
void        gnome_db_control_widget_run     (GnomeDbControlWidget *wid);
void        gnome_db_control_widget_set_owner
                                            (GnomeDbControlWidget *wid);
void        gnome_db_control_widget_unset_owner
                                            (GnomeDbControlWidget *wid);
void        gnome_db_control_widget_do_print
                                            (GnomeDbControlWidget *wid);
void        gnome_db_control_widget_do_cut_clipboard
                                            (GnomeDbControlWidget *wid);
void        gnome_db_control_widget_do_copy_clipboard
                                            (GnomeDbControlWidget *wid);
void        gnome_db_control_widget_do_paste_clipboard
                                            (GnomeDbControlWidget *wid);

Description

The GnomeDbControlWidget widget allows you to easily load GNOME-DB Bonobo controls in your application. It is, in other words, the client side of the GNOME::Database::UIControl interface, allowing you not only to load *ANY* Bonobo control (not only GNOME-DB ones), but to interact with the control through the GNOME::Database::UIControl interface if the loaded control implements it.

Details

gnome_db_control_widget_new ()

GtkWidget*  gnome_db_control_widget_new     (const gchar *id,
                                             Bonobo_UIContainer uic);

Creates a new widget that loads the Bonobo control specified by the id parameter. The second argument, uic, is needed to associate a Bonobo container with the new control, so that menus and toolbars are merged. This is easily done by using a GnomeDbWindow for all your Bonobo container needs, and then use the gnome_db_window_get_ui_container to retrieve the Bonobo_UIContainer associated with the GnomeDbWindow widget.

id :

ID of the Bonobo control to be loaded

uic :

a reference to the Bonobo_UIContainer to use for the control

Returns :

a pointer to the newly-created widget

gnome_db_control_widget_supported ()

gboolean    gnome_db_control_widget_supported
                                            (const gchar *goad_id);

goad_id :

Returns :

gnome_db_control_widget_is_alive ()

gboolean    gnome_db_control_widget_is_alive
                                            (GnomeDbControlWidget *wid);

Pings the given GnomeDbControlWidget widget to see if the underlying CORBA server is still alive.

wid :

a GnomeDbControlWidget widget

Returns :

TRUE if alive, FALSE if dead

gnome_db_control_widget_activate ()

void        gnome_db_control_widget_activate
                                            (GnomeDbControlWidget *wid);

Activates the given GnomeDbControlWidget widget. This means that the underlying control's menus and toolbars will be merged with the menus and toolbars of the container being used, generally a GnomeDbWindow widget.

wid :

a GnomeDbControlWidget widget

gnome_db_control_widget_deactivate ()

void        gnome_db_control_widget_deactivate
                                            (GnomeDbControlWidget *wid);

Deactivates the given GnomeDbControlWidget widget. This means that all of the control's menus and toolbars are removed from the container.

wid :

a GnomeDbControlWidget widget

gnome_db_control_widget_get_repo_id()

#define     gnome_db_control_widget_get_repo_id(_wid_)

_wid_ :

gnome_db_control_widget_prop_supported ()

gboolean    gnome_db_control_widget_prop_supported
                                            (GnomeDbControlWidget *wid,
                                             const gchar *prop_name);

wid :

prop_name :

Returns :

gnome_db_control_widget_get_prop ()

void        gnome_db_control_widget_get_prop
                                            (GnomeDbControlWidget *wid,
                                             const gchar *prop_name,
                                             gpointer *value);

wid :

prop_name :

value :

gnome_db_control_widget_set_prop_ptr ()

void        gnome_db_control_widget_set_prop_ptr
                                            (GnomeDbControlWidget *wid,
                                             const gchar *prop_name,
                                             gconstpointer value);

wid :

prop_name :

value :

gnome_db_control_widget_set_prop ()

void        gnome_db_control_widget_set_prop
                                            (GnomeDbControlWidget *wid,
                                             const gchar *prop_name,
                                             ...);

wid :

prop_name :

... :

gnome_db_control_widget_get_version ()

gchar*      gnome_db_control_widget_get_version
                                            (GnomeDbControlWidget *wid);

Return the version supported by the underlying control.

wid :

control widget

Returns :

a newly allocated string that contains the version number.

gnome_db_control_widget_get_authors ()

gchar*      gnome_db_control_widget_get_authors
                                            (GnomeDbControlWidget *wid);

wid :

Returns :

gnome_db_control_widget_run ()

void        gnome_db_control_widget_run     (GnomeDbControlWidget *wid);

wid :

control widget

gnome_db_control_widget_set_owner ()

void        gnome_db_control_widget_set_owner
                                            (GnomeDbControlWidget *wid);

wid :

a GnomeDbControlWidget widget

gnome_db_control_widget_unset_owner ()

void        gnome_db_control_widget_unset_owner
                                            (GnomeDbControlWidget *wid);

wid :

gnome_db_control_widget_do_print ()

void        gnome_db_control_widget_do_print
                                            (GnomeDbControlWidget *wid);

wid :

control widget

gnome_db_control_widget_do_cut_clipboard ()

void        gnome_db_control_widget_do_cut_clipboard
                                            (GnomeDbControlWidget *wid);

wid :

control widget

gnome_db_control_widget_do_copy_clipboard ()

void        gnome_db_control_widget_do_copy_clipboard
                                            (GnomeDbControlWidget *wid);

wid :

control widget

gnome_db_control_widget_do_paste_clipboard ()

void        gnome_db_control_widget_do_paste_clipboard
                                            (GnomeDbControlWidget *wid);

wid :

control widget

<<< gnome-db-control-defpropsGnomeDbControl >>>