sungmg/mutter-performance-source
1
0
Fork 0
Code Activity

docs: Update documentation to reflect automatic map/unmap/etc.

Browse source 
Update the ClutterActor documentation to reflect the new automatic
map/unmap/realize/unrealize implementations.
This commit is contained in:
Chris Lord 2010-11-24 16:34:21 +00:00
parent 186d5698ce
commit f687ec6a22
2 changed files with 5 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
clutter/clutter-actor.h
View file

@ -173,9 +173,11 @@ struct _ClutterActor
* @unrealize: virtual function, used to deallocate resources allocated * @unrealize: virtual function, used to deallocate resources allocated
* in ::realize; it should chain up to the parent's implementation * in ::realize; it should chain up to the parent's implementation
* @map: virtual function for containers and composite actors, to * @map: virtual function for containers and composite actors, to
* map their children; it must chain up to the parent's implementation * map their children; it must chain up to the parent's implementation.
* Overriding this function is optional.
* @unmap: virtual function for containers and composite actors, to * @unmap: virtual function for containers and composite actors, to
* unmap their children; it must chain up to the parent's implementation * unmap their children; it must chain up to the parent's implementation.
* Overriding this function is optional.
* @paint: virtual function, used to paint the actor * @paint: virtual function, used to paint the actor
* @get_preferred_width: virtual function, used when querying the minimum * @get_preferred_width: virtual function, used when querying the minimum
* and natural widths of an actor for a given height; it is used by * and natural widths of an actor for a given height; it is used by

10
doc/reference/clutter/subclassing-ClutterActor.xml
View file

@ -80,15 +80,7 @@ foo_actor_init (FooActor *actor)
<listitem><para>used by containers and composite actors to <listitem><para>used by containers and composite actors to
determine whether their children should allocate (and deallocate) determine whether their children should allocate (and deallocate)
specific resources associated with being added to the #ClutterStage, specific resources associated with being added to the #ClutterStage,
and whether their children should be painted or not. A and whether their children should be painted or not.</para></listitem>
#ClutterContainer implementation should not care about overriding
the <classname>ClutterActor</classname>::realize(),
<classname>ClutterActor</classname>::unrealize(),
<classname>ClutterActor</classname>::map() and
<classname>ClutterActor</classname>::unmap() virtual functions, but
composite actors with private children MUST implement at least
<classname>ClutterActor</classname>::map() and
<classname>ClutterActor</classname>::unmap().</para></listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>