ac9aa06fcf
* clutter/clutter-script-private.h: * clutter/clutter-script.h: * clutter/clutter-script.c: Add licensing information to the newly added files. * clutter/clutter-script.c: Support creating behaviours with ClutterScript. ClutterAlpha objects are implicit, but timelines can be both explicit objects using their id or implicit objects. Make the property resolution and translation more robust. Support the pixbuf property. * tests/test-script.c: Test the newly added features. * docs/reference/clutter-docs.sgml: * docs/reference/clutter-sections.txt: Add ClutterScript.
229 lines
6.8 KiB
XML
229 lines
6.8 KiB
XML
<?xml version="1.0"?>
|
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
|
<!ENTITY version SYSTEM "version.xml">
|
|
<!ENTITY clutter-SubclassingActor SYSTEM "xml/subclassing-ClutterActor.sgml">
|
|
<!ENTITY clutter-animation SYSTEM "xml/clutter-animation.sgml">
|
|
]>
|
|
|
|
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
|
|
<bookinfo>
|
|
<title>Clutter &version; Reference Manual</title>
|
|
<releaseinfo>Version &version;</releaseinfo>
|
|
|
|
<copyright>
|
|
<year>2007</year>
|
|
<holder>OpenedHand LTD</holder>
|
|
</copyright>
|
|
|
|
<legalnotice>
|
|
<para>
|
|
Permission is granted to copy, distribute and/or modify this
|
|
document under the terms of the <citetitle>GNU Free
|
|
Documentation License</citetitle>, Version 1.1 or any later
|
|
version published by the Free Software Foundation with no
|
|
Invariant Sections, no Front-Cover Texts, and no Back-Cover
|
|
Texts. You may obtain a copy of the <citetitle>GNU Free
|
|
Documentation License</citetitle> from the Free Software
|
|
Foundation by visiting <ulink type="http"
|
|
url="http://www.fsf.org">their Web site</ulink> or by writing
|
|
to:
|
|
|
|
<address>
|
|
The Free Software Foundation, Inc.,
|
|
<street>59 Temple Place</street> - Suite 330,
|
|
<city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>,
|
|
<country>USA</country>
|
|
</address>
|
|
</para>
|
|
</legalnotice>
|
|
</bookinfo>
|
|
|
|
<part id="clutter">
|
|
<title>Clutter Overview</title>
|
|
|
|
<partintro>
|
|
|
|
<para>
|
|
|
|
Clutter is a GObject based library for creating fast, visually
|
|
rich graphical user interfaces.
|
|
|
|
</para>
|
|
<para>
|
|
|
|
Clutter semantics work by having a stage (a window) and then
|
|
adding actors (widgets) to the stage and manipulating via the
|
|
actor api. Actors can contain child actors (ClutterGroup for
|
|
example) and be manipulated as a whole.
|
|
|
|
</para>
|
|
<para>
|
|
|
|
Animations and visual effects can be created via the use of
|
|
timelines and behaviours. Timelines provide accurate frame based
|
|
animations. Behaviours further extend this by taking a timeline, a
|
|
control function (ClutterAlpha) and then applying to actors as to
|
|
modify a property as a function of time.
|
|
|
|
</para>
|
|
|
|
</partintro>
|
|
</part>
|
|
|
|
<part id="clutterbase">
|
|
<title>Clutter Core Reference</title>
|
|
|
|
<chapter>
|
|
<title>Abstract Classes and Interfaces</title>
|
|
<xi:include href="xml/clutter-actor.xml"/>
|
|
<xi:include href="xml/clutter-container.xml"/>
|
|
<xi:include href="xml/clutter-layout.xml"/>
|
|
<xi:include href="xml/clutter-box.xml"/>
|
|
<xi:include href="xml/clutter-media.xml"/>
|
|
</chapter>
|
|
|
|
<chapter>
|
|
<title>Base Actors</title>
|
|
<xi:include href="xml/clutter-stage.xml"/>
|
|
<xi:include href="xml/clutter-rectangle.xml"/>
|
|
<xi:include href="xml/clutter-texture.xml"/>
|
|
<xi:include href="xml/clutter-clone-texture.xml"/>
|
|
<xi:include href="xml/clutter-label.xml"/>
|
|
<xi:include href="xml/clutter-entry.xml"/>
|
|
</chapter>
|
|
|
|
<chapter>
|
|
<title>Container Actors</title>
|
|
|
|
<xi:include href="xml/clutter-group.xml"/>
|
|
<xi:include href="xml/clutter-hbox.xml"/>
|
|
<xi:include href="xml/clutter-vbox.xml"/>
|
|
</chapter>
|
|
|
|
</part>
|
|
|
|
<part id="clutteranimation">
|
|
<title>Clutter Animation Support</title>
|
|
|
|
|
|
<chapter>
|
|
<title>Base Classes</title>
|
|
|
|
<xi:include href="xml/clutter-timeline.xml"/>
|
|
<xi:include href="xml/clutter-alpha.xml"/>
|
|
<xi:include href="xml/clutter-behaviour.xml"/>
|
|
</chapter>
|
|
|
|
<chapter>
|
|
<title>Clutter Behaviours</title>
|
|
|
|
<xi:include href="xml/clutter-behaviour-bspline.xml"/>
|
|
<xi:include href="xml/clutter-behaviour-depth.xml"/>
|
|
<xi:include href="xml/clutter-behaviour-ellipse.xml"/>
|
|
<xi:include href="xml/clutter-behaviour-opacity.xml"/>
|
|
<xi:include href="xml/clutter-behaviour-path.xml"/>
|
|
<xi:include href="xml/clutter-behaviour-rotate.xml"/>
|
|
<xi:include href="xml/clutter-behaviour-scale.xml"/>
|
|
</chapter>
|
|
|
|
<chapter>
|
|
<title>Simple Effects</title>
|
|
|
|
<xi:include href="xml/clutter-effect.xml"/>
|
|
</chapter>
|
|
|
|
</part>
|
|
|
|
<part>
|
|
<title>Clutter Tools</title>
|
|
|
|
<xi:include href="xml/clutter-main.xml"/>
|
|
<xi:include href="xml/clutter-event.xml"/>
|
|
<xi:include href="xml/clutter-color.xml"/>
|
|
<xi:include href="xml/clutter-util.xml"/>
|
|
<xi:include href="xml/clutter-fixed.xml"/>
|
|
<xi:include href="xml/clutter-version.xml"/>
|
|
<xi:include href="xml/clutter-units.xml"/>
|
|
<xi:include href="xml/clutter-script.xml"/>
|
|
</part>
|
|
|
|
<part>
|
|
<title>Clutter Backends</title>
|
|
|
|
<partintro>
|
|
<para>Clutter is usually compiled against a specific drawing backend.
|
|
All backends have a common API for querying the underlying platform,
|
|
and some of them might have specific API exposed by Clutter.</para>
|
|
</partintro>
|
|
|
|
<xi:include href="xml/clutter-backend.xml"/>
|
|
<xi:include href="xml/clutter-glx.xml"/>
|
|
|
|
</part>
|
|
|
|
<part>
|
|
<title>Additional Documentation</title>
|
|
|
|
<partintro>
|
|
<para>This section contains additional useful documentation for
|
|
developing with Clutter.</para>
|
|
</partintro>
|
|
|
|
&clutter-SubclassingActor;
|
|
|
|
&clutter-animation;
|
|
|
|
</part>
|
|
|
|
<index>
|
|
<title>Index</title>
|
|
</index>
|
|
<index role="deprecated">
|
|
<title>Index of deprecated symbols</title>
|
|
</index>
|
|
<index role="0.2">
|
|
<title>Index of new symbols in 0.2</title>
|
|
</index>
|
|
<index role="0.4">
|
|
<title>Index of new symbols in 0.4</title>
|
|
</index>
|
|
<index role="0.6">
|
|
<title>Index of new symbols in 0.6</title>
|
|
</index>
|
|
|
|
<appendix id="license">
|
|
<title>License</title>
|
|
|
|
<para>
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the <citetitle>GNU Library General
|
|
Public License</citetitle> as published by the Free Software
|
|
Foundation; either version 2 of the License, or (at your option)
|
|
any later version.
|
|
</para>
|
|
|
|
<para>
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
<citetitle>GNU Library General Public License</citetitle> for
|
|
more details.
|
|
</para>
|
|
|
|
<para>
|
|
You may obtain a copy of the <citetitle>GNU Library General
|
|
Public License</citetitle> from the Free Software Foundation by
|
|
visiting <ulink type="http" url="http://www.fsf.org">their Web
|
|
site</ulink> or by writing to:
|
|
|
|
<address>
|
|
Free Software Foundation, Inc.
|
|
<street>59 Temple Place</street> - Suite 330
|
|
<city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>
|
|
<country>USA</country>
|
|
</address>
|
|
</para>
|
|
</appendix>
|
|
|
|
</book>
|