gnome-embeddable-client

Name

gnome-embeddable-client —

Synopsis



GnomeViewFrame* gnome_embeddable_client_new_view
                                            (GnomeObjectClient *server_object,
                                             GnomeClientSite *client_site);
GnomeViewFrame* gnome_embeddable_client_new_view_simple
                                            (GnomeObjectClient *server_object,
                                             GnomeClientSite *client_site);
void        gnome_embeddable_client_activate
                                            (GnomeObjectClient *client_object);
void        gnome_embeddable_client_deactivate
                                            (GnomeObjectClient *client_object);
GList*      gnome_embeddable_client_get_verbs
                                            (GnomeObjectClient *server_object);
void        gnome_embeddable_client_free_verbs
                                            (GList *string_list);
void        gnome_view_client_do_verb       (GnomeView *view,
                                             const char *verb);

Description

Details

gnome_embeddable_client_new_view ()

GnomeViewFrame* gnome_embeddable_client_new_view
                                            (GnomeObjectClient *server_object,
                                             GnomeClientSite *client_site);

Creates a ViewFrame and asks the remote server_object (which must support the GNOME::Embeddable interface) to provide a new view of its data.

server_object : A handle to a remote object
client_site : the client site that contains the server_object.
Returns :a GtkWidget that contains the view frame for the new view of server_object bonobo_object.


gnome_embeddable_client_new_view_simple ()

GnomeViewFrame* gnome_embeddable_client_new_view_simple
                                            (GnomeObjectClient *server_object,
                                             GnomeClientSite *client_site);

Just like gnome_embeddable_new_view, this function creates a ViewFrame and asks server_object to provide a new view of its data. It then connects some simple callbacks to the ViewFrame's GnomeWrapper widget so that double clicks on the widget will cause the Embeddable to be activated. Finally, a callback is attached to the view_activated signal of the ViewFrame such that when the Embeddable notifies the ViewFrame that it is activated, the ViewFrame can hide the cover, allowing the user to interact with the embedded component.

server_object : The remote Embeddable server for which a new view should be created.
client_site : The local client site for this Embeddable.
Returns :the newly created ViewFrame.


gnome_embeddable_client_activate ()

void        gnome_embeddable_client_activate
                                            (GnomeObjectClient *client_object);

Activates the client object, this will make the object start receiving events from the windowing system

client_object : The pointer to the embedded server object


gnome_embeddable_client_deactivate ()

void        gnome_embeddable_client_deactivate
                                            (GnomeObjectClient *client_object);

DeActivates the client object, this will make the object stop receiving events from the windowing system.

client_object : The pointer to the embedded server object


gnome_embeddable_client_get_verbs ()

GList*      gnome_embeddable_client_get_verbs
                                            (GnomeObjectClient *server_object);

server_object : The pointer to the embedeed server object
Returns : A GList containing the string verbs supported by the Embeddable. The strings can be deallocated with a call to gnome_embeddable_free_verbs().


gnome_embeddable_client_free_verbs ()

void        gnome_embeddable_client_free_verbs
                                            (GList *string_list);

Releases the list returned previously by gnome_embeddable_get_verbs() function.

string_list : a list of strings, returned from gnome_embeddable_get_verbs().


gnome_view_client_do_verb ()

void        gnome_view_client_do_verb       (GnomeView *view,
                                             const char *verb);

Executes the verb verb in server_object.

view : 
verb : string representing the verb to perform