Top | ![]() |
![]() |
![]() |
![]() |
void | activate | Run Last |
void | disconnected | Run Last |
void | plug-created | Run Last |
void | set-frame | Run Last |
struct | BonoboControl |
BonoboControlPrivate | |
BonoboControlClass | |
#define | BONOBO_CONTROL_POPUP_BUTTON1 |
#define | BONOBO_CONTROL_POPUP_BUTTON2 |
#define | BONOBO_CONTROL_POPUP_BUTTON3 |
The BonoboControl object implements the CORBA interface for handling remote embeddable components. A Control is a light weight, single view, arbitrarily complex 'widget'. Controls typicaly expose much of their functionality through a property bag.
A BonoboControl provides the server ( or component ) side implementation of a Control. The client that uses this control will probably use a BonoboWidget to use the control in their program.
If you want to expose your widget as a control it is very simple
Example 1. CORBA-ifying your GtkWidget
1 2 3 4 5 6 7 |
BonoboControl *control; GtkWidget *widget; Bonobo_Unknown corba_object; widget = make_my_widget (); gtk_widget_show (widget); control = bonobo_control_new (widget); corba_object = BONOBO_OBJREF (control); |
The corba_object can then be passed off down the wire to anyone
and the control popped into a BonoboWidget or BonoboControlFrame
at the other end. Here is an even less useful example
Example 2. A pretty useless Control
1 2 3 4 |
GtkWidget *widget; widget = gtk_button_new_with_label ("My Control"); gtk_widget_show (widget); return bonobo_control_new (widget); |
If you learn only one thing from this example, it should be that
you need to do a gtk_widget_show on your control. It is not
sufficient to do a gtk_widget_show_all on the top level of the
client side, since this will not ( and should not ) propagate
over to the Control.
One final thing worth thinking about is activation. When a control is embedded inside a BonoboControlFrame, it is initialy inactive. In order for the control to recieve interactive input it is neccessary to use bonobo_control_frame_activate. This signals to the control that it is activated, at which point the Control should merge any UI elements it has with the associated BonoboUIComponent. This needs to be done every time the control is activated.
BonoboControl *
bonobo_control_new (GtkWidget *widget
);
This function creates a new BonoboControl object for widget
.
GtkWidget *
bonobo_control_get_widget (BonoboControl *control
);
Returns the GtkWidget associated with a BonoboControl.
void bonobo_control_set_automerge (BonoboControl *control
,gboolean automerge
);
Sets whether or not the control handles menu/toolbar merging automatically. If automerge is on, the control will automatically register its BonoboUIComponent with the remote BonoboUIContainer when it is activated.
gboolean
bonobo_control_get_automerge (BonoboControl *control
);
Whether or not the control is set to automerge its
menus/toolbars. See bonobo_control_set_automerge()
.
void bonobo_control_set_property (BonoboControl *control
,CORBA_Environment *opt_ev
,const char *first_prop
,...
);
This method takes a NULL terminated list of name, type, value triplicates, and sets the corresponding values on the control's associated property bag.
void bonobo_control_get_property (BonoboControl *control
,CORBA_Environment *opt_ev
,const char *first_prop
,...
);
This method takes a NULL terminated list of name, type, value triplicates, and fetches the corresponding values on the control's associated property bag.
void bonobo_control_set_transient_for (BonoboControl *control
,GtkWindow *window
,CORBA_Environment *opt_ev
);
Attempts to make the window
transient for the toplevel
of any associated controlframe the BonoboControl may have.
void bonobo_control_unset_transient_for (BonoboControl *control
,GtkWindow *window
,CORBA_Environment *opt_ev
);
BonoboControl * bonobo_control_construct (BonoboControl *control
,GtkWidget *widget
);
BonoboUIComponent *
bonobo_control_get_ui_component (BonoboControl *control
);
void bonobo_control_set_ui_component (BonoboControl *control
,BonoboUIComponent *component
);
Bonobo_UIContainer bonobo_control_get_remote_ui_container (BonoboControl *control
,CORBA_Environment *opt_ev
);
void bonobo_control_set_control_frame (BonoboControl *control
,Bonobo_ControlFrame control_frame
,CORBA_Environment *opt_ev
);
Bonobo_ControlFrame bonobo_control_get_control_frame (BonoboControl *control
,CORBA_Environment *opt_ev
);
void bonobo_control_set_properties (BonoboControl *control
,Bonobo_PropertyBag pb
,CORBA_Environment *opt_ev
);
Binds pb
to control
. When a remote object queries control
for its property bag, pb
will be used in the responses.
control |
A BonoboControl object. |
|
pb |
A Bonobo_PropertyBag. |
|
opt_ev |
An optional exception environment |
Bonobo_PropertyBag
bonobo_control_get_properties (BonoboControl *control
);
Bonobo_PropertyBag bonobo_control_get_ambient_properties (BonoboControl *control
,CORBA_Environment *opt_ev
);
control |
A BonoboControl which is bound to a remote BonoboControlFrame. |
|
opt_ev |
an optional exception environment |
void bonobo_control_activate_notify (BonoboControl *control
,gboolean activated
,CORBA_Environment *opt_ev
);
Notifies the remote ControlFrame which is associated with
control
that control
has been activated/deactivated.
control |
A BonoboControl object which is bound to a remote ControlFrame. |
|
activated |
Whether or not |
|
opt_ev |
An optional exception environment |
Bonobo_Gdk_WindowId
bonobo_control_window_id_from_x11 (guint32 x11_id
);
guint32
bonobo_control_x11_from_window_id (const CORBA_char *id
);
De-mangle a window id string, fields are separated by ':' character, currently only the first field is used.
BonoboUIContainer *
bonobo_control_get_popup_ui_container (BonoboControl *control
);
BonoboUIComponent *
bonobo_control_get_popup_ui_component (BonoboControl *control
);
void bonobo_control_set_popup_ui_container (BonoboControl *control
,BonoboUIContainer *ui_container
);
gboolean bonobo_control_do_popup (BonoboControl *control
,guint button
,guint32 activate_time
);
gboolean bonobo_control_do_popup_full (BonoboControl *control
,GtkWidget *parent_menu_shell
,GtkWidget *parent_menu_item
,GtkMenuPositionFunc func
,gpointer data
,guint button
,guint32 activate_time
);
void
bonobo_control_life_set_purge (long ms Param1
);
Set time we're prepared to wait without a ControlFrame before terminating the Control. This can happen if the panel activates us but crashes before the set_frame.
void
bonobo_control_life_set_callback (BonoboControlLifeCallback all_dead_callback
);
void
bonobo_control_life_instrument (BonoboControl *control
);
Request that control
is lifecycle managed by this code;
when it (and all other registerees are dead, the
all_dead_callback set by bonobo_control_life_set_callback
will be called at idle.
typedef struct { BonoboObjectClass parent_class; POA_Bonobo_Control__epv epv; gpointer dummy[2]; /* Signals. */ void (*plug_created) (BonoboControl *control); void (*disconnected) (BonoboControl *control); void (*set_frame) (BonoboControl *control); void (*activate) (BonoboControl *control, gboolean state); } BonoboControlClass;
“activate”
signalvoid user_function (BonoboControl *bonobocontrol, gboolean arg1, gpointer user_data)
bonobocontrol |
the object which received the signal. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“disconnected”
signalvoid user_function (BonoboControl *bonobocontrol, gpointer user_data)
bonobocontrol |
the object which received the signal. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“plug-created”
signalvoid user_function (BonoboControl *bonobocontrol, gpointer user_data)
bonobocontrol |
the object which received the signal. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“set-frame”
signalvoid user_function (BonoboControl *bonobocontrol, gpointer user_data)
bonobocontrol |
the object which received the signal. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last