GNOME.org

StScrollView

StScrollView — a container for scrollable children

Synopsis

struct              StScrollView;
struct              StScrollViewClass;
StWidget *          st_scroll_view_new                  (void);
ClutterActor *      st_scroll_view_get_hscroll_bar      (StScrollView *scroll);
ClutterActor *      st_scroll_view_get_vscroll_bar      (StScrollView *scroll);
gfloat              st_scroll_view_get_column_size      (StScrollView *scroll);
void                st_scroll_view_set_column_size      (StScrollView *scroll,
                                                         gfloat column_size);
gfloat              st_scroll_view_get_row_size         (StScrollView *scroll);
void                st_scroll_view_set_row_size         (StScrollView *scroll,
                                                         gfloat row_size);
void                st_scroll_view_set_mouse_scrolling  (StScrollView *scroll,
                                                         gboolean enabled);
gboolean            st_scroll_view_get_mouse_scrolling  (StScrollView *scroll);
void                st_scroll_view_set_overlay_scrollbars
                                                        (StScrollView *scroll,
                                                         gboolean enabled);
gboolean            st_scroll_view_get_overlay_scrollbars
                                                        (StScrollView *scroll);
void                st_scroll_view_set_policy           (StScrollView *scroll,
                                                         GtkPolicyType hscroll,
                                                         GtkPolicyType vscroll);
void                st_scroll_view_update_fade_effect   (StScrollView *scroll,
                                                         float vfade_offset,
                                                         float hfade_offset);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----ClutterActor
               +----StWidget
                     +----StBin
                           +----StScrollView

Implemented Interfaces

StScrollView implements ClutterContainer, ClutterScriptable, ClutterAnimatable and AtkImplementorIface.

Properties

  "enable-mouse-scrolling"   gboolean              : Read / Write
  "hscroll"                  StScrollBar*          : Read
  "hscrollbar-policy"        GtkPolicyType         : Read / Write
  "hscrollbar-visible"       gboolean              : Read
  "overlay-scrollbars"       gboolean              : Read / Write
  "vscroll"                  StScrollBar*          : Read
  "vscrollbar-policy"        GtkPolicyType         : Read / Write
  "vscrollbar-visible"       gboolean              : Read

Description

StScrollView is a single child container for actors that implement StScrollable. It provides scrollbars around the edge of the child to allow the user to move around the scrollable area.

Details

struct StScrollView

struct StScrollView;

The contents of this structure are private and should only be accessed through the public API.

struct StScrollViewClass

struct StScrollViewClass {
  StBinClass parent_class;
};

st_scroll_view_new ()

StWidget *          st_scroll_view_new                  (void);

st_scroll_view_get_hscroll_bar ()

ClutterActor *      st_scroll_view_get_hscroll_bar      (StScrollView *scroll);

Gets the horizontal scrollbar of the scrollbiew

scroll :

 a StScrollView

Returns :

 the horizontal StScrollBar. [transfer none]

st_scroll_view_get_vscroll_bar ()

ClutterActor *      st_scroll_view_get_vscroll_bar      (StScrollView *scroll);

Gets the vertical scrollbar of the scrollbiew

scroll :

 a StScrollView

Returns :

 the vertical StScrollBar. [transfer none]

st_scroll_view_get_column_size ()

gfloat              st_scroll_view_get_column_size      (StScrollView *scroll);

st_scroll_view_set_column_size ()

void                st_scroll_view_set_column_size      (StScrollView *scroll,
                                                         gfloat column_size);

st_scroll_view_get_row_size ()

gfloat              st_scroll_view_get_row_size         (StScrollView *scroll);

st_scroll_view_set_row_size ()

void                st_scroll_view_set_row_size         (StScrollView *scroll,
                                                         gfloat row_size);

st_scroll_view_set_mouse_scrolling ()

void                st_scroll_view_set_mouse_scrolling  (StScrollView *scroll,
                                                         gboolean enabled);

st_scroll_view_get_mouse_scrolling ()

gboolean            st_scroll_view_get_mouse_scrolling  (StScrollView *scroll);

st_scroll_view_set_overlay_scrollbars ()

void                st_scroll_view_set_overlay_scrollbars
                                                        (StScrollView *scroll,
                                                         gboolean enabled);

Sets whether scrollbars are painted on top of the content.

scroll :

 A StScrollView

enabled :

 Whether to enable overlay scrollbars

st_scroll_view_get_overlay_scrollbars ()

gboolean            st_scroll_view_get_overlay_scrollbars
                                                        (StScrollView *scroll);

Gets the value set by st_scroll_view_set_overlay_scrollbars().

scroll :

 A StScrollView

st_scroll_view_set_policy ()

void                st_scroll_view_set_policy           (StScrollView *scroll,
                                                         GtkPolicyType hscroll,
                                                         GtkPolicyType vscroll);

Set the scroll policy.

scroll :

 A StScrollView

hscroll :

 Whether to enable horizontal scrolling

vscroll :

 Whether to enable vertical scrolling

st_scroll_view_update_fade_effect ()

void                st_scroll_view_update_fade_effect   (StScrollView *scroll,
                                                         float vfade_offset,
                                                         float hfade_offset);

Sets the height of the fade area area in pixels. A value of 0 disables the effect.

scroll :

 a StScrollView

vfade_offset :

 The length of the veritcal fade effect, in pixels.

hfade_offset :

 The length of the horizontal fade effect, in pixels.

Property Details

The "enable-mouse-scrolling" property

  "enable-mouse-scrolling"   gboolean              : Read / Write

Enable automatic mouse wheel scrolling.

Default value: TRUE

The "hscroll" property

  "hscroll"                  StScrollBar*          : Read

Horizontal scroll indicator.

The "hscrollbar-policy" property

  "hscrollbar-policy"        GtkPolicyType         : Read / Write

When the horizontal scrollbar is displayed.

Default value: GTK_POLICY_AUTOMATIC

The "hscrollbar-visible" property

  "hscrollbar-visible"       gboolean              : Read

Whether the horizontal scrollbar is visible.

Default value: TRUE

The "overlay-scrollbars" property

  "overlay-scrollbars"       gboolean              : Read / Write

Overlay scrollbars over the content.

Default value: FALSE

The "vscroll" property

  "vscroll"                  StScrollBar*          : Read

Vertical scroll indicator.

The "vscrollbar-policy" property

  "vscrollbar-policy"        GtkPolicyType         : Read / Write

When the vertical scrollbar is displayed.

Default value: GTK_POLICY_AUTOMATIC

The "vscrollbar-visible" property

  "vscrollbar-visible"       gboolean              : Read

Whether the vertical scrollbar is visible.

Default value: TRUE

Generated by GTK-Doc V1.19.1