Clutter.ScrollActor

Subclasses:

None

Methods

Inherited:

Clutter.Actor (238), GObject.Object (37), Clutter.Animatable (5), Clutter.Container (17), Clutter.Scriptable (4)

Structs:

GObject.ObjectClass (5)

class	new ()
	get_scroll_mode ()
	scroll_to_point (point)
	scroll_to_rect (rect)
	set_scroll_mode (mode)

Virtual Methods

Inherited:

Clutter.Actor (35), GObject.Object (7), Clutter.Animatable (5), Clutter.Container (13), Clutter.Scriptable (4)

Properties

Inherited:

Clutter.Actor (82)

Name	Type	Flags	Short Description
scroll-mode	Clutter.ScrollMode	r/w	The scrolling direction

Signals

Inherited:

Clutter.Actor (26), GObject.Object (1), Clutter.Container (3)

Fields

Inherited:

Clutter.Actor (26), GObject.Object (1), Clutter.Container (3)

Name	Type	Access	Description
parent_instance	Clutter.Actor	r

Class Details

class Clutter.ScrollActor(**kwargs)

Bases:

Clutter.Actor

Abstract:

No

Structure:

Clutter.ScrollActorClass

The Clutter.ScrollActor structure contains only private data, and should be accessed using the provided API.

Added in version 1.12.

classmethod new()

Returns:

The newly created Clutter.ScrollActor instance.

Return type:

Clutter.Actor

Creates a new Clutter.ScrollActor.

Added in version 1.12.

get_scroll_mode()

Returns:

the scrolling mode

Return type:

Clutter.ScrollMode

Retrieves the Clutter.ScrollActor :scroll-mode property

Added in version 1.12.

scroll_to_point(point)

Parameters:

point (Clutter.Point) – a Clutter.Point

Scrolls the contents of self so that point is the new origin of the visible area.

The coordinates of point must be relative to the self.

This function will use the currently set easing state of the self to transition from the current scroll origin to the new one.

Added in version 1.12.

scroll_to_rect(rect)

Parameters:

rect (Clutter.Rect) – a Clutter.Rect

Scrolls self so that rect is in the visible portion.

Added in version 1.12.

set_scroll_mode(mode)

Parameters:

mode (Clutter.ScrollMode) – a Clutter.ScrollMode

Sets the Clutter.ScrollActor :scroll-mode property.

Added in version 1.12.

Property Details

Clutter.ScrollActor.props.scroll_mode

Name:

scroll-mode

Type:

Clutter.ScrollMode

Default Value:

Clutter.ScrollMode.HORIZONTALLY | Clutter.ScrollMode.VERTICALLY | Clutter.ScrollMode.BOTH

Flags:

READABLE, WRITABLE

The scrollin direction.

Added in version 1.12.