mutter/doc/reference/tmpl/clutter-actor.sgml
Emmanuele Bassi 10fbfb1659 2006-12-12 Emmanuele Bassi <ebassi@openedhand.com>
Rework part of the show/hide machinery.  Allow groups sub-classes
	and composite actors to override show_all/hide_all in order to
	decide which children they wish to show/hide.  This means that
	if an actor overrides the default show/hide virtual methods, it'll
	have to chain up to the parent class show/hide.  While we're at it,
	provide the fully recursive clutter_actor_show_all() and
	clutter_actor_hide_all() methods.

	* clutter/clutter-behaviour-path.c: Add apidoc for the ClutterKnot
	functions; add pathological equality case for clutter_knot_equal().

	* clutter/clutter-event.h:
	* clutter/clutter-feature.h:
	* clutter/clutter-behaviour.c:
	* clutter/clutter-behaviour-scale.c:Fix parameters name so that
	gtk-doc doesn't complain.

	* clutter/clutter-actor.c:
	* clutter/clutter-event.c: Add apidoc

	* clutter/clutter-actor.h:
	* clutter/clutter-actor.c: Add a clutter_actor_show_all() and a
	clutter_actor_hide_all() functions; provide a mechanism for
	groups and composited actors to programmatically select what to
	show/hide when clutter_actor_show_all() and clutter_actor_hide_all()
	are called.  If you are overriding the ClutterActor::show or
	the ClutterActor::hide virtual methods you should chain up with
	the parent class.

	* clutter/clutter-group.c: Override show_all and hide_all and
	recursively show/hide every child inside the group;
	clutter_group_show_all() and clutter_group_hide_all() remain as non
	recursive versions of clutter_actor_show_all() and
	clutter_actor_hide_all() (maybe we should rename them in order
	to avoid name clashes with the bindings).

	* clutter/clutter-stage.c:
	* clutter/clutter-texture.c: Chain up with parent class show
	and hide vfuncs.

	* clutter/clutter-clone-texture.h:
	* clutter/clutter-clone-texture.c: Provide API for changing the
	parent texture of a clone texture actor.

	* examples/behave.c:
	* examples/super-oh.c:
	* examples/test.c: Use clutter_actor_show_all() instead of
	clutter_group_show_all().
2006-12-12 20:20:04 +00:00

664 lines
6.9 KiB
Plaintext

<!-- ##### SECTION Title ##### -->
ClutterActor
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### MACRO CLUTTER_TYPE_GEOMETRY ##### -->
<para>
</para>
<!-- ##### MACRO CLUTTER_TYPE_ACTOR_BOX ##### -->
<para>
</para>
<!-- ##### MACRO CLUTTER_ACTOR_SET_FLAGS ##### -->
<para>
</para>
@e:
@f:
<!-- ##### MACRO CLUTTER_ACTOR_UNSET_FLAGS ##### -->
<para>
</para>
@e:
@f:
<!-- ##### MACRO CLUTTER_ACTOR_IS_MAPPED ##### -->
<para>
</para>
@e:
<!-- ##### MACRO CLUTTER_ACTOR_IS_REALIZED ##### -->
<para>
</para>
@e:
<!-- ##### MACRO CLUTTER_ACTOR_IS_VISIBLE ##### -->
<para>
</para>
@e:
<!-- ##### STRUCT ClutterActorBox ##### -->
<para>
</para>
@x1:
@y1:
@x2:
@y2:
<!-- ##### ENUM ClutterActorFlags ##### -->
<para>
</para>
@CLUTTER_ACTOR_MAPPED:
@CLUTTER_ACTOR_REALIZED:
<!-- ##### STRUCT ClutterGeometry ##### -->
<para>
</para>
@x:
@y:
@width:
@height:
<!-- ##### MACRO CLUTTER_CALLBACK ##### -->
<para>
</para>
@f:
<!-- ##### USER_FUNCTION ClutterCallback ##### -->
<para>
</para>
@actor:
@data:
<!-- ##### STRUCT ClutterActor ##### -->
<para>
</para>
@parent_instance:
@flags:
<!-- ##### 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>
</para>
@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_hide ##### -->
<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_get_width ##### -->
<para>
</para>
@self:
@Returns:
<!-- ##### 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: