isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2025-06-14 01:09:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

2006-12-13 Emmanuele Bassi <ebassi@openedhand.com>

Browse Source 
* clutter-sections.txt: Update.

	* tmpl/*.sgml: Update the templates.
This commit is contained in:
Emmanuele Bassi
2006-12-13 18:11:50 +00:00
parent 77f421a294
commit 2231c939d0
14 changed files with 156 additions and 121 deletions
Download Patch File Download Diff File Expand all files Collapse all files

102
doc/reference/tmpl/clutter-actor.sgml
View File

@ -17,114 +17,102 @@ ClutterActor
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### MACRO CLUTTER_TYPE_GEOMETRY ##### -->
<para>
</para>
<!-- ##### MACRO CLUTTER_TYPE_ACTOR_BOX ##### -->
<para>
</para>
<!-- ##### MACRO CLUTTER_ACTOR_SET_FLAGS ##### -->
<para>
Sets a flag from #ClutterActorFlags to an actor
</para>
@e:
@f:
@e: a #ClutterActor
@f: the flag to set
<!-- ##### MACRO CLUTTER_ACTOR_UNSET_FLAGS ##### -->
<para>
Unsets a flag from #ClutterActorFlags to an actor
</para>
@e:
@f:
@e: a #ClutterActor
@f: the flag to unset
<!-- ##### MACRO CLUTTER_ACTOR_IS_MAPPED ##### -->
<para>
Evaluates to %TRUE if an actor is mapped.
</para>
@e:
@e: a #ClutterActor
<!-- ##### MACRO CLUTTER_ACTOR_IS_REALIZED ##### -->
<para>
Evaluates to %TRUE if an actor has been realized.
</para>
@e:
@e: a #ClutterActor
<!-- ##### MACRO CLUTTER_ACTOR_IS_VISIBLE ##### -->
<para>
Evaluates to %TRUE if an actor is visible.
</para>
@e:
@e: a #ClutterActor
<!-- ##### STRUCT ClutterActorBox ##### -->
<para>
Coordinates (top-left to bottom-right) of a box surrounding an actor.
</para>
@x1:
@y1:
@x2:
@y2:
@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:
@CLUTTER_ACTOR_REALIZED:
@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:
@y:
@width:
@height:
@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:
@f: a function pointer
<!-- ##### USER_FUNCTION ClutterCallback ##### -->
<para>
Generic callback function.
</para>
@actor:
@data:
@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:
@flags:
@parent_instance: parent class
@flags: flags set for the actor
<!-- ##### SIGNAL ClutterActor::destroy ##### -->
<para>
@ -202,10 +190,10 @@ ClutterActor
<!-- ##### STRUCT ClutterActorClass ##### -->
<para>
Base class for #ClutterActor
</para>
@parent_class:
@parent_class: parent class
@show:
@show_all:
@hide:
@ -235,6 +223,14 @@ ClutterActor
@self:
<!-- ##### FUNCTION clutter_actor_show_all ##### -->
<para>
</para>
@self:
<!-- ##### FUNCTION clutter_actor_hide ##### -->
<para>
@ -243,6 +239,14 @@ ClutterActor
@self:
<!-- ##### FUNCTION clutter_actor_hide_all ##### -->
<para>
</para>
@self:
<!-- ##### FUNCTION clutter_actor_realize ##### -->
<para>

20
doc/reference/tmpl/clutter-alpha.sgml
View File

@ -77,19 +77,21 @@ accessed directly.
<!-- ##### MACRO CLUTTER_ALPHA_MAX_ALPHA ##### -->
<para>
Maximum value of the alpha function. You should use this value to
scale the computed alpha value.
</para>
<!-- ##### USER_FUNCTION ClutterAlphaFunc ##### -->
<para>
The alpha function is a function of time. You should provide a function
transforming the current position in the timeline.
</para>
@alpha:
@user_data:
@Returns:
@alpha: a #ClutterAlpha
@user_data: optional user defined data passed to the function
@Returns: a value between 0 and CLUTTER_ALPHA_MAX_ALPHA
<!-- ##### FUNCTION clutter_alpha_set_func ##### -->
@ -123,7 +125,7 @@ accessed directly.
<!-- ##### MACRO CLUTTER_ALPHA_RAMP_INC ##### -->
<para>
Symbolic name for passing clutter_ramp_inc_func().
</para>
@ -140,7 +142,7 @@ accessed directly.
<!-- ##### MACRO CLUTTER_ALPHA_RAMP_DEC ##### -->
<para>
Symbolic name for passing clutter_ramp_dec_func().
</para>
@ -157,7 +159,7 @@ accessed directly.
<!-- ##### MACRO CLUTTER_ALPHA_RAMP ##### -->
<para>
Symbolic name for passing clutter_ramp_func().
</para>
@ -174,7 +176,7 @@ accessed directly.
<!-- ##### MACRO CLUTTER_ALPHA_SINE ##### -->
<para>
Symbolic name for passing clutter_sine_func().
</para>

5
doc/reference/tmpl/clutter-behaviour-opacity.sgml
View File

@ -19,7 +19,8 @@ ClutterBehaviourOpacity
<!-- ##### STRUCT ClutterBehaviourOpacity ##### -->
<para>
The <structname>ClutterBehaviourOpacity</structname> struct has only
private data and should not be accessed directly.
</para>
@ -35,7 +36,7 @@ ClutterBehaviourOpacity
<!-- ##### STRUCT ClutterBehaviourOpacityClass ##### -->
<para>
Class structure for #ClutterBehaviourOpacity.
</para>
@parent_class:

18
doc/reference/tmpl/clutter-behaviour-path.sgml
View File

@ -17,20 +17,13 @@ ClutterBehaviourPath
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### MACRO CLUTTER_TYPE_KNOT ##### -->
<para>
</para>
<!-- ##### STRUCT ClutterKnot ##### -->
<para>
A single node of the path followed by a #ClutterBehaviourPath.
</para>
@x:
@y:
@x: X coordinate of the node
@y: Y coordinate of the node
<!-- ##### FUNCTION clutter_knot_copy ##### -->
<para>
@ -61,7 +54,8 @@ ClutterBehaviourPath
<!-- ##### STRUCT ClutterBehaviourPath ##### -->
<para>
The <structname>ClutterBehaviourPath</structname> structure contains
only private data, and should not be accessed directly.
</para>
@ -80,7 +74,7 @@ ClutterBehaviourPath
<!-- ##### STRUCT ClutterBehaviourPathClass ##### -->
<para>
Class structure for #ClutterBehaviourPath.
</para>
@parent_class:

9
doc/reference/tmpl/clutter-behaviour-scale.sgml
View File

@ -19,7 +19,7 @@ ClutterBehaviourScale
<!-- ##### ENUM ClutterGravity ##### -->
<para>
Defines the reference point of the scaling.
</para>
@CLUTTER_GRAVITY_NONE:
@ -31,11 +31,12 @@ ClutterBehaviourScale
@CLUTTER_GRAVITY_SOUTH_WEST:
@CLUTTER_GRAVITY_WEST:
@CLUTTER_GRAVITY_NORTH_WEST:
@CLUTTER_GRAVITY_CENTER:
@CLUTTER_GRAVITY_CENTER: the actor should scale from the center
<!-- ##### STRUCT ClutterBehaviourScale ##### -->
<para>
The <structname>ClutterBehaviourScale</structname> structure contains only
private data and should not be accessed directly.
</para>
@ -56,7 +57,7 @@ ClutterBehaviourScale
<!-- ##### STRUCT ClutterBehaviourScaleClass ##### -->
<para>
Class structure for #ClutterBehaviourScale.
</para>
@parent_class:

19
doc/reference/tmpl/clutter-behaviour.sgml
View File

@ -30,11 +30,15 @@ ClutterBehaviour
<!-- ##### STRUCT ClutterBehaviourClass ##### -->
<para>
Class structure.
</para>
@parent_class:
@alpha_notify:
@parent_class: parent class
@alpha_notify: Override this virtual function when creating a new behaviour.
The alpha notify virtual function is called each time the alpha value
computed by the #ClutterAlpha object changes; in this virtual function
you should update the properties driven by your behaviour for all the
actors to which the behaviour applies.
@_clutter_behaviour1:
@_clutter_behaviour2:
@_clutter_behaviour3:
@ -62,12 +66,13 @@ ClutterBehaviour
<!-- ##### USER_FUNCTION ClutterBehaviourForeachFunc ##### -->
<para>
The function used to iterate on every #ClutterActor to which a behaviour
applies.
</para>
@behaviour:
@actor:
@data:
@behaviour: a #ClutterBehaviour
@actor: a #ClutterActor
@data: optional user data passed to this function
<!-- ##### FUNCTION clutter_behaviour_actors_foreach ##### -->

18
doc/reference/tmpl/clutter-clone-texture.sgml
View File

@ -48,3 +48,21 @@ ClutterCloneTexture
@Returns:
<!-- ##### FUNCTION clutter_clone_texture_get_parent_texture ##### -->
<para>
</para>
@clone:
@Returns:
<!-- ##### FUNCTION clutter_clone_texture_set_parent_texture ##### -->
<para>
</para>
@clone:
@texture:

7
doc/reference/tmpl/clutter-color.sgml
View File

@ -17,13 +17,6 @@ clutter-color
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### MACRO CLUTTER_TYPE_COLOR ##### -->
<para>
</para>
<!-- ##### STRUCT ClutterColor ##### -->
<para>

25
doc/reference/tmpl/clutter-event.sgml
View File

@ -30,13 +30,6 @@ Windowing events handled by Clutter.
@CLUTTER_2BUTTON_PRESS:
@CLUTTER_BUTTON_RELEASE:
<!-- ##### MACRO CLUTTER_TYPE_EVENT ##### -->
<para>
</para>
<!-- ##### STRUCT ClutterAnyEvent ##### -->
<para>
@ -120,6 +113,15 @@ Windowing events handled by Clutter.
@event:
<!-- ##### FUNCTION clutter_event_type ##### -->
<para>
</para>
@event:
@Returns:
<!-- ##### FUNCTION clutter_key_event_time ##### -->
<para>
@ -138,6 +140,15 @@ Windowing events handled by Clutter.
@Returns:
<!-- ##### FUNCTION clutter_button_event_time ##### -->
<para>
</para>
@buttev:
@Returns:
<!-- ##### FUNCTION clutter_button_event_x ##### -->
<para>

16
doc/reference/tmpl/clutter-main.sgml
View File

@ -19,22 +19,22 @@ clutter-main
<!-- ##### MACRO CLUTTER_INIT_ERROR ##### -->
<para>
GError domain for the #ClutterInitError enum.
</para>
<!-- ##### ENUM ClutterInitError ##### -->
<para>
Error codes for the Clutter initialisation process.
</para>
@CLUTTER_INIT_SUCCESS:
@CLUTTER_INIT_ERROR_UNKOWN:
@CLUTTER_INIT_ERROR_THREADS:
@CLUTTER_INIT_ERROR_DISPLAY:
@CLUTTER_INIT_ERROR_INTERNAL:
@CLUTTER_INIT_ERROR_OPENGL:
@CLUTTER_INIT_SUCCESS: Clutter was successfully initialised
@CLUTTER_INIT_ERROR_UNKOWN: Unknown error while initialising Clutter
@CLUTTER_INIT_ERROR_THREADS: Unable to initialise threading
@CLUTTER_INIT_ERROR_DISPLAY: Unable to open the X display
@CLUTTER_INIT_ERROR_INTERNAL: Internal Clutter error
@CLUTTER_INIT_ERROR_OPENGL: Unable to initialise OpenGL
<!-- ##### FUNCTION clutter_init ##### -->
<para>

8
doc/reference/tmpl/clutter-media.sgml
View File

@ -17,14 +17,6 @@ clutter-media
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### MACRO CLUTTER_MEDIA_GET_INTERFACE ##### -->
<para>
</para>
@obj:
<!-- ##### STRUCT ClutterMedia ##### -->
<para>

4
doc/reference/tmpl/clutter-stage.sgml
View File

@ -19,14 +19,14 @@ ClutterStage
<!-- ##### MACRO CLUTTER_STAGE_WIDTH ##### -->
<para>
Macro evaluating to the width of the #ClutterStage
</para>
<!-- ##### MACRO CLUTTER_STAGE_HEIGHT ##### -->
<para>
Macro evaluating to the height of the #ClutterStage
</para>