From 2231c939d060c199e63cac99045dc88d9b51e770 Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Wed, 13 Dec 2006 18:11:50 +0000 Subject: [PATCH] 2006-12-13 Emmanuele Bassi * clutter-sections.txt: Update. * tmpl/*.sgml: Update the templates. --- doc/reference/ChangeLog | 6 ++ doc/reference/clutter-sections.txt | 20 ++-- doc/reference/tmpl/clutter-actor.sgml | 102 +++++++++--------- doc/reference/tmpl/clutter-alpha.sgml | 20 ++-- .../tmpl/clutter-behaviour-opacity.sgml | 5 +- .../tmpl/clutter-behaviour-path.sgml | 18 ++-- .../tmpl/clutter-behaviour-scale.sgml | 9 +- doc/reference/tmpl/clutter-behaviour.sgml | 19 ++-- doc/reference/tmpl/clutter-clone-texture.sgml | 18 ++++ doc/reference/tmpl/clutter-color.sgml | 7 -- doc/reference/tmpl/clutter-event.sgml | 25 +++-- doc/reference/tmpl/clutter-main.sgml | 16 +-- doc/reference/tmpl/clutter-media.sgml | 8 -- doc/reference/tmpl/clutter-stage.sgml | 4 +- 14 files changed, 156 insertions(+), 121 deletions(-) diff --git a/doc/reference/ChangeLog b/doc/reference/ChangeLog index fc608ee21..8e9e6d30f 100644 --- a/doc/reference/ChangeLog +++ b/doc/reference/ChangeLog @@ -1,3 +1,9 @@ +2006-12-13 Emmanuele Bassi + + * clutter-sections.txt: Update. + + * tmpl/*.sgml: Update the templates. + 2006-12-04 Emmanuele Bassi * clutter-sections.txt: Update with the newly added API. diff --git a/doc/reference/clutter-sections.txt b/doc/reference/clutter-sections.txt index 28aafa2c7..5a9388939 100644 --- a/doc/reference/clutter-sections.txt +++ b/doc/reference/clutter-sections.txt @@ -1,6 +1,5 @@
clutter-media -CLUTTER_MEDIA_GET_INTERFACE ClutterMedia ClutterMediaInterface clutter_media_set_uri @@ -19,6 +18,7 @@ clutter_media_set_filename CLUTTER_MEDIA CLUTTER_IS_MEDIA CLUTTER_TYPE_MEDIA +CLUTTER_MEDIA_GET_INTERFACE clutter_media_get_type
@@ -124,6 +124,8 @@ clutter_alpha_get_type ClutterCloneTexture ClutterCloneTextureClass clutter_clone_texture_new +clutter_clone_texture_get_parent_texture +clutter_clone_texture_set_parent_texture CLUTTER_CLONE_TEXTURE CLUTTER_IS_CLONE_TEXTURE @@ -193,8 +195,6 @@ clutter_rectangle_get_type
clutter-actor -CLUTTER_TYPE_GEOMETRY -CLUTTER_TYPE_ACTOR_BOX CLUTTER_ACTOR_SET_FLAGS CLUTTER_ACTOR_UNSET_FLAGS CLUTTER_ACTOR_IS_MAPPED @@ -209,7 +209,9 @@ ClutterCallback ClutterActor ClutterActorClass clutter_actor_show +clutter_actor_show_all clutter_actor_hide +clutter_actor_hide_all clutter_actor_realize clutter_actor_unrealize clutter_actor_paint @@ -256,6 +258,8 @@ clutter_actor_get_scalex clutter_actor_get_scale clutter_actor_get_abs_size +CLUTTER_TYPE_GEOMETRY +CLUTTER_TYPE_ACTOR_BOX CLUTTER_ACTOR CLUTTER_IS_ACTOR CLUTTER_TYPE_ACTOR @@ -360,7 +364,6 @@ clutter_timeline_get_type
clutter-behaviour-path ClutterBehaviourPath -CLUTTER_TYPE_KNOT ClutterKnot clutter_knot_copy clutter_knot_free @@ -375,6 +378,7 @@ clutter_behaviour_path_insert_knot clutter_behaviour_path_remove_knot clutter_behaviour_path_clear +CLUTTER_TYPE_KNOT CLUTTER_BEHAVIOUR_PATH CLUTTER_IS_BEHAVIOUR_PATH CLUTTER_TYPE_BEHAVIOUR_PATH @@ -461,7 +465,6 @@ CLUTTER_FIXED_DIV
clutter-color -CLUTTER_TYPE_COLOR ClutterColor clutter_color_parse clutter_color_add @@ -473,6 +476,8 @@ clutter_color_to_hls clutter_color_from_hls clutter_color_to_pixel clutter_color_from_pixel + +CLUTTER_TYPE_COLOR clutter_color_get_type
@@ -480,7 +485,6 @@ clutter_color_get_type
clutter-event ClutterEventType -CLUTTER_TYPE_EVENT ClutterAnyEvent ClutterKeyEvent ClutterButtonEvent @@ -490,15 +494,19 @@ ClutterEvent clutter_event_new clutter_event_copy clutter_event_free +clutter_event_type clutter_key_event_type clutter_key_event_time clutter_key_event_state +clutter_button_event_time clutter_button_event_x clutter_button_event_y clutter_key_event_symbol clutter_key_event_code clutter_key_event_unicode clutter_keysym_to_unicode + +CLUTTER_TYPE_EVENT clutter_event_get_type
diff --git a/doc/reference/tmpl/clutter-actor.sgml b/doc/reference/tmpl/clutter-actor.sgml index d7000dde5..7e057e9a0 100644 --- a/doc/reference/tmpl/clutter-actor.sgml +++ b/doc/reference/tmpl/clutter-actor.sgml @@ -17,114 +17,102 @@ ClutterActor - - - - - - - - - - - - - - - +Sets a flag from #ClutterActorFlags to an actor -@e: -@f: +@e: a #ClutterActor +@f: the flag to set - +Unsets a flag from #ClutterActorFlags to an actor -@e: -@f: +@e: a #ClutterActor +@f: the flag to unset - +Evaluates to %TRUE if an actor is mapped. -@e: +@e: a #ClutterActor - +Evaluates to %TRUE if an actor has been realized. -@e: +@e: a #ClutterActor - +Evaluates to %TRUE if an actor is visible. -@e: +@e: a #ClutterActor - +Coordinates (top-left to bottom-right) of a box surrounding an actor. -@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 - +Flags used by an actor. -@CLUTTER_ACTOR_MAPPED: -@CLUTTER_ACTOR_REALIZED: +@CLUTTER_ACTOR_MAPPED: the actor is mapped +@CLUTTER_ACTOR_REALIZED: the actor is realised - +Positional and dimensional coordinates of an actor. -@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 - +Casts a generic callback function into a #ClutterCallback -@f: +@f: a function pointer - +Generic callback function. -@actor: -@data: +@actor: a #ClutterActor +@data: optional data to be passed to the function - +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 #ClutterGroups or let them follow a #ClutterBehaviour. -@parent_instance: -@flags: +@parent_instance: parent class +@flags: flags set for the actor @@ -202,10 +190,10 @@ ClutterActor - +Base class for #ClutterActor -@parent_class: +@parent_class: parent class @show: @show_all: @hide: @@ -235,6 +223,14 @@ ClutterActor @self: + + + + + +@self: + + @@ -243,6 +239,14 @@ ClutterActor @self: + + + + + +@self: + + diff --git a/doc/reference/tmpl/clutter-alpha.sgml b/doc/reference/tmpl/clutter-alpha.sgml index a0f632648..2c8c15e72 100644 --- a/doc/reference/tmpl/clutter-alpha.sgml +++ b/doc/reference/tmpl/clutter-alpha.sgml @@ -77,19 +77,21 @@ accessed directly. - +Maximum value of the alpha function. You should use this value to +scale the computed alpha value. - +The alpha function is a function of time. You should provide a function +transforming the current position in the timeline. -@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 @@ -123,7 +125,7 @@ accessed directly. - +Symbolic name for passing clutter_ramp_inc_func(). @@ -140,7 +142,7 @@ accessed directly. - +Symbolic name for passing clutter_ramp_dec_func(). @@ -157,7 +159,7 @@ accessed directly. - +Symbolic name for passing clutter_ramp_func(). @@ -174,7 +176,7 @@ accessed directly. - +Symbolic name for passing clutter_sine_func(). diff --git a/doc/reference/tmpl/clutter-behaviour-opacity.sgml b/doc/reference/tmpl/clutter-behaviour-opacity.sgml index 45c02d634..ee1299ae4 100644 --- a/doc/reference/tmpl/clutter-behaviour-opacity.sgml +++ b/doc/reference/tmpl/clutter-behaviour-opacity.sgml @@ -19,7 +19,8 @@ ClutterBehaviourOpacity - +The ClutterBehaviourOpacity struct has only +private data and should not be accessed directly. @@ -35,7 +36,7 @@ ClutterBehaviourOpacity - +Class structure for #ClutterBehaviourOpacity. @parent_class: diff --git a/doc/reference/tmpl/clutter-behaviour-path.sgml b/doc/reference/tmpl/clutter-behaviour-path.sgml index 4208cb0d7..a691df95e 100644 --- a/doc/reference/tmpl/clutter-behaviour-path.sgml +++ b/doc/reference/tmpl/clutter-behaviour-path.sgml @@ -17,20 +17,13 @@ ClutterBehaviourPath - - - - - - - - +A single node of the path followed by a #ClutterBehaviourPath. -@x: -@y: +@x: X coordinate of the node +@y: Y coordinate of the node @@ -61,7 +54,8 @@ ClutterBehaviourPath - +The ClutterBehaviourPath structure contains +only private data, and should not be accessed directly. @@ -80,7 +74,7 @@ ClutterBehaviourPath - +Class structure for #ClutterBehaviourPath. @parent_class: diff --git a/doc/reference/tmpl/clutter-behaviour-scale.sgml b/doc/reference/tmpl/clutter-behaviour-scale.sgml index 8b12be847..7695eeffe 100644 --- a/doc/reference/tmpl/clutter-behaviour-scale.sgml +++ b/doc/reference/tmpl/clutter-behaviour-scale.sgml @@ -19,7 +19,7 @@ ClutterBehaviourScale - +Defines the reference point of the scaling. @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 - +The ClutterBehaviourScale structure contains only +private data and should not be accessed directly. @@ -56,7 +57,7 @@ ClutterBehaviourScale - +Class structure for #ClutterBehaviourScale. @parent_class: diff --git a/doc/reference/tmpl/clutter-behaviour.sgml b/doc/reference/tmpl/clutter-behaviour.sgml index 24ed86e86..a03532d94 100644 --- a/doc/reference/tmpl/clutter-behaviour.sgml +++ b/doc/reference/tmpl/clutter-behaviour.sgml @@ -30,11 +30,15 @@ ClutterBehaviour - +Class structure. -@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 - +The function used to iterate on every #ClutterActor to which a behaviour +applies. -@behaviour: -@actor: -@data: +@behaviour: a #ClutterBehaviour +@actor: a #ClutterActor +@data: optional user data passed to this function diff --git a/doc/reference/tmpl/clutter-clone-texture.sgml b/doc/reference/tmpl/clutter-clone-texture.sgml index d079502ce..e50d3ba91 100644 --- a/doc/reference/tmpl/clutter-clone-texture.sgml +++ b/doc/reference/tmpl/clutter-clone-texture.sgml @@ -48,3 +48,21 @@ ClutterCloneTexture @Returns: + + + + + +@clone: +@Returns: + + + + + + + +@clone: +@texture: + + diff --git a/doc/reference/tmpl/clutter-color.sgml b/doc/reference/tmpl/clutter-color.sgml index 312ddc39f..16e48f8d5 100644 --- a/doc/reference/tmpl/clutter-color.sgml +++ b/doc/reference/tmpl/clutter-color.sgml @@ -17,13 +17,6 @@ clutter-color - - - - - - - diff --git a/doc/reference/tmpl/clutter-event.sgml b/doc/reference/tmpl/clutter-event.sgml index 66fc377c8..8892c104e 100644 --- a/doc/reference/tmpl/clutter-event.sgml +++ b/doc/reference/tmpl/clutter-event.sgml @@ -30,13 +30,6 @@ Windowing events handled by Clutter. @CLUTTER_2BUTTON_PRESS: @CLUTTER_BUTTON_RELEASE: - - - - - - - @@ -120,6 +113,15 @@ Windowing events handled by Clutter. @event: + + + + + +@event: +@Returns: + + @@ -138,6 +140,15 @@ Windowing events handled by Clutter. @Returns: + + + + + +@buttev: +@Returns: + + diff --git a/doc/reference/tmpl/clutter-main.sgml b/doc/reference/tmpl/clutter-main.sgml index 4e712f581..8788ffd5f 100644 --- a/doc/reference/tmpl/clutter-main.sgml +++ b/doc/reference/tmpl/clutter-main.sgml @@ -19,22 +19,22 @@ clutter-main - +GError domain for the #ClutterInitError enum. - +Error codes for the Clutter initialisation process. -@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 diff --git a/doc/reference/tmpl/clutter-media.sgml b/doc/reference/tmpl/clutter-media.sgml index 8097a52a8..5330021ec 100644 --- a/doc/reference/tmpl/clutter-media.sgml +++ b/doc/reference/tmpl/clutter-media.sgml @@ -17,14 +17,6 @@ clutter-media - - - - - -@obj: - - diff --git a/doc/reference/tmpl/clutter-stage.sgml b/doc/reference/tmpl/clutter-stage.sgml index 2c4f11f25..979a5e68e 100644 --- a/doc/reference/tmpl/clutter-stage.sgml +++ b/doc/reference/tmpl/clutter-stage.sgml @@ -19,14 +19,14 @@ ClutterStage - +Macro evaluating to the width of the #ClutterStage - +Macro evaluating to the height of the #ClutterStage