Clutter.ScrollActor
Description: Reference for Clutter.ScrollActor

### Class

# ClutterScrollActor

since: 13

#### Description [src]

    class Clutter.ScrollActor : Clutter.Actor
      implements Atk.ImplementorIface, Clutter.Animatable, Clutter.Container, Clutter.Scriptable {
      /* No available fields */
    }

An actor for displaying a portion of its children

`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.

See scroll-actor.c for an example of how to use `ClutterScrollActor`..

Available since: 13

#### Ancestors

- ClutterActor
- GInitiallyUnowned
- GObject

#### Implements

- AtkImplementorIface
- ClutterAnimatable
- ClutterContainer
- ClutterScriptable

#### Constructors

###### clutter_scroll_actor_new

Creates a new `ClutterScrollActor`.

since: 13

#### Instance methods

###### clutter_scroll_actor_get_scroll_mode

Retrieves the `ClutterScrollActor:scroll-mode` property.

since: 13

###### clutter_scroll_actor_scroll_to_point

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

since: 13

###### clutter_scroll_actor_scroll_to_rect

Scrolls `actor` so that `rect` is in the visible portion.

since: 13

###### clutter_scroll_actor_set_scroll_mode

Sets the `ClutterScrollActor:scroll-mode` property.

since: 13

##### Methods inherited from ClutterActor (218)

Please see ClutterActor for a full list of methods.

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

##### Methods inherited from ClutterAnimatable (5)

###### clutter_animatable_find_property

Finds the `GParamSpec` for `property_name`.

since: 13

###### clutter_animatable_get_actor

Get animated actor.

since: 13

###### clutter_animatable_get_initial_state

Retrieves the current state of `property_name` and sets `value` with it.

since: 13

###### clutter_animatable_interpolate_value

Asks a `ClutterAnimatable` implementation to interpolate a a named property between the initial and final values of a `ClutterInterval`, using `progress` as the interpolation value, and store the result inside `value`.

since: 13

###### clutter_animatable_set_final_state

Sets the current state of `property_name` to `value`.

since: 13

##### Methods inherited from ClutterContainer (13)

###### clutter_container_add

Adds a list of `ClutterActor`s to `container`. Each time and actor is added, the “actor-added” signal is emitted. Each actor should be parented to `container`, which takes a reference on the actor. You cannot add a `ClutterActor` to more than one `ClutterContainer`.

deprecated: 1.10 since: 13

###### clutter_container_add_actor

Adds a `ClutterActor` to `container`. This function will emit the “actor-added” signal. The actor should be parented to `container`. You cannot add a `ClutterActor` to more than one `ClutterContainer`.

deprecated: 1.10 since: 13

###### clutter_container_child_get

Gets `container` specific properties of an actor.

since: 13

###### clutter_container_child_get_property

Gets a container specific property of a child of `container`, In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().

since: 13

###### clutter_container_child_notify

Calls the `ClutterContainerIface`.child_notify() virtual function of `ClutterContainer`. The default implementation will emit the `ClutterContainer::child-notify` signal.

since: 13

###### clutter_container_child_set

Sets container specific properties on the child of a container.

since: 13

###### clutter_container_child_set_property

Sets a container-specific property on a child of `container`.

since: 13

###### clutter_container_create_child_meta

Creates the `ClutterChildMeta` wrapping `actor` inside the `container`, if the `ClutterContainerIface::child_meta_type` class member is not set to `G_TYPE_INVALID`.

since: 13

###### clutter_container_destroy_child_meta

Destroys the `ClutterChildMeta` wrapping `actor` inside the `container`, if any.

since: 13

###### clutter_container_find_child_by_name

Finds a child actor of a container by its name. Search recurses into any child container.

since: 13

###### clutter_container_get_child_meta

Retrieves the `ClutterChildMeta` which contains the data about the `container` specific state for `actor`.

since: 13

###### clutter_container_remove

Removes a `NULL` terminated list of `ClutterActor`s from `container`. Each actor should be unparented, so if you want to keep it around you must hold a reference to it yourself, using g_object_ref(). Each time an actor is removed, the “actor-removed” signal is emitted by `container`.

deprecated: 1.10 since: 13

###### clutter_container_remove_actor

Removes `actor` from `container`. The actor should be unparented, so if you want to keep it around you must hold a reference to it yourself, using g_object_ref(). When the actor has been removed, the “actor-removed” signal is emitted by `container`.

deprecated: 1.10 since: 13

##### Methods inherited from ClutterScriptable (4)

###### clutter_scriptable_get_id

Retrieves the id of `scriptable` set using `clutter_scriptable_set_id()`.

since: 13

###### clutter_scriptable_parse_custom_node

Parses the passed JSON node. The implementation must set the type of the passed `GValue` pointer using g_value_init().

since: 13

###### clutter_scriptable_set_custom_property

Overrides the common properties setting. The underlying virtual function should be used when implementing custom properties.

since: 13

###### clutter_scriptable_set_id

Sets `id_` as the unique Clutter script it for this instance of `ClutterScriptableIface`.

since: 13

#### Properties

###### Clutter.ScrollActor:scroll-mode

The scrolling direction.

since: 13

##### Properties inherited from ClutterActor (71)

###### Clutter.Actor:actions

Adds a `ClutterAction` to the actor.

since: 13

###### Clutter.Actor:allocation

The allocation for the actor, in pixels.

since: 13

###### Clutter.Actor:background-color

Paints a solid fill of the actor’s allocation using the specified color.

since: 13

###### Clutter.Actor:background-color-set

Whether the `ClutterActor:background-color` property has been set.

since: 13

###### Clutter.Actor:child-transform

Applies a transformation matrix on each child of an actor.

since: 13

###### Clutter.Actor:child-transform-set

Whether the `ClutterActor:child-transform` property is set.

since: 13

###### Clutter.Actor:clip-rect

The visible region of the actor, in actor-relative coordinates, expressed as a #graphene_rect_t.

since: 13

###### Clutter.Actor:clip-to-allocation

Whether the clip region should track the allocated area of the actor.

since: 13

###### Clutter.Actor:color-state

The `ClutterColorState` contains the properties like colorspace for each actors.

since: 13

###### Clutter.Actor:constraints

Adds a `ClutterConstraint` to the actor.

since: 13

###### Clutter.Actor:content

The `ClutterContent` implementation that controls the content of the actor.

since: 13

###### Clutter.Actor:content-box

The bounding box for the `ClutterContent` used by the actor.

since: 13

###### Clutter.Actor:content-gravity

The alignment that should be honoured by the `ClutterContent` set with the `ClutterActor:content` property.

since: 13

###### Clutter.Actor:content-repeat

The repeat policy for the actor’s `ClutterActor:content`.

since: 13

###### Clutter.Actor:effect

Adds `ClutterEffect` to the list of effects be applied on a `ClutterActor`.

since: 13

###### Clutter.Actor:first-child

The actor’s first child.

since: 13

###### Clutter.Actor:fixed-position-set

This flag controls whether the `ClutterActor:fixed-x` and `ClutterActor:fixed-y` properties are used.

since: 13

###### Clutter.Actor:fixed-x

The fixed X position of the actor in pixels.

since: 13

###### Clutter.Actor:fixed-y

The fixed Y position of the actor in pixels.

since: 13

###### Clutter.Actor:has-clip

Whether the actor has the `ClutterActor:clip` property set or not.

since: 13

###### Clutter.Actor:has-pointer

Whether the actor contains the pointer of a `ClutterInputDevice` or not.

since: 13

###### Clutter.Actor:height

Height of the actor (in pixels). If written, forces the minimum and natural size request of the actor to the given height. If read, returns the allocated height if available, otherwise the height request.

since: 13

###### Clutter.Actor:last-child

The actor’s last child.

since: 13

###### Clutter.Actor:layout-manager

A delegate object for controlling the layout of the children of an actor.

since: 13

###### Clutter.Actor:magnification-filter

No description available.

since: 13

###### Clutter.Actor:mapped

Whether the actor is mapped (will be painted when the stage to which it belongs is mapped)

since: 13

###### Clutter.Actor:margin-bottom

The margin (in pixels) from the bottom of the actor.

since: 13

###### Clutter.Actor:margin-left

The margin (in pixels) from the left of the actor.

since: 13

###### Clutter.Actor:margin-right

The margin (in pixels) from the right of the actor.

since: 13

###### Clutter.Actor:margin-top

The margin (in pixels) from the top of the actor.

since: 13

###### Clutter.Actor:min-height

A forced minimum height request for the actor, in pixels.

since: 13

###### Clutter.Actor:min-height-set

This flag controls whether the `ClutterActor:min-height` property is used.

since: 13

###### Clutter.Actor:min-width

A forced minimum width request for the actor, in pixels.

since: 13

###### Clutter.Actor:min-width-set

This flag controls whether the `ClutterActor:min-width` property is used.

since: 13

###### Clutter.Actor:minification-filter

No description available.

since: 13

###### Clutter.Actor:name

The name of the actor.

since: 13

###### Clutter.Actor:natural-height

A forced natural height request for the actor, in pixels.

since: 13

###### Clutter.Actor:natural-height-set

This flag controls whether the `ClutterActor:natural-height` property is used.

since: 13

###### Clutter.Actor:natural-width

A forced natural width request for the actor, in pixels.

since: 13

###### Clutter.Actor:natural-width-set

This flag controls whether the `ClutterActor:natural-width` property is used.

since: 13

###### Clutter.Actor:offscreen-redirect

Determines the conditions in which the actor will be redirected to an offscreen framebuffer while being painted. For example this can be used to cache an actor in a framebuffer or for improved handling of transparent actors. See `clutter_actor_set_offscreen_redirect()` for details.

since: 13

###### Clutter.Actor:opacity

Opacity of an actor, between 0 (fully transparent) and 255 (fully opaque)

since: 13

###### Clutter.Actor:pivot-point

The point around which the scaling and rotation transformations occur.

since: 13

###### Clutter.Actor:pivot-point-z

The Z component of the `ClutterActor:pivot-point`, expressed as a value along the Z axis.

since: 13

###### Clutter.Actor:position

The position of the origin of the actor.

since: 13

###### Clutter.Actor:reactive

Whether the actor is reactive to events or not.

since: 13

###### Clutter.Actor:realized

Whether the actor has been realized.

since: 13

###### Clutter.Actor:request-mode

Request mode for the `ClutterActor`. The request mode determines the type of geometry management used by the actor, either height for width (the default) or width for height.

since: 13

###### Clutter.Actor:rotation-angle-x

The rotation angle on the X axis.

since: 13

###### Clutter.Actor:rotation-angle-y

The rotation angle on the Y axis.

since: 13

###### Clutter.Actor:rotation-angle-z

The rotation angle on the Z axis.

since: 13

###### Clutter.Actor:scale-x

The horizontal scale of the actor.

since: 13

###### Clutter.Actor:scale-y

The vertical scale of the actor.

since: 13

###### Clutter.Actor:scale-z

The scale factor of the actor along the Z axis.

since: 13

###### Clutter.Actor:show-on-set-parent

If `TRUE`, the actor is automatically shown when parented.

since: 13

###### Clutter.Actor:size

The size of the actor.

since: 13

###### Clutter.Actor:text-direction

The direction of the text inside a `ClutterActor`.

since: 13

###### Clutter.Actor:transform

Overrides the transformations of a `ClutterActor` with a custom matrix.

since: 13

###### Clutter.Actor:transform-set

Whether the `ClutterActor:transform` property is set.

since: 13

###### Clutter.Actor:translation-x

An additional translation applied along the X axis, relative to the actor’s `ClutterActor:pivot-point`.

since: 13

###### Clutter.Actor:translation-y

An additional translation applied along the Y axis, relative to the actor’s `ClutterActor:pivot-point`.

since: 13

###### Clutter.Actor:translation-z

An additional translation applied along the Z axis, relative to the actor’s `ClutterActor:pivot-point`.

since: 13

###### Clutter.Actor:visible

Whether the actor is set to be visible or not.

since: 13

###### Clutter.Actor:width

Width of the actor (in pixels). If written, forces the minimum and natural size request of the actor to the given width. If read, returns the allocated width if available, otherwise the width request.

since: 13

###### Clutter.Actor:x

X coordinate of the actor in pixels. If written, forces a fixed position for the actor. If read, returns the fixed position if any, otherwise the allocation if available, otherwise 0.

since: 13

###### Clutter.Actor:x-align

The alignment of an actor on the X axis, if the actor has been given extra space for its allocation. See also the `ClutterActor:x-expand` property.

since: 13

###### Clutter.Actor:x-expand

Whether a layout manager should assign more space to the actor on the X axis.

since: 13

###### Clutter.Actor:y

Y coordinate of the actor in pixels. If written, forces a fixed position for the actor. If read, returns the fixed position if any, otherwise the allocation if available, otherwise 0.

since: 13

###### Clutter.Actor:y-align

The alignment of an actor on the Y axis, if the actor has been given extra space for its allocation.

since: 13

###### Clutter.Actor:y-expand

Whether a layout manager should assign more space to the actor on the Y axis.

since: 13

###### Clutter.Actor:z-position

The actor’s position on the Z axis, relative to the parent’s transformations.

since: 13

#### Signals

##### Signals inherited from ClutterActor (27)

###### ClutterActor::button-press-event

The signal is emitted each time a mouse button is pressed on `actor`.

since: 13

###### ClutterActor::button-release-event

The signal is emitted each time a mouse button is released on `actor`.

since: 13

###### ClutterActor::captured-event

The signal is emitted when an event is captured by Clutter. This signal will be emitted starting from the top-level container (the `ClutterStage`) to the actor which received the event going down the hierarchy. This signal can be used to intercept every event before the specialized events (like ClutterActor::button-press-event or ::key-released-event) are emitted.

since: 13

###### ClutterActor::cloned

No description available.

since: 13

###### ClutterActor::decloned

No description available.

since: 13

###### ClutterActor::destroy

The signal notifies that all references held on the actor which emitted it should be released.

since: 13

###### ClutterActor::enter-event

The signal is emitted when the pointer enters the `actor`.

since: 13

###### ClutterActor::event

The signal is emitted each time an event is received by the `actor`. This signal will be emitted on every actor, following the hierarchy chain, until it reaches the top-level container (the `ClutterStage`).

since: 13

###### ClutterActor::hide

The signal is emitted when an actor is no longer rendered on the stage.

since: 13

###### ClutterActor::key-focus-in

The signal is emitted when `actor` receives key focus.

since: 13

###### ClutterActor::key-focus-out

The signal is emitted when `actor` loses key focus.

since: 13

###### ClutterActor::key-press-event

The signal is emitted each time a keyboard button is pressed while `actor` has key focus (see clutter_stage_set_key_focus()).

since: 13

###### ClutterActor::key-release-event

The signal is emitted each time a keyboard button is released while `actor` has key focus (see clutter_stage_set_key_focus()).

since: 13

###### ClutterActor::leave-event

The signal is emitted when the pointer leaves the `actor`.

since: 13

###### ClutterActor::motion-event

The signal is emitted each time the mouse pointer is moved over `actor`.

since: 13

###### ClutterActor::parent-set

This signal is emitted when the parent of the actor changes.

since: 13

###### ClutterActor::pick

The signal is emitted each time an actor is being painted in “pick mode”. The pick mode is used to identify the actor during the event handling phase, or by clutter_stage_get_actor_at_pos().

deprecated: 1.12 since: 13

###### ClutterActor::queue-relayout

The signal is emitted when `clutter_actor_queue_relayout()` is called on an actor.

since: 13

###### ClutterActor::realize

The signal is emitted each time an actor is being realized.

deprecated: 1.16 since: 13

###### ClutterActor::resource-scale-changed

The signal is emitted when the resource scale value returned by `clutter_actor_get_resource_scale()` changes.

since: 13

###### ClutterActor::scroll-event

The signal is emitted each time the mouse is scrolled on `actor`.

since: 13

###### ClutterActor::show

The signal is emitted when an actor is visible and rendered on the stage.

since: 13

###### ClutterActor::stage-views-changed

The signal is emitted when the position or size an actor is being painted at have changed so that it’s visible on different stage views.

since: 13

###### ClutterActor::touch-event

The signal is emitted each time a touch begin/end/update/cancel event.

since: 13

###### ClutterActor::transition-stopped

The signal is emitted once a transition is stopped; a transition is stopped once it reached its total duration (including eventual repeats), it has been stopped using clutter_timeline_stop(), or it has been removed from the transitions applied on `actor`, using clutter_actor_remove_transition().

since: 13

###### ClutterActor::transitions-completed

The signal is emitted once all transitions involving `actor` are complete.

since: 13

###### ClutterActor::unrealize

The signal is emitted each time an actor is being unrealized.

deprecated: 1.16 since: 13

##### Signals inherited from GObject (1)

###### GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

since: 2.0

##### Signals inherited from ClutterContainer (3)

###### ClutterContainer::actor-added

The signal is emitted each time an actor has been added to `container`.

since: 13

###### ClutterContainer::actor-removed

The signal is emitted each time an actor is removed from `container`.

since: 13

###### ClutterContainer::child-notify

The signal is emitted each time a property is being set through the `clutter_container_child_set()` and `clutter_container_child_set_property()` calls.

since: 13

#### Class structure

    struct ClutterScrollActorClass {
      /* no available fields */
    }

The `ClutterScrollActor` structure contains only private data.