EScrollFrame

Name

EScrollFrame -- 

Synopsis



struct      EScrollFrame;
GtkWidget*  e_scroll_frame_new              (GtkAdjustment *hadj,
                                             GtkAdjustment *vadj);
void        e_scroll_frame_set_hadjustment  (EScrollFrame *sf,
                                             GtkAdjustment *adj);
void        e_scroll_frame_set_vadjustment  (EScrollFrame *sf,
                                             GtkAdjustment *adj);
GtkAdjustment* e_scroll_frame_get_hadjustment
                                            (EScrollFrame *sf);
GtkAdjustment* e_scroll_frame_get_vadjustment
                                            (EScrollFrame *sf);
void        e_scroll_frame_set_policy       (EScrollFrame *sf,
                                             GtkPolicyType hsb_policy,
                                             GtkPolicyType vsb_policy);
void        e_scroll_frame_set_placement    (EScrollFrame *sf,
                                             GtkCornerType frame_placement);
void        e_scroll_frame_set_shadow_type  (EScrollFrame *sf,
                                             GtkShadowType shadow_type);
void        e_scroll_frame_set_scrollbar_spacing
                                            (EScrollFrame *sf,
                                             guint spacing);
void        e_scroll_frame_add_with_viewport
                                            (EScrollFrame *sf,
                                             GtkWidget *child);

Object Hierarchy


  GtkObject
   +----GtkWidget
         +----GtkContainer
               +----GtkBin
                     +----EScrollFrame

Description

Details

struct EScrollFrame

struct EScrollFrame;


e_scroll_frame_new ()

GtkWidget*  e_scroll_frame_new              (GtkAdjustment *hadj,
                                             GtkAdjustment *vadj);

Creates a new scroll frame widget.

hadj : If non-NULL, the adjustment to use for horizontal scrolling.
vadj : If non-NULL, the adjustment to use for vertical scrolling.
Returns : The newly-created scroll frame widget.


e_scroll_frame_set_hadjustment ()

void        e_scroll_frame_set_hadjustment  (EScrollFrame *sf,
                                             GtkAdjustment *adj);

Sets the adjustment to be used for horizontal scrolling in a scroll frame widget.

sf : A scroll frame widget.
adj : An adjustment.


e_scroll_frame_set_vadjustment ()

void        e_scroll_frame_set_vadjustment  (EScrollFrame *sf,
                                             GtkAdjustment *adj);

Sets the adjustment to be used for vertical scrolling in a scroll frame widget.

sf : A scroll frame widget.
adj : An adjustment.


e_scroll_frame_get_hadjustment ()

GtkAdjustment* e_scroll_frame_get_hadjustment
                                            (EScrollFrame *sf);

Queries the horizontal adjustment of a scroll frame widget.

sf : A scroll frame widget.
Returns : The horizontal adjustment of the scroll frame, or NULL if none.


e_scroll_frame_get_vadjustment ()

GtkAdjustment* e_scroll_frame_get_vadjustment
                                            (EScrollFrame *sf);

Queries the vertical adjustment of a scroll frame widget.

sf : A scroll frame widget.
Returns : The vertical adjustment of the scroll frame, or NULL if none.


e_scroll_frame_set_policy ()

void        e_scroll_frame_set_policy       (EScrollFrame *sf,
                                             GtkPolicyType hsb_policy,
                                             GtkPolicyType vsb_policy);

Sets the scrollbar policies of a scroll frame widget. These determine when the scrollbars are to be shown or hidden.

sf : A scroll frame widget.
hsb_policy : Policy for the horizontal scrollbar.
vsb_policy : Policy for the vertical scrollbar.


e_scroll_frame_set_placement ()

void        e_scroll_frame_set_placement    (EScrollFrame *sf,
                                             GtkCornerType frame_placement);

Sets the placement of a scroll frame widget's frame with respect to its scrollbars.

sf : A scroll frame widget.
frame_placement : Placement for the frame.


e_scroll_frame_set_shadow_type ()

void        e_scroll_frame_set_shadow_type  (EScrollFrame *sf,
                                             GtkShadowType shadow_type);

Sets the shadow type of a scroll frame widget. You can use this when you insert a child that does not paint a frame on its own.

sf : A scroll frame widget.
shadow_type : A shadow type.


e_scroll_frame_set_scrollbar_spacing ()

void        e_scroll_frame_set_scrollbar_spacing
                                            (EScrollFrame *sf,
                                             guint spacing);

Sets the spacing between the frame and the scrollbars of a scroll frame widget.

sf : A scroll frame widget.
spacing : Desired spacing in pixels.


e_scroll_frame_add_with_viewport ()

void        e_scroll_frame_add_with_viewport
                                            (EScrollFrame *sf,
                                             GtkWidget *child);

Creates a GtkViewport and puts the specified child inside it, thus allowing the viewport to be scrolled by the scroll frame widget. This is meant to be used only when a child does not support the scrolling interface.

sf : A scroll frame widget.
child : A widget.