Bonobo API Reference Manual
<<< Previous Page | Home | Up | Next Page >>>

# BonoboViewFrame

## Name

BonoboViewFrame -- the container side frame for a BonoboView

## Synopsis

    struct      BonoboViewFrame;
    struct      BonoboViewFrameClass;
    BonoboViewFrame* bonobo_view_frame_construct
                                                (BonoboViewFrame *view_frame,
                                                 BonoboClientSite *client_site,
                                                 Bonobo_UIContainer uih);
    BonoboViewFrame* bonobo_view_frame_new      (BonoboClientSite *client_site,
                                                 Bonobo_Unknown uih);
    void        bonobo_view_frame_bind_to_view  (BonoboViewFrame *view_frame,
                                                 Bonobo_View view);
    Bonobo_View bonobo_view_frame_get_view      (BonoboViewFrame *view_frame);
    BonoboClientSite* bonobo_view_frame_get_client_site
                                                (BonoboViewFrame *view_frame);
    GtkWidget*  bonobo_view_frame_get_wrapper   (BonoboViewFrame *view_frame);
    void        bonobo_view_frame_set_covered   (BonoboViewFrame *view_frame,
                                                 gboolean covered);
    Bonobo_UIContainer bonobo_view_frame_get_ui_container
                                                (BonoboViewFrame *view_frame);
    void        bonobo_view_frame_view_activate (BonoboViewFrame *view_frame);
    void        bonobo_view_frame_view_deactivate
                                                (BonoboViewFrame *view_frame);
    void        bonobo_view_frame_set_zoom_factor
                                                (BonoboViewFrame *view_frame,
                                                 double zoom);

## Object Hierarchy

      GtkObject
       +----BonoboObject
             +----BonoboXObject
                   +----BonoboControlFrame
                         +----BonoboViewFrame

## Signal Prototypes

    "user-activate"
                void        user_function      (BonoboViewFrame *bonoboviewframe,
                                                gpointer user_data);
    "user-context"
                void        user_function      (BonoboViewFrame *bonoboviewframe,
                                                gpointer user_data);

## Description

The BonoboViewFrame is the container side control interface for its attached remote BonoboView. The view frame can be used to set the zoom factor on the embedded view using the `bonobo_view_freame_set_zoom_factor` function.

## Details

### struct BonoboViewFrame

    struct BonoboViewFrame;

### struct BonoboViewFrameClass

    struct BonoboViewFrameClass {
    	BonoboControlFrameClass parent_class;

    	POA_Bonobo_ViewFrame__epv epv;

    	/* Signals. */
    	void (*user_activate)       (BonoboViewFrame *view_frame);
    	void (*user_context)        (BonoboViewFrame *view_frame);
    };

### bonobo_view_frame_construct ()

    BonoboViewFrame* bonobo_view_frame_construct
                                                (BonoboViewFrame *view_frame,
                                                 BonoboClientSite *client_site,
                                                 Bonobo_UIContainer uih);

Initializes `view_frame` with the parameters.

`view_frame` : | The BonoboViewFrame object to be initialized.
`client_site` : | the client site to which the newly-created ViewFrame will belong.
`uih` : |
Returns : | the initialized BonoboViewFrame object `view_frame` that implements the Bonobo::ViewFrame CORBA service.

### bonobo_view_frame_new ()

    BonoboViewFrame* bonobo_view_frame_new      (BonoboClientSite *client_site,
                                                 Bonobo_Unknown uih);

`client_site` : | the client site to which the newly-created ViewFrame will belong.
`uih` : |
Returns : | BonoboViewFrame object that implements the Bonobo::ViewFrame CORBA service.

### bonobo_view_frame_bind_to_view ()

    void        bonobo_view_frame_bind_to_view  (BonoboViewFrame *view_frame,
                                                 Bonobo_View view);

Associates `view` with this `view_frame`.

`view_frame` : | A BonoboViewFrame object.
`view` : | The CORBA object for the BonoboView embedded in this ViewFrame.

### bonobo_view_frame_get_view ()

    Bonobo_View bonobo_view_frame_get_view      (BonoboViewFrame *view_frame);

Associates `view` with this `view_frame`.

`view_frame` : | A BonoboViewFrame object.
Returns : |

### bonobo_view_frame_get_client_site ()

    BonoboClientSite* bonobo_view_frame_get_client_site
                                                (BonoboViewFrame *view_frame);

`view_frame` : | The view frame
Returns : | the BonoboClientSite associated with this view frame

### bonobo_view_frame_get_wrapper ()

    GtkWidget*  bonobo_view_frame_get_wrapper   (BonoboViewFrame *view_frame);

`view_frame` : | A BonoboViewFrame object.
Returns : | The BonoboWrapper widget associated with this ViewFrame.

### bonobo_view_frame_set_covered ()

    void        bonobo_view_frame_set_covered   (BonoboViewFrame *view_frame,
                                                 gboolean covered);

This function either covers or uncovers the View embedded in a BonoboViewFrame. If the View is covered, then the embedded widgets will receive no Gtk events, such as mouse movements, keypresses, and exposures. When the View is uncovered, all events pass through to the BonoboView's widgets normally.

`view_frame` : | A BonoboViewFrame object whose embedded View should be either covered or uncovered.
`covered` : | `TRUE` if the View should be covered. `FALSE` if it should be uncovered.

### bonobo_view_frame_get_ui_container ()

    Bonobo_UIContainer bonobo_view_frame_get_ui_container
                                                (BonoboViewFrame *view_frame);

`view_frame` : | A BonoboViewFrame object.
Returns : | The BonoboUIContainer associated with this ViewFrame. See also bonobo_view_frame_set_ui_container().

### bonobo_view_frame_view_activate ()

    void        bonobo_view_frame_view_activate (BonoboViewFrame *view_frame);

Activates the BonoboView embedded in `view_frame` by calling the activate() Bonobo_Control interface method on it.

`view_frame` : | The BonoboViewFrame object whose view should be activated.

### bonobo_view_frame_view_deactivate ()

    void        bonobo_view_frame_view_deactivate
                                                (BonoboViewFrame *view_frame);

Deactivates the BonoboView embedded in `view_frame` by calling a the activate() CORBA method on it with the parameter `FALSE`.

`view_frame` : | The BonoboViewFrame object whose view should be deactivated.

### bonobo_view_frame_set_zoom_factor ()

    void        bonobo_view_frame_set_zoom_factor
                                                (BonoboViewFrame *view_frame,
                                                 double zoom);

Requests the associated view to change its zoom factor the the value in `zoom`.

`view_frame` : | A BonoboViewFrame object.
`zoom` : | a zoom factor. 1.0 means one-to-one mapping.

## Signals

### The "user-activate" signal

    void        user_function                  (BonoboViewFrame *bonoboviewframe,
                                                gpointer user_data);

`bonoboviewframe` : | the object which received the signal.
`user_data` : | user data set when the signal handler was connected.

### The "user-context" signal

    void        user_function                  (BonoboViewFrame *bonoboviewframe,
                                                gpointer user_data);

`bonoboviewframe` : | the object which received the signal.
`user_data` : | user data set when the signal handler was connected.

## See Also

BonoboControlFrame, BonoboView

<<< Previous Page | Home | Up | Next Page >>>
BonoboView | BonoboCanvasItem