mirror of
https://github.com/brl/mutter.git
synced 2024-11-27 02:20:43 -05:00
6f6950f4cc
Fix the ClutterBehaviourBspline header file. Fix typos in ClutterBehaviourRotate API documentation.
140 lines
4.8 KiB
XML
140 lines
4.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">
|
|
]>
|
|
|
|
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
|
|
<bookinfo>
|
|
<title>Clutter &version; Reference Manual</title>
|
|
<releaseinfo>Version &version;</releaseinfo>
|
|
|
|
<copyright>
|
|
<year>2006</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>
|
|
|
|
<chapter>
|
|
<title>Clutter Overview</title>
|
|
<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>
|
|
</chapter>
|
|
<chapter>
|
|
<title>Clutter Actors And Objects</title>
|
|
<xi:include href="xml/clutter-actor.xml"/>
|
|
<xi:include href="xml/clutter-stage.xml"/>
|
|
<xi:include href="xml/clutter-group.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-timeline.xml"/>
|
|
<xi:include href="xml/clutter-media.xml"/>
|
|
</chapter>
|
|
<chapter>
|
|
<title>Clutter Behaviours</title>
|
|
<xi:include href="xml/clutter-alpha.xml"/>
|
|
<xi:include href="xml/clutter-behaviour.xml"/>
|
|
<xi:include href="xml/clutter-behaviour-bspline.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>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"/>
|
|
</chapter>
|
|
<chapter>
|
|
<title>Clutter Backends</title>
|
|
<xi:include href="xml/clutter-backend.xml"/>
|
|
<xi:include href="xml/clutter-glx.xml"/>
|
|
</chapter>
|
|
|
|
<index></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>
|