MxScrollView

MxScrollView — a container for scrollable children

Synopsis

                    MxScrollView;
ClutterActor *      mx_scroll_view_new                  (void);
ClutterActor *      mx_scroll_view_get_hscroll_bar      (MxScrollView *scroll);
ClutterActor *      mx_scroll_view_get_vscroll_bar      (MxScrollView *scroll);
gfloat              mx_scroll_view_get_column_size      (MxScrollView *scroll);
void                mx_scroll_view_set_column_size      (MxScrollView *scroll,
                                                         gfloat column_size);
gfloat              mx_scroll_view_get_row_size         (MxScrollView *scroll);
void                mx_scroll_view_set_row_size         (MxScrollView *scroll,
                                                         gfloat row_size);
void                mx_scroll_view_set_mouse_scrolling  (MxScrollView *scroll,
                                                         gboolean enabled);
gboolean            mx_scroll_view_get_mouse_scrolling  (MxScrollView *scroll);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----ClutterActor
               +----MxWidget
                     +----MxBin
                           +----MxScrollView

Implemented Interfaces

MxScrollView implements ClutterScriptable, MxStylable and ClutterContainer.

Properties

  "enable-gestures"          gboolean              : Read / Write
  "enable-mouse-scrolling"   gboolean              : Read / Write
  "hscroll"                  MxScrollBar*          : Read
  "vscroll"                  MxScrollBar*          : Read

Description

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

Figure 9. MxScrollView around an MxBoxLayout

An example of an MxScrollView wrapped around an MxBoxLayout actor (which implements MxScrollable). The MxBoxLayout contains nine ClutterRectangle instances, but the stage is too small for all of them to be visible. The MxScrollView adds the appropriate horizontal scroll, which makes it possible to scroll to the end of the row of rectangles.

MxScrollView around an MxBoxLayout


Details

MxScrollView

typedef struct _MxScrollView MxScrollView;

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


mx_scroll_view_new ()

ClutterActor *      mx_scroll_view_new                  (void);

Returns :


mx_scroll_view_get_hscroll_bar ()

ClutterActor *      mx_scroll_view_get_hscroll_bar      (MxScrollView *scroll);

scroll :

Returns :


mx_scroll_view_get_vscroll_bar ()

ClutterActor *      mx_scroll_view_get_vscroll_bar      (MxScrollView *scroll);

scroll :

Returns :


mx_scroll_view_get_column_size ()

gfloat              mx_scroll_view_get_column_size      (MxScrollView *scroll);

scroll :

Returns :


mx_scroll_view_set_column_size ()

void                mx_scroll_view_set_column_size      (MxScrollView *scroll,
                                                         gfloat column_size);

scroll :

column_size :


mx_scroll_view_get_row_size ()

gfloat              mx_scroll_view_get_row_size         (MxScrollView *scroll);

scroll :

Returns :


mx_scroll_view_set_row_size ()

void                mx_scroll_view_set_row_size         (MxScrollView *scroll,
                                                         gfloat row_size);

scroll :

row_size :


mx_scroll_view_set_mouse_scrolling ()

void                mx_scroll_view_set_mouse_scrolling  (MxScrollView *scroll,
                                                         gboolean enabled);

scroll :

enabled :


mx_scroll_view_get_mouse_scrolling ()

gboolean            mx_scroll_view_get_mouse_scrolling  (MxScrollView *scroll);

scroll :

Returns :

Property Details

The "enable-gestures" property

  "enable-gestures"          gboolean              : Read / Write

Enable use of pointer gestures for scrolling.

Default value: FALSE


The "enable-mouse-scrolling" property

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

Enable automatic mouse wheel scrolling.

Default value: TRUE


The "hscroll" property

  "hscroll"                  MxScrollBar*          : Read

Horizontal scroll indicator.


The "vscroll" property

  "vscroll"                  MxScrollBar*          : Read

Vertical scroll indicator.