Adds a ClutterActor to container. This function will emit the "actor-added" signal. The actor should be parented to ClutterContainer.

Parameters:

Clutter.Actor actor Required (not null)

Returns:

none

Called by the parent of an actor to assign the actor its size. Should never be called by applications (except when implementing a container or layout manager). Actors can know from their allocation box whether they have moved with respect to their parent actor. The flags parameter describes additional information about the allocation, for instance whether the parent has moved with respect to the stage, for example because a grandparent's origin has moved.

Parameters:

Clutter.ActorBox box Required (not null)

Clutter.AllocationFlags flags Required (not null)

Returns:

none

Allocates self taking into account the ClutterActor's preferred size, but limiting it to the maximum available width and height provided. This function will do the right thing when dealing with the actor's request mode. The implementation of this function is equivalent to: |[ if (request_mode == CLUTTER_REQUEST_HEIGHT_FOR_WIDTH) { clutter_actor_get_preferred_width (self, available_height, &min_width, &natural_width); width = CLAMP (natural_width, min_width, available_width); clutter_actor_get_preferred_height (self, width, &min_height, &natural_height); height = CLAMP (natural_height, min_height, available_height); } else { clutter_actor_get_preferred_height (self, available_width, &min_height, &natural_height); height = CLAMP (natural_height, min_height, available_height); clutter_actor_get_preferred_width (self, height, &min_width, &natural_width); width = CLAMP (natural_width, min_width, available_width); } box.x1 = x; box.y1 = y; box.x2 = box.x1 + available_width; box.y2 = box.y1 + available_height; clutter_actor_allocate (self, &box, flags); ]| This function can be used by fluid layout managers to allocate an actor's preferred size without making it bigger than the area available for the container.

Parameters:

Number x Required (not null)

Number y Required (not null)

Number available_width Required (not null)

actor's natural width

Number available_height Required (not null)

actor's natural height

Clutter.AllocationFlags flags Required (not null)

Returns:

none

Allocates the natural size of self. This function is a utility call for ClutterActor implementations that allocates the actor's preferred natural size. It can be used by fixed layout managers (like ClutterGroup or so called 'composite actors') inside the ClutterActor::allocate implementation to give each child exactly how much space it requires. This function is not meant to be used by applications. It is also not meant to be used outside the implementation of the ClutterActor::allocate virtual function.

Parameters:

Clutter.AllocationFlags flags Required (not null)

Returns:

none

Animates the given list of properties of actor between the current value for each property and a new final value. The animation has a definite behaviour given by the passed alpha. See clutter_actor_animate() for further details. This function is useful if you want to use an existing ClutterAlpha to animate actor. This is the vector-based variant of clutter_actor_animate_with_alpha(), useful for language bindings. Unlike clutter_actor_animate_with_alpha(), this function will not allow you to specify "signal::" names and callbacks.

Parameters:

Clutter.Alpha alpha Required (not null)

Number n_properties Required (not null)

Array properties Required (not null)

a vector containing the property names to set

Array values Required (not null)

a vector containing the property values to set

Returns:

Clutter.Animation a ClutterAnimation object. The object is owned by the ClutterActor and should not be unreferenced with g_object_unref()

Animates the given list of properties of actor between the current value for each property and a new final value. The animation has a definite duration given by timeline and a speed given by the mode. See clutter_actor_animate() for further details. This function is useful if you want to use an existing timeline to animate actor. This is the vector-based variant of clutter_actor_animate_with_timeline(), useful for language bindings. Unlike clutter_actor_animate_with_timeline(), this function will not allow you to specify "signal::" names and callbacks.

Parameters:

Number mode Required (not null)

Clutter.Timeline timeline Required (not null)

Number n_properties Required (not null)

Array properties Required (not null)

a vector containing the property names to set

Array values Required (not null)

a vector containing the property values to set

Returns:

Clutter.Animation a ClutterAnimation object. The object is owned by the ClutterActor and should not be unreferenced with g_object_unref()

Animates the given list of properties of actor between the current value for each property and a new final value. The animation has a definite duration and a speed given by the mode. This is the vector-based variant of clutter_actor_animate(), useful for language bindings. Unlike clutter_actor_animate(), this function will not allow you to specify "signal::" names and callbacks.

Parameters:

Number mode Required (not null)

Number duration Required (not null)

Number n_properties Required (not null)

Array properties Required (not null)

a vector containing the property names to set

Array values Required (not null)

a vector containing the property values to set

Returns:

Clutter.Animation a ClutterAnimation object. The object is owned by the ClutterActor and should not be unreferenced with g_object_unref()

Transforms point in coordinates relative to the actor into ancestor-relative coordinates using the relevant transform stack (i.e. scale, rotation, etc). If ancestor is NULL the ancestor will be the ClutterStage. In this case, the coordinates returned will be the coordinates on the stage before the projection is applied. This is different from the behaviour of clutter_actor_apply_transform_to_point().

Parameters:

Clutter.Actor ancestor

A ClutterActor ancestor, or NULL to use the default ClutterStage

Clutter.Vertex point Required (not null)

Clutter.Vertex vertex Required (not null)

Returns:

none

Transforms point in coordinates relative to the actor into screen-relative coordinates with the current actor transformation (i.e. scale, rotation, etc)

Parameters:

Clutter.Vertex point Required (not null)

Clutter.Vertex vertex Required (not null)

Returns:

none

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(). Note that clutter_container_child_set_property() is really intended for language bindings, clutter_container_child_set() is much more convenient for C programming.

Parameters:

Clutter.Actor child Required (not null)

String property Required (not null)

GObject.Value value Required (not null)

Returns:

none

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

Parameters:

Clutter.Actor child Required (not null)

String property Required (not null)

GObject.Value value Required (not null)

Returns:

none

Creates the ClutterChildMeta wrapping actor inside the class member is not set to G_TYPE_INVALID. This function is only useful when adding a ClutterActor to a ClutterContainer implementation outside of the ClutterContainer::add() virtual function implementation. Applications should not call this function.

Parameters:

Clutter.Actor actor Required (not null)

Returns:

none

Creates a PangoContext for the given actor. The PangoContext is already configured using the appropriate font map, resolution and font options. See also clutter_actor_get_pango_context().

Returns:

Pango.Context on the returned value to deallocate its resources

Creates a new PangoLayout from the same PangoContext used by the ClutterActor. The PangoLayout is already configured with the font map, resolution and font options, and the given text. If you want to keep around a PangoLayout created by this function you will have to connect to the ClutterBackend::font-changed and ClutterBackend::resolution-changed signals, and call pango_layout_context_changed() in response to them.

Parameters:

String text

the text to set on the PangoLayout, or NULL

Returns:

Pango.Layout when done

Destroys an actor. When an actor is destroyed, it will break any references it holds to other objects. If the actor is inside a container, the actor will be removed. When you destroy a container, its children will be destroyed as well. clutter_stage_get_default().

Returns:

none

Destroys the ClutterChildMeta wrapping actor inside the This function is only useful when removing a ClutterActor to a ClutterContainer implementation outside of the ClutterContainer::add() virtual function implementation. Applications should not call this function.

Parameters:

Clutter.Actor actor Required (not null)

Returns:

none

This function is used to emit an event on the main stage. You should rarely need to use this function, except for synthetising events.

Parameters:

Clutter.Event event Required (not null)

Boolean capture Required (not null)

Returns:

Boolean if the actor handled the event, or FALSE if the event was not handled

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

Parameters:

String child_name Required (not null)

Returns:

Clutter.Actor The child actor with the requested name, or NULL if no actor with that name was found.

Calls callback for each child of container that was added by the application (with clutter_container_add_actor()). Does not iterate over "internal" children that are part of the container's own implementation, if any.

Parameters:

Function (Actor actor, void* data) : none Required (not null)

void* user_data Required (not null)

Returns:

none

Calls callback for each child of container, including "internal" children built in to the container itself that were never added by the application.

Parameters:

Function (Actor actor, void* data) : none Required (not null)

void* user_data Required (not null)

Returns:

none

Calculates the transformed screen coordinates of the four corners of the actor; the returned vertices relate to the ClutterActorBox coordinates as follows: v[0] contains (x1, y1) v[1] contains (x2, y1) v[2] contains (x1, y2) v[3] contains (x2, y2)

Returns:

Array

Retrieves the adjustment used to determine the zoom factor of the zoomable actor

Returns:

Gtk.Adjustment a GtkAdjustment

Retrieves the horizontal and vertical adjustments used to determine the position of the scrollable actor.

Parameters:

Gtk.Adjustment h_adjust Required (not null)

Gtk.Adjustment v_adjust Required (not null)

Returns:

none

Gets the layout box an actor has been assigned. The allocation can only be assumed valid inside a paint() method; anywhere else, it may be out-of-date. An allocation does not incorporate the actor's scale or anchor point; those transformations do not affect layout, only rendering. Do not call any of the clutter_actor_get_allocation_*() family of functions inside the implementation of the get_preferred_width() or get_preferred_height() virtual functions.

Returns:

Clutter.ActorBox

Gets the layout box an actor has been assigned. The allocation can only be assumed valid inside a paint() method; anywhere else, it may be out-of-date. An allocation does not incorporate the actor's scale or anchor point; those transformations do not affect layout, only rendering. The returned rectangle is in pixels.

Returns:

Clutter.Geometry

Calculates the transformed coordinates of the four corners of the actor in the plane of ancestor. The returned vertices relate to the ClutterActorBox coordinates as follows: verts[0] contains (x1, y1) verts[1] contains (x2, y1) verts[2] contains (x1, y2) verts[3] contains (x2, y2) If ancestor is NULL the ancestor will be the ClutterStage. In this case, the coordinates returned will be the coordinates on the stage before the projection is applied. This is different from the behaviour of clutter_actor_get_abs_allocation_vertices().

Parameters:

Clutter.Actor ancestor

A ClutterActor to calculate the vertices against, or NULL to use the default ClutterStage

Returns:

Array

Gets the current anchor point of the actor in pixels.

Returns:

anchor_x: Number

anchor_y: Number

Retrieves the anchor position expressed as a ClutterGravity. If the anchor point was specified using pixels or units this will return CLUTTER_GRAVITY_NONE.

Returns:

Clutter.Gravity

Retrieves the ClutterAnimation used by actor, if clutter_actor_animate() has been called on actor.

Returns:

Clutter.Animation a ClutterAnimation, or NULL

Retrieves the ClutterChildMeta which contains the data about the

Parameters:

Clutter.Actor actor Required (not null)

Returns:

Clutter.ChildMeta the ClutterChildMeta for the actor child of container or NULL if the specifiec actor does not exist or the container is not configured to provide ClutterChildMetas

Retrieves all the children of container.

Returns:

Array a list of ClutterActors. Use g_list_free() on the returned list when done.

Gets the clip area for self, if any is set

Returns:

xoff: Number

yoff: Number

width: Number

height: Number

Retrieves the depth of self.

Returns:

Number

Checks whether an actor has a fixed position set (and will thus be unaffected by any layout manager).

Returns:

Boolean

Retrieves the flags set on self

Returns:

Clutter.ActorFlags

Gets the size and position of an actor relative to its parent actor. This is the same as calling clutter_actor_get_position() and clutter_actor_get_size(). It tries to "do what you mean" and get the requested size and position if the actor's allocation is invalid.

Returns:

Clutter.Geometry

Retrieves the unique id for self.

Returns:

Number

Retrieves the height of a ClutterActor. If the actor has a valid allocation, this function will return the height of the allocated area given to the actor. If the actor does not have a valid allocation, this function will return the actor's natural height, that is the preferred height of the actor. If you care whether you get the preferred height or the height that has been assigned to the actor, you should probably call a different function like clutter_actor_get_allocation_box() to retrieve the allocated size or clutter_actor_get_preferred_height() to retrieve the preferred height. If an actor has a fixed height, for instance a height that has been assigned using clutter_actor_set_height(), the height returned will be the same value.

Returns:

Number

Retrieves the id of scriptable set using clutter_scriptable_set_id().

Returns:

String the scriptable object and should never be modified of freed

Retrieves the name of self.

Returns:

String owned by the actor and should not be modified or freed.

Retrieves the opacity value of an actor, as set by clutter_actor_set_opacity(). For retrieving the absolute opacity of the actor inside a paint virtual function, see clutter_actor_get_paint_opacity().

Returns:

Number

Retrieves the absolute opacity of the actor, as it appears on the stage. This function traverses the hierarchy chain and composites the opacity of the actor with that of its parents. This function is intended for subclasses to use in the paint virtual function, to paint themselves with the correct opacity.

Returns:

Number

Retrieves the 'paint' visibility of an actor recursively checking for non visible parents. This is by definition the same as CLUTTER_ACTOR_IS_MAPPED().

Returns:

Boolean

Retrieves the PangoContext for self. The actor's PangoContext is already configured using the appropriate font map, resolution and font options. Unlike clutter_actor_create_pango_context(), this context is owend by the ClutterActor and it will be updated each time the options stored by the ClutterBackend change. You can use the returned PangoContext to create a PangoLayout and render text using cogl_pango_render_layout() to reuse the glyphs cache also used by Clutter.

Returns:

Pango.Context the PangoContext for a ClutterActor. The returned PangoContext is owned by the actor and should not be unreferenced by the application code

Retrieves the parent of self.

Returns:

Clutter.Actor The ClutterActor parent, or NULL if no parent is set

This function tries to "do what you mean" and tell you where the actor is, prior to any transformations. Retrieves the fixed position of an actor in pixels, if one has been set; otherwise, if the allocation is valid, returns the actor's allocated position; otherwise, returns 0,0. The returned position is in pixels.

Returns:

x: Number

y: Number

Computes the requested minimum and natural heights for an actor, or if they are already computed, returns the cached values. An actor may not get its request - depending on the layout manager that's in effect. A request should not incorporate the actor's scale or anchor point; those transformations do not affect layout, only rendering.

Parameters:

Number for_width Required (not null)

or a negative value to indicate that no width is defined

Returns:

min_height_p: Number

natural_height_p: Number

Computes the preferred minimum and natural size of an actor, taking into account the actor's geometry management (either height-for-width or width-for-height). The width and height used to compute the preferred height and preferred width are the actor's natural ones. If you need to control the height for the preferred width, or the width for the preferred height, you should use clutter_actor_get_preferred_width() and clutter_actor_get_preferred_height(), and check the actor's preferred geometry management using the ClutterActor:request-mode property.

Returns:

min_width_p: Number

min_height_p: Number

natural_width_p: Number

natural_height_p: Number

Computes the requested minimum and natural widths for an actor, optionally depending on the specified height, or if they are already computed, returns the cached values. An actor may not get its request - depending on the layout manager that's in effect. A request should not incorporate the actor's scale or anchor point; those transformations do not affect layout, only rendering.

Parameters:

Number for_height Required (not null)

or a negative value to indicate that no height is defined

Returns:

min_width_p: Number

natural_width_p: Number

Checks whether actor is marked as reactive.

Returns:

Boolean

Retrieves the geometry request mode of self

Returns:

Clutter.RequestMode

Retrieves the angle and center of rotation on the given axis, set using clutter_actor_set_rotation().

Parameters:

Clutter.RotateAxis axis Required (not null)

Object out_values

Number x

Number y

Number z

Returns:

Number

Retrieves an actors scale factors.

Returns:

scale_x: Number

scale_y: Number

Retrieves the scale center coordinate in pixels relative to the top left corner of the actor. If the scale center was specified using a ClutterGravity this will calculate the pixel offset using the current size of the actor.

Returns:

center_x: Number

center_y: Number

Retrieves the scale center as a compass direction. If the scale center was specified in pixels or units this will return CLUTTER_GRAVITY_NONE.

Returns:

Clutter.Gravity

Queries the currently set ClutterShader on self.

Returns:

Clutter.Shader The currently set ClutterShader or NULL if no shader is set.

This function tries to "do what you mean" and return the size an actor will have. If the actor has a valid allocation, the allocation will be returned; otherwise, the actors natural size request will be returned. If you care whether you get the request vs. the allocation, you should probably call a different function like clutter_actor_get_allocation_box() or clutter_actor_get_preferred_width().

Returns:

width: Number

height: Number

Retrieves the ClutterStage where actor is contained.

Returns:

Clutter.Actor the stage containing the actor, or NULL

Retrieves the value set using clutter_actor_set_text_direction() If no text direction has been previously set, the default text direction, as returned by clutter_get_default_text_direction(), will be returned instead

Returns:

Clutter.TextDirection

Retrieves the transformations applied to self

Returns:

Cogl.Matrix

Gets the absolute position of an actor, in pixels relative to the stage.

Returns:

x: Number

y: Number

Gets the absolute size of an actor in pixels, taking into account the scaling factors. If the actor has a valid allocation, the allocated size will be used. If the actor has not a valid allocation then the preferred size will be transformed and returned. If you want the transformed allocation, see clutter_actor_get_abs_allocation_vertices() instead. When the actor (or one of its ancestors) is rotated around the X or Y axis, it no longer appears as on the stage as a rectangle, but as a generic quadrangle; in that case this function returns the size of the smallest rectangle that encapsulates the entire quad. Please note that in this case no assumptions can be made about the relative position of this envelope to the absolute position of the actor, as returned by clutter_actor_get_transformed_position(); if you need this information, you need to use clutter_actor_get_abs_allocation_vertices() to get the coords of the actual quadrangle.

Returns:

width: Number

height: Number

Retrieves the width of a ClutterActor. If the actor has a valid allocation, this function will return the width of the allocated area given to the actor. If the actor does not have a valid allocation, this function will return the actor's natural width, that is the preferred width of the actor. If you care whether you get the preferred width or the width that has been assigned to the actor, you should probably call a different function like clutter_actor_get_allocation_box() to retrieve the allocated size or clutter_actor_get_preferred_width() to retrieve the preferred width. If an actor has a fixed width, for instance a width that has been assigned using clutter_actor_set_width(), the width returned will be the same value.

Returns:

Number

Returns:

Number

Returns:

Number

Retrieves the center for the rotation around the Z axis as a compass direction. If the center was specified in pixels or units this will return CLUTTER_GRAVITY_NONE.

Returns:

Clutter.Gravity

Sets the key focus of the ClutterStage including self to this ClutterActor.

Returns:

none

Checks if the actor has an up-to-date allocation assigned to visible and has a parent. It also means that there is no outstanding relayout request in progress for the actor or its children (There might be other outstanding layout requests in progress that will cause the actor to get a new allocation when the stage is laid out, however). If this function returns FALSE, then the actor will normally be allocated before it is next drawn on the screen.

Returns:

Boolean

Determines whether the actor has a clip area set or not.

Returns:

Boolean

Checks whether an actor contains the the pointer of a ClutterInputDevice

Returns:

Boolean FALSE otherwise

Flags an actor to be hidden. A hidden actor will not be rendered on the stage. Actors are visible by default. If this function is called on an actor without a parent, the ClutterActor:show-on-set-parent property will be set to FALSE as a side-effect.

Returns:

none

Calls clutter_actor_hide() on all child actors (if any).

Returns:

none

Checks whether self is being currently painted by a ClutterClone This function is useful only inside the ::paint virtual function implementations or within handlers for the ClutterActor::paint signal This function should not be used by applications

Returns:

Boolean by a ClutterClone, and FALSE otherwise

Checks whether any rotation is applied to the actor.

Returns:

Boolean

Checks whether the actor is scaled in either dimension.

Returns:

Boolean

Puts self below above. Both actors must have the same parent, and the parent must implement the ClutterContainer interface. This function is the equivalent of clutter_container_lower_child().

Parameters:

Clutter.Actor above

A ClutterActor to lower below

Returns:

none

Lowers self to the bottom. This function calls clutter_actor_lower() internally.

Returns:

none

Lowers actor to sibling level, in the depth ordering.

Parameters:

Clutter.Actor actor Required (not null)

Clutter.Actor sibling Required (not null)

Returns:

none

Sets the CLUTTER_ACTOR_MAPPED flag on the actor and possibly maps and realizes its children if they are visible. Does nothing if the actor is not visible. ClutterActor::map virtual function in an actor and you need to map the children of that actor. It is not necessary to call this if you implement ClutterContainer because the default implementation will automatically map children of containers. When overriding map, it is mandatory to chain up to the parent implementation.

Returns:

none

Sets an anchor point for the actor, and adjusts the actor postion so that the relative position of the actor toward its parent remains the same.

Parameters:

Number anchor_x Required (not null)

Number anchor_y Required (not null)

Returns:

none

Sets an anchor point on the actor based on the given gravity, adjusting the actor postion so that its relative position within its parent remains unchanged. Since version 1.0 the anchor point will be stored as a gravity so that if the actor changes size then the anchor point will move. For example, if you set the anchor point to CLUTTER_GRAVITY_SOUTH_EAST and later double the size of the actor, the anchor point will move to the bottom right.

Parameters:

Clutter.Gravity gravity Required (not null)

Returns:

none

Moves an actor by the specified distance relative to its current position in pixels. This function modifies the fixed position of an actor and thus removes it from any layout management. Another way to move an actor is with an anchor point, see clutter_actor_set_anchor_point().

Parameters:

Number dx Required (not null)

Number dy Required (not null)

Returns:

none

Renders the actor to display. This function should not be called directly by applications. Call clutter_actor_queue_redraw() to queue paints, instead. This function will emit the ClutterActor::paint signal.

Returns:

none

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

Parameters:

Clutter.Script script Required (not null)

GObject.Value value Required (not null)

String name Required (not null)

ClutterJson.JsonNode node Required (not null)

Returns:

Boolean

Disables the effects of clutter_actor_pop_internal()

Returns:

none

Should be used by actors implementing the ClutterContainer and with internal children added through clutter_actor_set_parent(), for instance: |[ static void my_actor_init (MyActor *self) { self->priv = SELF_ACTOR_GET_PRIVATE (self); clutter_actor_push_internal (CLUTTER_ACTOR (self)); /* calling clutter_actor_set_parent() now will result in * the internal flag being set on a child of MyActor */ clutter_actor_pop_internal (CLUTTER_ACTOR (self)); /* calling clutter_actor_set_parent() now will not result in * the internal flag being set on a child of MyActor */ } ]| This function will be used by Clutter to toggle an "internal child" flag whenever clutter_actor_set_parent() is called; internal children are handled differently by Clutter, specifically when destroying their parent. Call clutter_actor_pop_internal() when you finished adding internal children. Nested calls to clutter_actor_push_internal() are allowed, but each one must by followed by a clutter_actor_pop_internal() call.

Returns:

none

Queues up a redraw of an actor and any children. The redraw occurs once the main loop becomes idle (after the current batch of events has been processed, roughly). Applications rarely need to call this, as redraws are handled automatically by modification functions. This function will not do anything if self is not visible, or if the actor is inside an invisible part of the scenegraph. Also be aware that painting is a NOP for actors with an opacity of 0

Returns:

none

Indicates that the actor's size request or other layout-affecting properties may have changed. This function is used inside ClutterActor subclass implementations, not by applications directly. Queueing a new layout automatically queues a redraw as well.

Returns:

none

Puts self above below. Both actors must have the same parent, and the parent must implement the ClutterContainer interface This function is the equivalent of clutter_container_raise_child().

Parameters:

Clutter.Actor below

A ClutterActor to raise above.

Returns:

none

Raises actor to sibling level, in the depth ordering.

Parameters:

Clutter.Actor actor Required (not null)

Clutter.Actor sibling Required (not null)

Returns:

none

Raises self to the top. This function calls clutter_actor_raise() internally.

Returns:

none

Realization informs the actor that it is attached to a stage. It can use this to allocate resources if it wanted to delay allocation until it would be rendered. However it is perfectly acceptable for an actor to create resources before being realized because Clutter only ever has a single rendering context so that actor is free to be moved from one stage to another. This function does nothing if the actor is already realized. Because a realized actor must have realized parent actors, calling clutter_actor_realize() will also realize all parents of the actor. This function does not realize child actors, except in the special case that realizing the stage, when the stage is visible, will suddenly map (and thus realize) the children of the stage.

Returns:

none

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.

Parameters:

Clutter.Actor actor Required (not null)

Returns:

none

Returns:

none

This function resets the parent actor of self. It is logically equivalent to calling clutter_actor_unparent() and clutter_actor_set_parent(), but more efficiently implemented, ensures the child is not finalized when unparented, and emits the parent-set signal only one time.

Parameters:

Clutter.Actor new_parent Required (not null)

Returns:

none

Sets the adjustment used to determine the zoom factor of the zoomable actor

Parameters:

Gtk.Adjustment z_adjust Required (not null)

a GtkAdjustment, or NULL

Returns:

none

Sets the horizontal and vertical adjustments used to determine the position of the scrollable actor.

Parameters:

Gtk.Adjustment h_adjust Required (not null)

Gtk.Adjustment v_adjust Required (not null)

Returns:

none

Sets an anchor point for self. The anchor point is a point in the coordinate space of an actor to which the actor position within its parent is relative; the default is (0, 0), i.e. the top-left corner of the actor.

Parameters:

Number anchor_x Required (not null)

Number anchor_y Required (not null)

Returns:

none

Sets an anchor point on the actor, based on the given gravity (this is a convenience function wrapping clutter_actor_set_anchor_point()). Since version 1.0 the anchor point will be stored as a gravity so that if the actor changes size then the anchor point will move. For example, if you set the anchor point to CLUTTER_GRAVITY_SOUTH_EAST and later double the size of the actor, the anchor point will move to the bottom right.

Parameters:

Clutter.Gravity gravity Required (not null)

Returns:

none

Sets clip area for self. The clip area is always computed from the upper left corner of the actor, even if the anchor point is set otherwise.

Parameters:

Number xoff Required (not null)

Number yoff Required (not null)

Number width Required (not null)

Number height Required (not null)

Returns:

none

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

Parameters:

Clutter.Script script Required (not null)

String name Required (not null)

GObject.Value value Required (not null)

Returns:

none

Sets the Z coordinate of self to depth. The unit used by depth is dependant on the perspective setup. See also clutter_stage_set_perspective().

Parameters:

Number depth Required (not null)

Returns:

none

Sets whether an actor has a fixed position set (and will thus be unaffected by any layout manager).

Parameters:

Boolean is_set Required (not null)

Returns:

none

Sets flags on self This function will emit notifications for the changed properties

Parameters:

Clutter.ActorFlags flags Required (not null)

Returns:

none

Sets the actor's fixed position and forces its minimum and natural size, in pixels. This means the untransformed actor will have the given geometry. This is the same as calling clutter_actor_set_position() and clutter_actor_set_size().

Parameters:

Clutter.Geometry geometry Required (not null)

Returns:

none

Parameters:

Number height Required (not null)

Returns:

none

Sets id as the unique Clutter script it for this instance of ClutterScriptableIface. This name can be used by user interface designer applications to define a unique name for an object constructable using the UI definition language parsed by ClutterScript.

Parameters:

String id Required (not null)

Returns:

none

Sets the given name to self. The name can be used to identify a ClutterActor.

Parameters:

String name Required (not null)

Returns:

none

Sets the actor's opacity, with zero being completely transparent and 255 (0xff) being fully opaque.

Parameters:

Number opacity Required (not null)

Returns:

none

Sets the parent of self to parent. The opposite function is clutter_actor_unparent(). This function should not be used by applications, but by custom container actor subclasses.

Parameters:

Clutter.Actor parent Required (not null)

Returns:

none

Parameters:

Number x Required (not null)

Number y Required (not null)

Returns:

none

Sets actor as reactive. Reactive actors will receive events.

Parameters:

Boolean reactive Required (not null)

Returns:

none

Sets the geometry request mode of self. The mode determines the order for invoking clutter_actor_get_preferred_width() and clutter_actor_get_preferred_height()

Parameters:

Clutter.RequestMode mode Required (not null)

Returns:

none

Sets the rotation angle of self around the given axis. The rotation center coordinates used depend on the value of axis: CLUTTER_X_AXIS requires y and z CLUTTER_Y_AXIS requires x and z CLUTTER_Z_AXIS requires x and y The rotation coordinates are relative to the anchor point of the actor, set using clutter_actor_set_anchor_point(). If no anchor point is set, the upper left corner is assumed as the origin.

Parameters:

Clutter.RotateAxis axis Required (not null)

Number angle Required (not null)

Number x Required (not null)

Number y Required (not null)

Number z Required (not null)

Returns:

none

Scales an actor with the given factors. The scaling is relative to the scale center and the anchor point. The scale center is unchanged by this function and defaults to 0,0.

Parameters:

Number scale_x Required (not null)

Number scale_y Required (not null)

Returns:

none

Scales an actor with the given factors around the given center point. The center point is specified in pixels relative to the anchor point (usually the top left corner of the actor).

Parameters:

Number scale_x Required (not null)

Number scale_y Required (not null)

Number center_x Required (not null)

Number center_y Required (not null)

Returns:

none

direction. Scales an actor with the given factors around the given center point. The center point is specified as one of the compass directions in ClutterGravity. For example, setting it to north will cause the top of the actor to remain unchanged and the rest of the actor to expand left, right and downwards.

Parameters:

Number scale_x Required (not null)

Number scale_y Required (not null)

Clutter.Gravity gravity Required (not null)

Returns:

none

Sets the ClutterShader to be used when rendering self. If shader is NULL it will unset any currently set shader for the actor.

Parameters:

Clutter.Shader shader

a ClutterShader or NULL to unset the shader.

Returns:

Boolean

Sets the value for a named parameter of the shader applied to actor.

Parameters:

String param Required (not null)

GObject.Value value Required (not null)

Returns:

none

Sets the value for a named float parameter of the shader applied to actor.

Parameters:

String param Required (not null)

Number value Required (not null)

Returns:

none

Sets the value for a named int parameter of the shader applied to

Parameters:

String param Required (not null)

Number value Required (not null)

Returns:

none

Parameters:

Number width Required (not null)

Number height Required (not null)

Returns:

none

Sets the ClutterTextDirection for an actor The passed text direction must not be CLUTTER_TEXT_DIRECTION_DEFAULT If self implements ClutterContainer then this function will recurse inside all the children of self (including the internal ones). Composite actors not implementing ClutterContainer, or actors requiring special handling when the text direction changes, should connect to the GObject::notify signal for the ClutterActor:text-direction property

Parameters:

Clutter.TextDirection text_dir Required (not null)

Returns:

none

Parameters:

Number width Required (not null)

Returns:

none

Sets the actor's X coordinate, relative to its parent, in pixels. Overrides any layout manager and forces a fixed position for the actor.

Parameters:

Number x Required (not null)

Returns:

none

Sets the actor's Y coordinate, relative to its parent, in pixels.# Overrides any layout manager and forces a fixed position for the actor.

Parameters:

Number y Required (not null)

Returns:

none

Sets the rotation angle of self around the Z axis using the center point specified as a compass point. For example to rotate such that the center of the actor remains static you can use CLUTTER_GRAVITY_CENTER. If the actor changes size the center point will move accordingly.

Parameters:

Number angle Required (not null)

Clutter.Gravity gravity Required (not null)

Returns:

none

Should be called inside the implementation of the ClutterActor::pick virtual function in order to check whether the actor should paint itself in pick mode or not. This function should never be called directly by applications.

Returns:

Boolean FALSE otherwise

Flags an actor to be displayed. An actor that isn't shown will not be rendered on the stage. Actors are visible by default. If this function is called on an actor without a parent, the ClutterActor:show-on-set-parent will be set to TRUE as a side effect.

Returns:

none

Calls clutter_actor_show() on all children of an actor (if any).

Returns:

none

Sorts a container's children using their depth. This function should not be normally used by applications.

Returns:

none

Parameters:

Number x Required (not null)

Number y Required (not null)

Object out_values

Number x_out

Number y_out

Returns:

Boolean

Unsets the CLUTTER_ACTOR_MAPPED flag on the actor and possibly unmaps its children if they were mapped. ClutterActor::unmap virtual function in an actor and you need to unmap the children of that actor. It is not necessary to call this if you implement ClutterContainer because the default implementation will automatically unmap children of containers. When overriding unmap, it is mandatory to chain up to the parent implementation.

Returns:

none

Removes the parent of self. This function should not be used in applications. It should be called by implementations of container actors, to dissociate a child from the container.

Returns:

none

Unrealization informs the actor that it may be being destroyed or moved to another stage. The actor may want to destroy any underlying graphics resources at this point. However it is perfectly acceptable for it to retain the resources until the actor is destroyed because Clutter only ever uses a single rendering context and all of the graphics resources are valid on any stage. Because mapped actors must be realized, actors may not be unrealized if they are mapped. This function hides the actor to be sure it isn't mapped, an application-visible side effect that you may not be expecting. This function should not really be in the public API, because there isn't a good reason to call it. ClutterActor will already unrealize things for you when it's important to do so. If you were using clutter_actor_unrealize() in a dispose implementation, then don't, just chain up to ClutterActor's dispose. If you were using clutter_actor_unrealize() to implement unrealizing children of your container, then don't, ClutterActor will already take care of that. If you were using clutter_actor_unrealize() to re-realize to create your resources in a different way, then use _clutter_actor_rerealize() (inside Clutter) or just call your code that recreates your resources directly (outside Clutter).

Returns:

none

Unsets flags on self This function will emit notifications for the changed properties

Parameters:

Clutter.ActorFlags flags Required (not null)

Returns:

none

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

Parameters:

Clutter.Container self

Clutter.Actor actor

Returns:

{none}

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

Parameters:

Clutter.Container self

Clutter.Actor actor

Returns:

{none}

The ::allocation-changed signal is emitted when the ClutterActor:allocation property changes. Usually, application code should just use the notifications for the :allocation property but if you want to track the allocation flags as well, for instance to know whether the absolute origin of actor changed, then you might want use this signal instead.

Parameters:

Clutter.Actor self

Clutter.ActorBox box

Clutter.AllocationFlags flags

Returns:

{none}

The ::button-press-event signal is emitted each time a mouse button is pressed on actor.

Parameters:

Clutter.Actor self

Clutter.Event event

Returns:

{Boolean}

The ::button-release-event signal is emitted each time a mouse button is released on actor.

Parameters:

Clutter.Actor self

Clutter.Event event

Returns:

{Boolean}

The ::captured-event 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.

Parameters:

Clutter.Actor self

Clutter.Event event

Returns:

{Boolean}

The ::child-notify signal is emitted each time a property is being set through the clutter_container_child_set() and clutter_container_child_set_property() calls.

Parameters:

Clutter.Container self

Clutter.Actor actor

GObject.ParamSpec since

Returns:

{none}

The ::destroy signal is emitted when an actor is destroyed, either by direct invocation of clutter_actor_destroy() or when the ClutterGroup that contains the actor is destroyed.

Parameters:

Clutter.Actor self

Returns:

{none}

The ::enter-event signal is emitted when the pointer enters the actor

Parameters:

Clutter.Actor self

Clutter.Event event

Returns:

{Boolean}

The ::event 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).

Parameters:

Clutter.Actor self

Clutter.Event event

Returns:

{Boolean}

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

Parameters:

Clutter.Actor self

Returns:

{none}

The ::focus-in signal is emitted when actor recieves key focus.

Parameters:

Clutter.Actor self

Returns:

{none}

The ::key-focus-out signal is emitted when actor loses key focus.

Parameters:

Clutter.Actor self

Returns:

{none}

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

Parameters:

Clutter.Actor self

Clutter.Event event

Returns:

{Boolean}

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

Parameters:

Clutter.Actor self

Clutter.Event event

Returns:

{Boolean}

The ::leave-event signal is emitted when the pointer leaves the actor.

Parameters:

Clutter.Actor self

Clutter.Event event

Returns:

{Boolean}

The ::motion-event signal is emitted each time the mouse pointer is moved over actor.

Parameters:

Clutter.Actor self

Clutter.Event event

Returns:

{Boolean}

The ::paint signal is emitted each time an actor is being painted. Subclasses of ClutterActor should override the class signal handler and paint themselves in that function. It is possible to connect a handler to the ::paint signal in order to set up some custom aspect of a paint.

Parameters:

Clutter.Actor self

Returns:

{none}

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

Parameters:

Clutter.Actor self

Clutter.Actor old_parent

Returns:

{none}

The ::pick 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(). The actor should paint its shape using the passed pick_color. Subclasses of ClutterActor should override the class signal handler and paint themselves in that function. It is possible to connect a handler to the ::pick signal in order to set up some custom aspect of a paint in pick mode.

Parameters:

Clutter.Actor self

Clutter.Color color

Returns:

{none}

The ::queue_redraw signal is emitted when clutter_actor_queue_redraw() is called on origin. The default implementation for ClutterActor chains up to the parent actor and queues a redraw on the parent, thus "bubbling" the redraw queue up through the actor graph. The default implementation for ClutterStage queues a clutter_redraw() in a main loop idle handler. Note that the origin actor may be the stage, or a container; it does not have to be a leaf node in the actor graph. Toolkits embedding a ClutterStage which require a redraw and relayout cycle can stop the emission of this signal using the GSignal API, redraw the UI and then call clutter_redraw() themselves, like: |[ static void on_redraw_complete (void) { /* execute the Clutter drawing pipeline */ clutter_redraw (); } static void on_stage_queue_redraw (ClutterStage *stage) { /* this prevents the default handler to run */ g_signal_stop_emission_by_name (stage, "queue-redraw"); /* queue a redraw with the host toolkit and call * a function when the redraw has been completed */ queue_a_redraw (G_CALLBACK (on_redraw_complete)); } ]| This signal is emitted before the Clutter paint pipeline is executed. If you want to know when the pipeline has been completed you should connect to the ::paint signal on the Stage with g_signal_connect_after().

Parameters:

Clutter.Actor self

Clutter.Actor origin

Returns:

{none}

Parameters:

Clutter.Actor self

Returns:

{none}

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

Parameters:

Clutter.Actor self

Returns:

{none}

The ::scroll-event signal is emitted each time the mouse is scrolled on actor

Parameters:

Clutter.Actor self

Clutter.Event event

Returns:

{Boolean}

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

Parameters:

Clutter.Actor self

Returns:

{none}

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

Parameters:

Clutter.Actor self

Returns:

{none}