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> ]
+ [