NbtkScrollView

NbtkScrollView — a container for scrollable children

Synopsis

                    NbtkScrollView;
NbtkWidget *        nbtk_scroll_view_new                (void);
ClutterActor *      nbtk_scroll_view_get_hscroll_bar    (NbtkScrollView *scroll);
ClutterActor *      nbtk_scroll_view_get_vscroll_bar    (NbtkScrollView *scroll);
ClutterActor *      nbtk_scroll_view_get_child          (NbtkScrollView *scroll);
gfloat              nbtk_scroll_view_get_column_size    (NbtkScrollView *scroll);
void                nbtk_scroll_view_set_column_size    (NbtkScrollView *scroll,
                                                         gfloat column_size);
gfloat              nbtk_scroll_view_get_row_size       (NbtkScrollView *scroll);
void                nbtk_scroll_view_set_row_size       (NbtkScrollView *scroll,
                                                         gfloat row_size);
void                nbtk_scroll_view_set_mouse_scrolling
                                                        (NbtkScrollView *scroll,
                                                         gboolean enabled);
gboolean            nbtk_scroll_view_get_mouse_scrolling
                                                        (NbtkScrollView *scroll);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----ClutterActor
               +----NbtkWidget
                     +----NbtkBin
                           +----NbtkScrollView

Implemented Interfaces

NbtkScrollView implements ClutterContainer, ClutterScriptable and NbtkStylable.

Properties

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

Description

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

Details

NbtkScrollView

typedef struct _NbtkScrollView NbtkScrollView;

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

nbtk_scroll_view_new ()

NbtkWidget *        nbtk_scroll_view_new                (void);

Returns :

nbtk_scroll_view_get_hscroll_bar ()

ClutterActor *      nbtk_scroll_view_get_hscroll_bar    (NbtkScrollView *scroll);

scroll :

Returns :

nbtk_scroll_view_get_vscroll_bar ()

ClutterActor *      nbtk_scroll_view_get_vscroll_bar    (NbtkScrollView *scroll);

scroll :

Returns :

nbtk_scroll_view_get_child ()

ClutterActor *      nbtk_scroll_view_get_child          (NbtkScrollView *scroll);

scroll :

Returns :

nbtk_scroll_view_get_column_size ()

gfloat              nbtk_scroll_view_get_column_size    (NbtkScrollView *scroll);

scroll :

Returns :

nbtk_scroll_view_set_column_size ()

void                nbtk_scroll_view_set_column_size    (NbtkScrollView *scroll,
                                                         gfloat column_size);

scroll :

column_size :

nbtk_scroll_view_get_row_size ()

gfloat              nbtk_scroll_view_get_row_size       (NbtkScrollView *scroll);

scroll :

Returns :

nbtk_scroll_view_set_row_size ()

void                nbtk_scroll_view_set_row_size       (NbtkScrollView *scroll,
                                                         gfloat row_size);

scroll :

row_size :

nbtk_scroll_view_set_mouse_scrolling ()

void                nbtk_scroll_view_set_mouse_scrolling
                                                        (NbtkScrollView *scroll,
                                                         gboolean enabled);

scroll :

enabled :

nbtk_scroll_view_get_mouse_scrolling ()

gboolean            nbtk_scroll_view_get_mouse_scrolling
                                                        (NbtkScrollView *scroll);

scroll :

Returns :

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"                  NbtkScrollBar*        : Read

Horizontal scroll indicator.

The "vscroll" property

  "vscroll"                  NbtkScrollBar*        : Read

Vertical scroll indicator.

Generated by GTK-Doc V1.11