![]() |
![]() |
![]() |
clutk Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Properties |
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
);
GObject +----GInitiallyUnowned +----ClutterActor +----CtkActor +----CtkBin +----CtkScrollView
CtkScrollView implements ClutterScriptable, CtkFocusable and ClutterContainer.
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
typedef enum { CTK_SCROLLBAR_INSET, CTK_SCROLLBAR_OVERLAY, CTK_SCROLLBAR_HIDDEN } CtkScrollbarType;
CtkScrollbarType ctk_scroll_view_get_bar_type (CtkScrollView *view
);
Retrives the scrollbar type of view
|
a CtkScrollView object |
Returns : |
a CtkScrollbarType |
void ctk_scroll_view_set_bar_type (CtkScrollView *view
,CtkScrollbarType type
);
sets view
to use the type of scrollbar defined in type
. see: CtkScrollbarType
|
a CtkScrollView object |
|
a CtkScrollbarType object |
gboolean ctk_scroll_view_scroll (CtkScrollView *view
,ClutterScrollEvent *event
);
Scrolls view
in a given direction by some ammount, see ClutterScrollEvent
|
a CtkScrollView object |
|
a ClutterScrollEvent object |
Returns : |
A boolean value true if the method completed correctly |
void ctk_scroll_view_set_value (CtkScrollView *view
,gfloat value
);
Sets the scroll position to the given value
|
a CtkScrollView object |
|
a float from 0.0->1.0 |
gfloat ctk_scroll_view_get_value (CtkScrollView *view
);
Retrives the current scroll position (from 0.0 -> 1.0) of view
|
A CtkScrollView |
Returns : |
a float from 0.0 to 1.0 |
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
|
A CtkScrollView object |
|
a ClutterActor object |
|
a ClutterActor object |
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
|
a CtkScrollView object |
|
a Pointer to a ClutterActor object |
|
a Pointer to a ClutterActor object |
gboolean ctk_scroll_view_can_scroll (CtkScrollView *view
);
Retrives wheather view
can be scrolled or not
|
a CtkScrollView object |
Returns : |
a boolean value, false if view is invalid
|
"scrollbar-type"
property"scrollbar-type" CtkScrollbarType : Read / Write
How to show the scroll bar.
Default value: CTK_SCROLLBAR_INSET
"value"
property"value" gfloat : Read / Write
How far the view has scrolled.
Allowed values: [0,1]
Default value: 0