isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-12-29 14:22:13 +00:00
Code Issues Packages Projects Releases Wiki Activity
b6a931c8d9
mutter/doc/reference/clutter/clutter2-docs.xml.in

293 lines
9.6 KiB
XML
Raw Normal View History

2006-06-22 Matthew Allum <mallum@openedhand.com> * clutter/clutter-actor.c: * clutter/clutter-clone-texture.c: * clutter/clutter-color.c: * clutter/clutter-event.c: * clutter/clutter-group.c: * clutter/clutter-label.c: * clutter/clutter-main.c: * clutter/clutter-media.c: * clutter/clutter-rectangle.c: * clutter/clutter-stage.c: * clutter/clutter-texture.c: * clutter/clutter-timeline.c: * clutter/clutter-util.c: * clutter/clutter-video-texture.c: * configure.ac: Documentation updates - add section headers.
2006-06-21 22:34:25 +00:00
<?xml version="1.0"?>
2008-02-15 Tomas Frydrych <tf@openedhand.com> * clutter-docs.sgml: Build instructions for Linux and Windows.
2008-02-15 16:17:31 +00:00
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
2006-06-22 Matthew Allum <mallum@openedhand.com> * clutter/clutter-actor.c: * clutter/clutter-clone-texture.c: * clutter/clutter-color.c: * clutter/clutter-event.c: * clutter/clutter-group.c: * clutter/clutter-label.c: * clutter/clutter-main.c: * clutter/clutter-media.c: * clutter/clutter-rectangle.c: * clutter/clutter-stage.c: * clutter/clutter-texture.c: * clutter/clutter-timeline.c: * clutter/clutter-util.c: * clutter/clutter-video-texture.c: * configure.ac: Documentation updates - add section headers.
2006-06-21 22:34:25 +00:00
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
[docs] Rework the API reference version generation Clutter copies the gtk-doc from the usual gtk+ template, and has a version.xml.in containing only: @VERSION@ Without a newline at the end. Unfortunately, it appears that autoconf has started adding a newline to the generated version.xml which then is used as the payload for the "version" XML entity. Instead of using a secondary file we can make configure generate the whole clutter-docs.xml and cogl-docs.xml files from a template; this way we also get the ability to substitute more autoconf variables into the documentation -- if needs be.
2009-06-01 16:35:41 +00:00
<!ENTITY version "@VERSION@">
2006-06-22 Matthew Allum <mallum@openedhand.com> * clutter/clutter-actor.c: * clutter/clutter-clone-texture.c: * clutter/clutter-color.c: * clutter/clutter-event.c: * clutter/clutter-group.c: * clutter/clutter-label.c: * clutter/clutter-main.c: * clutter/clutter-media.c: * clutter/clutter-rectangle.c: * clutter/clutter-stage.c: * clutter/clutter-texture.c: * clutter/clutter-timeline.c: * clutter/clutter-util.c: * clutter/clutter-video-texture.c: * configure.ac: Documentation updates - add section headers.
2006-06-21 22:34:25 +00:00
]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
[docs] Remove the version number from the title The version number in the title made sense when we were breaking API with every minor release. Now that we're API stable we can drop that and make the output in Devhelp and on the website slightly more good looking.
2009-08-13 15:15:04 +00:00
<title>Clutter Reference Manual</title>
<releaseinfo>for Clutter &version;</releaseinfo>
2006-06-22 Matthew Allum <mallum@openedhand.com> * clutter-docs.sgml: Add copyright info.
2006-06-22 09:06:24 +00:00
<copyright>
docs: Add 2010 in COGL's Copyright notice While at it, fix the usage of <year> in <copyright> to let the stylesheet do the collation when having several years.
2010-02-08 19:18:36 +00:00
<year>2006</year>
<year>2007</year>
<year>2008</year>
2006-06-22 Matthew Allum <mallum@openedhand.com> * clutter-docs.sgml: Add copyright info.
2006-06-22 09:06:24 +00:00
<holder>OpenedHand LTD</holder>
</copyright>
Remove CloneTexture from the API ClutterClone supercedes ClutterCloneTexture, since it can clone every kind of actor -- including composite ones. This is another "brain surgery with a shotgun" kind of commit: it removes CloneTexture and updates every test case using CloneTexture to ClutterClone. The API fallout is minimal, luckily for us.
2009-01-27 15:18:45 +00:00
<copyright>
docs: Add 2010 in COGL's Copyright notice While at it, fix the usage of <year> in <copyright> to let the stylesheet do the collation when having several years.
2010-02-08 19:18:36 +00:00
<year>2009</year>
<year>2010</year>
docs: Update the API reference Add all the new symbols.
2012-02-02 14:51:17 +00:00
<year>2011</year>
<year>2012</year>
Remove CloneTexture from the API ClutterClone supercedes ClutterCloneTexture, since it can clone every kind of actor -- including composite ones. This is another "brain surgery with a shotgun" kind of commit: it removes CloneTexture and updates every test case using CloneTexture to ClutterClone. The API fallout is minimal, luckily for us.
2009-01-27 15:18:45 +00:00
<holder>Intel Corporation</holder>
</copyright>
2006-06-22 Matthew Allum <mallum@openedhand.com> * clutter-docs.sgml: Add copyright info.
2006-06-22 09:06:24 +00:00
<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>
2006-06-22 Matthew Allum <mallum@openedhand.com> * clutter/clutter-actor.c: * clutter/clutter-clone-texture.c: * clutter/clutter-color.c: * clutter/clutter-event.c: * clutter/clutter-group.c: * clutter/clutter-label.c: * clutter/clutter-main.c: * clutter/clutter-media.c: * clutter/clutter-rectangle.c: * clutter/clutter-stage.c: * clutter/clutter-texture.c: * clutter/clutter-timeline.c: * clutter/clutter-util.c: * clutter/clutter-video-texture.c: * configure.ac: Documentation updates - add section headers.
2006-06-21 22:34:25 +00:00
</bookinfo>
2008-06-26 Emmanuele Bassi <ebassi@openedhand.com> * clutter/clutter-overview.xml: Split the overview into its own file, so we gtk-doc can linkify all class names. * clutter/building-clutter.xml: Split the building instructions into its own file, for better maintainability. * clutter/clutter-animation.xml: * clutter/creating-behaviours.xml: * clutter/subclassing-ClutterActor.xml: Rename from SGML to XML; these were not SGML files anyway, but templates. * clutter/clutter-docs.sgml: Use XInclude instead of the ugly entities hack. * clutter/Makefile.am: Update the build.
2008-06-26 09:02:58 +00:00
<xi:include href="xml/clutter-overview.xml"/>
<xi:include href="xml/building-clutter.xml"/>
[docs] Document envvars and command line switches Clutter uses checks on various environment variables and installs various command line switches. The API reference should list them and document them both.
2009-02-23 13:44:03 +00:00
<xi:include href="xml/running-clutter.xml"/>
2008-02-13 Matthew Allum <mallum@openedhand.com> * Makefile.am: * clutter-docs.sgml: Add new appendix + FIXME for building * creating-your-own-behaviours.sgml: Add new initial doc on custom behaviour creation. * subclassing-ClutterActor.sgml: Add FIXME notes.
2008-02-13 16:46:07 +00:00
2007-06-14 Emmanuele Bassi <ebassi@openedhand.com> * clutter/clutter-box.[ch]: Base class for layout containers. * clutter/clutter-hbox.[ch]: Horizontal box actor. * clutter/clutter-vbox.[ch]: Vertical box actor. * clutter/clutter.h: * clutter/Makefile.am: Build glue * tests/Makefile.am: * tests/test-boxes.c: Test suite for ClutterBox API and implementations.
2007-06-14 15:29:52 +00:00
<part id="clutterbase">
<title>Clutter Core Reference</title>
<chapter>
2007-11-23 Emmanuele Bassi <ebassi@openedhand.com> * clutter-docs.sgml: Shuffle around non-actor classes.
2007-11-23 17:25:50 +00:00
<title>Abstract classes and interfaces</title>
2007-06-14 Emmanuele Bassi <ebassi@openedhand.com> * clutter/clutter-box.[ch]: Base class for layout containers. * clutter/clutter-hbox.[ch]: Horizontal box actor. * clutter/clutter-vbox.[ch]: Vertical box actor. * clutter/clutter.h: * clutter/Makefile.am: Build glue * tests/Makefile.am: * tests/test-boxes.c: Test suite for ClutterBox API and implementations.
2007-06-14 15:29:52 +00:00
<xi:include href="xml/clutter-actor.xml"/>
<xi:include href="xml/clutter-container.xml"/>
2008-06-12 Emmanuele Bassi <ebassi@openedhand.com> * clutter/clutter-docs.sgml: Clean up. * clutter/clutter-sections.txt: Add missing new symbols. * clutter/clutter.types: Add ClutterChildMeta type.
2008-06-12 11:41:03 +00:00
<xi:include href="xml/clutter-child-meta.xml"/>
[layout, docs] Add layout managers sections Add LayoutManager and its subclasses, and the Box actor to the gtk-doc machinery needed to generate the API reference.
2009-09-15 15:24:47 +00:00
<xi:include href="xml/clutter-layout-manager.xml"/>
[layout] Add LayoutMeta Instead of overloading ClutterChildMeta with both container and layout metadata and delegate to every LayoutManager implementation to keep a backpointer to the layout manager instance, we can simply subclass ChildMeta into LayoutMeta and presto! everything works out pretty well for everyone.
2009-09-15 16:37:11 +00:00
<xi:include href="xml/clutter-layout-meta.xml"/>
Miscellaneous documentation fixes
2010-05-19 15:10:05 +00:00
<xi:include href="xml/clutter-actor-meta.xml"/>
docs: Add ClickAction to the API reference And clean up the reference index.
2010-05-25 10:53:59 +00:00
<xi:include href="xml/clutter-action.xml"/>
<xi:include href="xml/clutter-constraint.xml"/>
docs: Effects fixes for the API reference
2010-06-03 13:34:41 +00:00
<xi:include href="xml/clutter-effect.xml"/>
docs: Update the API reference Add all the new symbols.
2012-02-02 14:51:17 +00:00
<xi:include href="xml/clutter-content.xml"/>
2007-06-14 Emmanuele Bassi <ebassi@openedhand.com> * clutter/clutter-box.[ch]: Base class for layout containers. * clutter/clutter-hbox.[ch]: Horizontal box actor. * clutter/clutter-vbox.[ch]: Vertical box actor. * clutter/clutter.h: * clutter/Makefile.am: Build glue * tests/Makefile.am: * tests/test-boxes.c: Test suite for ClutterBox API and implementations.
2007-06-14 15:29:52 +00:00
</chapter>
<chapter>
2007-11-23 Emmanuele Bassi <ebassi@openedhand.com> * clutter-docs.sgml: Shuffle around non-actor classes.
2007-11-23 17:25:50 +00:00
<title>Base actors</title>
docs: Move deprecated sections to the proper location
2012-01-03 14:51:37 +00:00
<xi:include href="xml/clutter-stage.xml"/>
Remove CloneTexture from the API ClutterClone supercedes ClutterCloneTexture, since it can clone every kind of actor -- including composite ones. This is another "brain surgery with a shotgun" kind of commit: it removes CloneTexture and updates every test case using CloneTexture to ClutterClone. The API fallout is minimal, luckily for us.
2009-01-27 15:18:45 +00:00
<xi:include href="xml/clutter-clone.xml"/>
[docs] Update the API reference Add all the unused API to the sections file; there are still some undocumented bits, but clutter-unused.txt is empty for the time being. Also, add ClutterText to the main XML document and remove ClutterLabel and ClutterEntry.
2008-12-11 15:01:28 +00:00
<xi:include href="xml/clutter-text.xml"/>
docs: Add ScrollActor to the API reference
2012-04-25 14:48:10 +00:00
<xi:include href="xml/clutter-scroll-actor.xml"/>
2007-06-14 Emmanuele Bassi <ebassi@openedhand.com> * clutter/clutter-box.[ch]: Base class for layout containers. * clutter/clutter-hbox.[ch]: Horizontal box actor. * clutter/clutter-vbox.[ch]: Vertical box actor. * clutter/clutter.h: * clutter/Makefile.am: Build glue * tests/Makefile.am: * tests/test-boxes.c: Test suite for ClutterBox API and implementations.
2007-06-14 15:29:52 +00:00
</chapter>
[layout, docs] Add layout managers sections Add LayoutManager and its subclasses, and the Box actor to the gtk-doc machinery needed to generate the API reference.
2009-09-15 15:24:47 +00:00
<chapter>
<title>Layout managers</title>
<xi:include href="xml/clutter-fixed-layout.xml"/>
<xi:include href="xml/clutter-bin-layout.xml"/>
[layout] Initial implementation of FlowLayout FlowLayout is a layout manager that arranges its children in a reflowing line; the orientation controls the major axis for the layout: horizontal, for reflow on the Y axis, and vertical, for reflow on the X axis.
2009-09-18 16:28:02 +00:00
<xi:include href="xml/clutter-flow-layout.xml"/>
layout: Document BoxLayout Add BoxLayout to the API reference.
2009-10-13 11:15:25 +00:00
<xi:include href="xml/clutter-box-layout.xml"/>
Add ClutterTableLayout, a layout showing children in rows and columns A TableLayout is a layout manager that allocates its children in rows and columns. Each child is assigned to a cell (or more if a cell span is set). The supported child properties are: • x-expand and y-expand: if this cell with try to allocate the available extra space for the table. • x-fill and y-fill: if the child will get all the space available in the cell. • x-align and y-align: if the child does not fill the cell, then where the child will be aligned inside the cell. • row-span and col-span: number of cells the child will allocate for itself. Also, the TableLayout has row-spacing and col-spacing for specifying the space in pixels between rows and between columns. We also include a simple test of the layout manager, and the documentation updates. The TableLayout was implemented starting from MxTable and ClutterBoxLayout. http://bugzilla.clutter-project.org/show_bug.cgi?id=2038 Signed-off-by: Emmanuele Bassi <ebassi@linux.intel.com>
2010-03-18 16:02:31 +00:00
<xi:include href="xml/clutter-table-layout.xml"/>
Add ClutterGridLayout ClutterGridLayout is port of GtkGrid to a Clutter layout manager. All the logic is taken from gtkgrid.c, so all the credits should go to Matthias Clasen for writing this nice piece of code. ClutterGridLayout supports adding children with it's own methods GridLayout.attach() and GridLayout.attach_next_to() as well as Actor.add_child() and friends. The latter adds children in a similar fashion to ClutterBoxLayout https://bugzilla.gnome.org/show_bug.cgi?id=677372
2012-06-03 03:02:31 +00:00
<xi:include href="xml/clutter-grid-layout.xml"/>
2007-06-14 Emmanuele Bassi <ebassi@openedhand.com> * clutter/clutter-box.[ch]: Base class for layout containers. * clutter/clutter-hbox.[ch]: Horizontal box actor. * clutter/clutter-vbox.[ch]: Vertical box actor. * clutter/clutter.h: * clutter/Makefile.am: Build glue * tests/Makefile.am: * tests/test-boxes.c: Test suite for ClutterBox API and implementations.
2007-06-14 15:29:52 +00:00
</chapter>
Miscellaneous documentation fixes
2010-05-19 15:10:05 +00:00
<chapter>
Add SnapConstraint A SnapConstraint is a constraint that "snaps" the edges of two actors together.
2010-11-10 16:37:34 +00:00
<title>Actions</title>
Miscellaneous documentation fixes
2010-05-19 15:10:05 +00:00
docs: Add ClickAction to the API reference And clean up the reference index.
2010-05-25 10:53:59 +00:00
<xi:include href="xml/clutter-click-action.xml"/>
Miscellaneous documentation fixes
2010-05-19 15:10:05 +00:00
<xi:include href="xml/clutter-drag-action.xml"/>
docs: Document ClutterDropAction And add it to the API reference. https://bugzilla.gnome.org/show_bug.cgi?id=652842
2011-06-17 16:22:01 +00:00
<xi:include href="xml/clutter-drop-action.xml"/>
docs: Add the new actions to the API reference http://bugzilla.clutter-project.org/show_bug.cgi?id=2585
2011-06-10 13:47:16 +00:00
<xi:include href="xml/clutter-gesture-action.xml"/>
pan-action: add PanAction, to handle panning in scrollable actors PanAction is a GestureAction-subclass that implements the panning concept for scrollable actors, with the ability to emit interpolated signals to emulate the kinetic inertia of the panning. PanAction provides: • pan signal, notifying users of the panning gesture status; • pan-stopped signal, emitted at the end of the interpolated phase of the panning gesture, if enabled; • pan-axis property, to allow constraining the dragging to a specific axis; • interpolated property, to enable or disable the inertial behaviour; • deceleration property, to customize the rate at which the momentum of the panning will be slowed down; • acceleration-factor property, applied to the inertial momentum when starting the interpolated sequence. An interactive test is also provided. https://bugzilla.gnome.org/show_bug.cgi?id=681648
2012-08-25 14:23:23 +00:00
<xi:include href="xml/clutter-pan-action.xml"/>
docs: Add the new actions to the API reference http://bugzilla.clutter-project.org/show_bug.cgi?id=2585
2011-06-10 13:47:16 +00:00
<xi:include href="xml/clutter-swipe-action.xml"/>
docs: Add missing section for ClutterRotateAction
2012-07-18 21:15:13 +00:00
<xi:include href="xml/clutter-rotate-action.xml"/>
docs: Add ZoomAction to the API reference
2012-08-20 17:29:31 +00:00
<xi:include href="xml/clutter-zoom-action.xml"/>
tap-action: Add TapAction, to handle mouse/touch tapping TapAction is a GestureAction-subclass that handles clicks and tap gestures. It is meant to provide a replacement for ClickAction using GestureAction: • it handles events trasparently without capturing them, so that it can coexists with other GestureActions; • the ::tap signal is not emitted if the drag threshold is exceeded; • building upon GestureAction the amount of code is greatly reduced. TapAction provides: • tap signal, notifying users when a tap has been performed. The image-content example program has been updated replacing its ClickAction usage with TapAction. https://bugzilla.gnome.org/show_bug.cgi?id=683948
2012-10-01 14:15:06 +00:00
<xi:include href="xml/clutter-tap-action.xml"/>
Add SnapConstraint A SnapConstraint is a constraint that "snaps" the edges of two actors together.
2010-11-10 16:37:34 +00:00
</chapter>
<chapter>
<title>Constraints</title>
docs: Effects fixes for the API reference
2010-06-03 13:34:41 +00:00
Miscellaneous documentation fixes
2010-05-19 15:10:05 +00:00
<xi:include href="xml/clutter-align-constraint.xml"/>
Add SnapConstraint A SnapConstraint is a constraint that "snaps" the edges of two actors together.
2010-11-10 16:37:34 +00:00
<xi:include href="xml/clutter-bind-constraint.xml"/>
gtk-doc: Add PathConstraint to the Clutter API reference
2010-11-08 16:03:44 +00:00
<xi:include href="xml/clutter-path-constraint.xml"/>
Add SnapConstraint A SnapConstraint is a constraint that "snaps" the edges of two actors together.
2010-11-10 16:37:34 +00:00
<xi:include href="xml/clutter-snap-constraint.xml"/>
</chapter>
<chapter>
<title>Effects</title>
docs: Effects fixes for the API reference
2010-06-03 13:34:41 +00:00
<xi:include href="xml/clutter-offscreen-effect.xml"/>
<xi:include href="xml/clutter-shader-effect.xml"/>
Add SnapConstraint A SnapConstraint is a constraint that "snaps" the edges of two actors together.
2010-11-10 16:37:34 +00:00
<xi:include href="xml/clutter-deform-effect.xml"/>
docs: Effects fixes for the API reference
2010-06-03 13:34:41 +00:00
<xi:include href="xml/clutter-blur-effect.xml"/>
Add brightness/contrast effect The ClutterBrightnessContrastEffect effect class allows changing the brightness and contrast levels of an actor. Modified-by: Emmanuele Bassi <ebassi@linux.intel.com> Modified-by: Neil Roberts <neil@linux.intel.com> https://bugzilla.gnome.org/show_bug.cgi?id=656156
2012-02-02 21:23:00 +00:00
<xi:include href="xml/clutter-brightness-contrast-effect.xml"/>
docs: Effects fixes for the API reference
2010-06-03 13:34:41 +00:00
<xi:include href="xml/clutter-colorize-effect.xml"/>
<xi:include href="xml/clutter-desaturate-effect.xml"/>
docs: Add DeformEffect and PageTurnEffect to the API reference
2010-06-10 17:51:22 +00:00
<xi:include href="xml/clutter-page-turn-effect.xml"/>
Miscellaneous documentation fixes
2010-05-19 15:10:05 +00:00
</chapter>
Add ClutterCanvas, a drawing content
2012-03-08 10:31:21 +00:00
<chapter>
<title>Content</title>
<xi:include href="xml/clutter-canvas.xml"/>
docs: Fixes for ClutterImage's API reference
2012-03-15 19:08:20 +00:00
<xi:include href="xml/clutter-image.xml"/>
Add ClutterCanvas, a drawing content
2012-03-08 10:31:21 +00:00
</chapter>
docs: Update the API reference Add all the new symbols.
2012-02-02 14:51:17 +00:00
<chapter>
<title>Paint Objects</title>
<xi:include href="xml/clutter-paint-node.xml"/>
<xi:include href="xml/clutter-paint-nodes.xml"/>
</chapter>
2007-06-14 Emmanuele Bassi <ebassi@openedhand.com> * clutter/clutter-box.[ch]: Base class for layout containers. * clutter/clutter-hbox.[ch]: Horizontal box actor. * clutter/clutter-vbox.[ch]: Vertical box actor. * clutter/clutter.h: * clutter/Makefile.am: Build glue * tests/Makefile.am: * tests/test-boxes.c: Test suite for ClutterBox API and implementations.
2007-06-14 15:29:52 +00:00
</part>
<part id="clutteranimation">
2008-06-12 Emmanuele Bassi <ebassi@openedhand.com> * clutter/clutter-docs.sgml: Clean up. * clutter/clutter-sections.txt: Add missing new symbols. * clutter/clutter.types: Add ClutterChildMeta type.
2008-06-12 11:41:03 +00:00
<title>Clutter Animation Framework</title>
<partintro>
<para>Clutter has a fully extensible animation framework
providing support for explicit and implicit animations of
single actors as well as groups of actors.</para>
</partintro>
2007-07-26 Matthew Allum <mallum@openedhand.com> * Makefile.am: * clutter-animation.sgml: * clutter-docs.sgml: An initial shot at some general animation documentation. Needs some love.
2007-07-26 14:00:20 +00:00
2007-06-14 Emmanuele Bassi <ebassi@openedhand.com> * clutter/clutter-box.[ch]: Base class for layout containers. * clutter/clutter-hbox.[ch]: Horizontal box actor. * clutter/clutter-vbox.[ch]: Vertical box actor. * clutter/clutter.h: * clutter/Makefile.am: Build glue * tests/Makefile.am: * tests/test-boxes.c: Test suite for ClutterBox API and implementations.
2007-06-14 15:29:52 +00:00
<chapter>
2007-11-23 Emmanuele Bassi <ebassi@openedhand.com> * clutter-docs.sgml: Shuffle around non-actor classes.
2007-11-23 17:25:50 +00:00
<title>Base classes</title>
2007-06-16 Emmanuele Bassi <ebassi@openedhand.com> * subclassing-ClutterActor.sgml: Add a chapter about how to correctly subclass the actor base class. * clutter-docs.sgml: Include the new chapter about subclassing ClutterActor; add a description for some of the API reference parts.
2007-06-16 20:56:40 +00:00
2007-06-14 Emmanuele Bassi <ebassi@openedhand.com> * clutter/clutter-box.[ch]: Base class for layout containers. * clutter/clutter-hbox.[ch]: Horizontal box actor. * clutter/clutter-vbox.[ch]: Vertical box actor. * clutter/clutter.h: * clutter/Makefile.am: Build glue * tests/Makefile.am: * tests/test-boxes.c: Test suite for ClutterBox API and implementations.
2007-06-14 15:29:52 +00:00
<xi:include href="xml/clutter-timeline.xml"/>
docs: Reorganize the API reference index
2012-03-20 13:06:48 +00:00
<xi:include href="xml/clutter-interval.xml"/>
<xi:include href="xml/clutter-animatable.xml"/>
Add ClutterKeyframeTransition A simple transition class that interpolates a property between key frames.
2012-04-11 14:53:52 +00:00
<xi:include href="xml/clutter-transition.xml"/>
docs: Reorganize the API reference index
2012-03-20 13:06:48 +00:00
<xi:include href="xml/clutter-property-transition.xml"/>
Add ClutterKeyframeTransition A simple transition class that interpolates a property between key frames.
2012-04-11 14:53:52 +00:00
<xi:include href="xml/clutter-keyframe-transition.xml"/>
Add ClutterTransitionGroup The TransitionGroup class is a logical container for running multiple transitions. TransitionGroup is not a Score: it is a Transition that advances each Transition it contains using the delta between frames, and ensures that all transitions are in a consistent state; these transitions are not advanced by the master clock.
2012-03-20 10:59:34 +00:00
<xi:include href="xml/clutter-transition-group.xml"/>
2007-06-14 Emmanuele Bassi <ebassi@openedhand.com> * clutter/clutter-box.[ch]: Base class for layout containers. * clutter/clutter-hbox.[ch]: Horizontal box actor. * clutter/clutter-vbox.[ch]: Vertical box actor. * clutter/clutter.h: * clutter/Makefile.am: Build glue * tests/Makefile.am: * tests/test-boxes.c: Test suite for ClutterBox API and implementations.
2007-06-14 15:29:52 +00:00
</chapter>
</part>
[docs] Add more collateral documentation * Add the main Glossary for Clutter terms * Add the annotation glossary, as generated by gtk-doc * Add the objects index and tree
2009-09-03 15:51:14 +00:00
<part id="cluttertools">
2006-06-22 Matthew Allum <mallum@openedhand.com> * clutter/clutter-actor.c: * clutter/clutter-clone-texture.c: * clutter/clutter-color.c: * clutter/clutter-event.c: * clutter/clutter-group.c: * clutter/clutter-label.c: * clutter/clutter-main.c: * clutter/clutter-media.c: * clutter/clutter-rectangle.c: * clutter/clutter-stage.c: * clutter/clutter-texture.c: * clutter/clutter-timeline.c: * clutter/clutter-util.c: * clutter/clutter-video-texture.c: * configure.ac: Documentation updates - add section headers.
2006-06-21 22:34:25 +00:00
<title>Clutter Tools</title>
2007-06-14 Emmanuele Bassi <ebassi@openedhand.com> * clutter/clutter-box.[ch]: Base class for layout containers. * clutter/clutter-hbox.[ch]: Horizontal box actor. * clutter/clutter-vbox.[ch]: Vertical box actor. * clutter/clutter.h: * clutter/Makefile.am: Build glue * tests/Makefile.am: * tests/test-boxes.c: Test suite for ClutterBox API and implementations.
2007-06-14 15:29:52 +00:00
2007-10-25 Emmanuele Bassi <ebassi@openedhand.com> * clutter.types: * clutter-sections.txt: * clutter-docs.sgml: Add new ClutterScriptable API.
2007-10-25 14:46:59 +00:00
<chapter>
2007-11-23 Emmanuele Bassi <ebassi@openedhand.com> * clutter-docs.sgml: Shuffle around non-actor classes.
2007-11-23 17:25:50 +00:00
<title>General purpose API</title>
2007-10-25 Emmanuele Bassi <ebassi@openedhand.com> * clutter.types: * clutter-sections.txt: * clutter-docs.sgml: Add new ClutterScriptable API.
2007-10-25 14:46:59 +00:00
<xi:include href="xml/clutter-color.xml"/>
2008-12-08 Emmanuele Bassi <ebassi@linux.intel.com> * clutter/clutter-docs.xml: * clutter/clutter-sections.txt: Add ClutterBindingPool section and link.
2008-12-08 14:22:39 +00:00
<xi:include href="xml/clutter-binding-pool.xml"/>
gtk-doc: Add PathConstraint to the Clutter API reference
2010-11-08 16:03:44 +00:00
<xi:include href="xml/clutter-device-manager.xml"/>
2007-11-23 Emmanuele Bassi <ebassi@openedhand.com> * clutter-docs.sgml: Shuffle around non-actor classes.
2007-11-23 17:25:50 +00:00
<xi:include href="xml/clutter-event.xml"/>
gtk-doc: Add PathConstraint to the Clutter API reference
2010-11-08 16:03:44 +00:00
<xi:include href="xml/clutter-feature.xml"/>
docs: Add a reference section for geometric types
2012-04-19 13:55:08 +00:00
<xi:include href="xml/clutter-geometric-types.xml"/>
gtk-doc: Add PathConstraint to the Clutter API reference
2010-11-08 16:03:44 +00:00
<xi:include href="xml/clutter-input-device.xml"/>
2007-11-23 Emmanuele Bassi <ebassi@openedhand.com> * clutter-docs.sgml: Shuffle around non-actor classes.
2007-11-23 17:25:50 +00:00
<xi:include href="xml/clutter-main.xml"/>
gtk-doc: Add PathConstraint to the Clutter API reference
2010-11-08 16:03:44 +00:00
<xi:include href="xml/clutter-path.xml"/>
docs: Add Settings to the API reference And document properties.
2010-06-21 16:57:11 +00:00
<xi:include href="xml/clutter-settings.xml"/>
docs: Make StageManager a public class The StageManager API is useful to track the stages of an application. It will also be useful when we land the modules API.
2009-10-10 12:52:46 +00:00
<xi:include href="xml/clutter-stage-manager.xml"/>
Add ClutterTextBuffer to the API reference
2012-01-17 12:00:54 +00:00
<xi:include href="xml/clutter-text-buffer.xml"/>
2007-10-25 Emmanuele Bassi <ebassi@openedhand.com> * clutter.types: * clutter-sections.txt: * clutter-docs.sgml: Add new ClutterScriptable API.
2007-10-25 14:46:59 +00:00
<xi:include href="xml/clutter-units.xml"/>
2007-11-23 Emmanuele Bassi <ebassi@openedhand.com> * clutter-docs.sgml: Shuffle around non-actor classes.
2007-11-23 17:25:50 +00:00
<xi:include href="xml/clutter-version.xml"/>
2007-10-25 Emmanuele Bassi <ebassi@openedhand.com> * clutter.types: * clutter-sections.txt: * clutter-docs.sgml: Add new ClutterScriptable API.
2007-10-25 14:46:59 +00:00
</chapter>
<chapter>
2007-11-23 Emmanuele Bassi <ebassi@openedhand.com> * clutter-docs.sgml: Shuffle around non-actor classes.
2007-11-23 17:25:50 +00:00
<title>User interface definition</title>
2007-10-25 Emmanuele Bassi <ebassi@openedhand.com> * clutter.types: * clutter-sections.txt: * clutter-docs.sgml: Add new ClutterScriptable API.
2007-10-25 14:46:59 +00:00
<xi:include href="xml/clutter-script.xml"/>
<xi:include href="xml/clutter-scriptable.xml"/>
</chapter>
2007-11-23 Emmanuele Bassi <ebassi@openedhand.com> * clutter-docs.sgml: Shuffle around non-actor classes.
2007-11-23 17:25:50 +00:00
<chapter>
<title>Generic list model</title>
<xi:include href="xml/clutter-model.xml"/>
<xi:include href="xml/clutter-model-iter.xml"/>
2008-01-09 Emmanuele Bassi <ebassi@openedhand.com> * clutter/clutter-model-default.[ch]: Rename ClutterModelDefault into ClutterListModel, to make it clear that the default ClutterModel implementation is list-based * tests/test-model.c: Update call
2008-01-09 14:34:24 +00:00
<xi:include href="xml/clutter-list-model.xml"/>
2007-11-23 Emmanuele Bassi <ebassi@openedhand.com> * clutter-docs.sgml: Shuffle around non-actor classes.
2007-11-23 17:25:50 +00:00
</chapter>
docs: Add Effects API to the reference
2010-04-21 10:30:06 +00:00
2007-06-14 Emmanuele Bassi <ebassi@openedhand.com> * clutter/clutter-box.[ch]: Base class for layout containers. * clutter/clutter-hbox.[ch]: Horizontal box actor. * clutter/clutter-vbox.[ch]: Vertical box actor. * clutter/clutter.h: * clutter/Makefile.am: Build glue * tests/Makefile.am: * tests/test-boxes.c: Test suite for ClutterBox API and implementations.
2007-06-14 15:29:52 +00:00
</part>
[docs] Add more collateral documentation * Add the main Glossary for Clutter terms * Add the annotation glossary, as generated by gtk-doc * Add the objects index and tree
2009-09-03 15:51:14 +00:00
<part id="clutterbackends">
2007-03-22 Emmanuele Bassi <ebassi@openedhand.com> * Makefile.am: Include the clutter-glx backend API.
2007-03-22 20:31:53 +00:00
<title>Clutter Backends</title>
2007-06-16 Emmanuele Bassi <ebassi@openedhand.com> * subclassing-ClutterActor.sgml: Add a chapter about how to correctly subclass the actor base class. * clutter-docs.sgml: Include the new chapter about subclassing ClutterActor; add a description for some of the API reference parts.
2007-06-16 20:56:40 +00:00
<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>
2008-02-15 Tomas Frydrych <tf@openedhand.com> * clutter-docs.sgml: Build instructions for Linux and Windows.
2008-02-15 16:17:31 +00:00
2007-03-22 Emmanuele Bassi <ebassi@openedhand.com> * Makefile.am: Include the clutter-glx backend API.
2007-03-22 20:31:53 +00:00
<xi:include href="xml/clutter-backend.xml"/>
docs: Fix up the main index of the Clutter API reference
2010-08-28 20:17:52 +00:00
<xi:include href="xml/clutter-x11.xml"/>
2008-03-26 Neil Roberts <neil@o-hand.com> * clutter/win32/clutter-win32.h: Added gtk-doc documentation for the Win32 backend section. * clutter/win32/clutter-stage-win32.c (clutter_win32_get_stage_window): Fixed punctuation in the documentation. * README: Added notes about the Win32 backend. 2008-03-26 Neil Roberts <neil@o-hand.com> * clutter-sections.txt: Added a section for the Win32 specific API. * clutter-docs.sgml: Added comments about the Win32 backend. * Makefile.am: Added bits to ignore the headers for the Win32 backend.
2008-03-26 22:22:32 +00:00
<xi:include href="xml/clutter-win32.xml"/>
egl: Consolidates eglx and eglnative into one "egl" winsys This remove quite a lot of redundant code by consolidating the eglx and eglnative window system backends.
2010-06-18 03:38:43 +00:00
<xi:include href="xml/clutter-egl.xml"/>
cex100: Add an API to configure the GDL plane to use Intel CE3100 and CE4100 have several planes (framebuffers) and a hardware blender to blend the planes togeteher to produce the final image. clutter_cex100_set_plane() lets you configure which framebuffer clutter will use for its rendering.
2010-08-28 09:43:39 +00:00
<xi:include href="xml/clutter-cex100.xml"/>
docs: Fixes for the API reference
2011-11-22 00:29:08 +00:00
<xi:include href="xml/clutter-gdk.xml"/>
docs: Add clutter-wayland section to reference docs Gives this stray section a home in the reference documentation.
2013-05-13 11:07:26 +00:00
<xi:include href="xml/clutter-wayland.xml"/>
docs: Update the Actor API reference Given the size and scope of the changes in ClutterActor, we ought to rewrite the overall description of what an actor is, what it does, and how are you supposed to use it and subclass it.
2011-12-20 13:32:37 +00:00
<xi:include href="xml/clutter-wayland-compositor.xml"/>
<xi:include href="xml/clutter-wayland-surface.xml"/>
2007-06-14 Emmanuele Bassi <ebassi@openedhand.com> * clutter/clutter-box.[ch]: Base class for layout containers. * clutter/clutter-hbox.[ch]: Horizontal box actor. * clutter/clutter-vbox.[ch]: Vertical box actor. * clutter/clutter.h: * clutter/Makefile.am: Build glue * tests/Makefile.am: * tests/test-boxes.c: Test suite for ClutterBox API and implementations.
2007-06-14 15:29:52 +00:00
</part>
[docs] Add more collateral documentation * Add the main Glossary for Clutter terms * Add the annotation glossary, as generated by gtk-doc * Add the objects index and tree
2009-09-03 15:51:14 +00:00
<part id="clutterobjects">
<title>Clutter Actors and Objects</title>
<chapter id="clutterobjecthierarchy">
<title>Object Hierarchy</title>
[layout] Add LayoutMeta Instead of overloading ClutterChildMeta with both container and layout metadata and delegate to every LayoutManager implementation to keep a backpointer to the layout manager instance, we can simply subclass ChildMeta into LayoutMeta and presto! everything works out pretty well for everyone.
2009-09-15 16:37:11 +00:00
<xi:include href="xml/tree_index.sgml"><xi:fallback /></xi:include>
[docs] Add more collateral documentation * Add the main Glossary for Clutter terms * Add the annotation glossary, as generated by gtk-doc * Add the objects index and tree
2009-09-03 15:51:14 +00:00
</chapter>
<chapter id="clutterobjectindex">
<title>Object Index</title>
[layout] Add LayoutMeta Instead of overloading ClutterChildMeta with both container and layout metadata and delegate to every LayoutManager implementation to keep a backpointer to the layout manager instance, we can simply subclass ChildMeta into LayoutMeta and presto! everything works out pretty well for everyone.
2009-09-15 16:37:11 +00:00
<xi:include href="xml/object_index.sgml"><xi:fallback /></xi:include>
[docs] Add more collateral documentation * Add the main Glossary for Clutter terms * Add the annotation glossary, as generated by gtk-doc * Add the objects index and tree
2009-09-03 15:51:14 +00:00
</chapter>
</part>
<part id="clutterglossary">
<title>Glossaries</title>
<xi:include href="xml/glossary.xml"><xi:fallback /></xi:include>
docs: Allow XInclude fallback for the annotation glossary
2009-10-13 16:00:15 +00:00
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
[docs] Add more collateral documentation * Add the main Glossary for Clutter terms * Add the annotation glossary, as generated by gtk-doc * Add the objects index and tree
2009-09-03 15:51:14 +00:00
</part>
2007-06-14 Emmanuele Bassi <ebassi@openedhand.com> * clutter/clutter-box.[ch]: Base class for layout containers. * clutter/clutter-hbox.[ch]: Horizontal box actor. * clutter/clutter-vbox.[ch]: Vertical box actor. * clutter/clutter.h: * clutter/Makefile.am: Build glue * tests/Makefile.am: * tests/test-boxes.c: Test suite for ClutterBox API and implementations.
2007-06-14 15:29:52 +00:00
<index>
[docs] Add more collateral documentation * Add the main Glossary for Clutter terms * Add the annotation glossary, as generated by gtk-doc * Add the objects index and tree
2009-09-03 15:51:14 +00:00
<title>Index of all symbols</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
2007-06-14 Emmanuele Bassi <ebassi@openedhand.com> * clutter/clutter-box.[ch]: Base class for layout containers. * clutter/clutter-hbox.[ch]: Horizontal box actor. * clutter/clutter-vbox.[ch]: Vertical box actor. * clutter/clutter.h: * clutter/Makefile.am: Build glue * tests/Makefile.am: * tests/test-boxes.c: Test suite for ClutterBox API and implementations.
2007-06-14 15:29:52 +00:00
</index>
2008-06-12 Emmanuele Bassi <ebassi@openedhand.com> * clutter/clutter-docs.sgml: Clean up. * clutter/clutter-sections.txt: Add missing new symbols. * clutter/clutter.types: Add ClutterChildMeta type.
2008-06-12 11:41:03 +00:00
2007-08-04 Emmanuele Bassi <ebassi@openedhand.com> * clutter-docs.sgml: Add autogeneration of the per-version indexes of symbols, plus the index of deprecated symbols.
2007-08-04 09:52:51 +00:00
<index role="deprecated">
<title>Index of deprecated symbols</title>
[docs] Add more collateral documentation * Add the main Glossary for Clutter terms * Add the annotation glossary, as generated by gtk-doc * Add the objects index and tree
2009-09-03 15:51:14 +00:00
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
2007-08-04 Emmanuele Bassi <ebassi@openedhand.com> * clutter-docs.sgml: Add autogeneration of the per-version indexes of symbols, plus the index of deprecated symbols.
2007-08-04 09:52:51 +00:00
</index>
2008-06-12 Emmanuele Bassi <ebassi@openedhand.com> * clutter/clutter-docs.sgml: Clean up. * clutter/clutter-sections.txt: Add missing new symbols. * clutter/clutter.types: Add ClutterChildMeta type.
2008-06-12 11:41:03 +00:00
2006-06-22 Matthew Allum <mallum@openedhand.com> * clutter/clutter-main.h: Remove bogus xvisual call.
2006-06-22 08:40:37 +00:00
<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>
2006-06-22 Matthew Allum <mallum@openedhand.com> * clutter/clutter-actor.c: * clutter/clutter-clone-texture.c: * clutter/clutter-color.c: * clutter/clutter-event.c: * clutter/clutter-group.c: * clutter/clutter-label.c: * clutter/clutter-main.c: * clutter/clutter-media.c: * clutter/clutter-rectangle.c: * clutter/clutter-stage.c: * clutter/clutter-texture.c: * clutter/clutter-timeline.c: * clutter/clutter-util.c: * clutter/clutter-video-texture.c: * configure.ac: Documentation updates - add section headers.
2006-06-21 22:34:25 +00:00
</book>
Reference in New Issue Copy Permalink