struct BonoboWidget

struct BonoboWidget;

BonoboWidgetClass

typedef struct {
	GtkBinClass	 bin_class;
} BonoboWidgetClass;

bonobo_widget_get_server ()

BonoboObjectClient* bonobo_widget_get_server
                                            (BonoboWidget *bw);

bonobo_widget_construct_control ()

BonoboWidget* bonobo_widget_construct_control
                                            (BonoboWidget *bw,
                                             const char *moniker,
                                             Bonobo_UIContainer uic);

This is a constructor function. Only usable for wrapping and derivation of new objects. For normal use, please refer to bonobo_widget_new_control.

This function will unref the passed in bw in case it cannot launch the component and return NULL in such a case. Otherwise it returns the bw itself.

bonobo_widget_construct_control_from_objref ()

BonoboWidget* bonobo_widget_construct_control_from_objref
                                            (BonoboWidget *bw,
                                             Bonobo_Control control,
                                             Bonobo_UIContainer uic);

This is a constructor function. Only usable for wrapping and derivation of new objects. For normal use, please refer to bonobo_widget_new_control_from_objref.

bonobo_widget_new_control ()

GtkWidget*  bonobo_widget_new_control       (const char *moniker,
                                             Bonobo_UIContainer uic);

This function is a simple wrapper for easily embedding controls into applications. It will launch the component identified by id and will return it as a GtkWidget.

bonobo_widget_new_control_from_objref ()

GtkWidget*  bonobo_widget_new_control_from_objref
                                            (Bonobo_Control control,
                                             Bonobo_UIContainer uic);

This function is a simple wrapper for easily embedding controls into applications. This function is used when you have already a CORBA object reference to an IDL:Bonobo/Control:1.0 (the control) argument.

bonobo_widget_get_control_frame ()

BonoboControlFrame* bonobo_widget_get_control_frame
                                            (BonoboWidget *bw);

Every IDL:Bonobo/Control:1.0 needs to be placed inside an IDL:Bonobo/ControlFrame:1.0. This returns the BonoboControlFrame object that wraps the Control in the bonobo_widget.

bonobo_widget_new_subdoc ()

GtkWidget*  bonobo_widget_new_subdoc        (const char *moniker,
                                             Bonobo_UIContainer uic);

This function is a simple wrapper for easily embedding documents into applications. It will launch the component identified by id and will return it as a GtkWidget.

This will launch a single view of the embeddable activated by moniker.

FIXME: this function should really be using bonobo_get_object() instead of bonobo_activate_object() to launch the object.

bonobo_widget_get_container ()

BonoboItemContainer* bonobo_widget_get_container
                                            (BonoboWidget *bw);

This operation is only valid for BonoboWidgets that were created by the bonobo_widget_new_subdoc().

bonobo_widget_get_client_site ()

BonoboClientSite* bonobo_widget_get_client_site
                                            (BonoboWidget *bw);

This operation is only valid for BonoboWidgets that were created by the bonobo_widget_new_subdoc().

bonobo_widget_get_view_frame ()

BonoboViewFrame* bonobo_widget_get_view_frame
                                            (BonoboWidget *bw);

This operation is only valid for BonoboWidgets that were created by the bonobo_widget_new_subdoc().

bonobo_widget_get_uih ()

Bonobo_UIContainer bonobo_widget_get_uih    (BonoboWidget *bw);

bonobo_widget_get_objref ()

Bonobo_Unknown bonobo_widget_get_objref     (BonoboWidget *bw);

bonobo_widget_set_property ()

void        bonobo_widget_set_property      (BonoboWidget *control,
                                             const char *first_prop,
                                             ...);

This is a utility function used to set a number of properties in the Bonobo Control in control.

This function takes a variable list of arguments that must be NULL terminated. Arguments come in tuples: a string (for the argument name) and the data type that is to be transfered. The implementation of the actual setting of the PropertyBag values is done by the bonobo_property_bag_client_setv() function).

FIXME: This function is error prone because it depends on the client and the server to agree on the data types to be sent. If the server arguments change the data type, this routine will not be able to cope gracefully with this condition.

This only works for BonoboWidgets that represent controls (ie, that were returned by bonobo_widget_new_control_from_objref() or bonobo_widget_new_control().

bonobo_widget_get_property ()

void        bonobo_widget_get_property      (BonoboWidget *control,
                                             const char *first_prop,
                                             ...);

This is a utility function used to get a number of properties in the Bonobo Control in control.

This function takes a variable list of arguments that must be NULL terminated. Arguments come in tuples: a string (for the argument name) and a pointer where the data will be stored. The implementation of the actual setting of the PropertyBag values is done by the bonobo_property_bag_client_setv() function).

FIXME: This function is error prone because it depends on the client and the server to agree on the data types to be sent. If the server arguments change the data type, this routine will not be able to cope gracefully with this condition.

This only works for BonoboWidgets that represent controls (ie, that were returned by bonobo_widget_new_control_from_objref() or bonobo_widget_new_control().