mutter/doc/reference/tmpl/clutter-actor.sgml

<!-- ##### SECTION Title ##### -->
ClutterActor

<!-- ##### SECTION Short_Description ##### -->


<!-- ##### SECTION Long_Description ##### -->
<para>

</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### SECTION Stability_Level ##### -->


<!-- ##### MACRO CLUTTER_ACTOR_SET_FLAGS ##### -->
<para>
Sets a flag from #ClutterActorFlags to an actor
</para>

@e: a #ClutterActor
@f: the flag to set


<!-- ##### MACRO CLUTTER_ACTOR_UNSET_FLAGS ##### -->
<para>
Unsets a flag from #ClutterActorFlags to an actor
</para>

@e: a #ClutterActor
@f: the flag to unset


<!-- ##### MACRO CLUTTER_ACTOR_IS_MAPPED ##### -->
<para>
Evaluates to %TRUE if an actor is mapped.
</para>

@e: a #ClutterActor


<!-- ##### MACRO CLUTTER_ACTOR_IS_REALIZED ##### -->
<para>
Evaluates to %TRUE if an actor has been realized.
</para>

@e: a #ClutterActor


<!-- ##### MACRO CLUTTER_ACTOR_IS_VISIBLE ##### -->
<para>
Evaluates to %TRUE if an actor is visible.
</para>

@e: a #ClutterActor


<!-- ##### STRUCT ClutterActorBox ##### -->
<para>
Coordinates (top-left to bottom-right) of a box surrounding an actor; in
cluttter units.
</para>

@x1: X coordinate of the top left corner of the box
@y1: Y coordinate of the top left corner of the box
@x2: X coordinate of the bottom right corner of the box
@y2: Y coordinate of the bottom right corner of the box

<!-- ##### ENUM ClutterActorFlags ##### -->
<para>
Flags used by an actor.
</para>

@CLUTTER_ACTOR_MAPPED: the actor is mapped
@CLUTTER_ACTOR_REALIZED: the actor is realised

<!-- ##### STRUCT ClutterGeometry ##### -->
<para>
Positional and dimensional coordinates of an actor.
</para>

@x: X coordinate of the top left corner of an actor
@y: Y coordinate of the top left corner of an actor
@width: width of an actor
@height: height of an actor

<!-- ##### MACRO CLUTTER_CALLBACK ##### -->
<para>
Casts a generic callback function into a #ClutterCallback
</para>

@f: a function pointer


<!-- ##### USER_FUNCTION ClutterCallback ##### -->
<para>
Generic callback function.
</para>

@actor: a #ClutterActor
@data: optional data to be passed to the function


<!-- ##### STRUCT ClutterActor ##### -->
<para>
Basic element of the Clutter canvas.  Every object present on the stage must
be an actor.  You can scale, move and rotate an actor; you can group actors
inside #ClutterGroup<!-- -->s or let them follow a #ClutterBehaviour.
</para>

@parent_instance: parent class
@flags: flags set for the actor

<!-- ##### SIGNAL ClutterActor::destroy ##### -->
<para>

</para>

@clutteractor: the object which received the signal.

<!-- ##### SIGNAL ClutterActor::hide ##### -->
<para>

</para>

@clutteractor: the object which received the signal.

<!-- ##### SIGNAL ClutterActor::parent-set ##### -->
<para>

</para>

@clutteractor: the object which received the signal.
@arg1: 

<!-- ##### SIGNAL ClutterActor::show ##### -->
<para>

</para>

@clutteractor: the object which received the signal.

<!-- ##### ARG ClutterActor:clip ##### -->
<para>

</para>

<!-- ##### ARG ClutterActor:has-clip ##### -->
<para>

</para>

<!-- ##### ARG ClutterActor:height ##### -->
<para>

</para>

<!-- ##### ARG ClutterActor:name ##### -->
<para>

</para>

<!-- ##### ARG ClutterActor:opacity ##### -->
<para>

</para>

<!-- ##### ARG ClutterActor:visible ##### -->
<para>

</para>

<!-- ##### ARG ClutterActor:width ##### -->
<para>

</para>

<!-- ##### ARG ClutterActor:x ##### -->
<para>

</para>

<!-- ##### ARG ClutterActor:y ##### -->
<para>

</para>

<!-- ##### STRUCT ClutterActorClass ##### -->
<para>
Base class for #ClutterActor
</para>

@parent_class: parent class
@show: 
@show_all: 
@hide: 
@hide_all: 
@realize: 
@unrealize: 
@paint: 
@request_coords: 
@allocate_coords: 
@set_depth: 
@get_depth: 
@parent_set: 
@destroy: 
@queue_redraw: 
@_clutter_actor_1: 
@_clutter_actor_2: 
@_clutter_actor_3: 
@_clutter_actor_4: 
@_clutter_actor_5: 
@_clutter_actor_6: 

<!-- ##### FUNCTION clutter_actor_show ##### -->
<para>

</para>

@self: 


<!-- ##### FUNCTION clutter_actor_show_all ##### -->
<para>

</para>

@self: 


<!-- ##### FUNCTION clutter_actor_hide ##### -->
<para>

</para>

@self: 


<!-- ##### FUNCTION clutter_actor_hide_all ##### -->
<para>

</para>

@self: 


<!-- ##### FUNCTION clutter_actor_realize ##### -->
<para>

</para>

@self: 


<!-- ##### FUNCTION clutter_actor_unrealize ##### -->
<para>

</para>

@self: 


<!-- ##### FUNCTION clutter_actor_paint ##### -->
<para>

</para>

@self: 


<!-- ##### FUNCTION clutter_actor_queue_redraw ##### -->
<para>

</para>

@self: 


<!-- ##### FUNCTION clutter_actor_destroy ##### -->
<para>

</para>

@self: 


<!-- ##### FUNCTION clutter_actor_request_coords ##### -->
<para>

</para>

@self: 
@box: 


<!-- ##### FUNCTION clutter_actor_allocate_coords ##### -->
<para>

</para>

@self: 
@box: 


<!-- ##### FUNCTION clutter_actor_set_geometry ##### -->
<para>

</para>

@self: 
@geometry: 


<!-- ##### FUNCTION clutter_actor_get_geometry ##### -->
<para>

</para>

@self: 
@geometry: 


<!-- ##### FUNCTION clutter_actor_get_coords ##### -->
<para>

</para>

@self: 
@x1: 
@y1: 
@x2: 
@y2: 


<!-- ##### FUNCTION clutter_actor_set_size ##### -->
<para>

</para>

@self: 
@width: 
@height: 


<!-- ##### FUNCTION clutter_actor_get_size ##### -->
<para>

</para>

@self: 
@width: 
@height: 


<!-- ##### FUNCTION clutter_actor_set_position ##### -->
<para>

</para>

@self: 
@x: 
@y: 


<!-- ##### FUNCTION clutter_actor_get_abs_position ##### -->
<para>

</para>

@self: 
@x: 
@y: 


<!-- ##### FUNCTION clutter_actor_set_width ##### -->
<para>

</para>

@self: 
@width: 


<!-- ##### FUNCTION clutter_actor_get_width ##### -->
<para>

</para>

@self: 
@Returns: 


<!-- ##### FUNCTION clutter_actor_set_height ##### -->
<para>

</para>

@self: 
@height: 


<!-- ##### FUNCTION clutter_actor_get_height ##### -->
<para>

</para>

@self: 
@Returns: 


<!-- ##### FUNCTION clutter_actor_get_x ##### -->
<para>

</para>

@self: 
@Returns: 


<!-- ##### FUNCTION clutter_actor_get_y ##### -->
<para>

</para>

@self: 
@Returns: 


<!-- ##### FUNCTION clutter_actor_move_by ##### -->
<para>

</para>

@self: 
@dx: 
@dy: 


<!-- ##### FUNCTION clutter_actor_rotate_x ##### -->
<para>

</para>

@self: 
@angle: 
@y: 
@z: 


<!-- ##### FUNCTION clutter_actor_rotate_y ##### -->
<para>

</para>

@self: 
@angle: 
@x: 
@z: 


<!-- ##### FUNCTION clutter_actor_rotate_z ##### -->
<para>

</para>

@self: 
@angle: 
@x: 
@y: 


<!-- ##### FUNCTION clutter_actor_set_opacity ##### -->
<para>

</para>

@self: 
@opacity: 


<!-- ##### FUNCTION clutter_actor_get_opacity ##### -->
<para>

</para>

@self: 
@Returns: 


<!-- ##### FUNCTION clutter_actor_set_name ##### -->
<para>

</para>

@self: 
@name: 


<!-- ##### FUNCTION clutter_actor_get_name ##### -->
<para>

</para>

@self: 
@Returns: 


<!-- ##### FUNCTION clutter_actor_get_id ##### -->
<para>

</para>

@self: 
@Returns: 


<!-- ##### FUNCTION clutter_actor_set_clip ##### -->
<para>

</para>

@self: 
@xoff: 
@yoff: 
@width: 
@height: 


<!-- ##### FUNCTION clutter_actor_remove_clip ##### -->
<para>

</para>

@self: 


<!-- ##### FUNCTION clutter_actor_has_clip ##### -->
<para>

</para>

@self: 
@Returns: 


<!-- ##### FUNCTION clutter_actor_set_parent ##### -->
<para>

</para>

@self: 
@parent: 


<!-- ##### FUNCTION clutter_actor_get_parent ##### -->
<para>

</para>

@self: 
@Returns: 


<!-- ##### FUNCTION clutter_actor_reparent ##### -->
<para>

</para>

@self: 
@new_parent: 


<!-- ##### FUNCTION clutter_actor_unparent ##### -->
<para>

</para>

@self: 


<!-- ##### FUNCTION clutter_actor_raise ##### -->
<para>

</para>

@self: 
@below: 


<!-- ##### FUNCTION clutter_actor_lower ##### -->
<para>

</para>

@self: 
@above: 


<!-- ##### FUNCTION clutter_actor_raise_top ##### -->
<para>

</para>

@self: 


<!-- ##### FUNCTION clutter_actor_lower_bottom ##### -->
<para>

</para>

@self: 


<!-- ##### FUNCTION clutter_actor_set_depth ##### -->
<para>

</para>

@self: 
@depth: 


<!-- ##### FUNCTION clutter_actor_get_depth ##### -->
<para>

</para>

@self: 
@Returns: 


<!-- ##### FUNCTION clutter_actor_set_scalex ##### -->
<para>

</para>

@self: 
@scale_x: 
@scale_y: 


<!-- ##### FUNCTION clutter_actor_set_scale ##### -->
<para>

</para>

@self: 
@scale_x: 
@scale_y: 


<!-- ##### FUNCTION clutter_actor_get_scalex ##### -->
<para>

</para>

@self: 
@scale_x: 
@scale_y: 


<!-- ##### FUNCTION clutter_actor_get_scale ##### -->
<para>

</para>

@self: 
@scale_x: 
@scale_y: 


<!-- ##### FUNCTION clutter_actor_get_abs_size ##### -->
<para>

</para>

@self: 
@width: 
@height: