BonoboUIComponent
A UI interface that handles UI merging for a component
The BonoboUIComponent is the client side portion of the UI merging scheme.
It should be implemented by any component that wishes to merge menus / UI.
The Component object is neccessary to receive notifications from the
associated #BonoboUIContainer. Notifications come in two forms - verbs and
events. Verbs have an associated ( non translated ) name that is used to
match them with callbacks. Events have an associated ( non translated ) id
that does the same thing. Events pass a state string. Events are used for
eg. toggle buttons, Verbs are used for eg. Menu items.
Mostly you don't need to bother with creating your own BonoboUIComponent,
if you implement a Control eg. a BonoboUIComponent is created at Control
construction time and can be accessed thus:
Using the UI Component associated with a control
/*
* For the format of the XML see bonobo/doc/xml-ui.txt
* For a standard template to base your UI on see bonobo/doc/std-ui.xml
*/
const char my_ui_elements [] =
">placeholder name=\"FileOps\"<"
" >menuitem name=\"Foo\" verb=\"FileFoo\" _label=\"Foo!\""
" _tip=\"do some foo thing\"/<"
">/placeholder<";
static void
control_activate_cb (BonoboControl *object,
gboolean state,
gpointer user_data)
{
BonoboUIComponent *ui_component;
/* Get UIComponent from control */
ui_component = bonobo_control_get_ui_component (control);
if (state) /* Activate */
bonobo_ui_component_set_translate (
ui_component, "/menu/File", my_ui_elements, NULL);
else /* De-activate */
bonobo_ui_component_unset_container (ui_component);
}
static void
verb_foo_cb (BonoboUIComponent *ui_container,
gpointer user_data,
const char *cname)
{
BonoboControl *control = user_data;
g_print ("FileFoo !\n");
}
static BonoboUIVerb my_ui_verbs[] = {
BONOBO_UI_VERB ("FileFoo", verb_foo_cb),
BONOBO_UI_VERB_END
};
BonoboObject *
create_ui_control (void)
{
BonoboControl *control;
BonoboUIComponent *ui_component;
GtkWidget *widget;
control = bonobo_control_new ((widget = gtk_widget_new_label ("Hello World")));
/* Automaticaly associate the remote UIContainer for us on activate */
bonobo_control_set_automerge (control, TRUE);
ui_component = bonobo_control_get_ui_component (control);
/* Register the verbs with the UI Component */
bonobo_ui_component_add_verb_list_with_data (
ui_component, my_ui_verbs, control);
gtk_signal_connect (GTK_OBJECT (control), "activate",
GTK_SIGNAL_FUNC (control_activate_cb), NULL);
gtk_widget_show (widget);
return BONOBO_OBJECT (control);
}
This sets up the UI, associates a 'FileFoo' verb with a callback, and
on control activation merges the UI elements into a standard path
in the file menu.
There are several standard placeholders that it is important for
containers to implement, basing your UI on the doc/std-ui.xml is
a very good starting point. Also in the above example the _label
and _tip are not cmd / widget separated - for more information read
doc/ui-xml.txt.
Most applications will should not use the BonoboUIComponent in this
way, there is a bonobo_ui_util_set_ui that does
the translation, help menu build, insertion etc. from an installed
XML file. The above example is complete except for translation, which
is extremely important. Here is a better activate function:
A better way to create your UI
static void
control_activate_cb (BonoboControl *object,
gboolean state,
gpointer user_data)
{
BonoboUIComponent *ui_component;
/* Get UIComponent from control */
ui_component = bonobo_control_get_ui_component (control);
if (state) /* Activate */
/*
* Use a helper function to setup your UI from a file:
*/
bonobo_ui_util_set_ui (
ui_component, MY_COMPILE_TIME_PREFIX,
"GNOME_MyApp.ui", "my-app");
else /* De-activate */
bonobo_ui_component_unset_container (ui_component);
}
In this example "GNOME_MyApp.ui" is the correctly namespaced UI
xml filename, ( see doc/NAMESPACE to register your name ), and
"my-app" is the gnome application name, from which a path to your
installed help files can be deduced.
#BonoboUIContainer, , #BonoboControl
@bonobouicomponent: the object which received the signal.
@arg1:
@bonobouicomponent: the object which received the signal.
@arg1:
@arg2:
@arg3:
@component:
@path:
@type:
@state:
@user_data:
@component:
@user_data:
@cname:
@parent_class:
@epv:
@dummy:
@exec_verb:
@ui_event:
@freeze:
@thaw:
@xml_set:
@xml_get:
@xml_rm:
@set_prop:
@get_prop:
@exists:
@component:
@name:
@Returns:
@name:
@Returns:
@Returns:
@component:
@name:
@component:
@Returns:
@component:
@container:
@opt_ev:
@component:
@opt_ev:
@component:
@Returns:
@component:
@cname:
@fn:
@user_data:
@component:
@cname:
@closure:
@component:
@cname:
@component:
@closure:
@component:
@id:
@fn:
@user_data:
@component:
@id:
@closure:
@component:
@cname:
@component:
@closure:
@component:
@path:
@xml:
@opt_ev:
@component:
@path:
@xml:
@opt_ev:
@component:
@path:
@node:
@ev:
@component:
@path:
@ev:
@component:
@path:
@ev:
@Returns:
@component:
@path:
@recurse:
@opt_ev:
@Returns:
@component:
@path:
@recurse:
@opt_ev:
@Returns:
@component:
@path:
@control:
@opt_ev:
@component:
@path:
@opt_ev:
@Returns:
@component:
@path:
@widget:
@opt_ev:
@component:
@opt_ev:
@component:
@opt_ev:
@component:
@path:
@prop:
@value:
@opt_ev:
@component:
@path:
@prop:
@opt_ev:
@Returns:
@component:
@text:
@opt_ev:
@cname:
@cb:
@user_data:
@dummy:
This declares and fills a BonoboUIVerb structure suitable for
use in constructing a lost of verbs to add with
bonobo_ui_component_add_verb_list_with_data.
@name: the verb name
@cb: the callback function.
This declares and fills a BonoboUIVerb structure suitable for
use in constructing a lost of verbs to add with
bonobo_ui_component_add_verb_list.
@name: the verb name
@cb: the callback function
@data: some associated user_data
As BONOBO_UI_VERB, but unsafely casts @cb to the correct type
@name: the verb name
@cb: the callback function.
As BONOBO_UI_VERB_DATA, but unsafely casts @cb to the correct type
@name: the verb name
@cb: the callback function
@data: some associated user_data
The terminator BonoboUIVerb structure for a list of BonoboUIVerbs.
@component:
@list:
@component:
@list:
@user_data: