| Clutter Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Implemented Interfaces | Properties | ||||
ClutterScrollActor; struct ClutterScrollActorClass; ClutterActor * clutter_scroll_actor_new (void); enum ClutterScrollMode; void clutter_scroll_actor_set_scroll_mode (ClutterScrollActor *actor,ClutterScrollMode mode); ClutterScrollMode clutter_scroll_actor_get_scroll_mode (ClutterScrollActor *actor); void clutter_scroll_actor_scroll_to_point (ClutterScrollActor *actor,const ClutterPoint *point); void clutter_scroll_actor_scroll_to_rect (ClutterScrollActor *actor,const ClutterRect *rect);
ClutterScrollActor implements ClutterContainer, ClutterScriptable, ClutterAnimatable and AtkImplementorIface.
ClutterScrollActor is an actor that can be used to display a portion of the contents of its children.
The extent of the area of a ClutterScrollActor is defined by the size
of its children; the visible region of the children of a ClutterScrollActor
is set by using clutter_scroll_actor_scroll_to_point() or by using
clutter_scroll_actor_scroll_to_rect() to define a point or a rectangle
acting as the origin, respectively.
ClutterScrollActor does not provide pointer or keyboard event handling, nor does it provide visible scroll handles.
ClutterScrollActor is available since Clutter 1.12.
typedef struct _ClutterScrollActor ClutterScrollActor;
The ClutterScrollActor structure contains only private data, and should be accessed using the provided API.
Since 1.12
struct ClutterScrollActorClass {
};
The ClutterScrollActor structure contains only private data.
Since 1.12
ClutterActor * clutter_scroll_actor_new (void);
Creates a new ClutterScrollActor.
Returns : |
The newly created ClutterScrollActor instance. [transfer full] |
Since 1.12
typedef enum {
/*< prefix=CLUTTER_SCROLL >*/
CLUTTER_SCROLL_NONE = 0,
CLUTTER_SCROLL_HORIZONTALLY = 1 << 0,
CLUTTER_SCROLL_VERTICALLY = 1 << 1,
CLUTTER_SCROLL_BOTH = CLUTTER_SCROLL_HORIZONTALLY | CLUTTER_SCROLL_VERTICALLY
} ClutterScrollMode;
Scroll modes.
| Ignore scrolling | |
| Scroll only horizontally | |
| Scroll only vertically | |
| Scroll in both directions |
Since 1.12
void clutter_scroll_actor_set_scroll_mode (ClutterScrollActor *actor,ClutterScrollMode mode);
Sets the "scroll-mode" property.
|
a ClutterScrollActor |
|
a ClutterScrollMode |
Since 1.12
ClutterScrollMode clutter_scroll_actor_get_scroll_mode
(ClutterScrollActor *actor);
Retrieves the "scroll-mode" property
|
a ClutterScrollActor |
Returns : |
the scrolling mode |
Since 1.12
void clutter_scroll_actor_scroll_to_point (ClutterScrollActor *actor,const ClutterPoint *point);
Scrolls the contents of actor so that point is the new origin
of the visible area.
The coordinates of point must be relative to the actor.
This function will use the currently set easing state of the actor
to transition from the current scroll origin to the new one.
|
a ClutterScrollActor |
|
a ClutterPoint |
Since 1.12
void clutter_scroll_actor_scroll_to_rect (ClutterScrollActor *actor,const ClutterRect *rect);
Scrolls actor so that rect is in the visible portion.
|
a ClutterScrollActor |
|
a ClutterRect |
Since 1.12
"scroll-mode" property"scroll-mode" ClutterScrollMode : Read / Write
The scrollin direction.
Default value: CLUTTER_SCROLL_HORIZONTALLY|CLUTTER_SCROLL_VERTICALLY
Since 1.12