From dbe2e3d3d1f6b8f198b35d738d46ab4edd93d03a Mon Sep 17 00:00:00 2001 From: David PIROTTE Date: Sun, 28 Sep 2014 18:01:54 -0300 Subject: [PATCH 7/7] update previously existing generated documentation Note that this patch does _not_ bring the documentation up-to-date with the clutter-1.12.2 source documentation, that still needs to be done. This patch merely updates the existing *.texi files that were present in the 1.10 binding, according to their related source documentation changes. These changes are mostly: [1] double space after a dot; [2] #\" changed to their opening/closing friends, U+201C left double quotation mark and U+201D right double quotation mark; [3] paragraphs being re-indented, for some reason, even though in most cases, the original text still is the same. doc/clutter-glx/section-clutter-x11-texture-pixmap.xml.texi: doc/clutter-glx/undocumented.texi: doc/clutter/section-clutter-actor-meta.xml.texi: doc/clutter/section-clutter-actor.xml.texi: doc/clutter/section-clutter-alpha.xml.texi: doc/clutter/section-clutter-animatable.xml.texi: doc/clutter/section-clutter-animation.xml.texi: doc/clutter/section-clutter-animator.xml.texi: doc/clutter/section-clutter-backend.xml.texi: doc/clutter/section-clutter-bin-layout.xml.texi: doc/clutter/section-clutter-bind-constraint.xml.texi: doc/clutter/section-clutter-binding-pool.xml.texi: doc/clutter/section-clutter-box-layout.xml.texi: doc/clutter/section-clutter-cairo-texture.xml.texi: doc/clutter/section-clutter-canvas.xml.texi: doc/clutter/section-clutter-click-action.xml.texi: doc/clutter/section-clutter-constraint.xml.texi: doc/clutter/section-clutter-container.xml.texi: doc/clutter/section-clutter-deform-effect.xml.texi: doc/clutter/section-clutter-desaturate-effect.xml.texi: doc/clutter/section-clutter-device-manager.xml.texi: doc/clutter/section-clutter-drag-action.xml.texi: doc/clutter/section-clutter-drop-action.xml.texi: doc/clutter/section-clutter-effect.xml.texi: doc/clutter/section-clutter-flow-layout.xml.texi: doc/clutter/section-clutter-gesture-action.xml.texi: doc/clutter/section-clutter-image.xml.texi: doc/clutter/section-clutter-interval.xml.texi: doc/clutter/section-clutter-layout-manager.xml.texi: doc/clutter/section-clutter-list-model.xml.texi: doc/clutter/section-clutter-main.xml.texi: doc/clutter/section-clutter-media.xml.texi: doc/clutter/section-clutter-model-iter.xml.texi: doc/clutter/section-clutter-model.xml.texi: doc/clutter/section-clutter-offscreen-effect.xml.texi: doc/clutter/section-clutter-paint-node.xml.texi: doc/clutter/section-clutter-path-constraint.xml.texi: doc/clutter/section-clutter-path.xml.texi: doc/clutter/section-clutter-script.xml.texi: doc/clutter/section-clutter-scriptable.xml.texi: doc/clutter/section-clutter-settings.xml.texi: doc/clutter/section-clutter-shader-effect.xml.texi: doc/clutter/section-clutter-shader.xml.texi: doc/clutter/section-clutter-stage-manager.xml.texi: doc/clutter/section-clutter-stage.xml.texi: doc/clutter/section-clutter-state.xml.texi: doc/clutter/section-clutter-table-layout.xml.texi: doc/clutter/section-clutter-text-buffer.xml.texi: doc/clutter/section-clutter-texture.xml.texi: doc/clutter/section-clutter-timeline.xml.texi: doc/clutter/section-clutter-units.xml.texi: doc/clutter/section-clutter-version.xml.texi: doc/clutter/undocumented.texi: --- .../section-clutter-x11-texture-pixmap.xml.texi | 2 +- doc/clutter-glx/undocumented.texi | 3 + doc/clutter/section-clutter-actor-meta.xml.texi | 4 +- doc/clutter/section-clutter-actor.xml.texi | 174 ++++++---- doc/clutter/section-clutter-alpha.xml.texi | 27 +- doc/clutter/section-clutter-animatable.xml.texi | 16 +- doc/clutter/section-clutter-animation.xml.texi | 18 +- doc/clutter/section-clutter-animator.xml.texi | 25 +- doc/clutter/section-clutter-backend.xml.texi | 2 +- doc/clutter/section-clutter-bin-layout.xml.texi | 35 +- .../section-clutter-bind-constraint.xml.texi | 18 +- doc/clutter/section-clutter-binding-pool.xml.texi | 24 +- doc/clutter/section-clutter-box-layout.xml.texi | 31 +- doc/clutter/section-clutter-cairo-texture.xml.texi | 10 +- doc/clutter/section-clutter-canvas.xml.texi | 6 +- doc/clutter/section-clutter-click-action.xml.texi | 51 +-- doc/clutter/section-clutter-constraint.xml.texi | 32 +- doc/clutter/section-clutter-container.xml.texi | 2 +- doc/clutter/section-clutter-deform-effect.xml.texi | 10 +- .../section-clutter-desaturate-effect.xml.texi | 4 +- .../section-clutter-device-manager.xml.texi | 2 +- doc/clutter/section-clutter-drag-action.xml.texi | 17 +- doc/clutter/section-clutter-drop-action.xml.texi | 12 +- doc/clutter/section-clutter-effect.xml.texi | 41 +-- doc/clutter/section-clutter-flow-layout.xml.texi | 21 +- .../section-clutter-gesture-action.xml.texi | 42 ++- doc/clutter/section-clutter-image.xml.texi | 2 +- doc/clutter/section-clutter-interval.xml.texi | 4 +- .../section-clutter-layout-manager.xml.texi | 89 +++--- doc/clutter/section-clutter-list-model.xml.texi | 2 +- doc/clutter/section-clutter-main.xml.texi | 4 +- doc/clutter/section-clutter-media.xml.texi | 2 + doc/clutter/section-clutter-model-iter.xml.texi | 4 +- doc/clutter/section-clutter-model.xml.texi | 14 +- .../section-clutter-offscreen-effect.xml.texi | 14 +- doc/clutter/section-clutter-paint-node.xml.texi | 2 +- .../section-clutter-path-constraint.xml.texi | 4 +- doc/clutter/section-clutter-path.xml.texi | 16 +- doc/clutter/section-clutter-script.xml.texi | 16 +- doc/clutter/section-clutter-scriptable.xml.texi | 2 +- doc/clutter/section-clutter-settings.xml.texi | 2 +- doc/clutter/section-clutter-shader-effect.xml.texi | 18 +- doc/clutter/section-clutter-shader.xml.texi | 2 +- doc/clutter/section-clutter-stage-manager.xml.texi | 4 +- doc/clutter/section-clutter-stage.xml.texi | 16 +- doc/clutter/section-clutter-state.xml.texi | 14 +- doc/clutter/section-clutter-table-layout.xml.texi | 6 +- doc/clutter/section-clutter-text-buffer.xml.texi | 4 +- doc/clutter/section-clutter-texture.xml.texi | 5 +- doc/clutter/section-clutter-timeline.xml.texi | 45 +-- doc/clutter/section-clutter-units.xml.texi | 8 +- doc/clutter/section-clutter-version.xml.texi | 2 +- doc/clutter/undocumented.texi | 355 ++++++++++++++++----- 53 files changed, 766 insertions(+), 519 deletions(-) diff --git a/doc/clutter-glx/section-clutter-x11-texture-pixmap.xml.texi b/doc/clutter-glx/section-clutter-x11-texture-pixmap.xml.texi index ad5f1d5..c16098e 100644 --- a/doc/clutter-glx/section-clutter-x11-texture-pixmap.xml.texi +++ b/doc/clutter-glx/section-clutter-x11-texture-pixmap.xml.texi @@ -7,7 +7,7 @@ A texture which displays the content of an X Pixmap. @section Overview @code{} is a class for displaying the -content of an X Pixmap as a ClutterActor. Used together with the X +content of an X Pixmap as a ClutterActor. Used together with the X Composite extension, it allows to display the content of X Windows inside Clutter. diff --git a/doc/clutter-glx/undocumented.texi b/doc/clutter-glx/undocumented.texi index 36a59b6..bdf7b0e 100644 --- a/doc/clutter-glx/undocumented.texi +++ b/doc/clutter-glx/undocumented.texi @@ -6,6 +6,9 @@ The following symbols, if any, have not been properly documented. @section (gnome gw clutter-glx) address@hidden clutter-x11-event-sequence-get-touch-detail address@hidden defvar + @defvar clutter-x11-texture-pixmap-new-with-pixmap @end defvar diff --git a/doc/clutter/section-clutter-actor-meta.xml.texi b/doc/clutter/section-clutter-actor-meta.xml.texi index 82ccaf7..b0ab264 100644 --- a/doc/clutter/section-clutter-actor-meta.xml.texi +++ b/doc/clutter/section-clutter-actor-meta.xml.texi @@ -13,8 +13,8 @@ A @code{} can only be owned by a single @code{} at any time. Every sub-class of @code{} should check if the address@hidden<"enabled">} property is set to @address@hidden before applying -any kind of modification. address@hidden<“enabled”>} property is set to @address@hidden before +applying any kind of modification. @code{} is available since Clutter 1.4 diff --git a/doc/clutter/section-clutter-actor.xml.texi b/doc/clutter/section-clutter-actor.xml.texi index ff25367..1883a42 100644 --- a/doc/clutter/section-clutter-actor.xml.texi +++ b/doc/clutter/section-clutter-actor.xml.texi @@ -12,7 +12,7 @@ a node in the graph. @section Actor transformations Each actor can be transformed using methods like address@hidden or @code{clutter-actor-set-rotation}. The address@hidden or @code{clutter-actor-set-rotation}. The order in which the transformations are applied is decided by Clutter and it is the following: @@ -26,29 +26,30 @@ it is the following: @item @end enumerate -translation by the origin of the @code{<"allocation">}; +translation by the origin of the @code{<“allocation”>}; -translation by the actor's @code{<"depth">}; +translation by the actor's @code{<“depth”>}; -scaling by the @code{<"scale-x">} and @code{<"scale-y">} factors; +scaling by the @code{<“scale-x”>} and @code{<“scale-y”>} +factors; -rotation around the @code{<"rotation-z-angle">} and address@hidden<"rotation-z-center">}; +rotation around the @code{<“rotation-angle-x”>} and address@hidden<“rotation-center-x”>}; -rotation around the @code{<"rotation-y-angle">} and address@hidden<"rotation-y-center">}; +rotation around the @code{<“rotation-angle-y”>} and address@hidden<“rotation-center-y”>}; -rotation around the @code{<"rotation-x-angle">} and address@hidden<"rotation-x-center">}; +rotation around the @code{<“rotation-angle-z”>} and address@hidden<“rotation-center-z”>}; -negative translation by the @code{<"anchor-x">} and @code{<"anchor-y">} -point. +negative translation by the @code{<“anchor-x”>} and address@hidden<“anchor-y”>} point. @section Modifying an actor's geometry -Each actor has a bounding box, called @code{<"allocation">} which is +Each actor has a bounding box, called @code{<“allocation”>} which is either set by its parent or explicitly through the @code{clutter-actor-set-position} and @code{clutter-actor-set-size} -methods. Each actor also has an implicit preferred size. +methods. Each actor also has an implicit preferred size. An actor’s preferred size can be defined by any subclass by overriding the @code{clutter-actor-class.get-preferred-width} and the @@ -93,22 +94,23 @@ using @code{clutter-actor-destroy}. @end example Children can be inserted at a given index, or above and below another -child actor. The order of insertion determines the order of the children -when iterating over them. Iterating over children is performed by using address@hidden, +child actor. The order of insertion determines the order of the +children when iterating over them. Iterating over children is performed +by using @code{clutter-actor-get-first-child}, @code{clutter-actor-get-previous-sibling}, @code{clutter-actor-get-next-sibling}, and address@hidden It is also possible to retrieve a address@hidden It is also possible to retrieve a list of children by using @code{clutter-actor-get-children}, as well as retrieving a specific child at a given index by using @code{clutter-actor-get-child-at-index}. If you need to track additions of children to a @code{}, -use the @code{<"actor-added">} signal; similarly, to track removals of -children from a ClutterActor, use the @code{<"actor-removed">} signal. +use the @code{<“actor-added”>} signal; similarly, to track removals +of children from a ClutterActor, use the @code{<“actor-removed”>} +signal. @example address@hidden (http://www.w3.org/2001/XInclude:include (@ (parse "text") (href "../../../../tests/interactive/test-actor.c")) (c (% (all "(http://www.w3.org/2001/XInclude:fallback \"FIXME: MISSING XINCLUDE CONTENT\")")))) address@hidden (http://www.w3.org/2001/XInclude:include (@ (parse "text") (href "../../../../examples/basic-actor.c")) (c (% (all "(http://www.w3.org/2001/XInclude:fallback \"FIXME: MISSING XINCLUDE CONTENT\")")))) @end example @c (title "Actors") @@ -122,7 +124,7 @@ There are three ways to paint an actor: @end itemize set a delegate @code{} as the value for the address@hidden<"content">} property of the actor; address@hidden<“content”>} property of the actor; subclass @code{} and override the @code{clutter-actor-class.paint-node} virtual function; @@ -132,10 +134,10 @@ subclass @code{} and override the @c (title "Setting the Content property") A @code{} is a delegate object that takes over the -painting operation of one, or more actors. The @code{} -painting will be performed on top of the @code{<"background-color">} of -the actor, and before calling the @code{clutter-actor-class.paint-node} -virtual function. +painting operation of one, or more actors. The @code{} +painting will be performed on top of the @code{<“background-color”>} +of the actor, and before calling the address@hidden virtual function. @example @@ -152,13 +154,14 @@ clutter_actor_set_content (actor, image_content); @c (title "Overriding the paint_node virtual function") The @code{clutter-actor-class.paint-node} virtual function is invoked -whenever an actor needs to be painted. The implementation of the virtual -function must only paint the contents of the actor itself, and not the -contents of its children, if the actor has any. +whenever an actor needs to be painted. The implementation of the +virtual function must only paint the contents of the actor itself, and +not the contents of its children, if the actor has any. The @code{} passed to the virtual function is the local root of the render tree; any node added to it will be rendered at -the correct position, as defined by the actor's @code{<"allocation">}. +the correct position, as defined by the actor's address@hidden<“allocation”>}. @example @@ -189,33 +192,33 @@ my_actor_paint_node (ClutterActor *actor, @c (title "Overriding the paint virtual function") The @code{clutter-actor-class.paint} virtual function is invoked when -the @code{<"paint">} signal is emitted, and after the other signal -handlers have been invoked. Overriding the paint virtual function gives +the @code{<“paint”>} signal is emitted, and after the other signal +handlers have been invoked. Overriding the paint virtual function gives total control to the paint sequence of the actor itself, including the children of the actor, if any. It is strongly discouraged to override the @code{clutter-actor-class.paint} virtual function, as well as connecting -to the @code{<"paint">} signal. These hooks into the paint sequence are -considered legacy, and will be removed when the Clutter API changes. +to the @code{<“paint”>} signal. These hooks into the paint sequence +are considered legacy, and will be removed when the Clutter API changes. @section Handling events on an actor A @code{} can receive and handle input device events, for instance pointer events and key events, as long as its address@hidden<"reactive">} property is set to @address@hidden address@hidden<“reactive”>} property is set to @address@hidden Once an actor has been determined to be the source of an event, Clutter will traverse the scene graph from the top-level actor towards the event -source, emitting the @code{<"captured-event">} signal on each ancestor -until it reaches the source; this phase is also called @emph{the capture -phase}. If the event propagation was not stopped, the graph is walked -backwards, from the source actor to the top-level, and the address@hidden<"event">} signal, along with other event signals if needed, is -emitted; this phase is also called @emph{the bubble phase}. At any point -of the signal emission, signal handlers can stop the propagation through -the scene graph by returning @samp{CLUTTER_EVENT_STOP}; otherwise, they -can continue the propagation by returning address@hidden +source, emitting the @code{<“captured-event”>} signal on each +ancestor until it reaches the source; this phase is also called address@hidden capture phase}. If the event propagation was not stopped, the +graph is walked backwards, from the source actor to the top-level, and +the @code{<“event”>} signal, along with other event signals if +needed, is emitted; this phase is also called @emph{the bubble phase}. +At any point of the signal emission, signal handlers can stop the +propagation through the scene graph by returning address@hidden; otherwise, they can continue the propagation +by returning @samp{CLUTTER_EVENT_PROPAGATE}. @section Animation Animation is a core concept of modern user interfaces; Clutter provides @@ -227,13 +230,16 @@ from your application code. The implicit animation model of Clutter assumes that all the changes in an actor state should be gradual and asynchronous; Clutter will automatically transition an actor's property change between the current -state and the desired one without manual intervention. +state and the desired one without manual intervention, if the property +is defined to be animatable in its documentation. By default, in the 1.0 API series, the transition happens with a duration of zero milliseconds, and the implicit animation is an opt in -feature to retain backwards compatibility. In order to enable implicit -animations, it is necessary to change the easing state of an actor by -using @code{clutter-actor-save-easing-state}: +feature to retain backwards compatibility. + +Implicit animations depend on the current easing state; in order to use +the default easing state for an actor you should call the address@hidden function: @example @@ -273,6 +279,9 @@ default easing mode of @samp{CLUTTER_EASE_OUT_CUBIC}, unless you call @code{clutter-actor-set-easing-duration} after changing the easing state of the actor. +Changing the easing state will affect all the following property +transitions, but will not affect existing transitions. + It is important to note that if you modify the state on an animatable property while a transition is in flight, the transition's final value will be updated, as well as its duration and progress mode by using the @@ -281,19 +290,22 @@ current easing state; for instance, in the following example: @example clutter_actor_save_easing_state (actor); +clutter_actor_set_easing_duration (actor, 1000); clutter_actor_set_x (actor, 200); clutter_actor_restore_easing_state (actor); clutter_actor_save_easing_state (actor); +clutter_actor_set_easing_duration (actor, 500); clutter_actor_set_x (actor, 100); clutter_actor_restore_easing_state (actor); @end example the first call to @code{clutter-actor-set-x} will begin a transition of -the @code{<"x">} property to the value of 200; the second call to +the @code{<“x”>} property from the current value to the value of 200 +over a duration of one second; the second call to @code{clutter-actor-set-x} will change the transition's final value to -100. +100 and the duration to 500 milliseconds. It is possible to retrieve the @code{} used by the animatable properties by using @code{clutter-actor-get-transition} and @@ -302,7 +314,7 @@ using the property name as the transition name. @c (title "Explicit animations") The explicit animation model supported by Clutter requires that you create a @code{} object, and set the initial and -final values. The transition will not start unless you add it to the +final values. The transition will not start unless you add it to the @code{}. @example @@ -313,17 +325,23 @@ transition = clutter_property_transition_new ("opacity"); clutter_timeline_set_duration (CLUTTER_TIMELINE (transition), 3000); clutter_timeline_set_repeat_count (CLUTTER_TIMELINE (transition), 2); clutter_timeline_set_auto_reverse (CLUTTER_TIMELINE (transition), TRUE); -clutter_transition_set_interval (transition, clutter_interval_new (G_TYPE_UINT, 255, 0)); +clutter_transition_set_from (transition, G_TYPE_UINT, 255); +clutter_transition_set_to (transition, G_TYPE_UINT, 0); clutter_actor_add_transition (actor, "animate-opacity", transition); @end example -The example above will animate the @code{<"opacity">} property of an +The example above will animate the @code{<“opacity”>} property of an actor between fully opaque and fully transparent, and back, over a span -of 3 seconds. The animation does not begin until it is added to the +of 3 seconds. The animation does not begin until it is added to the actor. +The explicit animation API applies to all @code{} properties, +as well as the custom properties defined through the address@hidden} interface, regardless of whether they are +defined as implicitly animatable or not. + The explicit animation API should also be used when using custom animatable properties for @code{}, @code{}, and @code{} instances @@ -342,8 +360,8 @@ ClutterInterval *interval; transition = clutter_property_transition_new ("opacity"); /* we want to animate the opacity between 0 and 255 */ -internal = clutter_interval_new (G_TYPE_UINT, 0, 255); -clutter_transition_set_interval (transition, interval); +clutter_transition_set_from (transition, G_TYPE_UINT, 0); +clutter_transition_set_to (transition, G_TYPE_UINT, 255); /* over a one second duration, running an infinite amount of times */ clutter_timeline_set_duration (CLUTTER_TIMELINE (transition), 1000); @@ -365,21 +383,21 @@ clutter_actor_add_transition (actor, "opacityAnimation", transition); @section Implementing an actor Careful consideration should be given when deciding to implement a address@hidden} sub-class. It is generally recommended to address@hidden} sub-class. It is generally recommended to implement a sub-class of @code{} only for actors that should be used as leaf nodes of a scene graph. If your actor should be painted in a custom way, you should override the address@hidden<"paint">} signal class handler. You can either opt to chain up to -the parent class implementation or decide to fully override the default -paint implementation; Clutter will set up the transformations and clip -regions prior to emitting the @code{<"paint">} signal. address@hidden<“paint”>} signal class handler. You can either opt to chain +up to the parent class implementation or decide to fully override the +default paint implementation; Clutter will set up the transformations +and clip regions prior to emitting the @code{<“paint”>} signal. By overriding the @code{clutter-actor-class.get-preferred-width} and @code{clutter-actor-class.get-preferred-height} virtual functions it is possible to change or provide the preferred size of an actor; similarly, by overriding the @code{clutter-actor-class.allocate} virtual function -it is possible to control the layout of the children of an actor. Make +it is possible to control the layout of the children of an actor. Make sure to always chain up to the parent implementation of the @code{clutter-actor-class.allocate} virtual function. @@ -408,6 +426,22 @@ The @emph{center} array is optional, and if present it must contain the center of rotation as described by two coordinates: Y and Z for "x-axis"; X and Z for "y-axis"; and X and Y for "z-axis". address@hidden} also defines a scriptable "margin" property which +follows the CSS "margin" shorthand. + address@hidden + +// 4 values +"margin" : [ , , ] +// 3 values +"margin" : [ , , ] +// 2 values +"margin" : [ , ] +// 1 value +"margin" : [ ] + address@hidden example + @code{} will also parse every positional and dimensional property defined as a string through @code{clutter-units-from-string}; you should read the documentation for the @code{} parser @@ -421,7 +455,7 @@ for animation purposes. In order to access a specific @code{} or a @code{} property it is necessary to set the address@hidden<"name">} property on the given action or constraint. address@hidden<“name”>} property on the given action or constraint. The property can be accessed using the following syntax: @@ -437,13 +471,13 @@ The @emph{section} fragment can be one between "actions", "constraints" and "effects". The @emph{meta-name} fragment is the name of the action or constraint, -as specified by the @code{<"name">} property. +as specified by the @code{<“name”>} property. The @emph{property-name} fragment is the name of the action or constraint property to be animated. The example below animates a @code{} applied to -an actor using @code{clutter-actor-animate}. The @emph{rect} has a +an actor using @code{clutter-actor-animate}. The @emph{rect} has a binding constraint for the @emph{origin} actor, and in its initial state is overlapping the actor to which is bound to. @@ -466,7 +500,8 @@ g_signal_connect (origin, "button-press-event", @end example On button press, the rectangle "slides" from behind the actor to which -is bound to, using the @code{<"offset">} property to achieve the effect: +is bound to, using the @code{<“offset”>} property to achieve the +effect: @example @@ -476,7 +511,6 @@ on_button_press (ClutterActor *origin, ClutterActor *rect) @{ ClutterTransition *transition; - ClutterInterval *interval; /* the offset that we want to apply; this will make the actor * slide in from behind the origin and rest at the right of @@ -501,8 +535,8 @@ on_button_press (ClutterActor *origin, clutter_timeline_set_duration (CLUTTER_TIMELINE (transition), 500); /* create the interval with the initial and final values */ - interval = clutter_interval_new (G_TYPE_FLOAT, 0, new_offset); - clutter_transition_set_interval (transition, interval); + clutter_transition_set_from (transition, G_TYPE_FLOAT, 0.f); + clutter_transition_set_to (transition, G_TYPE_FLOAT, new_offset); /* add the transition to the actor; this causes the animation * to start. the name "offsetAnimation" can be used to retrieve diff --git a/doc/clutter/section-clutter-alpha.xml.texi b/doc/clutter/section-clutter-alpha.xml.texi index 0bf3c7d..4f2eb7e 100644 --- a/doc/clutter/section-clutter-alpha.xml.texi +++ b/doc/clutter/section-clutter-alpha.xml.texi @@ -9,13 +9,6 @@ A class for calculating a value as a function of time @code{} is a class for calculating an floating point value dependent only on the position of a @code{}. address@hidden (warning "For newly written code, it is recommended to use the\n" -(code "<\"progress-mode\">") " property of " (code "") -", or the\n" (code "clutter-timeline-set-progress-func") " function -instead of " (code "") ".\nThe " (code "") -" class will be deprecated in the future, and will not\nbe available any -more in the next major version of Clutter.") - A @code{} binds a @code{} to a progress function which translates the time T into an adimensional factor alpha. The factor can then be used to drive a @code{}, which @@ -44,24 +37,21 @@ function by using the appropriate functions of the instance, and it is internally used by the @code{} API. -(The missing figure, easing-modes - address@hidden (title "Easing modes provided by Clutter") @section ClutterAlpha custom properties for @code{} @code{} defines a custom "function" property for @code{} which allows to reference a custom alpha -function available in the source code. Setting the "function" property +function available in the source code. Setting the "function" property is equivalent to calling @code{clutter-alpha-set-func} with the -specified function name. No user data or @code{} is +specified function name. No user data or @code{} is available to be passed. @c (example (@ (id "ClutterAlpha-script-example"))) @c (title "Defining a ClutterAlpha in ClutterScript") The following JSON fragment defines a @code{} using a @code{} with id "sine-timeline" and an alpha function -called @code{my-sine-alpha}. The defined @code{} instance -can be reused in multiple @code{} definitions or for address@hidden} definitions. +called @code{my-sine-alpha}. The defined @code{} +instance can be reused in multiple @code{} +definitions or for @code{} definitions. @example @@ -77,10 +67,15 @@ can be reused in multiple @code{} definitions or for @end example -For the way to define the @code{<"mode">} property inside a +For the way to define the @code{<“mode”>} property inside a ClutterScript fragment, see the corresponding section in @code{}. address@hidden} is available since Clutter 0.2. + address@hidden} is deprecated since Clutter 1.12; use address@hidden} and the @code{<“progress-mode”>} property. + @section Usage @include defuns-clutter-alpha.xml.texi diff --git a/doc/clutter/section-clutter-animatable.xml.texi b/doc/clutter/section-clutter-animatable.xml.texi index 4e38fbe..52816f9 100644 --- a/doc/clutter/section-clutter-animatable.xml.texi +++ b/doc/clutter/section-clutter-animatable.xml.texi @@ -11,17 +11,17 @@ Interface for animatable classes animate a property. Each @code{} should implement the address@hidden virtual function of the interface to compute the -animation state between two values of an interval depending on a -progress factor, expressed as a floating point value. address@hidden virtual function of +the interface to compute the animation state between two values of an +interval depending on a progress factor, expressed as a floating point +value. If a @code{} is animated by a @code{} instance, the @code{} will -call @code{clutter-animatable-animate-property} passing the name of the -currently animated property; the initial and final values of the -animation interval; the progress factor. The @code{} -implementation should return the computed value for the animated -property. +call @code{clutter-animatable-interpolate-property} passing the name of +the currently animated property; the values interval; and the progress +factor. The @code{} implementation should return +the computed value for the animated property. @code{} is available since Clutter 1.0 diff --git a/doc/clutter/section-clutter-animation.xml.texi b/doc/clutter/section-clutter-animation.xml.texi index ef22797..ba34663 100644 --- a/doc/clutter/section-clutter-animation.xml.texi +++ b/doc/clutter/section-clutter-animation.xml.texi @@ -16,7 +16,7 @@ interpolate the property between the initial and final values of the interval. The duration of the animation is set using address@hidden The easing mode of the animation address@hidden The easing mode of the animation is set using @code{clutter-animation-set-mode}. If you want to control the animation you should retrieve the @@ -25,11 +25,11 @@ and then use @code{} functions like @code{clutter-timeline-start}, @code{clutter-timeline-pause} or @code{clutter-timeline-stop}. -A @code{} will emit the @code{<"completed">} signal -when the @code{} used by the animation is completed; -unlike @code{}, though, the @code{<"completed">} will -not be emitted if @code{<"loop">} is set to @address@hidden - that is, -a looping animation never completes. +A @code{} will emit the @code{<“completed”>} +signal when the @code{} used by the animation is +completed; unlike @code{}, though, the address@hidden<“completed”>} will not be emitted if @code{<“loop”>} is +set to @address@hidden - that is, a looping animation never completes. If your animation depends on user control you can force its completion using @code{clutter-animation-completed}. @@ -53,7 +53,7 @@ current state and the specified final state. @section Defining ClutterAnimationMode inside ClutterScript When defining a @code{} inside a ClutterScript file -or string the @code{<"mode">} can be defined either using the +or string the @code{<“mode”>} can be defined either using the @code{} enumeration values through their "nick" (the short string used inside @code{}), their numeric id, or using the following strings: @@ -141,7 +141,9 @@ Corresponding to the bouncing easing modes @c (http://www.w3.org/2001/XInclude:include (@ (parse "text") (href "../../../../tests/interactive/test-easing.c")) (c (% (all "(http://www.w3.org/2001/XInclude:fallback \"FIXME: MISSING XINCLUDE CONTENT\")")))) @end example address@hidden} is available since Clutter 1.0 address@hidden} is available since Clutter 1.0. + address@hidden} has been deprecated in Clutter 1.12. @section Usage @include defuns-clutter-animation.xml.texi diff --git a/doc/clutter/section-clutter-animator.xml.texi b/doc/clutter/section-clutter-animator.xml.texi index 84aea91..b257f93 100644 --- a/doc/clutter/section-clutter-animator.xml.texi +++ b/doc/clutter/section-clutter-animator.xml.texi @@ -11,25 +11,26 @@ for @code{} properties belonging to one or more @code{}s to @code{}. @code{} is used to build and describe complex -animations in terms of "key frames". @code{} is meant +animations in terms of "key frames". @code{} is meant to be used through the @code{} definition format, but it comes with a convenience C API. @section Key Frames Every animation handled by a @code{} can be described -in terms of "key frames". For each @code{} property there can +in terms of "key frames". For each @code{} property there can be multiple key frames, each one defined by the end value for the property to be computed starting from the current value to a specific point in time, using a given easing mode. The point in time is defined using a value representing the progress in -the normalized interval of [ 0, 1 ]. This maps the value returned by +the normalized interval of [ 0, 1 ]. This maps the value returned by @code{clutter-timeline-get-duration}. @c (title "Key Frames") In the image above the duration of the animation is represented by the -blue line. Each key frame is the white dot, along with its progress. The -red line represents the computed function of time given the easing mode. +blue line. Each key frame is the white dot, along with its progress. +The red line represents the computed function of time given the easing +mode. @section ClutterAnimator description for @code{} @code{} defines a custom "properties" property which @@ -42,12 +43,12 @@ The "properties" property has the following syntax: @{ "properties" : [ @{ - "object" : <id of an object>, - "name" : <name of the property>, - "ease-in" : <boolean>, - "interpolation" : <#ClutterInterpolation value>, + "object" : , + "name" : , + "ease-in" : , + "interpolation" : <#ClutterInterpolation value>, "keys" : [ - [ <progress>, <easing mode>, <final value> ] + [ , , ] ] ] @} @@ -59,7 +60,7 @@ The "properties" property has the following syntax: The following JSON fragment defines a @code{} with the duration of 1 second and operating on the x and y properties of a @code{} named "rect-01", with two frames for each -property. The first frame will linearly move the actor from its current +property. The first frame will linearly move the actor from its current position to the 100, 100 position in 20 percent of the duration of the animation; the second will using a cubic easing to move the actor to the 200, 200 coordinates. @@ -95,6 +96,8 @@ animation; the second will using a cubic easing to move the actor to the @code{} is available since Clutter 1.2 address@hidden} has been deprecated in Clutter 1.12 + @section Usage @include defuns-clutter-animator.xml.texi diff --git a/doc/clutter/section-clutter-backend.xml.texi b/doc/clutter/section-clutter-backend.xml.texi index 78b3e88..2839b39 100644 --- a/doc/clutter/section-clutter-backend.xml.texi +++ b/doc/clutter/section-clutter-backend.xml.texi @@ -6,7 +6,7 @@ Backend abstraction @section Overview -Clutter can be compiled against different backends. Each backend has to +Clutter can be compiled against different backends. Each backend has to implement a set of functions, in order to be used by Clutter. @code{} is the base class abstracting the various diff --git a/doc/clutter/section-clutter-bin-layout.xml.texi b/doc/clutter/section-clutter-bin-layout.xml.texi index cea0b70..a50bb29 100644 --- a/doc/clutter/section-clutter-bin-layout.xml.texi +++ b/doc/clutter/section-clutter-bin-layout.xml.texi @@ -22,8 +22,6 @@ for each layer there are horizontal and vertical alignment policies. @end itemize -(The missing figure, bin-layout - @c (title "Bin layout") The image shows a @code{} with three layers: a background @code{}, set to fill on both the X and @@ -33,39 +31,8 @@ axis; and a @code{}, set to @c (example (@ (id "example-clutter-bin-layout"))) @c (title "How to pack actors inside a BinLayout") -The following code shows how to build a composite actor with a texture -and a background, and add controls overlayed on top. The background is -set to fill the whole allocation, whilst the texture is centered; there -is a control in the top right corner and a label in the bottom, filling -out the whole allocated width. - @example - - ClutterLayoutManager *manager; - ClutterActor *box; - - /* create the layout first */ - layout = clutter_bin_layout_new (CLUTTER_BIN_ALIGNMENT_CENTER, - CLUTTER_BIN_ALIGNMENT_CENTER); - box = clutter_box_new (layout); /* then the container */ - - /* we can use the layout object to add actors */ - clutter_bin_layout_add (CLUTTER_BIN_LAYOUT (layout), background, - CLUTTER_BIN_ALIGNMENT_FILL, - CLUTTER_BIN_ALIGNMENT_FILL); - clutter_bin_layout_add (CLUTTER_BIN_LAYOUT (layout), icon, - CLUTTER_BIN_ALIGNMENT_CENTER, - CLUTTER_BIN_ALIGNMENT_CENTER); - - /* align to the bottom left */ - clutter_bin_layout_add (CLUTTER_BIN_LAYOUT (layout), label, - CLUTTER_BIN_ALIGNMENT_START, - CLUTTER_BIN_ALIGNMENT_END); - /* align to the top right */ - clutter_bin_layout_add (CLUTTER_BIN_LAYOUT (layout), button, - CLUTTER_BIN_ALIGNMENT_END, - CLUTTER_BIN_ALIGNMENT_START); - address@hidden (http://www.w3.org/2001/XInclude:include (@ (parse "text") (href "../../../../examples/bin-layout.c")) (c (% (all "(http://www.w3.org/2001/XInclude:fallback \"FIXME: MISSING XINCLUDE CONTENT\")")))) @end example @code{} is available since Clutter 1.2 diff --git a/doc/clutter/section-clutter-bind-constraint.xml.texi b/doc/clutter/section-clutter-bind-constraint.xml.texi index 9a4b6b9..60dffd4 100644 --- a/doc/clutter/section-clutter-bind-constraint.xml.texi +++ b/doc/clutter/section-clutter-bind-constraint.xml.texi @@ -11,18 +11,18 @@ binds the position or the size of the @code{} to which it is applied to the the position or the size of another @code{}, or "source". -An offset can be applied to the constraint, to avoid overlapping. The -offset can also be animated. For instance, the following code will set +An offset can be applied to the constraint, to avoid overlapping. The +offset can also be animated. For instance, the following code will set up three actors to be bound to the same origin: @example -/* source */ +/* source */ rect[0] = clutter_rectangle_new_with_color (&red_color); clutter_actor_set_position (rect[0], x_pos, y_pos); clutter_actor_set_size (rect[0], 100, 100); -/* second rectangle */ +/* second rectangle */ rect[1] = clutter_rectangle_new_with_color (&green_color); clutter_actor_set_size (rect[1], 100, 100); clutter_actor_set_opacity (rect[1], 0); @@ -32,7 +32,7 @@ clutter_actor_add_constraint_with_name (rect[1], "green-x", constraint); constraint = clutter_bind_constraint_new (rect[0], CLUTTER_BIND_Y, 0.0); clutter_actor_add_constraint_with_name (rect[1], "green-y", constraint); -/* third rectangle */ +/* third rectangle */ rect[2] = clutter_rectangle_new_with_color (&blue_color); clutter_actor_set_size (rect[2], 100, 100); clutter_actor_set_opacity (rect[2], 0); @@ -61,15 +61,15 @@ clutter_actor_animate (rect[2], CLUTTER_EASE_OUT_CUBIC, 250, @c (example (@ (id "bind-constraint-example"))) @c (title "Animating the offset property of ClutterBindConstraint") @example address@hidden (http://www.w3.org/2001/XInclude:include (@ (parse "text") (href "../../../../tests/interactive/test-constraints.c")) (c (% (all "(http://www.w3.org/2001/XInclude:fallback \"FIXME: MISSING XINCLUDE CONTENT\")")))) address@hidden (http://www.w3.org/2001/XInclude:include (@ (parse "text") (href "../../../../tests/interactive/test-bind-constraint.c")) (c (% (all "(http://www.w3.org/2001/XInclude:fallback \"FIXME: MISSING XINCLUDE CONTENT\")")))) @end example The example above creates eight rectangles and binds them to a rectangle positioned in the center of the stage; when the user presses the center -rectangle, the @code{<"offset">} property is animated through the +rectangle, the @code{<“offset”>} property is animated through the @code{clutter-actor-animate} function to lay out the eight rectangles -around the center one. Pressing one of the outer rectangles will animate -the offset back to 0. +around the center one. Pressing one of the outer rectangles will +animate the offset back to 0. @code{} is available since Clutter 1.4 diff --git a/doc/clutter/section-clutter-binding-pool.xml.texi b/doc/clutter/section-clutter-binding-pool.xml.texi index 916d096..404d58e 100644 --- a/doc/clutter/section-clutter-binding-pool.xml.texi +++ b/doc/clutter/section-clutter-binding-pool.xml.texi @@ -7,14 +7,14 @@ Pool for key bindings @section Overview @code{} is a data structure holding a set of key -bindings. Each key binding associates a key symbol (eventually with -modifiers) to an action. A callback function is associated to each +bindings. Each key binding associates a key symbol (eventually with +modifiers) to an action. A callback function is associated to each action. For a given key symbol and modifier mask combination there can be only -one action; for each action there can be only one callback. There can be -multiple actions with the same name, and the same callback can be used -to handle multiple key bindings. +one action; for each action there can be only one callback. There can +be multiple actions with the same name, and the same callback can be +used to handle multiple key bindings. Actors requiring key bindings should create a new @code{} inside their class initialization function @@ -51,21 +51,21 @@ The callback has a signature of: gpointer user_data); @end example -The actor should then override the @code{<"key-press-event">} and use address@hidden to match a +The actor should then override the @code{<“key-press-event”>} and +use @code{clutter-binding-pool-activate} to match a @code{} structure to one of the actions: @example ClutterBindingPool *pool; - /* retrieve the binding pool for the type of the actor */ + /* retrieve the binding pool for the type of the actor */ pool = clutter_binding_pool_find (G_OBJECT_TYPE_NAME (actor)); - /* activate any callback matching the key symbol and modifiers - * mask of the key event. the returned value can be directly - * used to signal that the actor has handled the event. - */ + /* activate any callback matching the key symbol and modifiers + * mask of the key event. the returned value can be directly + * used to signal that the actor has handled the event. + */ return clutter_binding_pool_activate (pool, key_event->keyval, key_event->modifier_state, diff --git a/doc/clutter/section-clutter-box-layout.xml.texi b/doc/clutter/section-clutter-box-layout.xml.texi index 31914c3..b98b6df 100644 --- a/doc/clutter/section-clutter-box-layout.xml.texi +++ b/doc/clutter/section-clutter-box-layout.xml.texi @@ -16,43 +16,34 @@ implementing the following layout policy: @item @item @item address@hidden @end itemize all children are arranged on a single line; -the axis used is controlled by the @code{<"vertical">} boolean property; +the axis used is controlled by the @code{<“orientation”>} property; -the order of the packing is determined by the @code{<"pack-start">} +the order of the packing is determined by the @code{<“pack-start”>} boolean property; -each child will be allocated to its natural size or, if set to expand, -the available size; - -if a child is set to fill on either (or both) axis, its allocation will -match all the available size; the fill layout property only makes sense -if the expand property is also set; +each child will be allocated to its natural size or, if address@hidden<“x-expand”>}/@code{<“y-expand”>} is set, the available +size; -if a child is set to expand but not to fill then it is possible to -control the alignment using the X and Y alignment layout properties. +honours the @code{}'s @code{<“x-align”>} and address@hidden<“y-align”>} properties to fill the available size; -if the @code{<"homogeneous">} boolean property is set, then all widgets -will get the same size, ignoring expand settings and the preferred sizes - -(The missing figure, box-layout +if the @code{<“homogeneous”>} boolean property is set, then all +widgets will get the same size, ignoring expand settings and the +preferred sizes @c (title "Box layout") The image shows a @code{} with the address@hidden<"vertical">} property set to @address@hidden address@hidden<“vertical”>} property set to @address@hidden It is possible to control the spacing between children of a @code{} by using @code{clutter-box-layout-set-spacing}. -In order to set the layout properties when packing an actor inside a address@hidden} you should use the address@hidden function. - @code{} is available since Clutter 1.2 @section Usage diff --git a/doc/clutter/section-clutter-cairo-texture.xml.texi b/doc/clutter/section-clutter-cairo-texture.xml.texi index 247c44a..e4a8e69 100644 --- a/doc/clutter/section-clutter-cairo-texture.xml.texi +++ b/doc/clutter/section-clutter-cairo-texture.xml.texi @@ -7,22 +7,22 @@ Texture with Cairo integration @section Overview @code{} is a @code{} that -displays the contents of a Cairo context. The +displays the contents of a Cairo context. The @code{} actor will create a Cairo image surface which will then be uploaded to a GL texture when needed. Since @code{} uses a Cairo image surface internally all the drawing operations will be performed in software and -not using hardware acceleration. This can lead to performance +not using hardware acceleration. This can lead to performance degradation if the contents of the texture change frequently. In order to use a @code{} you should connect to -the @code{<"draw">} signal; the signal is emitted each time the +the @code{<“draw”>} signal; the signal is emitted each time the @code{} has been told to invalidate its contents, by using @code{clutter-cairo-texture-invalidate-rectangle} or its sister function, @code{clutter-cairo-texture-invalidate}. -Each callback to the @code{<"draw">} signal will receive a +Each callback to the @code{<“draw”>} signal will receive a @code{} context which can be used for drawing; the Cairo context is owned by the @code{} and should not be destroyed explicitly. @@ -35,6 +35,8 @@ destroyed explicitly. @code{} is available since Clutter 1.0. address@hidden} is deprecated since Clutter 1.12. + @section Usage @include defuns-clutter-cairo-texture.xml.texi diff --git a/doc/clutter/section-clutter-canvas.xml.texi b/doc/clutter/section-clutter-canvas.xml.texi index 9e9dc63..12dc2d9 100644 --- a/doc/clutter/section-clutter-canvas.xml.texi +++ b/doc/clutter/section-clutter-canvas.xml.texi @@ -10,13 +10,13 @@ The @code{} class is a @code{} implementation that allows drawing using the Cairo API on a 2D surface. In order to draw on a @code{}, you should connect a -handler to the @code{<"draw">} signal; the signal will receive a +handler to the @code{<“draw”>} signal; the signal will receive a @code{} context that can be used to draw. address@hidden} will emit the @code{<"draw">} signal when address@hidden} will emit the @code{<“draw”>} signal when invalidated using @code{clutter-content-invalidate}. @example address@hidden (http://www.w3.org/2001/XInclude:include (@ (parse "text") (href "../../../../tests/interactive/test-canvas.c")) (c (% (all "(http://www.w3.org/2001/XInclude:fallback \"FIXME: MISSING XINCLUDE CONTENT\")")))) address@hidden (http://www.w3.org/2001/XInclude:include (@ (parse "text") (href "../../../../examples/canvas.c")) (c (% (all "(http://www.w3.org/2001/XInclude:fallback \"FIXME: MISSING XINCLUDE CONTENT\")")))) @end example @code{} is available since Clutter 1.10. diff --git a/doc/clutter/section-clutter-click-action.xml.texi b/doc/clutter/section-clutter-click-action.xml.texi index 45d32c3..3ddd8a6 100644 --- a/doc/clutter/section-clutter-click-action.xml.texi +++ b/doc/clutter/section-clutter-click-action.xml.texi @@ -8,13 +8,14 @@ Action for clickable actors @section Overview @code{} is a sub-class of @code{} that implements the logic for clickable actors, by using the low level -events of @code{}, such as @code{<"button-press-event">} -and @code{<"button-release-event">}, to synthesize the high level address@hidden<"clicked">} signal. +events of @code{}, such as address@hidden<“button-press-event”>} and address@hidden<“button-release-event”>}, to synthesize the high level address@hidden<“clicked”>} signal. To use @code{} you just need to apply it to a @code{} using @code{clutter-actor-add-action} and connect -to the @code{<"clicked">} signal: +to the @code{<“clicked”>} signal: @example @@ -27,13 +28,13 @@ to the @code{<"clicked">} signal: @code{} also supports long press gestures: a long press is activated if the pointer remains pressed within a certain -threshold (as defined by the @code{<"long-press-threshold">} property) -for a minimum amount of time (as the defined by the address@hidden<"long-press-duration">} property). The @code{<"long-press">} -signal is emitted multiple times, using different address@hidden} values; to handle long presses you -should connect to the @code{<"long-press">} signal and handle the -different states: +threshold (as defined by the @code{<“long-press-threshold”>} +property) for a minimum amount of time (as the defined by the address@hidden<“long-press-duration”>} property). The address@hidden<“long-press”>} signal is emitted multiple times, using +different @code{} values; to handle long +presses you should connect to the @code{<“long-press”>} signal and +handle the different states: @example @@ -45,26 +46,26 @@ different states: switch (state) @{ case CLUTTER_LONG_PRESS_QUERY: - /* return TRUE if the actor should support long press - * gestures, and FALSE otherwise; this state will be - * emitted on button presses - */ + /* return TRUE if the actor should support long press + * gestures, and FALSE otherwise; this state will be + * emitted on button presses + */ return TRUE; case CLUTTER_LONG_PRESS_ACTIVATE: - /* this state is emitted if the minimum duration has - * been reached without the gesture being cancelled. - * the return value is not used - */ + /* this state is emitted if the minimum duration has + * been reached without the gesture being cancelled. + * the return value is not used + */ return TRUE; case CLUTTER_LONG_PRESS_CANCEL: - /* this state is emitted if the long press was cancelled; - * for instance, the pointer went outside the actor or the - * allowed threshold, or the button was released before - * the minimum duration was reached. the return value is - * not used - */ + /* this state is emitted if the long press was cancelled; + * for instance, the pointer went outside the actor or the + * allowed threshold, or the button was released before + * the minimum duration was reached. the return value is + * not used + */ return FALSE; @} @} diff --git a/doc/clutter/section-clutter-constraint.xml.texi b/doc/clutter/section-clutter-constraint.xml.texi index df6b151..36d15e3 100644 --- a/doc/clutter/section-clutter-constraint.xml.texi +++ b/doc/clutter/section-clutter-constraint.xml.texi @@ -11,10 +11,10 @@ Abstract class for constraints on position or size A @code{} sub-class should contain the logic for modifying the position or size of the @code{} to which it -is applied, by updating the actor's allocation. Each +is applied, by updating the actor's allocation. Each @code{} can change the allocation of the actor to -which they are applied by overriding the @address@hidden -virtual function. +which they are applied by overriding the address@hidden virtual function. @section Using Constraints Constraints can be used with fixed layout managers, like @@ -50,27 +50,27 @@ space. @c (example (@ (id "ClutterConstraint-usage-example")) (para "(The missing figure, " "constraints-example")) @c (title "Usage of constraints") The example below uses various @code{}s to lay out -three actors on a resizable stage. Only the central actor has an +three actors on a resizable stage. Only the central actor has an explicit size, and no actor has an explicit position. @enumerate @item -The @code{} with @code{<"name">address@hidden is +The @code{} with @code{<“name”>address@hidden is explicitly sized to 100 pixels by 25 pixels, and it's added to the @code{}; @item two @code{}s are used to anchor @emph{layerA} to the center of the stage, by using 0.5 as the alignment address@hidden<"factor">} on both the X and Y axis. address@hidden<“factor”>} on both the X and Y axis. @item -the @code{} with @code{<"name">address@hidden is +the @code{} with @code{<“name”>address@hidden is added to the @code{} with no explicit size; @item -the @code{<"x">} and @code{<"width">} of @emph{layerB} are bound to the -same properties of @emph{layerA} using two +the @code{<“x”>} and @code{<“width”>} of @emph{layerB} are bound +to the same properties of @emph{layerA} using two @code{} objects, thus keeping @emph{layerB} aligned to @emph{layerA}; @@ -83,16 +83,16 @@ padding; since @emph{layerB} is snapped between two different @code{}s, its height is stretched to match the gap; @item -the @code{} with @code{<"name">address@hidden mirrors address@hidden, snapping the top edge of the @code{} to -the top edge of @emph{layerC} and the top edge of @emph{layerA} to the -bottom edge of @emph{layerC}; +the @code{} with @code{<“name”>address@hidden +mirrors @emph{layerB}, snapping the top edge of the address@hidden} to the top edge of @emph{layerC} and the top edge +of @emph{layerA} to the bottom edge of @emph{layerC}; @end enumerate @c (title "Constraints") @example address@hidden (http://www.w3.org/2001/XInclude:include (@ (parse "text") (href "../../../../tests/interactive/test-snap-constraint.c")) (c (% (all "(http://www.w3.org/2001/XInclude:fallback \"FIXME: MISSING XINCLUDE CONTENT\")")))) address@hidden (http://www.w3.org/2001/XInclude:include (@ (parse "text") (href "../../../../examples/constraints.c")) (c (% (all "(http://www.w3.org/2001/XInclude:fallback \"FIXME: MISSING XINCLUDE CONTENT\")")))) @end example You can try resizing interactively the @code{} and verify @@ -127,10 +127,10 @@ Constraints are queried in the same order as they were applied using It is not necessary for a @code{} sub-class to chain up to the parent's implementation. -If a @code{} is parametrized - i.e. if it contains +If a @code{} is parametrized - i.e. if it contains properties that affect the way the constraint is implemented - it should call @code{clutter-actor-queue-relayout} on the actor to which it is -attached to whenever any parameter is changed. The actor to which it is +attached to whenever any parameter is changed. The actor to which it is attached can be recovered at any point using @code{clutter-actor-meta-get-actor}. diff --git a/doc/clutter/section-clutter-container.xml.texi b/doc/clutter/section-clutter-container.xml.texi index 671df7f..8dbca4f 100644 --- a/doc/clutter/section-clutter-container.xml.texi +++ b/doc/clutter/section-clutter-container.xml.texi @@ -15,7 +15,7 @@ Until Clutter 1.10, the @code{} interface was also the public API for implementing container actors; this part of the interface has been deprecated: @code{} has a default implementation which defers to @code{} the child addition -and removal, as well as the iteration. See the documentation of +and removal, as well as the iteration. See the documentation of @code{} for the list of virtual functions that should be overridden. diff --git a/doc/clutter/section-clutter-deform-effect.xml.texi b/doc/clutter/section-clutter-deform-effect.xml.texi index 26fd154..a997dc2 100644 --- a/doc/clutter/section-clutter-deform-effect.xml.texi +++ b/doc/clutter/section-clutter-deform-effect.xml.texi @@ -16,11 +16,11 @@ API to submit the geometry to the GPU. @section Implementing ClutterDeformEffect Sub-classes of @code{} should override the address@hidden@code{deform-vertex}} virtual function; this function is called on -every vertex that needs to be deformed by the effect. Each passed vertex -is an in-out parameter that initially contains the position of the -vertex and should be modified according to a specific deformation -algorithm. address@hidden virtual function; this +function is called on every vertex that needs to be deformed by the +effect. Each passed vertex is an in-out parameter that initially +contains the position of the vertex and should be modified according to +a specific deformation algorithm. @code{} is available since Clutter 1.4 diff --git a/doc/clutter/section-clutter-desaturate-effect.xml.texi b/doc/clutter/section-clutter-desaturate-effect.xml.texi index 8185fc9..1bd1319 100644 --- a/doc/clutter/section-clutter-desaturate-effect.xml.texi +++ b/doc/clutter/section-clutter-desaturate-effect.xml.texi @@ -8,8 +8,8 @@ A desaturation effect @section Overview @code{} is a sub-class of @code{} that desaturates the color of an actor and its -contents. The strenght of the desaturation effect is controllable and -animatable through the @code{<"factor">} property. +contents. The strenght of the desaturation effect is controllable and +animatable through the @code{<“factor”>} property. @code{} is available since Clutter 1.4 diff --git a/doc/clutter/section-clutter-device-manager.xml.texi b/doc/clutter/section-clutter-device-manager.xml.texi index cbe16d8..e80c84b 100644 --- a/doc/clutter/section-clutter-device-manager.xml.texi +++ b/doc/clutter/section-clutter-device-manager.xml.texi @@ -10,7 +10,7 @@ Maintains the list of input devices which maintains the list of @code{}s. Depending on the backend used by Clutter it is possible to use the address@hidden<"device-added">} and @code{<"device-removed">} to monitor address@hidden<“device-added”>} and @code{<“device-removed”>} to monitor addition and removal of devices. @code{} is available since Clutter 1.2 diff --git a/doc/clutter/section-clutter-drag-action.xml.texi b/doc/clutter/section-clutter-drag-action.xml.texi index d39dd3e..c597936 100644 --- a/doc/clutter/section-clutter-drag-action.xml.texi +++ b/doc/clutter/section-clutter-drag-action.xml.texi @@ -24,24 +24,25 @@ whenever the pointer's button is pressed over the actor and moved across the stage. The @code{} will signal the begin and the end of a -dragging through the @code{<"drag-begin">} and @code{<"drag-end">} -signals, respectively. Each pointer motion during a drag will also -result in the @code{<"drag-motion">} signal to be emitted. +dragging through the @code{<“drag-begin”>} and address@hidden<“drag-end”>} signals, respectively. Each pointer motion +during a drag will also result in the @code{<“drag-motion”>} signal +to be emitted. It is also possible to set another @code{} as the dragged actor by calling @code{clutter-drag-action-set-drag-handle} from within -a handle of the @code{<"drag-begin">} signal. The drag handle must be -parented and exist between the emission of @code{<"drag-begin">} and address@hidden<"drag-end">}. +a handle of the @code{<“drag-begin”>} signal. The drag handle must +be parented and exist between the emission of @code{<“drag-begin”>} +and @code{<“drag-end”>}. @c (example (@ (id "drag-action-example"))) @c (title "A simple draggable actor") @example address@hidden (http://www.w3.org/2001/XInclude:include (@ (parse "text") (href "../../../../tests/interactive/test-drag.c")) (c (% (all "(http://www.w3.org/2001/XInclude:fallback \"FIXME: MISSING XINCLUDE CONTENT\")")))) address@hidden (http://www.w3.org/2001/XInclude:include (@ (parse "text") (href "../../../../examples/drag-action.c")) (c (% (all "(http://www.w3.org/2001/XInclude:fallback \"FIXME: MISSING XINCLUDE CONTENT\")")))) @end example The example program above allows dragging the rectangle around the stage -using a @code{}. When pressing the @c (keycap +using a @code{}. When pressing the @c (keycap "Shift") key the actor that is going to be dragged is a separate rectangle, and when the drag ends, the original rectangle will be animated to the final coordinates. diff --git a/doc/clutter/section-clutter-drop-action.xml.texi b/doc/clutter/section-clutter-drop-action.xml.texi index 5e782ee..fad8449 100644 --- a/doc/clutter/section-clutter-drop-action.xml.texi +++ b/doc/clutter/section-clutter-drop-action.xml.texi @@ -13,7 +13,7 @@ area or when a dragged actor is released (or "dropped") on the target area. A trivial use of @code{} consists in connecting to -the @code{<"drop">} signal and handling the drop from there, for +the @code{<“drop”>} signal and handling the drop from there, for instance: @example @@ -24,16 +24,16 @@ instance: clutter_actor_add_action (an_actor, action); @end example -The @code{<"can-drop">} can be used to control whether the address@hidden<"drop">} signal is going to be emitted; returning address@hidden@code{#f}} from a handler connected to the @code{<"can-drop">} -signal will cause the @code{<"drop">} signal to be skipped when the +The @code{<“can-drop”>} can be used to control whether the address@hidden<“drop”>} signal is going to be emitted; returning address@hidden@code{#f}} from a handler connected to the @code{<“can-drop”>} +signal will cause the @code{<“drop”>} signal to be skipped when the input device button is released. @c (example (@ (id "drop-action-example"))) @c (title "Drop targets") @example address@hidden (http://www.w3.org/2001/XInclude:include (@ (parse "text") (href "../../../../tests/interactive/test-drop.c")) (c (% (all "(http://www.w3.org/2001/XInclude:fallback \"FIXME: MISSING XINCLUDE CONTENT\")")))) address@hidden (http://www.w3.org/2001/XInclude:include (@ (parse "text") (href "../../../../examples/drop-action.c")) (c (% (all "(http://www.w3.org/2001/XInclude:fallback \"FIXME: MISSING XINCLUDE CONTENT\")")))) @end example It's important to note that @code{} will only work diff --git a/doc/clutter/section-clutter-effect.xml.texi b/doc/clutter/section-clutter-effect.xml.texi index 6afbf3c..5d25c3e 100644 --- a/doc/clutter/section-clutter-effect.xml.texi +++ b/doc/clutter/section-clutter-effect.xml.texi @@ -15,11 +15,11 @@ implementation. Effects should be the preferred way to affect the paint sequence of an actor without sub-classing the actor itself and overriding the address@hidden<"paint">} virtual function. address@hidden virtual function. @section Implementing a ClutterEffect Creating a sub-class of @code{} requires overriding the -‘paint’ method. The implementation of the function should look +‘paint’ method. The implementation of the function should look something like this: @example @@ -44,15 +44,15 @@ void effect_paint (ClutterEffect *effect, ClutterEffectPaintFlags flags) The effect can optionally avoid calling @code{clutter-actor-continue-paint} to skip any further stages of the -paint sequence. This is useful for example if the effect contains a -cached image of the actor. In that case it can optimise painting by -avoiding the actor paint and instead painting the cached image. The +paint sequence. This is useful for example if the effect contains a +cached image of the actor. In that case it can optimise painting by +avoiding the actor paint and instead painting the cached image. The @samp{CLUTTER_EFFECT_PAINT_ACTOR_DIRTY} flag is useful in this case. Clutter will set this flag when a redraw has been queued on the actor -since it was last painted. The effect can use this information to decide -if the cached image is still valid. +since it was last painted. The effect can use this information to +decide if the cached image is still valid. -The ‘paint’ virtual was added in Clutter 1.8. Prior to that there +The ‘paint’ virtual was added in Clutter 1.8. Prior to that there were two separate functions as follows. @itemize @@ -68,27 +68,30 @@ were two separate functions as follows. The @address@hidden function was used to set up the @code{} right before the @code{}'s paint -sequence. This function can fail, and return @address@hidden; in that +sequence. This function can fail, and return @address@hidden; in that case, no @address@hidden invocation will follow. The @address@hidden function was called after the @code{}'s paint sequence. With these two functions it is not possible to skip the rest of the -paint sequence. The default implementation of the ‘paint’ virtual -calls @code{pre-paint}, @code{clutter-actor-continue-paint} and then address@hidden so that existing actors that aren't using the paint -virtual will continue to work. New actors using the paint virtual do not -need to implement pre or post paint. +paint sequence. The default implementation of the ‘paint’ virtual +calls @code{clutter-effect-class.pre-paint}, address@hidden and then address@hidden so that existing actors that +aren't using the @code{clutter-effect-class.paint} virtual will continue +to work. New effects using the @code{clutter-effect-class.paint} +virtual do not need to implement pre or post paint. @c (example (@ (id "ClutterEffect-example"))) @c (title "A simple ClutterEffect implementation") The example below creates two rectangles: one will be painted "behind" -the actor, while another will be painted "on top" of the actor. The address@hidden@code{set-actor}} implementation will create the two materials -used for the two different rectangles; the @address@hidden function -will paint the first material using @code{cogl-rectangle}, before -continuing and then it will paint paint the second material after. +the actor, while another will be painted "on top" of the actor. The address@hidden implementation will create the +two materials used for the two different rectangles; the address@hidden implementation will paint the first +material using @code{cogl-rectangle}, before continuing and then it will +paint paint the second material after. @example diff --git a/doc/clutter/section-clutter-flow-layout.xml.texi b/doc/clutter/section-clutter-flow-layout.xml.texi index 6084726..5599c4b 100644 --- a/doc/clutter/section-clutter-flow-layout.xml.texi +++ b/doc/clutter/section-clutter-flow-layout.xml.texi @@ -17,8 +17,8 @@ following policy: @end itemize the preferred natural size depends on the value of the address@hidden<"orientation">} property; the layout will try to maintain all its -children on a single row or column; address@hidden<“orientation”>} property; the layout will try to maintain all +its children on a single row or column; if either the width or the height allocated are smaller than the preferred ones, the layout will wrap; in this case, the preferred height @@ -26,19 +26,22 @@ or width, respectively, will take into account the amount of columns and rows; each line (either column or row) in reflowing will have the size of the -biggest cell on that line; if the @code{<"homogeneous">} property is set -to @address@hidden the actor will be allocated within that area, and if -set to @address@hidden instead the actor will be given exactly that -area; +biggest cell on that line; if the @code{<“homogeneous”>} property is +set to @address@hidden the actor will be allocated within that area, +and if set to @address@hidden instead the actor will be given exactly +that area; the size of the columns or rows can be controlled for both minimum and maximum; the spacing can also be controlled in both columns and rows. -(The missing figure, flow-layout-image - @c (title "Horizontal flow layout") The image shows a @code{} with the address@hidden<"orientation">} propert set to @samp{CLUTTER_FLOW_HORIZONTAL}. address@hidden<“orientation”>} propert set to address@hidden + address@hidden address@hidden (http://www.w3.org/2001/XInclude:include (@ (parse "text") (href "../../../../examples/flow-layout.c")) (c (% (all "(http://www.w3.org/2001/XInclude:fallback \"FIXME: MISSING XINCLUDE CONTENT\")")))) address@hidden example @code{} is available since Clutter 1.2 diff --git a/doc/clutter/section-clutter-gesture-action.xml.texi b/doc/clutter/section-clutter-gesture-action.xml.texi index 46f0140..0752304 100644 --- a/doc/clutter/section-clutter-gesture-action.xml.texi +++ b/doc/clutter/section-clutter-gesture-action.xml.texi @@ -8,10 +8,10 @@ Action for gesture gestures @section Overview @code{} is a sub-class of @code{} that implements the logic for recognizing -gesture gestures. It listens for low level events such as +gesture gestures. It listens for low level events such as @code{} and @code{} on the -stage to raise the @code{<"gesture-begin">}, address@hidden<"gesture-progress">}, and * @code{<"gesture-end">} signals. +stage to raise the @code{<“gesture-begin”>}, address@hidden<“gesture-progress”>}, and @code{<“gesture-end”>} signals. To use @code{} you just need to apply it to a @code{} using @code{clutter-actor-add-action} and connect @@ -28,6 +28,42 @@ to the signals: g_signal_connect (action, "gesture-end", G_CALLBACK (on_gesture_end), NULL); @end example address@hidden Creating Gesture actions +A @code{} provides four separate states that can +be used to recognize or ignore gestures when writing a new action class: + address@hidden + + Prepare -> Cancel + Prepare -> Begin -> Cancel + Prepare -> Begin -> End + Prepare -> Begin -> Progress -> Cancel + Prepare -> Begin -> Progress -> End + + address@hidden example + +Each @code{} starts in the "prepare" state, and +calls the @code{clutter-gesture-action-class.gesture-prepare} virtual +function; this state can be used to reset the internal state of a address@hidden} subclass, but it can also immediately +cancel a gesture without going through the rest of the states. + +The "begin" state follows the "prepare" state, and calls the address@hidden virtual function. This +state signals the start of a gesture recognizing process. From the +"begin" state the gesture recognition process can successfully end, by +going to the "end" state; it can continue in the "progress" state, in +case of a continuous gesture; or it can be terminated, by moving to the +"cancel" state. + +In case of continuous gestures, the @code{} will +use the "progress" state, calling the address@hidden virtual function; +the "progress" state will continue until the end of the gesture, in +which case the "end" state will be reached, or until the gesture is +cancelled, in which case the "cancel" gesture will be used instead. + @section Usage @include defuns-clutter-gesture-action.xml.texi diff --git a/doc/clutter/section-clutter-image.xml.texi b/doc/clutter/section-clutter-image.xml.texi index 9f8a3ae..cf9c17c 100644 --- a/doc/clutter/section-clutter-image.xml.texi +++ b/doc/clutter/section-clutter-image.xml.texi @@ -10,7 +10,7 @@ Image data content displays image data. @example address@hidden (http://www.w3.org/2001/XInclude:include (@ (parse "text") (href "../../../../tests/interactive/test-image-box.c")) (c (% (all "(http://www.w3.org/2001/XInclude:fallback \"FIXME: MISSING XINCLUDE CONTENT\")")))) address@hidden (http://www.w3.org/2001/XInclude:include (@ (parse "text") (href "../../../../examples/image-content.c")) (c (% (all "(http://www.w3.org/2001/XInclude:fallback \"FIXME: MISSING XINCLUDE CONTENT\")")))) @end example @code{} is available since Clutter 1.10. diff --git a/doc/clutter/section-clutter-interval.xml.texi b/doc/clutter/section-clutter-interval.xml.texi index 6e254f6..0fe5b95 100644 --- a/doc/clutter/section-clutter-interval.xml.texi +++ b/doc/clutter/section-clutter-interval.xml.texi @@ -7,11 +7,11 @@ An object holding an interval of two values @section Overview @code{} is a simple object that can hold two values -defining an interval. @code{} can hold any value that +defining an interval. @code{} can hold any value that can be enclosed inside a @code{}. Once a @code{} for a specific @code{} has been -instantiated the @code{<"value-type">} property cannot be changed +instantiated the @code{<“value-type”>} property cannot be changed anymore. @code{} starts with a floating reference; this means diff --git a/doc/clutter/section-clutter-layout-manager.xml.texi b/doc/clutter/section-clutter-layout-manager.xml.texi index c45b072..09c7acd 100644 --- a/doc/clutter/section-clutter-layout-manager.xml.texi +++ b/doc/clutter/section-clutter-layout-manager.xml.texi @@ -7,7 +7,7 @@ Layout managers base class @section Overview @code{} is a base abstract class for layout -managers. A layout manager implements the layouting policy for a +managers. A layout manager implements the layouting policy for a composite or a container actor: it controls the preferred size of the actor to which it has been paired, and it controls the allocation of its children. @@ -24,19 +24,19 @@ sub-classes, like @code{} and @section Using a Layout Manager inside an Actor In order to use a @code{} inside a @code{} sub-class you should invoke address@hidden inside the @c -(structname "ClutterActor") ::@code{get-preferred-width} virtual -function and @code{clutter-layout-manager-get-preferred-height} inside -the @c (structname "ClutterActor") ::@code{get-preferred-height} virtual -function implementations. You should also call address@hidden inside the address@hidden virtual function and address@hidden inside the address@hidden virtual functions +implementation. You should also call @code{clutter-layout-manager-allocate} inside the implementation of the address@hidden (structname "ClutterActor") ::@code{allocate} virtual function. address@hidden virtual function. In order to receive notifications for changes in the layout manager -policies you should also connect to the @code{<"layout-changed">} signal -and queue a relayout on your actor. The following code should be enough -if the actor does not need to perform specific operations whenever a -layout manager changes: +policies you should also connect to the @code{<“layout-changed”>} +signal and queue a relayout on your actor. The following code should be +enough if the actor does not need to perform specific operations +whenever a layout manager changes: @example @@ -55,14 +55,14 @@ for subclassing ClutterActor. The layout manager implementation can hold a back pointer to the @code{} by implementing the address@hidden@code{set-container}} virtual function. The layout manager should -not hold a real reference (i.e. call @code{g-object-ref}) on the address@hidden@code{set-container}} virtual function. The layout manager should +not hold a real reference (i.e. call @code{g-object-ref}) on the container actor, to avoid reference cycles. If a layout manager has properties affecting the layout policies then it -should emit the @code{<"layout-changed">} signal on itself by using the address@hidden function whenever one of -these properties changes. +should emit the @code{<“layout-changed”>} signal on itself by using +the @code{clutter-layout-manager-layout-changed} function whenever one +of these properties changes. @section Animating a ClutterLayoutManager A layout manager is used to let a @code{} take @@ -76,8 +76,9 @@ manager itself. It is possible for a @code{} sub-class to animate its children layout by using the base class animation support. The @code{} animation support consists of three -virtual functions: @address@hidden, address@hidden@code{get-animation-progress}} and @address@hidden +virtual functions: @code{clutter-layout-manager-class.begin-animation}, address@hidden, and address@hidden @table @var @item @code{get-animation-progress} @@ -95,48 +96,50 @@ virtual functions: @address@hidden, @end table This virtual function is invoked when the layout manager should begin an -animation. The implementation should set up the state for the animation -and create the ancillary objects for animating the layout. The default +animation. The implementation should set up the state for the animation +and create the ancillary objects for animating the layout. The default implementation creates a @code{} for the given duration and a @code{} binding the timeline to the given -easing mode. This function returns a @code{} which should -be used to control the animation from the caller perspective. +easing mode. This function returns a @code{} which +should be used to control the animation from the caller perspective. This virtual function should be invoked when animating a layout manager. It returns the progress of the animation, using the same semantics as -the @code{<"alpha">} value. +the @code{<“alpha”>} value. This virtual function is invoked when the animation of a layout manager ends, and it is meant to be used for bookkeeping the objects created in -the @address@hidden function. The default implementation +the @address@hidden function. The default implementation will call it implicitly when the timeline is complete. The simplest way to animate a layout is to create a @code{} inside the @address@hidden virtual function, along with a @code{}, and for each address@hidden<"new-frame">} signal emission call address@hidden<“new-frame”>} signal emission call @code{clutter-layout-manager-layout-changed}, which will cause a -relayout. The @code{<"completed">} signal emission should cause address@hidden to be called. The default +relayout. The @code{<“completed”>} signal emission should cause address@hidden to be called. The default implementation provided internally by @code{} does exactly this, so most sub-classes should either not override any animation-related virtual function or simply override address@hidden@code{begin-animation}} and @address@hidden to set up -ad hoc state, and then chain up to the parent's implementation. address@hidden and address@hidden to set up ad hoc +state, and then chain up to the parent's implementation. @c (example (@ (id "example-ClutterLayoutManager-animation"))) @c (title "Animation of a Layout Manager") The code below shows how a @code{} sub-class should provide animating the allocation of its children from within the address@hidden@code{allocate}} virtual function implementation. The animation is -computed between the last stable allocation performed before the -animation started and the desired final allocation. address@hidden virtual function +implementation. The animation is computed between the last stable +allocation performed before the animation started and the desired final +allocation. The @c (varname "is_animating") variable is stored inside the @code{} sub-class and it is updated by -overriding the @address@hidden and address@hidden@code{end-animation}} virtual functions and chaining up to the -base class implementation. +overriding the @code{clutter-layout-manager-class.begin-animation} and +the @code{clutter-layout-manager-class.end-animation} virtual functions +and chaining up to the base class implementation. The last stable allocation is stored within a @code{} sub-class used by the implementation. @@ -250,14 +253,14 @@ If a layout manager has layout properties, that is properties that should exist only as the result of the presence of a specific (layout manager, container actor, child actor) combination, and it wishes to store those properties inside a @code{}, then it -should override the @c (structname "ClutterLayoutManager") -::@code{get-child-meta-type} virtual function to return the address@hidden} of the @code{} sub-class used to -store the layout properties; optionally, the address@hidden} sub-class might also override the @c -(structname "ClutterLayoutManager") ::@code{create-child-meta} virtual -function to control how the @code{} instance is -created, otherwise the default implementation will be equivalent to: +should override the address@hidden virtual function +to return the @code{} of the @code{} +sub-class used to store the layout properties; optionally, the address@hidden} sub-class might also override the address@hidden virtual function +to control how the @code{} instance is created, +otherwise the default implementation will be equivalent to: @example diff --git a/doc/clutter/section-clutter-list-model.xml.texi b/doc/clutter/section-clutter-list-model.xml.texi index b403152..3b48937 100644 --- a/doc/clutter/section-clutter-list-model.xml.texi +++ b/doc/clutter/section-clutter-list-model.xml.texi @@ -7,7 +7,7 @@ List model implementation @section Overview @code{} is a @code{} implementation -provided by Clutter. @code{} uses a +provided by Clutter. @code{} uses a @code{} for storing the values for each row, so it's optimized for insertion and look up in sorted lists. diff --git a/doc/clutter/section-clutter-main.xml.texi b/doc/clutter/section-clutter-main.xml.texi index f66ded6..fc27f77 100644 --- a/doc/clutter/section-clutter-main.xml.texi +++ b/doc/clutter/section-clutter-main.xml.texi @@ -17,7 +17,7 @@ threading is initialized through @code{clutter-init}. @c (example (@ (id "example-Thread-Init"))) @c (title "Thread Initialization") The code below shows how to correctly initialize Clutter in a -multi-threaded environment. These operations are mandatory for +multi-threaded environment. These operations are mandatory for applications that wish to use threads with Clutter. @example @@ -69,7 +69,7 @@ operation, and perform UI updates using the main loop. @c (example (@ (id "worker-thread-example"))) @c (title "A worker thread example") @example address@hidden (http://www.w3.org/2001/XInclude:include (@ (parse "text") (href "../../../../tests/interactive/test-thread.c")) (c (% (all "(http://www.w3.org/2001/XInclude:fallback \"FIXME: MISSING XINCLUDE CONTENT\")")))) address@hidden (http://www.w3.org/2001/XInclude:include (@ (parse "text") (href "../../../../examples/threads.c")) (c (% (all "(http://www.w3.org/2001/XInclude:fallback \"FIXME: MISSING XINCLUDE CONTENT\")")))) @end example @section Usage diff --git a/doc/clutter/section-clutter-media.xml.texi b/doc/clutter/section-clutter-media.xml.texi index 9ee4004..31c3ea7 100644 --- a/doc/clutter/section-clutter-media.xml.texi +++ b/doc/clutter/section-clutter-media.xml.texi @@ -15,6 +15,8 @@ a uniform API for applications. @code{} is available since Clutter 0.2 address@hidden} is deprecated since Clutter 1.12 + @section Usage @include defuns-clutter-media.xml.texi diff --git a/doc/clutter/section-clutter-model-iter.xml.texi b/doc/clutter/section-clutter-model-iter.xml.texi index de553be..ce3e17c 100644 --- a/doc/clutter/section-clutter-model-iter.xml.texi +++ b/doc/clutter/section-clutter-model-iter.xml.texi @@ -7,11 +7,11 @@ Iterates through a model @section Overview @code{} is an object used for iterating through all -the rows of a @code{}. It allows setting and getting +the rows of a @code{}. It allows setting and getting values on the row which is currently pointing at. A @code{} represents a position between two elements -of the sequence. For example, the iterator returned by +of the sequence. For example, the iterator returned by @code{clutter-model-get-first-iter} represents the gap immediately before the first row of the @code{}, and the iterator returned by @code{clutter-model-get-last-iter} represents the gap diff --git a/doc/clutter/section-clutter-model.xml.texi b/doc/clutter/section-clutter-model.xml.texi index 83312c7..ccc7dde 100644 --- a/doc/clutter/section-clutter-model.xml.texi +++ b/doc/clutter/section-clutter-model.xml.texi @@ -52,9 +52,9 @@ Iterating through the model consists of retrieving a new forward or backwards, repectively. A valid @code{} represents the position between two -rows in the model. For example, the "first" iterator represents the gap +rows in the model. For example, the "first" iterator represents the gap immediately before the first row, and the "last" iterator represents the -gap immediately after the last row. In an empty sequence, the first and +gap immediately after the last row. In an empty sequence, the first and last iterators are the same. Iterating a @code{}: @@ -90,23 +90,23 @@ enum @} @end example address@hidden} is an abstract class. Clutter provides a list address@hidden} is an abstract class. Clutter provides a list model implementation called @code{} which has been optimised for insertion and look up in sorted lists. @section ClutterModel custom properties for @code{} @code{} defines a custom property "columns" for @code{} which allows defining the column names and -types. It also defines a custom "rows" property which allows filling the address@hidden} with some data. +types. It also defines a custom "rows" property which allows filling +the @code{} with some data. @c (example (@ (id "ClutterModel-script-example"))) @c (title "Example of the \"columns\" and \"rows\" custom properties") The definition below will create a @code{} with three columns: the first one with name "Name" and containing strings; the second one with name "Score" and containing integers; the third one -with name "Icon" and containing @code{}s. The model is -filled with three rows. A row can be defined either with an array that +with name "Icon" and containing @code{}s. The model is +filled with three rows. A row can be defined either with an array that holds all columns of a row, or an object that holds "column-name" : "column-value" pairs. diff --git a/doc/clutter/section-clutter-offscreen-effect.xml.texi b/doc/clutter/section-clutter-offscreen-effect.xml.texi index 7498ef6..0f2d51b 100644 --- a/doc/clutter/section-clutter-offscreen-effect.xml.texi +++ b/doc/clutter/section-clutter-offscreen-effect.xml.texi @@ -26,17 +26,17 @@ chain up to the @code{}'s implementation. On top of the @code{}'s virtual functions, @code{} also provides a address@hidden@code{paint-target}} function, which encapsulates the effective -painting of the texture that contains the result of the offscreen -redirection. address@hidden function, which +encapsulates the effective painting of the texture that contains the +result of the offscreen redirection. The size of the target material is defined to be as big as the transformed size of the @code{} using the offscreen -effect. Sub-classes of @code{} can change the +effect. Sub-classes of @code{} can change the texture creation code to provide bigger textures by overriding the address@hidden@code{create-texture}} virtual function; no chain up to the address@hidden} implementation is required in this -case. address@hidden virtual function; +no chain up to the @code{} implementation is +required in this case. @code{} is available since Clutter 1.4 diff --git a/doc/clutter/section-clutter-paint-node.xml.texi b/doc/clutter/section-clutter-paint-node.xml.texi index 60c54e1..9228428 100644 --- a/doc/clutter/section-clutter-paint-node.xml.texi +++ b/doc/clutter/section-clutter-paint-node.xml.texi @@ -13,7 +13,7 @@ Clutter when submitting a frame to the graphics system. The render graph is distinct from the scene graph: the scene graph is composed by actors, which can be visible or invisible; the scene graph -elements also respond to events. The render graph, instead, is only +elements also respond to events. The render graph, instead, is only composed by nodes that will be painted. Each @code{} can submit multiple diff --git a/doc/clutter/section-clutter-path-constraint.xml.texi b/doc/clutter/section-clutter-path-constraint.xml.texi index 749d644..83a8791 100644 --- a/doc/clutter/section-clutter-path-constraint.xml.texi +++ b/doc/clutter/section-clutter-path-constraint.xml.texi @@ -10,8 +10,8 @@ A constraint that follows a path the allocation of the @code{} to which it has been applied using a @code{}. -By setting the @code{<"offset">} property it is possible to control how -far along the path the @code{} should be. +By setting the @code{<“offset”>} property it is possible to control +how far along the path the @code{} should be. ClutterPathConstraint is available since Clutter 1.6. diff --git a/doc/clutter/section-clutter-path.xml.texi b/doc/clutter/section-clutter-path.xml.texi index 3bdc7c4..242a34c 100644 --- a/doc/clutter/section-clutter-path.xml.texi +++ b/doc/clutter/section-clutter-path.xml.texi @@ -7,11 +7,11 @@ An object describing a path with straight lines and bezier curves. @section Overview A @code{} contains a description of a path consisting of -straight lines and bezier curves. This can be used in a +straight lines and bezier curves. This can be used in a @code{} to animate an actor moving along the path. -The path consists of a series of nodes. Each node is one of the +The path consists of a series of nodes. Each node is one of the following four types: @table @var @@ -35,30 +35,30 @@ following four types: @c %end of fragment @end table -Changes the position of the path to the given pair of coordinates. This +Changes the position of the path to the given pair of coordinates. This is usually used as the first node of a path to mark the start position. If it is used in the middle of a path then the path will be disjoint and the actor will appear to jump to the new position when animated. Creates a straight line from the previous point to the given point. -Creates a bezier curve. The end of the last node is used as the first +Creates a bezier curve. The end of the last node is used as the first control point and the three subsequent coordinates given in the node as used as the other three. Creates a straight line from the last node to the last address@hidden node. This can be used to close a path so address@hidden node. This can be used to close a path so that it will appear as a loop when animated. The first three types have the corresponding relative versions @samp{CLUTTER_PATH_REL_MOVE_TO}, @samp{CLUTTER_PATH_REL_LINE_TO} and address@hidden These are exactly the same except the address@hidden These are exactly the same except the coordinates are given relative to the previous node instead of as direct screen positions. You can build a path using the node adding functions such as address@hidden Alternatively the path can be described -in a string using a subset of the SVG path syntax. See address@hidden Alternatively the path can be +described in a string using a subset of the SVG path syntax. See @code{clutter-path-add-string} for details. @code{} is available since Clutter 1.0 diff --git a/doc/clutter/section-clutter-script.xml.texi b/doc/clutter/section-clutter-script.xml.texi index 2508944..01b9151 100644 --- a/doc/clutter/section-clutter-script.xml.texi +++ b/doc/clutter/section-clutter-script.xml.texi @@ -11,15 +11,15 @@ or a complete scenegraph from external definition data in forms of string buffers or files. The UI definition format is JSON, the JavaScript Object Notation as -described by RFC 4627. @code{} can load a JSON data -stream, parse it and build all the objects defined into it. Each object +described by RFC 4627. @code{} can load a JSON data +stream, parse it and build all the objects defined into it. Each object must have an "id" and a "type" properties defining the name to be used to retrieve it from @code{} with @code{clutter-script-get-object}, and the class type to be instanciated. Every other attribute will be mapped to the class properties. A @code{} holds a reference on every object it creates -from the definition data, except for the stage. Every non-actor object +from the definition data, except for the stage. Every non-actor object will be finalized when the @code{} instance holding it will be finalized, so they need to be referenced using @code{g-object-ref} in order for them to survive. @@ -33,7 +33,7 @@ A simple object might be defined as: "type" : "ClutterRectangle", "width" : 100, "height" : 100, - "color" : "#ff0000ff" + "color" : "#ff0000ff" @} @end example @@ -48,7 +48,7 @@ ClutterActor *red_button; red_button = CLUTTER_ACTOR (clutter_script_get_object (script, "red-button")); @end example -and then manipulated with the Clutter API. For every object created +and then manipulated with the Clutter API. For every object created using ClutterScript it is possible to check the id by calling @code{clutter-get-script-id}. @@ -184,12 +184,12 @@ to resolve the "target-state" key; it can be either a script id for a @code{} built by the same @code{} instance, or to a @code{} built in code and associated to the @code{} instance through the address@hidden function. If no "states" key is address@hidden function. If no "states" key is present, then the default @code{} associated to the @code{} instance will be used; the default @code{} can be set using @code{clutter-script-add-states} -using a @address@hidden name. The "warp" key can be used to warp to a -specific state instead of animating to it. State changes on signal +using a @address@hidden name. The "warp" key can be used to warp to a +specific state instead of animating to it. State changes on signal emission will not affect the signal emission chain. Clutter reserves the following names, so classes defining properties diff --git a/doc/clutter/section-clutter-scriptable.xml.texi b/doc/clutter/section-clutter-scriptable.xml.texi index 0788142..2f974e5 100644 --- a/doc/clutter/section-clutter-scriptable.xml.texi +++ b/doc/clutter/section-clutter-scriptable.xml.texi @@ -7,7 +7,7 @@ Override the UI definition parsing @section Overview The @code{} interface exposes the UI -definition parsing process to external classes. By implementing this +definition parsing process to external classes. By implementing this interface, a class can override the UI definition parsing and transform complex data types into GObject properties, or allow custom properties. diff --git a/doc/clutter/section-clutter-settings.xml.texi b/doc/clutter/section-clutter-settings.xml.texi index 3220372..0795e14 100644 --- a/doc/clutter/section-clutter-settings.xml.texi +++ b/doc/clutter/section-clutter-settings.xml.texi @@ -10,7 +10,7 @@ Clutter depends on some settings to perform operations like detecting multiple button press events, or font options to render text. Usually, Clutter will strive to use the platform's settings in order to -be as much integrated as possible. It is, however, possible to change +be as much integrated as possible. It is, however, possible to change these settings on a per-application basis, by using the @code{} singleton object and setting its properties. It is also possible, for toolkit developers, to retrieve the settings diff --git a/doc/clutter/section-clutter-shader-effect.xml.texi b/doc/clutter/section-clutter-shader-effect.xml.texi index 19ba69b..11d3c31 100644 --- a/doc/clutter/section-clutter-shader-effect.xml.texi +++ b/doc/clutter/section-clutter-shader-effect.xml.texi @@ -15,21 +15,21 @@ linking were successfull) to the buffer before painting it on screen. @section Implementing a ClutterShaderEffect Creating a sub-class of @code{} requires the -overriding of the @address@hidden virtual function from the address@hidden} class as well as the address@hidden@code{get-static-shader-source}} virtual from the +overriding of the @code{clutter-offscreen-effect-class.paint-target} +virtual function from the @code{} class as +well as the @address@hidden virtual from the @code{} class. -The @address@hidden function should return a copy -of the shader source to use. This function is only called once per -subclass of @code{} regardless of how many -instances of the effect are created. The source for the shader is -typically stored in a static const string which is returned from this +The @code{clutter-shader-effect-class.get-static-shader-source} function +should return a copy of the shader source to use. This function is only +called once per subclass of @code{} regardless of +how many instances of the effect are created. The source for the shader +is typically stored in a static const string which is returned from this function via @code{g-strdup}. The @address@hidden should set the shader's uniforms if any. This is done by calling @code{clutter-shader-effect-set-uniform-value} -or @code{clutter-shader-effect-set-uniform}. The sub-class should then +or @code{clutter-shader-effect-set-uniform}. The sub-class should then chain up to the @code{} implementation. @c (example (@ (id "ClutterShaderEffect-example-uniforms"))) diff --git a/doc/clutter/section-clutter-shader.xml.texi b/doc/clutter/section-clutter-shader.xml.texi index 2e3b244..9dd39d6 100644 --- a/doc/clutter/section-clutter-shader.xml.texi +++ b/doc/clutter/section-clutter-shader.xml.texi @@ -7,7 +7,7 @@ Programmable pipeline abstraction @section Overview @code{} is an object providing an abstraction over the -OpenGL programmable pipeline. By using @code{}s is +OpenGL programmable pipeline. By using @code{}s is possible to override the drawing pipeline by using small programs also known as "shaders". diff --git a/doc/clutter/section-clutter-stage-manager.xml.texi b/doc/clutter/section-clutter-stage-manager.xml.texi index 8dd01bc..119bf0e 100644 --- a/doc/clutter/section-clutter-stage-manager.xml.texi +++ b/doc/clutter/section-clutter-stage-manager.xml.texi @@ -10,8 +10,8 @@ Maintains the list of stages which maintains the list of currently active stages Every newly-created @code{} will cause the emission of -the @code{<"stage-added">} signal; once a @code{} has -been destroyed, the @code{<"stage-removed">} signal will be emitted +the @code{<“stage-added”>} signal; once a @code{} has +been destroyed, the @code{<“stage-removed”>} signal will be emitted @code{} is available since Clutter 0.8 diff --git a/doc/clutter/section-clutter-stage.xml.texi b/doc/clutter/section-clutter-stage.xml.texi index 8d128c9..23be5e4 100644 --- a/doc/clutter/section-clutter-stage.xml.texi +++ b/doc/clutter/section-clutter-stage.xml.texi @@ -9,17 +9,17 @@ Top level visual element to which actors are placed. @code{} is a top level 'window' on which child actors are placed and manipulated. -Backends might provide support for multiple stages. The support for this -feature can be checked at run-time using the +Backends might provide support for multiple stages. The support for +this feature can be checked at run-time using the @code{clutter-feature-available} function and the address@hidden flag. If the backend used supports -multiple stages, new @code{} instances can be created -using @code{clutter-stage-new}. These stages must be managed by the -developer using @code{clutter-actor-destroy}, which will take care of -destroying all the actors contained inside them. address@hidden flag. If the backend used +supports multiple stages, new @code{} instances can be +created using @code{clutter-stage-new}. These stages must be managed by +the developer using @code{clutter-actor-destroy}, which will take care +of destroying all the actors contained inside them. @code{} is a proxy actor, wrapping the backend-specific -implementation of the windowing system. It is possible to subclass +implementation of the windowing system. It is possible to subclass @code{}, as long as every overridden virtual function chains up to the parent class corresponding function. diff --git a/doc/clutter/section-clutter-state.xml.texi b/doc/clutter/section-clutter-state.xml.texi index eaf794a..ca59e59 100644 --- a/doc/clutter/section-clutter-state.xml.texi +++ b/doc/clutter/section-clutter-state.xml.texi @@ -8,7 +8,7 @@ State machine with animated transitions @section Overview @code{} is an object controlling the tweening of properties on multiple actors between a set of named states. address@hidden}s define how the properties are animated. If address@hidden}s define how the properties are animated. If the source_state_name for a key is NULL it is used for transition to the target state unless a specific key exists for transitioning from the current state to the requested state. @@ -48,8 +48,8 @@ clutter_state_warp_to_state (state, "base"); @end example The actor then uses the @code{} to animate through the -two states using callbacks for the @code{<"enter-event">} and address@hidden<"leave-event">} signals. +two states using callbacks for the @code{<“enter-event”>} and address@hidden<“leave-event”>} signals. @example @@ -123,9 +123,9 @@ Each element of the @emph{transitions} array follows the same rules as @code{clutter-state-set-key}. The @emph{source} and @emph{target} values control the source and target -state of the transition. The @emph{key} and @emph{animator} are mutually -exclusive. The @emph{pre-delay} and @emph{post-delay} values are -optional. +state of the transition. The @emph{key} and @emph{animator} are +mutually exclusive. The @emph{pre-delay} and @emph{post-delay} values +are optional. @c (example (@ (id "ClutterState-script-example"))) @c (title "ClutterState definition") @@ -164,6 +164,8 @@ definition of the code in the example above. @code{} is available since Clutter 1.4. address@hidden} has been deprecated in Clutter 1.12. + @section Usage @include defuns-clutter-state.xml.texi diff --git a/doc/clutter/section-clutter-table-layout.xml.texi b/doc/clutter/section-clutter-table-layout.xml.texi index 26d926b..b05b1bf 100644 --- a/doc/clutter/section-clutter-table-layout.xml.texi +++ b/doc/clutter/section-clutter-table-layout.xml.texi @@ -48,10 +48,8 @@ In order to set the layout properties when packing an actor inside a A @code{} can use animations to transition between different values of the layout management properties; the easing mode and duration used for the animations are controlled by the address@hidden<"easing-mode">} and @code{<"easing-duration">} properties and -their accessor functions. - -(The missing figure, table-layout-image address@hidden<“easing-mode”>} and @code{<“easing-duration”>} properties +and their accessor functions. @c (title "Table layout") The image shows a @code{}. diff --git a/doc/clutter/section-clutter-text-buffer.xml.texi b/doc/clutter/section-clutter-text-buffer.xml.texi index f953f06..c67abdb 100644 --- a/doc/clutter/section-clutter-text-buffer.xml.texi +++ b/doc/clutter/section-clutter-text-buffer.xml.texi @@ -13,9 +13,9 @@ A single @code{} object can be shared by multiple @code{} widgets which will then share the same text content, but not the cursor position, visibility attributes, icon etc. address@hidden} may be derived from. Such a derived class address@hidden} may be derived from. Such a derived class might allow text to be stored in an alternate location, such as -non-pageable memory, useful in the case of important passwords. Or a +non-pageable memory, useful in the case of important passwords. Or a derived class could integrate with an application's concept of undo/redo. diff --git a/doc/clutter/section-clutter-texture.xml.texi b/doc/clutter/section-clutter-texture.xml.texi index 3a94128..c9f7f48 100644 --- a/doc/clutter/section-clutter-texture.xml.texi +++ b/doc/clutter/section-clutter-texture.xml.texi @@ -14,10 +14,13 @@ The @code{clutter-texture-set-from-rgb-data} and data into texture memory and subsequently realize the texture. Note: a ClutterTexture will scale its contents to fit the bounding box -requested using @code{clutter-actor-set-size}. To display an area of a +requested using @code{clutter-actor-set-size}. To display an area of a texture without scaling, you should set the clip area using @code{clutter-actor-set-clip}. +The @code{} API is deprecated since Clutter 1.12. It +is strongly recommended to use @code{} instead. + @section Usage @include defuns-clutter-texture.xml.texi diff --git a/doc/clutter/section-clutter-timeline.xml.texi b/doc/clutter/section-clutter-timeline.xml.texi index 2530d49..b1b5dd7 100644 --- a/doc/clutter/section-clutter-timeline.xml.texi +++ b/doc/clutter/section-clutter-timeline.xml.texi @@ -15,40 +15,43 @@ signal that can be used to update the state of the actors. It is important to note that @code{} is not a generic API for calling closures after an interval; each Timeline is tied into -the master clock used to drive the frame cycle. If you need to schedule +the master clock used to drive the frame cycle. If you need to schedule a closure after an interval, see @code{clutter-threads-add-timeout} instead. Users of @code{} should connect to the address@hidden<"new-frame">} signal, which is emitted each time a timeline is -advanced during the maste clock iteration. The @code{<"new-frame">} -signal provides the time elapsed since the beginning of the timeline, in -milliseconds. A normalized progress value can be obtained by calling address@hidden By using address@hidden it is possible to obtain the wallclock -time elapsed since the last emission of the @code{<"new-frame">} signal. - -Initial state can be set up by using the @code{<"started">} signal, -while final state can be set up by using the @code{<"completed">} -signal. The @code{} guarantees the emission of at -least a single @code{<"new-frame">} signal, as well as the emission of -the @code{<"completed">} signal. address@hidden<“new-frame”>} signal, which is emitted each time a timeline +is advanced during the maste clock iteration. The address@hidden<“new-frame”>} signal provides the time elapsed since the +beginning of the timeline, in milliseconds. A normalized progress value +can be obtained by calling @code{clutter-timeline-get-progress}. By +using @code{clutter-timeline-get-delta} it is possible to obtain the +wallclock time elapsed since the last emission of the address@hidden<“new-frame”>} signal. + +Initial state can be set up by using the @code{<“started”>} signal, +while final state can be set up by using the @code{<“stopped”>} +signal. The @code{} guarantees the emission of at +least a single @code{<“new-frame”>} signal, as well as the emission +of the @code{<“completed”>} signal every time the address@hidden} reaches its @code{<“duration”>}. It is possible to connect to specific points in the timeline progress by adding @emph{markers} using @code{clutter-timeline-add-marker-at-time} -and connecting to the @code{<"marker-reached">} signal. +and connecting to the @code{<“marker-reached”>} signal. Timelines can be made to loop once they reach the end of their duration, by using @code{clutter-timeline-set-repeat-count}; a looping timeline -will still emit the @code{<"completed">} signal once it reaches the end -of its duration. +will still emit the @code{<“completed”>} signal once it reaches the +end of its duration at each repeat. If you want to be notified of the +end of the last repeat, use the @code{<“stopped”>} signal. -Timelines have a @code{<"direction">}: the default direction is +Timelines have a @code{<“direction”>}: the default direction is @samp{CLUTTER_TIMELINE_FORWARD}, and goes from 0 to the duration; it is possible to change the direction to @samp{CLUTTER_TIMELINE_BACKWARD}, -and have the timeline go from the duration to 0. The direction can be +and have the timeline go from the duration to 0. The direction can be automatically reversed when reaching completion by using the address@hidden<"auto-reverse">} property. address@hidden<“auto-reverse”>} property. Timelines are used in the Clutter animation framework by classes like @code{}, @code{}, and @@ -56,7 +59,7 @@ Timelines are used in the Clutter animation framework by classes like @section Defining Timelines in ClutterScript A @code{} can be described in @code{} -like any other object. Additionally, it is possible to define markers +like any other object. Additionally, it is possible to define markers directly inside the JSON definition by using the @emph{markers} JSON object member, such as: diff --git a/doc/clutter/section-clutter-units.xml.texi b/doc/clutter/section-clutter-units.xml.texi index 5e198f4..cb9fa7b 100644 --- a/doc/clutter/section-clutter-units.xml.texi +++ b/doc/clutter/section-clutter-units.xml.texi @@ -8,12 +8,12 @@ A logical distance unit @section Overview @code{} is a structure holding a logical distance value along with its type, expressed as a value of the address@hidden} enumeration. It is possible to use address@hidden} enumeration. It is possible to use @code{} to store a position or a size in units different than pixels, and convert them whenever needed (for instance inside the address@hidden}::@code{allocate} virtual function, or inside the address@hidden}::@code{get-preferred-width} and address@hidden}::@code{get-preferred-height} virtual functions. address@hidden virtual function, or inside the address@hidden and address@hidden virtual functions. In order to register a @code{} property, the @code{address@hidden} sub-class should be diff --git a/doc/clutter/section-clutter-version.xml.texi b/doc/clutter/section-clutter-version.xml.texi index 8363438..8816b82 100644 --- a/doc/clutter/section-clutter-version.xml.texi +++ b/doc/clutter/section-clutter-version.xml.texi @@ -13,7 +13,7 @@ at run time. Clutter adds version information to both API deprecations and additions; by definining the macros @samp{CLUTTER_VERSION_MIN_REQUIRED} and @samp{CLUTTER_VERSION_MAX_ALLOWED}, you can specify the range of Clutter -versions whose API you want to use. Functions that were deprecated +versions whose API you want to use. Functions that were deprecated before, or introduced after, this range will trigger compiler warnings. For instance, if we define the following symbols: diff --git a/doc/clutter/undocumented.texi b/doc/clutter/undocumented.texi index 32dc9fa..7a1b8b8 100644 --- a/doc/clutter/undocumented.texi +++ b/doc/clutter/undocumented.texi @@ -52,13 +52,13 @@ The following symbols, if any, have not been properly documented. @defvar clutter-actor-apply-transform-to-point @end defvar address@hidden clutter-actor-get-allocation-geometry address@hidden clutter-actor-box-alloc @end defvar address@hidden clutter-actor-get-anchor-point-gravity address@hidden clutter-actor-get-clip-to-allocation @end defvar address@hidden clutter-actor-get-clip-to-allocation address@hidden clutter-actor-get-content-repeat @end defvar @defun clutter-actor-get-content-scaling-filters _ @@ -76,25 +76,43 @@ The following symbols, if any, have not been properly documented. @defvar clutter-actor-get-paint-volume @end defvar address@hidden clutter-actor-get-pivot-point _ address@hidden defun + address@hidden clutter-actor-get-pivot-point-z address@hidden defvar + address@hidden clutter-actor-get-rotation-angle address@hidden defvar + address@hidden clutter-actor-get-scale-z address@hidden defvar + @defvar clutter-actor-get-transformed-paint-volume @end defvar @defun clutter-actor-get-transformed-position _ @end defun address@hidden clutter-actor-get-z-rotation-gravity address@hidden clutter-actor-get-translation _ address@hidden defun + address@hidden clutter-actor-get-x-expand @end defvar address@hidden clutter-actor-move-anchor-point-from-gravity address@hidden clutter-actor-get-y-expand @end defvar address@hidden clutter-actor-remove-all-transitions address@hidden clutter-actor-get-z-position @end defvar address@hidden clutter-actor-remove-constraint-by-name address@hidden clutter-actor-needs-expand @end defvar address@hidden clutter-actor-set-anchor-point-from-gravity address@hidden clutter-actor-remove-all-transitions address@hidden defvar + address@hidden clutter-actor-remove-constraint-by-name @end defvar @defvar clutter-actor-set-child-above-sibling @@ -106,6 +124,9 @@ The following symbols, if any, have not been properly documented. @defvar clutter-actor-set-clip-to-allocation @end defvar address@hidden clutter-actor-set-content-repeat address@hidden defvar + @defvar clutter-actor-set-content-scaling-filters @end defvar @@ -115,44 +136,44 @@ The following symbols, if any, have not been properly documented. @defvar clutter-actor-set-offscreen-redirect @end defvar address@hidden clutter-actor-set-scale-with-gravity address@hidden clutter-actor-set-pivot-point @end defvar address@hidden clutter-actor-set-z-rotation-from-gravity address@hidden clutter-actor-set-pivot-point-z @end defvar address@hidden clutter-align-constraint-get-align-axis address@hidden clutter-actor-set-rotation-angle @end defvar address@hidden clutter-align-constraint-set-align-axis address@hidden clutter-actor-set-scale-z @end defvar address@hidden clutter-animatable-get-initial-state address@hidden clutter-actor-set-translation @end defvar address@hidden clutter-animatable-interpolate-value address@hidden clutter-actor-set-x-expand @end defvar address@hidden clutter-animator-key-get-property-name address@hidden clutter-actor-set-y-expand @end defvar address@hidden clutter-animator-key-get-property-type _ address@hidden defun address@hidden clutter-actor-set-z-position address@hidden defvar address@hidden clutter-animator-property-get-ease-in address@hidden clutter-align-constraint-get-align-axis @end defvar address@hidden clutter-animator-property-get-interpolation address@hidden clutter-align-constraint-set-align-axis @end defvar address@hidden clutter-animator-property-set-ease-in address@hidden clutter-animatable-get-initial-state @end defvar address@hidden clutter-animator-property-set-interpolation address@hidden clutter-animatable-interpolate-value @end defvar address@hidden clutter-backend-get-font-options _ address@hidden defun address@hidden clutter-backend-get-font-options address@hidden defvar @defvar clutter-base-init @end defvar @@ -169,18 +190,6 @@ The following symbols, if any, have not been properly documented. @defvar clutter-binding-pool-override-closure @end defvar address@hidden clutter-box-layout-get-easing-duration address@hidden defvar - address@hidden clutter-box-layout-get-use-animations address@hidden defvar - address@hidden clutter-box-layout-set-easing-duration address@hidden defvar - address@hidden clutter-box-layout-set-use-animations address@hidden defvar - @defun clutter-brightness-contrast-effect-get-brightness _ @end defun @@ -202,16 +211,13 @@ The following symbols, if any, have not been properly documented. @defvar clutter-brightness-contrast-effect-set-contrast-full @end defvar address@hidden clutter-cairo-texture-get-auto-resize address@hidden clutter-cairo-clear @end defvar address@hidden clutter-cairo-texture-get-surface-size _ address@hidden defun - address@hidden clutter-cairo-texture-set-auto-resize address@hidden clutter-color-alloc @end defvar address@hidden clutter-cairo-texture-set-surface-size address@hidden clutter-color-init @end defvar @defvar clutter-container-child-get-property @@ -250,9 +256,27 @@ The following symbols, if any, have not been properly documented. @defvar clutter-drag-action-set-drag-threshold @end defvar address@hidden clutter-event-get-angle address@hidden defvar + address@hidden clutter-event-get-distance address@hidden defvar + address@hidden clutter-event-get-position address@hidden defvar + @defvar clutter-event-get-scroll-direction @end defvar address@hidden clutter-event-has-control-modifier address@hidden defvar + address@hidden clutter-event-has-shift-modifier address@hidden defvar + address@hidden clutter-event-is-pointer-emulated address@hidden defvar + @defvar clutter-flow-layout-get-column-spacing @end defvar @@ -268,23 +292,98 @@ The following symbols, if any, have not been properly documented. @defvar clutter-flow-layout-set-column-width @end defvar address@hidden clutter-gesture-action-cancel address@hidden defvar + address@hidden clutter-gesture-action-get-device address@hidden defvar + @defun clutter-gesture-action-get-motion-coords _ _ @end defun address@hidden clutter-gesture-action-get-motion-delta _ _ address@hidden defun + address@hidden clutter-gesture-action-get-n-current-points address@hidden defvar + address@hidden clutter-gesture-action-get-n-touch-points address@hidden defvar + @defun clutter-gesture-action-get-press-coords _ _ @end defun @defun clutter-gesture-action-get-release-coords _ _ @end defun address@hidden clutter-gesture-action-get-sequence address@hidden defvar + address@hidden clutter-gesture-action-get-velocity _ _ address@hidden defun + address@hidden clutter-gesture-action-set-n-touch-points address@hidden defvar + address@hidden clutter-grid-layout-attach address@hidden defvar + address@hidden clutter-grid-layout-attach-next-to address@hidden defvar + address@hidden clutter-grid-layout-get-child-at address@hidden defvar + address@hidden clutter-grid-layout-get-column-homogeneous address@hidden defvar + address@hidden clutter-grid-layout-get-column-spacing address@hidden defvar + address@hidden clutter-grid-layout-get-orientation address@hidden defvar + address@hidden clutter-grid-layout-get-row-homogeneous address@hidden defvar + address@hidden clutter-grid-layout-get-row-spacing address@hidden defvar + address@hidden clutter-grid-layout-insert-column address@hidden defvar + address@hidden clutter-grid-layout-insert-next-to address@hidden defvar + address@hidden clutter-grid-layout-insert-row address@hidden defvar + address@hidden clutter-grid-layout-new address@hidden defvar + address@hidden clutter-grid-layout-set-column-homogeneous address@hidden defvar + address@hidden clutter-grid-layout-set-column-spacing address@hidden defvar + address@hidden clutter-grid-layout-set-orientation address@hidden defvar + address@hidden clutter-grid-layout-set-row-homogeneous address@hidden defvar + address@hidden clutter-grid-layout-set-row-spacing address@hidden defvar + @defvar clutter-image-error-quark @end defvar @defvar clutter-input-device-get-associated-device @end defvar address@hidden clutter-input-device-get-device-coords _ address@hidden defun address@hidden clutter-input-device-get-coords address@hidden defvar @defvar clutter-input-device-get-device-mode @end defvar @@ -310,28 +409,46 @@ The following symbols, if any, have not been properly documented. @defun clutter-input-device-keycode-to-evdev _ _ @end defun address@hidden clutter-input-device-sequence-get-grabbed-actor address@hidden defvar + address@hidden clutter-input-device-sequence-grab address@hidden defvar + address@hidden clutter-input-device-sequence-ungrab address@hidden defvar + @defvar clutter-input-device-update-from-event @end defvar address@hidden clutter-knot-equal address@hidden clutter-interval-is-valid @end defvar address@hidden clutter-layout-manager-begin-animation address@hidden clutter-keyframe-transition-clear @end defvar address@hidden clutter-layout-manager-child-get-property address@hidden clutter-keyframe-transition-get-n-key-frames @end defvar address@hidden clutter-layout-manager-child-set-property address@hidden clutter-keyframe-transition-new @end defvar address@hidden clutter-layout-manager-end-animation address@hidden clutter-keyframe-transition-set-key-frame @end defvar address@hidden clutter-layout-manager-find-child-property address@hidden clutter-keyframe-transition-set-values @end defvar address@hidden clutter-layout-manager-get-animation-progress address@hidden clutter-knot-equal address@hidden defvar + address@hidden clutter-layout-manager-child-get-property address@hidden defvar + address@hidden clutter-layout-manager-child-set-property address@hidden defvar + address@hidden clutter-layout-manager-find-child-property @end defvar @defvar clutter-layout-manager-get-child-meta @@ -349,12 +466,6 @@ The following symbols, if any, have not been properly documented. @defvar clutter-layout-manager-set-container @end defvar address@hidden clutter-media-get-subtitle-font-name address@hidden defvar - address@hidden clutter-media-set-subtitle-font-name address@hidden defvar - @defun clutter-offscreen-effect-get-target-size _ @end defun @@ -367,12 +478,63 @@ The following symbols, if any, have not been properly documented. @defvar clutter-paint-volume-set-from-allocation @end defvar address@hidden clutter-pan-action-get-acceleration-factor address@hidden defvar + address@hidden clutter-pan-action-get-deceleration address@hidden defvar + address@hidden clutter-pan-action-get-interpolate address@hidden defvar + address@hidden clutter-pan-action-get-interpolated-coords _ address@hidden defun + address@hidden clutter-pan-action-get-interpolated-delta _ address@hidden defun + address@hidden clutter-pan-action-get-pan-axis address@hidden defvar + address@hidden clutter-pan-action-new address@hidden defvar + address@hidden clutter-pan-action-set-acceleration-factor address@hidden defvar + address@hidden clutter-pan-action-set-deceleration address@hidden defvar + address@hidden clutter-pan-action-set-interpolate address@hidden defvar + address@hidden clutter-pan-action-set-pan-axis address@hidden defvar + address@hidden clutter-point-alloc address@hidden defvar + address@hidden clutter-point-distance _ _ address@hidden defun + address@hidden clutter-point-equals address@hidden defvar + address@hidden clutter-point-init address@hidden defvar + address@hidden clutter-point-zero address@hidden defvar + @defvar clutter-property-transition-get-property-name @end defvar @defvar clutter-property-transition-set-property-name @end defvar address@hidden clutter-rotate-action-new address@hidden defvar + @defvar clutter-script-error-quark @end defvar @@ -382,6 +544,18 @@ The following symbols, if any, have not been properly documented. @defvar clutter-script-set-translation-domain @end defvar address@hidden clutter-scroll-actor-get-scroll-mode address@hidden defvar + address@hidden clutter-scroll-actor-new address@hidden defvar + address@hidden clutter-scroll-actor-scroll-to-point address@hidden defvar + address@hidden clutter-scroll-actor-set-scroll-mode address@hidden defvar + @defvar clutter-shader-effect-set-shader-source @end defvar @@ -391,6 +565,15 @@ The following symbols, if any, have not been properly documented. @defvar clutter-shader-error-quark @end defvar address@hidden clutter-size-alloc address@hidden defvar + address@hidden clutter-size-equals address@hidden defvar + address@hidden clutter-size-init address@hidden defvar + @defvar clutter-stage-get-motion-events-enabled @end defvar @@ -406,76 +589,88 @@ The following symbols, if any, have not been properly documented. @defvar clutter-stage-set-throttle-motion-events @end defvar address@hidden clutter-state-key-get-source-state-name address@hidden clutter-table-layout-get-column-count @end defvar address@hidden clutter-state-key-get-target-state-name address@hidden clutter-table-layout-get-column-spacing @end defvar address@hidden clutter-table-layout-get-column-count address@hidden clutter-table-layout-get-row-spacing @end defvar address@hidden clutter-table-layout-get-column-spacing address@hidden clutter-table-layout-set-column-spacing @end defvar address@hidden clutter-table-layout-get-easing-duration address@hidden clutter-table-layout-set-row-spacing @end defvar address@hidden clutter-table-layout-get-easing-mode address@hidden clutter-text-buffer-emit-deleted-text @end defvar address@hidden clutter-table-layout-get-row-spacing address@hidden clutter-text-buffer-emit-inserted-text @end defvar address@hidden clutter-table-layout-get-use-animations address@hidden clutter-text-get-font-description @end defvar address@hidden clutter-table-layout-set-column-spacing address@hidden clutter-text-get-selected-text-color @end defvar address@hidden clutter-table-layout-set-easing-duration address@hidden clutter-text-set-selected-text-color @end defvar address@hidden clutter-table-layout-set-easing-mode address@hidden clutter-texture-error-quark @end defvar address@hidden clutter-table-layout-set-row-spacing address@hidden clutter-timeline-get-cubic-bezier-progress @end defvar address@hidden clutter-table-layout-set-use-animations address@hidden clutter-timeline-set-cubic-bezier-progress @end defvar address@hidden clutter-text-buffer-emit-deleted-text address@hidden clutter-timeline-set-step-progress @end defvar address@hidden clutter-text-buffer-emit-inserted-text address@hidden clutter-transition-get-remove-on-complete @end defvar address@hidden clutter-text-get-font-description address@hidden clutter-transition-group-add-transition @end defvar address@hidden clutter-text-get-selected-text-color address@hidden clutter-transition-group-new @end defvar address@hidden clutter-text-set-selected-text-color address@hidden clutter-transition-group-remove-all @end defvar address@hidden clutter-texture-error-quark address@hidden clutter-transition-group-remove-transition @end defvar address@hidden clutter-texture-get-filter-quality address@hidden clutter-transition-set-from-value @end defvar address@hidden clutter-texture-get-keep-aspect-ratio address@hidden clutter-transition-set-remove-on-complete @end defvar address@hidden clutter-texture-set-keep-aspect-ratio address@hidden clutter-transition-set-to-value @end defvar address@hidden clutter-transition-get-remove-on-complete address@hidden clutter-vertex-alloc @end defvar address@hidden clutter-transition-set-remove-on-complete address@hidden clutter-zoom-action-get-focal-point address@hidden defvar + address@hidden clutter-zoom-action-get-transformed-focal-point address@hidden defvar + address@hidden clutter-zoom-action-get-zoom-axis address@hidden defvar + address@hidden clutter-zoom-action-new address@hidden defvar + address@hidden clutter-zoom-action-set-zoom-axis @end defvar -- 2.1.0