CtkScrollView

CtkScrollView — Provides a widget that allows data to be scrolled

Synopsis

                    CtkScrollView;
                    CtkScrollViewClass;
                    CtkScrollViewPrivate;
enum                CtkScrollbarType;
ClutterActor *      ctk_scroll_view_new                 (void);
CtkScrollbarType    ctk_scroll_view_get_bar_type        (CtkScrollView *view);
void                ctk_scroll_view_set_bar_type        (CtkScrollView *view,
                                                         CtkScrollbarType type);
gboolean            ctk_scroll_view_scroll              (CtkScrollView *view,
                                                         ClutterScrollEvent *event);
void                ctk_scroll_view_set_value           (CtkScrollView *view,
                                                         gfloat value);
gfloat              ctk_scroll_view_get_value           (CtkScrollView *view);
void                ctk_scroll_view_set_scroll_bar      (CtkScrollView *view,
                                                         ClutterActor *trough,
                                                         ClutterActor *slider);
void                ctk_scroll_view_get_scroll_bar      (CtkScrollView *view,
                                                         ClutterActor **trough,
                                                         ClutterActor **slider);
gboolean            ctk_scroll_view_can_scroll          (CtkScrollView *view);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----ClutterActor
               +----CtkActor
                     +----CtkBin
                           +----CtkScrollView

Implemented Interfaces

CtkScrollView implements ClutterScriptable, CtkFocusable and ClutterContainer.

Properties

  "scrollbar-type"           CtkScrollbarType      : Read / Write
  "value"                    gfloat                : Read / Write

Description

CtkScrollView can hold multiple widgets and will allow them to be scrolled using a scrollbar. It can also be customised in order to provide new scrollbar interfaces

Details

CtkScrollView

typedef struct _CtkScrollView CtkScrollView;


CtkScrollViewClass

typedef struct {
  /* signals, not vfuncs */

  /* vtable */
} CtkScrollViewClass;


CtkScrollViewPrivate

typedef struct _CtkScrollViewPrivate CtkScrollViewPrivate;


enum CtkScrollbarType

typedef enum
{
  CTK_SCROLLBAR_INSET,
  CTK_SCROLLBAR_OVERLAY,
  CTK_SCROLLBAR_HIDDEN

} CtkScrollbarType;


ctk_scroll_view_new ()

ClutterActor *      ctk_scroll_view_new                 (void);

Returns :


ctk_scroll_view_get_bar_type ()

CtkScrollbarType    ctk_scroll_view_get_bar_type        (CtkScrollView *view);

Retrives the scrollbar type of view

view :

a CtkScrollView object

Returns :

a CtkScrollbarType

ctk_scroll_view_set_bar_type ()

void                ctk_scroll_view_set_bar_type        (CtkScrollView *view,
                                                         CtkScrollbarType type);

sets view to use the type of scrollbar defined in type. see: CtkScrollbarType

view :

a CtkScrollView object

type :

a CtkScrollbarType object

ctk_scroll_view_scroll ()

gboolean            ctk_scroll_view_scroll              (CtkScrollView *view,
                                                         ClutterScrollEvent *event);

Scrolls view in a given direction by some ammount, see ClutterScrollEvent

view :

a CtkScrollView object

event :

a ClutterScrollEvent object

Returns :

A boolean value true if the method completed correctly

ctk_scroll_view_set_value ()

void                ctk_scroll_view_set_value           (CtkScrollView *view,
                                                         gfloat value);

Sets the scroll position to the given value

view :

a CtkScrollView object

value :

a float from 0.0->1.0

ctk_scroll_view_get_value ()

gfloat              ctk_scroll_view_get_value           (CtkScrollView *view);

Retrives the current scroll position (from 0.0 -> 1.0) of view

view :

A CtkScrollView

Returns :

a float from 0.0 to 1.0

ctk_scroll_view_set_scroll_bar ()

void                ctk_scroll_view_set_scroll_bar      (CtkScrollView *view,
                                                         ClutterActor *trough,
                                                         ClutterActor *slider);

Sets view to use trough and slider as its actors for its scrollbar

view :

A CtkScrollView object

trough :

a ClutterActor object

slider :

a ClutterActor object

ctk_scroll_view_get_scroll_bar ()

void                ctk_scroll_view_get_scroll_bar      (CtkScrollView *view,
                                                         ClutterActor **trough,
                                                         ClutterActor **slider);

Retrives the current ClutterActor used in view for its trough and slider graphics

view :

a CtkScrollView object

trough :

a Pointer to a ClutterActor object

slider :

a Pointer to a ClutterActor object

ctk_scroll_view_can_scroll ()

gboolean            ctk_scroll_view_can_scroll          (CtkScrollView *view);

Retrives wheather view can be scrolled or not

view :

a CtkScrollView object

Returns :

a boolean value, false if view is invalid

Property Details

The "scrollbar-type" property

  "scrollbar-type"           CtkScrollbarType      : Read / Write

How to show the scroll bar.

Default value: CTK_SCROLLBAR_INSET


The "value" property

  "value"                    gfloat                : Read / Write

How far the view has scrolled.

Allowed values: [0,1]

Default value: 0