Class
ClutterActor
Description [src]
class Clutter.Actor : GObject.InitiallyUnowned {
flags: guint32
}
Base class for actors.
Instance methods
clutter_actor_add_action_full
clutter_actor_add_action_with_name
A convenience function for setting the name of a ClutterAction
while adding it to the list of actions applied to self
.
Available since: 1.4
clutter_actor_add_constraint
Adds constraint
to the list of ClutterConstraint
s applied
to self
.
Available since: 1.4
clutter_actor_add_constraint_with_name
A convenience function for setting the name of a ClutterConstraint
while adding it to the list of constraints applied to self
.
Available since: 1.4
clutter_actor_add_effect
Adds effect
to the list of ClutterEffect
s applied to self
.
Available since: 1.4
clutter_actor_add_effect_with_name
A convenience function for setting the name of a ClutterEffect
while adding it to the list of effectss applied to self
.
Available since: 1.4
clutter_actor_add_transition
Adds a transition
to the ClutterActor
‘s list of animations.
Available since: 1.10
clutter_actor_allocate_align_fill
Allocates self
by taking into consideration the available allocation
area; an alignment factor on either axis; and whether the actor should
fill the allocation on either axis.
Available since: 1.4
clutter_actor_allocate_available_size
Allocates self
taking into account the ClutterActor
‘s
preferred size, but limiting it to the maximum available width
and height provided.
Available since: 1.0
clutter_actor_apply_relative_transform_to_point
Transforms point
in coordinates relative to the actor into
ancestor-relative coordinates using the relevant transform
stack (i.e. scale, rotation, etc).
Available since: 0.6
clutter_actor_apply_transform_to_point
Transforms point
in coordinates relative to the actor
into screen-relative coordinates with the current actor
transformation (i.e. scale, rotation, etc)
Available since: 0.4
clutter_actor_bind_model_with_properties
Binds a GListModel
to a ClutterActor
.
Available since: 1.24
clutter_actor_clear_constraints
Clears the list of constraints applied to self
.
Available since: 1.4
clutter_actor_contains
Determines if descendant
is contained inside self
(either as an
immediate child, or as a deeper descendant). If self
and
descendant
point to the same actor then it will also return TRUE
.
Available since: 1.4
clutter_actor_continue_paint
Run the next stage of the paint sequence. This function should only
be called within the implementation of the ‘run’ virtual of a
ClutterEffect
. It will cause the run method of the next effect to
be applied, or it will paint the actual actor if the current effect
is the last effect in the chain.
Available since: 1.8
clutter_actor_continue_pick
Run the next stage of the pick sequence. This function should only
be called within the implementation of the ‘pick’ virtual of a
ClutterEffect
. It will cause the run method of the next effect to
be applied, or it will pick the actual actor if the current effect
is the last effect in the chain.
clutter_actor_create_pango_context
Creates a PangoContext
for the given actor. The PangoContext
is already configured using the appropriate font map, resolution
and font options.
Available since: 1.0
clutter_actor_create_pango_layout
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
.
Available since: 1.0
clutter_actor_destroy
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.
clutter_actor_event
This function is used to emit an event on the main stage. You should rarely need to use this function, except for synthetising events.
Available since: 0.6
clutter_actor_get_abs_allocation_vertices
Calculates the transformed screen coordinates of the four corners of
the actor; the returned vertices relate to the ClutterActorBox
coordinates as follows:
Available since: 0.4
clutter_actor_get_accessible
Returns the accessible object that describes the actor to an assistive technology.
clutter_actor_get_action
Retrieves the ClutterAction
with the given name in the list
of actions applied to self
.
Available since: 1.4
clutter_actor_get_allocation_box
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.
Available since: 0.8
clutter_actor_get_background_color
Retrieves the color set using clutter_actor_set_background_color().
Available since: 1.10
clutter_actor_get_child_at_index
Retrieves the actor at the given index_
inside the list of
children of self
.
Available since: 1.10
clutter_actor_get_child_transform
Retrieves the child transformation matrix set using
clutter_actor_set_child_transform(); if none is currently set,
the transform
matrix will be initialized to the identity matrix.
Available since: 1.12
clutter_actor_get_clip_to_allocation
Retrieves the value set using clutter_actor_set_clip_to_allocation()
Available since: 1.4
clutter_actor_get_constraint
Retrieves the ClutterConstraint
with the given name in the list
of constraints applied to self
.
Available since: 1.4
clutter_actor_get_constraints
Retrieves the list of constraints applied to self
.
Available since: 1.4
clutter_actor_get_content_box
Retrieves the bounding box for the ClutterContent
of self
.
Available since: 1.10
clutter_actor_get_content_gravity
Retrieves the content gravity as set using clutter_actor_set_content_gravity().
Available since: 1.10
clutter_actor_get_content_repeat
Retrieves the repeat policy for a ClutterActor
set by clutter_actor_set_content_repeat().
Available since: 1.12
clutter_actor_get_content_scaling_filters
Retrieves the values set using clutter_actor_set_content_scaling_filters().
Available since: 1.10
clutter_actor_get_default_paint_volume
Retrieves the default paint volume for self
.
Available since: 1.10
clutter_actor_get_easing_delay
Retrieves the delay that should be applied when tweening animatable properties.
Available since: 1.10
clutter_actor_get_easing_duration
Retrieves the duration of the tweening for animatable
properties of self
for the current easing state.
Available since: 1.10
clutter_actor_get_easing_mode
Retrieves the easing mode for the tweening of animatable properties
of self
for the current easing state.
Available since: 1.10
clutter_actor_get_effect
Retrieves the ClutterEffect
with the given name in the list
of effects applied to self
.
Available since: 1.4
clutter_actor_get_effects
Retrieves the ClutterEffect
s applied on self
, if any.
Available since: 1.4
clutter_actor_get_fixed_position
This function gets the fixed position of the actor, if set. If there
is no fixed position set, this function returns FALSE
and doesn’t set
the x and y coordinates.
clutter_actor_get_fixed_position_set
Checks whether an actor has a fixed position set (and will thus be unaffected by any layout manager).
Available since: 0.8
clutter_actor_get_height
Retrieves the height of a ClutterActor
.
clutter_actor_get_layout_manager
Retrieves the ClutterLayoutManager
used by self
.
Available since: 1.10
clutter_actor_get_margin
Retrieves all the components of the margin of a ClutterActor
.
Available since: 1.10
clutter_actor_get_margin_bottom
Retrieves the bottom margin of a ClutterActor
.
Available since: 1.10
clutter_actor_get_name
Retrieves the name of self
.
clutter_actor_get_next_sibling
Retrieves the sibling of self
that comes after it in the list
of children of self
‘s parent.
Available since: 1.10
clutter_actor_get_offscreen_redirect
Retrieves whether to redirect the actor to an offscreen buffer, as set by clutter_actor_set_offscreen_redirect().
Available since: 1.8
clutter_actor_get_opacity
Retrieves the opacity value of an actor, as set by clutter_actor_set_opacity().
clutter_actor_get_paint_box
Retrieves the paint volume of the passed ClutterActor
, and
transforms it into a 2D bounding box in stage coordinates.
Available since: 1.6
clutter_actor_get_paint_opacity
Retrieves the absolute opacity of the actor, as it appears on the stage.
Available since: 0.8
clutter_actor_get_paint_visibility
Retrieves the ‘paint’ visibility of an actor recursively checking for non visible parents.
Available since: 0.8
clutter_actor_get_paint_volume
Retrieves the paint volume of the passed ClutterActor
, or NULL
when a paint volume can’t be determined.
Available since: 1.6
clutter_actor_get_pango_context
Retrieves the PangoContext
for self
. The actor’s PangoContext
is already configured using the appropriate font map, resolution
and font options.
Available since: 1.0
clutter_actor_get_parent
Retrieves the parent of self
.
clutter_actor_get_pivot_point
Retrieves the coordinates of the ClutterActor:pivot-point
.
Available since: 1.12
clutter_actor_get_pivot_point_z
Retrieves the Z component of the ClutterActor:pivot-point
.
Available since: 1.12
clutter_actor_get_position
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.
Available since: 0.6
clutter_actor_get_preferred_height
Computes the requested minimum and natural heights for an actor, or if they are already computed, returns the cached values.
Available since: 0.8
clutter_actor_get_preferred_size
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).
Available since: 0.8
clutter_actor_get_preferred_width
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.
Available since: 0.8
clutter_actor_get_previous_sibling
Retrieves the sibling of self
that comes before it in the list
of children of self
‘s parent.
Available since: 1.10
clutter_actor_get_resource_scale
Retrieves the resource scale for this actor.
clutter_actor_get_rotation_angle
Retrieves the angle of rotation set by clutter_actor_set_rotation_angle().
Available since: 1.12
clutter_actor_get_scale_z
Retrieves the scaling factor along the Z axis, as set using clutter_actor_set_scale_z().
Available since: 1.12
clutter_actor_get_size
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.
Available since: 0.2
clutter_actor_get_text_direction
Retrieves the value set using clutter_actor_set_text_direction()
Available since: 1.2
clutter_actor_get_transform
Retrieves the current transformation matrix of a ClutterActor
.
Available since: 1.12
clutter_actor_get_transformed_extents
Gets the transformed bounding rect of an actor, in pixels relative to the stage.
clutter_actor_get_transformed_paint_volume
Retrieves the 3D paint volume of an actor like
clutter_actor_get_paint_volume()
does (Please refer to the
documentation of clutter_actor_get_paint_volume()
for more
details.) and it additionally transforms the paint volume into the
coordinate space of relative_to_ancestor
. (Or the stage if NULL
is passed for relative_to_ancestor
)
Available since: 1.6
clutter_actor_get_transformed_position
Gets the absolute position of an actor, in pixels relative to the stage.
Available since: 0.8
clutter_actor_get_transformed_size
Gets the absolute size of an actor in pixels, taking into account the scaling factors.
Available since: 0.8
clutter_actor_get_transition
Retrieves the ClutterTransition
of a ClutterActor
by using the
transition name
.
Available since: 1.10
clutter_actor_get_translation
Retrieves the translation set using clutter_actor_set_translation().
Available since: 1.12
clutter_actor_get_width
Retrieves the width of a ClutterActor
.
clutter_actor_get_x
Retrieves the X coordinate of a ClutterActor
.
clutter_actor_get_x_align
Retrieves the horizontal alignment policy set using clutter_actor_set_x_align().
Available since: 1.10
clutter_actor_get_x_expand
Retrieves the value set with clutter_actor_set_x_expand().
Available since: 1.12
clutter_actor_get_y
Retrieves the Y coordinate of a ClutterActor
.
clutter_actor_get_y_align
Retrieves the vertical alignment policy set using clutter_actor_set_y_align().
Available since: 1.10
clutter_actor_get_y_expand
Retrieves the value set with clutter_actor_set_y_expand().
Available since: 1.12
clutter_actor_grab_key_focus
Sets the key focus of the ClutterStage
including self
to this ClutterActor
.
Available since: 1.0
clutter_actor_has_accessible
clutter_actor_has_allocation
Checks if the actor has an up-to-date allocation assigned to it. This means that the actor should have an allocation: it’s 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).
Available since: 1.4
clutter_actor_has_clip
Determines whether the actor has a clip area set or not.
Available since: 0.2
clutter_actor_has_constraints
Returns whether the actor has any constraints applied.
Available since: 1.10
clutter_actor_has_damage
clutter_actor_has_key_focus
Checks whether self
is the ClutterActor
that has key focus.
Available since: 1.4
clutter_actor_has_mapped_clones
Returns whether a ClutterActor
or any parent actors have mapped clones
that are clone-painting self
.
clutter_actor_has_overlaps
Asks the actor’s implementation whether it may contain overlapping primitives.
Available since: 1.8
clutter_actor_has_pointer
Checks whether an actor contains the pointer of a
ClutterInputDevice
.
Available since: 1.2
clutter_actor_has_transitions
clutter_actor_hide
Flags an actor to be hidden. A hidden actor will not be rendered on the stage.
clutter_actor_inhibit_culling
Increases the culling inhibitor counter. Inhibiting culling forces the actor to be painted even when outside the visible bounds of the stage view.
clutter_actor_insert_child_above
Inserts child
into the list of children of self
, above another
child of self
or, if sibling
is NULL
, above all the children
of self
.
Available since: 1.10
clutter_actor_insert_child_at_index
Inserts child
into the list of children of self
, using the
given index_
. If index_
is greater than the number of children
in self
, or is less than 0, then the new child is added at the end.
Available since: 1.10
clutter_actor_insert_child_below
Inserts child
into the list of children of self
, below another
child of self
or, if sibling
is NULL
, below all the children
of self
.
Available since: 1.10
clutter_actor_invalidate_paint_volume
Invalidates the cached paint volume of self
. This is needed for
implementations overriding the ClutterActorClass
.get_paint_volume()
virtual function and has to be called every time the paint volume
returned by that function would change.
clutter_actor_invalidate_transform
Invalidate the cached transformation matrix of self
.
This is needed for implementations overriding the apply_transform()
vfunc and has to be called if the matrix returned by apply_transform()
would change.
clutter_actor_is_effectively_on_stage_view
clutter_actor_is_in_clone_paint
Checks whether self
is being currently painted by a ClutterClone
.
Available since: 1.0
clutter_actor_is_scaled
Checks whether the actor is scaled in either dimension.
Available since: 0.6
clutter_actor_map
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.
Available since: 1.0
clutter_actor_move_by
Moves an actor by the specified distance relative to its current position in pixels.
Available since: 0.2
clutter_actor_needs_expand
Checks whether an actor, or any of its children, is set to expand horizontally or vertically.
Available since: 1.12
clutter_actor_paint
Renders the actor to display.
clutter_actor_peek_stage_views
Retrieves the list of ClutterStageView
s the actor is being
painted on.
clutter_actor_pick
Asks actor
to perform a pick.
clutter_actor_pick_box
Logs (does a virtual paint of) a rectangle for picking. Note that box
is
in the actor’s own local coordinates, so is usually {0,0,width,height}
to include the whole actor. That is unless the actor has a shaped input
region in which case you may wish to log the (multiple) smaller rectangles
that make up the input region.
clutter_actor_pick_frame_clock
Pick the most suitable frame clock for driving animations for this actor.
clutter_actor_queue_redraw
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).
clutter_actor_queue_redraw_with_clip
Queues a redraw on self
limited to a specific, actor-relative
rectangular area.
Available since: 1.10
clutter_actor_queue_relayout
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.
Available since: 0.8
clutter_actor_realize
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.
Deprecated since: 1.16
clutter_actor_remove_action
Removes action
from the list of actions applied to self
.
Available since: 1.4
clutter_actor_remove_action_by_name
Removes the ClutterAction
with the given name from the list
of actions applied to self
.
Available since: 1.4
clutter_actor_remove_all_transitions
Removes all transitions associated to self
.
Available since: 1.10
clutter_actor_remove_clip
Removes clip area from self
.
clutter_actor_remove_constraint
Removes constraint
from the list of constraints applied to self
.
Available since: 1.4
clutter_actor_remove_constraint_by_name
Removes the ClutterConstraint
with the given name from the list
of constraints applied to self
.
Available since: 1.4
clutter_actor_remove_effect
Removes effect
from the list of effects applied to self
.
Available since: 1.4
clutter_actor_remove_effect_by_name
Removes the ClutterEffect
with the given name from the list
of effects applied to self
.
Available since: 1.4
clutter_actor_remove_transition
Removes the transition stored inside a ClutterActor
using name
identifier.
Available since: 1.10
clutter_actor_replace_child
Replaces old_child
with new_child
in the list of children of self
.
Available since: 1.10
clutter_actor_restore_easing_state
Restores the easing state as it was prior to a call to clutter_actor_save_easing_state().
Available since: 1.10
clutter_actor_save_easing_state
Saves the current easing state for animatable properties, and creates a new state with the default values for easing mode and duration.
Available since: 1.10
clutter_actor_set_background_color
Sets the background color of a ClutterActor
.
Available since: 1.10
clutter_actor_set_child_above_sibling
Sets child
to be above sibling
in the list of children of self
.
Available since: 1.10
clutter_actor_set_child_at_index
Changes the index of child
in the list of children of self
.
Available since: 1.10
clutter_actor_set_child_below_sibling
Sets child
to be below sibling
in the list of children of self
.
Available since: 1.10
clutter_actor_set_child_transform
Sets the transformation matrix to be applied to all the children
of self
prior to their own transformations. The default child
transformation is the identity matrix.
Available since: 1.12
clutter_actor_set_clip
Sets clip area for self
. The clip area is always computed from the
upper left corner of the actor.
Available since: 0.6
clutter_actor_set_clip_to_allocation
Sets whether self
should be clipped to the same size as its allocation.
Available since: 1.4
clutter_actor_set_content_gravity
Sets the gravity of the ClutterContent
used by self
.
Available since: 1.10
clutter_actor_set_content_repeat
Sets the policy for repeating the ClutterActor:content
of a
ClutterActor
. The behaviour is deferred to the ClutterContent
implementation.
Available since: 1.12
clutter_actor_set_content_scaling_filters
Sets the minification and magnification filter to be applied when
scaling the ClutterActor:content
of a ClutterActor
.
Available since: 1.10
clutter_actor_set_easing_delay
Sets the delay that should be applied before tweening animatable properties.
Available since: 1.10
clutter_actor_set_easing_duration
Sets the duration of the tweening for animatable properties
of self
for the current easing state.
Available since: 1.10
clutter_actor_set_easing_mode
Sets the easing mode for the tweening of animatable properties
of self
.
Available since: 1.10
clutter_actor_set_fixed_position_set
Sets whether an actor has a fixed position set (and will thus be unaffected by any layout manager).
Available since: 0.8
clutter_actor_set_height
Forces a height on an actor, causing the actor’s preferred width and height (if any) to be ignored.
Available since: 0.2
clutter_actor_set_layout_manager
Sets the ClutterLayoutManager
delegate object that will be used to
lay out the children of self
.
Available since: 1.10
clutter_actor_set_margin
Sets all the components of the margin of a ClutterActor
.
Available since: 1.10
clutter_actor_set_margin_bottom
Sets the margin from the bottom of a ClutterActor
.
Available since: 1.10
clutter_actor_set_margin_left
Sets the margin from the left of a ClutterActor
.
Available since: 1.10
clutter_actor_set_margin_right
Sets the margin from the right of a ClutterActor
.
Available since: 1.10
clutter_actor_set_name
Sets the given name to self
. The name can be used to identify
a ClutterActor
.
clutter_actor_set_offscreen_redirect
Defines the circumstances where the actor should be redirected into an offscreen image. The offscreen image is used to flatten the actor into a single image while painting for two main reasons. Firstly, when the actor is painted a second time without any of its contents changing it can simply repaint the cached image without descending further down the actor hierarchy. Secondly, it will make the opacity look correct even if there are overlapping primitives in the actor.
Available since: 1.8
clutter_actor_set_opacity
Sets the actor’s opacity, with zero being completely transparent and 255 (0xff) being fully opaque.
clutter_actor_set_opacity_override
Allows overriding the calculated paint opacity (as returned by clutter_actor_get_paint_opacity()). This is used internally by ClutterClone and ClutterOffscreenEffect, and should be used by actors that need to mimic those.
clutter_actor_set_pivot_point
Sets the position of the ClutterActor:pivot-point
around which the
scaling and rotation transformations occur.
Available since: 1.12
clutter_actor_set_pivot_point_z
Sets the component on the Z axis of the ClutterActor:pivot-point
around
which the scaling and rotation transformations occur.
Available since: 1.12
clutter_actor_set_position
Sets the actor’s fixed position in pixels relative to any parent actor.
clutter_actor_set_reactive
Sets actor
as reactive. Reactive actors will receive events.
Available since: 0.6
clutter_actor_set_rotation_angle
Sets the angle
of rotation of a ClutterActor
on the given axis
.
Available since: 1.12
clutter_actor_set_scale_z
Scales an actor on the Z axis by the given scale_z
factor.
Available since: 1.12
clutter_actor_set_size
Sets the actor’s size request in pixels. This overrides any “normal” size request the actor would have. For example a text actor might normally request the size of the text; this function would force a specific size instead.
clutter_actor_set_transform
Overrides the transformations of a ClutterActor
with a custom
matrix, which will be applied relative to the origin of the
actor’s allocation and to the actor’s pivot point.
Available since: 1.12
clutter_actor_set_translation
Sets an additional translation transformation on a ClutterActor
,
relative to the ClutterActor:pivot-point
.
Available since: 1.12
clutter_actor_set_width
Forces a width on an actor, causing the actor’s preferred width and height (if any) to be ignored.
Available since: 0.2
clutter_actor_set_x
Sets the actor’s X coordinate, relative to its parent, in pixels.
Available since: 0.6
clutter_actor_set_x_align
Sets the horizontal alignment policy of a ClutterActor
, in case the
actor received extra horizontal space.
Available since: 1.10
clutter_actor_set_x_expand
Sets whether a ClutterActor
should expand horizontally; this means
that layout manager should allocate extra space for the actor, if possible.
Available since: 1.12
clutter_actor_set_y
Sets the actor’s Y coordinate, relative to its parent, in pixels.#
Available since: 0.6
clutter_actor_set_y_align
Sets the vertical alignment policy of a ClutterActor
, in case the
actor received extra vertical space.
Available since: 1.10
clutter_actor_set_y_expand
Sets whether a ClutterActor
should expand horizontally; this means
that layout manager should allocate extra space for the actor, if possible.
Available since: 1.12
clutter_actor_should_pick
Should be called inside the implementation of the
ClutterActor::pick
virtual function in order to check whether
the actor should be picked or not.
clutter_actor_show
Flags an actor to be displayed. An actor that isn’t shown will not be rendered on the stage.
clutter_actor_transform_stage_point
This function translates screen coordinates (x
, y
) to
coordinates relative to the actor. For example, it can be used to translate
screen events from global screen coordinates into actor-local coordinates.
Available since: 0.6
clutter_actor_uninhibit_culling
Decreases the culling inhibitor counter. See clutter_actor_inhibit_culling()
for when inhibit culling is necessary.
clutter_actor_unmap
Unsets the CLUTTER_ACTOR_MAPPED
flag on the actor and possibly
unmaps its children if they were mapped.
Available since: 1.0
clutter_actor_unrealize
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.
Deprecated since: 1.16
Methods inherited from ClutterAnimatable (5)
clutter_animatable_find_property
Finds the GParamSpec
for property_name
.
Available since: 1.4
clutter_animatable_get_actor
Get animated actor.
clutter_animatable_get_initial_state
Retrieves the current state of property_name
and sets value
with it.
Available since: 1.4
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
.
Available since: 1.8
clutter_animatable_set_final_state
Sets the current state of property_name
to value
.
Available since: 1.4
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
.
Available since: 0.4
Deprecated since: 1.10
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
.
Available since: 0.4
Deprecated since: 1.10
clutter_container_child_get
Gets container
specific properties of an actor.
Available since: 0.8
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().
Available since: 0.8
clutter_container_child_notify
Calls the ClutterContainerIface
.child_notify() virtual function
of ClutterContainer
. The default implementation will emit the
ClutterContainer::child-notify
signal.
Available since: 1.6
clutter_container_child_set
Sets container specific properties on the child of a container.
Available since: 0.8
clutter_container_child_set_property
Sets a container-specific property on a child of container
.
Available since: 0.8
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
.
Available since: 1.2
clutter_container_destroy_child_meta
Destroys the ClutterChildMeta
wrapping actor
inside the
container
, if any.
Available since: 1.2
clutter_container_find_child_by_name
Finds a child actor of a container by its name. Search recurses into any child container.
Available since: 0.6
clutter_container_get_child_meta
Retrieves the ClutterChildMeta
which contains the data about the
container
specific state for actor
.
Available since: 0.8
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
.
Available since: 0.4
Deprecated since: 1.10
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
.
Available since: 0.4
Deprecated since: 1.10
Methods inherited from ClutterScriptable (4)
clutter_scriptable_get_id
Retrieves the id of scriptable
set using clutter_scriptable_set_id().
Available since: 0.6
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().
Available since: 0.6
clutter_scriptable_set_custom_property
Overrides the common properties setting. The underlying virtual function should be used when implementing custom properties.
Available since: 0.6
clutter_scriptable_set_id
Sets id_
as the unique Clutter script it for this instance of
ClutterScriptableIface
.
Available since: 0.6
Properties
Clutter.Actor:background-color
Paints a solid fill of the actor’s allocation using the specified color.
Available since: 1.10
Clutter.Actor:background-color-set
Whether the ClutterActor:background-color
property has been set.
Available since: 1.10
Clutter.Actor:child-transform
Applies a transformation matrix on each child of an actor.
Available since: 1.12
Clutter.Actor:child-transform-set
Whether the ClutterActor:child-transform
property is set.
Available since: 1.12
Clutter.Actor:clip-rect
The visible region of the actor, in actor-relative coordinates, expressed as a #graphene_rect_t.
Available since: 1.12
Clutter.Actor:clip-to-allocation
Whether the clip region should track the allocated area of the actor.
Available since: 1.0
Clutter.Actor:content
The ClutterContent
implementation that controls the content
of the actor.
Available since: 1.10
Clutter.Actor:content-box
The bounding box for the ClutterContent
used by the actor.
Available since: 1.10
Clutter.Actor:content-gravity
The alignment that should be honoured by the ClutterContent
set with the ClutterActor:content
property.
Available since: 1.10
Clutter.Actor:content-repeat
The repeat policy for the actor’s ClutterActor:content
.
Available since: 1.12
Clutter.Actor:effect
Adds ClutterEffect
to the list of effects be applied on a ClutterActor
.
Available since: 1.4
Clutter.Actor:fixed-position-set
This flag controls whether the ClutterActor:fixed-x
and
ClutterActor:fixed-y
properties are used.
Available since: 0.8
Clutter.Actor:has-clip
Whether the actor has the ClutterActor:clip
property set or not.
Clutter.Actor:has-pointer
Whether the actor contains the pointer of a ClutterInputDevice
or not.
Available since: 1.2
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.
Clutter.Actor:layout-manager
A delegate object for controlling the layout of the children of an actor.
Available since: 1.10
Clutter.Actor:magnification-filter
Clutter.Actor:mapped
Whether the actor is mapped (will be painted when the stage to which it belongs is mapped)
Available since: 1.0
Clutter.Actor:margin-bottom
The margin (in pixels) from the bottom of the actor.
Available since: 1.10
Clutter.Actor:margin-right
The margin (in pixels) from the right of the actor.
Available since: 1.10
Clutter.Actor:min-height
A forced minimum height request for the actor, in pixels.
Available since: 0.8
Clutter.Actor:min-height-set
This flag controls whether the ClutterActor:min-height
property
is used.
Available since: 0.8
Clutter.Actor:min-width
A forced minimum width request for the actor, in pixels.
Available since: 0.8
Clutter.Actor:min-width-set
This flag controls whether the ClutterActor:min-width
property
is used.
Available since: 0.8
Clutter.Actor:minification-filter
Clutter.Actor:natural-height
A forced natural height request for the actor, in pixels.
Available since: 0.8
Clutter.Actor:natural-height-set
This flag controls whether the ClutterActor:natural-height
property
is used.
Available since: 0.8
Clutter.Actor:natural-width
A forced natural width request for the actor, in pixels.
Available since: 0.8
Clutter.Actor:natural-width-set
This flag controls whether the ClutterActor:natural-width
property
is used.
Available since: 0.8
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.
Available since: 1.8
Clutter.Actor:opacity
Opacity of an actor, between 0 (fully transparent) and 255 (fully opaque)
Clutter.Actor:pivot-point
The point around which the scaling and rotation transformations occur.
Available since: 1.12
Clutter.Actor:pivot-point-z
The Z component of the ClutterActor:pivot-point
, expressed as a value
along the Z axis.
Available since: 1.12
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.
Available since: 0.8
Clutter.Actor:show-on-set-parent
If TRUE
, the actor is automatically shown when parented.
Available since: 0.8
Clutter.Actor:transform
Overrides the transformations of a ClutterActor
with a custom matrix.
Available since: 1.12
Clutter.Actor:transform-set
Whether the ClutterActor:transform
property is set.
Available since: 1.12
Clutter.Actor:translation-x
An additional translation applied along the X axis, relative
to the actor’s ClutterActor:pivot-point
.
Available since: 1.12
Clutter.Actor:translation-y
An additional translation applied along the Y axis, relative
to the actor’s ClutterActor:pivot-point
.
Available since: 1.12
Clutter.Actor:translation-z
An additional translation applied along the Z axis, relative
to the actor’s ClutterActor:pivot-point
.
Available since: 1.12
Clutter.Actor:visible
Whether the actor is set to be visible or not.
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.
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.
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.
Available since: 1.10
Clutter.Actor:x-expand
Whether a layout manager should assign more space to the actor on the X axis.
Available since: 1.12
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.
Clutter.Actor:y-align
The alignment of an actor on the Y axis, if the actor has been given extra space for its allocation.
Available since: 1.10
Clutter.Actor:y-expand
Whether a layout manager should assign more space to the actor on the Y axis.
Available since: 1.12
Clutter.Actor:z-position
The actor’s position on the Z axis, relative to the parent’s transformations.
Available since: 1.12
Signals
Clutter.Actor::button-press-event
The ::button-press-event signal is emitted each time a mouse button
is pressed on actor
.
Available since: 0.6
Clutter.Actor::button-release-event
The ::button-release-event signal is emitted each time a mouse button
is released on actor
.
Available since: 0.6
Clutter.Actor::captured-event
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.
Available since: 0.6
Clutter.Actor::destroy
The ::destroy signal notifies that all references held on the actor which emitted it should be released.
Available since: 0.2
Clutter.Actor::enter-event
The ::enter-event signal is emitted when the pointer enters the actor
.
Available since: 0.6
Clutter.Actor::event
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
).
Available since: 0.6
Clutter.Actor::hide
The ::hide signal is emitted when an actor is no longer rendered on the stage.
Available since: 0.2
Clutter.Actor::key-focus-in
The ::key-focus-in signal is emitted when actor
receives key focus.
Available since: 0.6
Clutter.Actor::key-focus-out
The ::key-focus-out signal is emitted when actor
loses key focus.
Available since: 0.6
Clutter.Actor::key-press-event
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()).
Available since: 0.6
Clutter.Actor::key-release-event
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()).
Available since: 0.6
Clutter.Actor::leave-event
The ::leave-event signal is emitted when the pointer leaves the actor
.
Available since: 0.6
Clutter.Actor::motion-event
The ::motion-event signal is emitted each time the mouse pointer is
moved over actor
.
Available since: 0.6
Clutter.Actor::parent-set
This signal is emitted when the parent of the actor changes.
Available since: 0.2
Clutter.Actor::pick
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().
Available since: 1.0
Deprecated since: 1.12
Clutter.Actor::queue-relayout
The ::queue_layout signal is emitted when clutter_actor_queue_relayout()
is called on an actor.
Available since: 1.2
Clutter.Actor::realize
The ::realize signal is emitted each time an actor is being realized.
Available since: 0.8
Deprecated since: 1.16
Clutter.Actor::resource-scale-changed
The ::resource-scale-changed signal is emitted when the resource scale
value returned by clutter_actor_get_resource_scale()
changes.
Clutter.Actor::scroll-event
The ::scroll-event signal is emitted each time the mouse is
scrolled on actor
.
Available since: 0.6
Clutter.Actor::show
The ::show signal is emitted when an actor is visible and rendered on the stage.
Available since: 0.2
Clutter.Actor::stage-views-changed
The ::stage-views-changed 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.
Clutter.Actor::touch-event
The ::touch-event signal is emitted each time a touch begin/end/update/cancel event.
Available since: 1.12
Clutter.Actor::transition-stopped
The ::transition-stopped 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().
Available since: 1.12
Clutter.Actor::transitions-completed
The ::transitions-completed signal is emitted once all transitions
involving actor
are complete.
Available since: 1.10
Clutter.Actor::unrealize
The ::unrealize signal is emitted each time an actor is being unrealized.
Available since: 0.8
Deprecated since: 1.16
Signals inherited from GObject (1)
GObject.Object::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.
Signals inherited from ClutterContainer (3)
Clutter.Container::actor-added
The ::actor-added signal is emitted each time an actor
has been added to container
.
Available since: 0.4
Clutter.Container::actor-removed
The ::actor-removed signal is emitted each time an actor
is removed from container
.
Available since: 0.4
Clutter.Container::child-notify
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.
Available since: 0.8
Class structure
struct ClutterActorClass {
void (* show) (
ClutterActor* self
);
void (* hide) (
ClutterActor* self
);
void (* hide_all) (
ClutterActor* self
);
void (* realize) (
ClutterActor* self
);
void (* unrealize) (
ClutterActor* self
);
void (* map) (
ClutterActor* self
);
void (* unmap) (
ClutterActor* self
);
void (* paint) (
ClutterActor* self,
ClutterPaintContext* paint_context
);
void (* parent_set) (
ClutterActor* actor,
ClutterActor* old_parent
);
void (* destroy) (
ClutterActor* self
);
void (* pick) (
ClutterActor* actor,
ClutterPickContext* pick_context
);
void (* get_preferred_width) (
ClutterActor* self,
gfloat for_height,
gfloat* min_width_p,
gfloat* natural_width_p
);
void (* get_preferred_height) (
ClutterActor* self,
gfloat for_width,
gfloat* min_height_p,
gfloat* natural_height_p
);
void (* allocate) (
ClutterActor* self,
const ClutterActorBox* box
);
void (* apply_transform) (
ClutterActor* actor,
graphene_matrix_t* matrix
);
gboolean (* event) (
ClutterActor* actor,
ClutterEvent* event
);
gboolean (* button_press_event) (
ClutterActor* actor,
ClutterButtonEvent* event
);
gboolean (* button_release_event) (
ClutterActor* actor,
ClutterButtonEvent* event
);
gboolean (* scroll_event) (
ClutterActor* actor,
ClutterScrollEvent* event
);
gboolean (* key_press_event) (
ClutterActor* actor,
ClutterKeyEvent* event
);
gboolean (* key_release_event) (
ClutterActor* actor,
ClutterKeyEvent* event
);
gboolean (* motion_event) (
ClutterActor* actor,
ClutterMotionEvent* event
);
gboolean (* enter_event) (
ClutterActor* actor,
ClutterCrossingEvent* event
);
gboolean (* leave_event) (
ClutterActor* actor,
ClutterCrossingEvent* event
);
gboolean (* captured_event) (
ClutterActor* actor,
ClutterEvent* event
);
void (* key_focus_in) (
ClutterActor* actor
);
void (* key_focus_out) (
ClutterActor* actor
);
void (* queue_relayout) (
ClutterActor* self
);
AtkObject* (* get_accessible) (
ClutterActor* self
);
gboolean (* get_paint_volume) (
ClutterActor* actor,
ClutterPaintVolume* volume
);
gboolean (* has_overlaps) (
ClutterActor* self
);
void (* paint_node) (
ClutterActor* self,
ClutterPaintNode* root
);
gboolean (* touch_event) (
ClutterActor* self,
ClutterTouchEvent* event
);
gboolean (* has_accessible) (
ClutterActor* self
);
void (* resource_scale_changed) (
ClutterActor* self
);
float (* calculate_resource_scale) (
ClutterActor* self,
int phase
);
}
Class members
show |
|
No description available. | |
hide |
|
No description available. | |
hide_all |
|
No description available. | |
realize |
|
No description available. | |
unrealize |
|
No description available. | |
map |
|
No description available. | |
unmap |
|
No description available. | |
paint |
|
No description available. | |
parent_set |
|
No description available. | |
destroy |
|
No description available. | |
pick |
|
No description available. | |
get_preferred_width |
|
No description available. | |
get_preferred_height |
|
No description available. | |
allocate |
|
No description available. | |
apply_transform |
|
No description available. | |
event |
|
No description available. | |
button_press_event |
|
No description available. | |
button_release_event |
|
No description available. | |
scroll_event |
|
No description available. | |
key_press_event |
|
No description available. | |
key_release_event |
|
No description available. | |
motion_event |
|
No description available. | |
enter_event |
|
No description available. | |
leave_event |
|
No description available. | |
captured_event |
|
No description available. | |
key_focus_in |
|
No description available. | |
key_focus_out |
|
No description available. | |
queue_relayout |
|
No description available. | |
get_accessible |
|
No description available. | |
get_paint_volume |
|
No description available. | |
has_overlaps |
|
No description available. | |
paint_node |
|
No description available. | |
touch_event |
|
No description available. | |
has_accessible |
|
No description available. | |
resource_scale_changed |
|
No description available. | |
calculate_resource_scale |
|
No description available. |
Virtual methods
Clutter.ActorClass.allocate
Assigns the size of a ClutterActor
from the given box
.
Available since: 0.8
Clutter.ActorClass.apply_transform
Clutter.ActorClass.button_press_event
Clutter.ActorClass.button_release_event
Clutter.ActorClass.calculate_resource_scale
Clutter.ActorClass.captured_event
Clutter.ActorClass.destroy
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.
Clutter.ActorClass.enter_event
Clutter.ActorClass.event
Clutter.ActorClass.get_accessible
Returns the accessible object that describes the actor to an assistive technology.
Clutter.ActorClass.get_paint_volume
Clutter.ActorClass.get_preferred_height
Computes the requested minimum and natural heights for an actor, or if they are already computed, returns the cached values.
Available since: 0.8
Clutter.ActorClass.get_preferred_width
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.
Available since: 0.8
Clutter.ActorClass.has_accessible
Clutter.ActorClass.has_overlaps
Asks the actor’s implementation whether it may contain overlapping primitives.
Available since: 1.8
Clutter.ActorClass.hide
Flags an actor to be hidden. A hidden actor will not be rendered on the stage.
Clutter.ActorClass.hide_all
Clutter.ActorClass.key_focus_in
Clutter.ActorClass.key_focus_out
Clutter.ActorClass.key_press_event
Clutter.ActorClass.key_release_event
Clutter.ActorClass.leave_event
Clutter.ActorClass.map
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.
Available since: 1.0
Clutter.ActorClass.motion_event
Clutter.ActorClass.paint
Renders the actor to display.
Clutter.ActorClass.paint_node
Clutter.ActorClass.parent_set
Clutter.ActorClass.pick
Asks actor
to perform a pick.
Clutter.ActorClass.queue_relayout
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.
Available since: 0.8
Clutter.ActorClass.realize
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.
Deprecated since: 1.16
Clutter.ActorClass.resource_scale_changed
Clutter.ActorClass.scroll_event
Clutter.ActorClass.show
Flags an actor to be displayed. An actor that isn’t shown will not be rendered on the stage.
Clutter.ActorClass.touch_event
Clutter.ActorClass.unmap
Unsets the CLUTTER_ACTOR_MAPPED
flag on the actor and possibly
unmaps its children if they were mapped.
Available since: 1.0
Clutter.ActorClass.unrealize
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.
Deprecated since: 1.16