doc/reference/clutter/clutter-docs.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
   4 <!ENTITY version "1.10.0">
   5 ]>
   6
   7 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
   8   <bookinfo>
   9     <title>Clutter Reference Manual</title>
  10     <releaseinfo>for Clutter &version;</releaseinfo>
  11
  12     <copyright>
  13       <year>2006</year>
  14       <year>2007</year>
  15       <year>2008</year>
  16       <holder>OpenedHand LTD</holder>
  17     </copyright>
  18
  19     <copyright>
  20       <year>2009</year>
  21       <year>2010</year>
  22       <year>2011</year>
  23       <year>2012</year>
  24       <holder>Intel Corporation</holder>
  25     </copyright>
  26
  27     <legalnotice>
  28       <para>
  29         Permission is granted to copy, distribute and/or modify this
  30         document under the terms of the <citetitle>GNU Free
  31         Documentation License</citetitle>, Version 1.1 or any later
  32         version published by the Free Software Foundation with no
  33         Invariant Sections, no Front-Cover Texts, and no Back-Cover
  34         Texts. You may obtain a copy of the <citetitle>GNU Free
  35         Documentation License</citetitle> from the Free Software
  36         Foundation by visiting <ulink type="http"
  37         url="http://www.fsf.org">their Web site</ulink> or by writing
  38         to:
  39
  40         <address>
  41           The Free Software Foundation, Inc.,
  42           <street>59 Temple Place</street> - Suite 330,
  43           <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>,
  44           <country>USA</country>
  45         </address>
  46       </para>
  47     </legalnotice>
  48   </bookinfo>
  49
  50   <xi:include href="xml/clutter-overview.xml"/>
  51   <xi:include href="xml/building-clutter.xml"/>
  52   <xi:include href="xml/running-clutter.xml"/>
  53
  54   <part id="clutterbase">
  55     <title>Clutter Core Reference</title>
  56
  57     <chapter>
  58       <title>Abstract classes and interfaces</title>
  59       <xi:include href="xml/clutter-actor.xml"/>
  60       <xi:include href="xml/clutter-container.xml"/>
  61       <xi:include href="xml/clutter-child-meta.xml"/>
  62       <xi:include href="xml/clutter-media.xml"/>
  63       <xi:include href="xml/clutter-layout-manager.xml"/>
  64       <xi:include href="xml/clutter-layout-meta.xml"/>
  65       <xi:include href="xml/clutter-actor-meta.xml"/>
  66       <xi:include href="xml/clutter-action.xml"/>
  67       <xi:include href="xml/clutter-constraint.xml"/>
  68       <xi:include href="xml/clutter-effect.xml"/>
  69       <xi:include href="xml/clutter-content.xml"/>
  70     </chapter>
  71
  72     <chapter>
  73       <title>Base actors</title>
  74       <xi:include href="xml/clutter-stage.xml"/>
  75       <xi:include href="xml/clutter-texture.xml"/>
  76       <xi:include href="xml/clutter-clone.xml"/>
  77       <xi:include href="xml/clutter-text.xml"/>
  78       <xi:include href="xml/clutter-cairo-texture.xml"/>
  79     </chapter>
  80
  81     <chapter>
  82       <title>Layout managers</title>
  83
  84       <xi:include href="xml/clutter-fixed-layout.xml"/>
  85       <xi:include href="xml/clutter-bin-layout.xml"/>
  86       <xi:include href="xml/clutter-flow-layout.xml"/>
  87       <xi:include href="xml/clutter-box-layout.xml"/>
  88       <xi:include href="xml/clutter-table-layout.xml"/>
  89     </chapter>
  90
  91     <chapter>
  92       <title>Actions</title>
  93
  94       <xi:include href="xml/clutter-click-action.xml"/>
  95       <xi:include href="xml/clutter-drag-action.xml"/>
  96       <xi:include href="xml/clutter-drop-action.xml"/>
  97       <xi:include href="xml/clutter-gesture-action.xml"/>
  98       <xi:include href="xml/clutter-swipe-action.xml"/>
  99     </chapter>
 100
 101     <chapter>
 102       <title>Constraints</title>
 103
 104       <xi:include href="xml/clutter-align-constraint.xml"/>
 105       <xi:include href="xml/clutter-bind-constraint.xml"/>
 106       <xi:include href="xml/clutter-path-constraint.xml"/>
 107       <xi:include href="xml/clutter-snap-constraint.xml"/>
 108     </chapter>
 109
 110     <chapter>
 111       <title>Effects</title>
 112
 113       <xi:include href="xml/clutter-offscreen-effect.xml"/>
 114       <xi:include href="xml/clutter-shader-effect.xml"/>
 115       <xi:include href="xml/clutter-deform-effect.xml"/>
 116
 117       <xi:include href="xml/clutter-blur-effect.xml"/>
 118       <xi:include href="xml/clutter-brightness-contrast-effect.xml"/>
 119       <xi:include href="xml/clutter-colorize-effect.xml"/>
 120       <xi:include href="xml/clutter-desaturate-effect.xml"/>
 121       <xi:include href="xml/clutter-page-turn-effect.xml"/>
 122     </chapter>
 123
 124     <chapter>
 125       <title>Content</title>
 126
 127       <xi:include href="xml/clutter-canvas.xml"/>
 128       <xi:include href="xml/clutter-image.xml"/>
 129     </chapter>
 130
 131     <chapter>
 132       <title>Paint Objects</title>
 133
 134       <xi:include href="xml/clutter-paint-node.xml"/>
 135       <xi:include href="xml/clutter-paint-nodes.xml"/>
 136     </chapter>
 137
 138   </part>
 139
 140   <part id="clutteranimation">
 141     <title>Clutter Animation Framework</title>
 142
 143     <partintro>
 144       <para>Clutter has a fully extensible animation framework
 145       providing support for explicit and implicit animations of
 146       single actors as well as groups of actors.</para>
 147     </partintro>
 148
 149     <chapter>
 150       <title>Base classes</title>
 151
 152       <xi:include href="xml/clutter-timeline.xml"/>
 153       <xi:include href="xml/clutter-alpha.xml"/>
 154       <xi:include href="xml/clutter-interval.xml"/>
 155       <xi:include href="xml/clutter-transition.xml"/>
 156       <xi:include href="xml/clutter-animatable.xml"/>
 157       <xi:include href="xml/clutter-property-transition.xml"/>
 158     </chapter>
 159
 160     <chapter>
 161       <title>High Level API</title>
 162
 163       <xi:include href="xml/clutter-animation.xml"/>
 164       <xi:include href="xml/clutter-animator.xml"/>
 165       <xi:include href="xml/clutter-state.xml"/>
 166
 167     </chapter>
 168
 169   </part>
 170
 171   <part id="cluttertools">
 172     <title>Clutter Tools</title>
 173
 174     <chapter>
 175       <title>General purpose API</title>
 176
 177       <xi:include href="xml/clutter-color.xml"/>
 178       <xi:include href="xml/clutter-binding-pool.xml"/>
 179       <xi:include href="xml/clutter-device-manager.xml"/>
 180       <xi:include href="xml/clutter-event.xml"/>
 181       <xi:include href="xml/clutter-feature.xml"/>
 182       <xi:include href="xml/clutter-input-device.xml"/>
 183       <xi:include href="xml/clutter-main.xml"/>
 184       <xi:include href="xml/clutter-path.xml"/>
 185       <xi:include href="xml/clutter-settings.xml"/>
 186       <xi:include href="xml/clutter-stage-manager.xml"/>
 187       <xi:include href="xml/clutter-text-buffer.xml"/>
 188       <xi:include href="xml/clutter-units.xml"/>
 189       <xi:include href="xml/clutter-util.xml"/>
 190       <xi:include href="xml/clutter-version.xml"/>
 191     </chapter>
 192
 193     <chapter>
 194       <title>User interface definition</title>
 195
 196       <xi:include href="xml/clutter-script.xml"/>
 197       <xi:include href="xml/clutter-scriptable.xml"/>
 198     </chapter>
 199
 200     <chapter>
 201       <title>Generic list model</title>
 202
 203       <xi:include href="xml/clutter-model.xml"/>
 204       <xi:include href="xml/clutter-model-iter.xml"/>
 205       <xi:include href="xml/clutter-list-model.xml"/>
 206     </chapter>
 207
 208   </part>
 209
 210   <part id="clutterbackends">
 211     <title>Clutter Backends</title>
 212
 213     <partintro>
 214       <para>Clutter is usually compiled against a specific drawing backend.
 215       All backends have a common API for querying the underlying platform,
 216       and some of them might have specific API exposed by Clutter.</para>
 217     </partintro>
 218
 219     <xi:include href="xml/clutter-backend.xml"/>
 220     <xi:include href="xml/clutter-x11.xml"/>
 221     <xi:include href="xml/clutter-x11-texture-pixmap.xml"/>
 222     <xi:include href="xml/clutter-glx-texture-pixmap.xml"/>
 223     <xi:include href="xml/clutter-win32.xml"/>
 224     <xi:include href="xml/clutter-egl.xml"/>
 225     <xi:include href="xml/clutter-cex100.xml"/>
 226     <xi:include href="xml/clutter-gdk.xml"/>
 227     <xi:include href="xml/clutter-wayland-compositor.xml"/>
 228     <xi:include href="xml/clutter-wayland-surface.xml"/>
 229   </part>
 230
 231   <part id="additionaldocs">
 232     <title>Additional Documentation</title>
 233
 234     <partintro>
 235       <para>This section contains additional useful documentation for
 236       developing with Clutter.</para>
 237     </partintro>
 238
 239     <xi:include href="xml/clutter-animation-tutorial.xml"/>
 240   </part>
 241
 242   <part id="migration">
 243     <title>Migrating from previous version of Clutter</title>
 244
 245     <partintro>
 246       <part>This section describes the changes that need to be
 247       done in applications using Clutter to use new features or
 248       to migrate from old, deprecated API to the new ones.</part>
 249     </partintro>
 250
 251     <xi:include href="xml/migrating-ClutterEffect.xml"/>
 252     <xi:include href="xml/migrating-ClutterPath.xml"/>
 253     <xi:include href="xml/migrating-ClutterBehaviour.xml"/>
 254
 255   </part>
 256
 257   <part id="deprecated">
 258     <title>Deprecated Classes</title>
 259
 260       <xi:include href="xml/clutter-score.xml"/>
 261       <xi:include href="xml/clutter-shader.xml"/>
 262       <xi:include href="xml/clutter-behaviour.xml"/>
 263       <xi:include href="xml/clutter-behaviour-depth.xml"/>
 264       <xi:include href="xml/clutter-behaviour-ellipse.xml"/>
 265       <xi:include href="xml/clutter-behaviour-opacity.xml"/>
 266       <xi:include href="xml/clutter-behaviour-path.xml"/>
 267       <xi:include href="xml/clutter-behaviour-rotate.xml"/>
 268       <xi:include href="xml/clutter-behaviour-scale.xml"/>
 269       <xi:include href="xml/clutter-group.xml"/>
 270       <xi:include href="xml/clutter-box.xml"/>
 271       <xi:include href="xml/clutter-rectangle.xml"/>
 272   </part>
 273
 274   <part id="clutterobjects">
 275     <title>Clutter Actors and Objects</title>
 276
 277     <chapter id="clutterobjecthierarchy">
 278       <title>Object Hierarchy</title>
 279
 280       <xi:include href="xml/tree_index.sgml"><xi:fallback /></xi:include>
 281     </chapter>
 282
 283     <chapter id="clutterobjectindex">
 284       <title>Object Index</title>
 285
 286       <xi:include href="xml/object_index.sgml"><xi:fallback /></xi:include>
 287     </chapter>
 288   </part>
 289
 290   <part id="clutterglossary">
 291     <title>Glossaries</title>
 292
 293     <xi:include href="xml/glossary.xml"><xi:fallback /></xi:include>
 294     <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
 295   </part>
 296
 297   <index>
 298     <title>Index of all symbols</title>
 299     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
 300   </index>
 301
 302   <index role="deprecated">
 303     <title>Index of deprecated symbols</title>
 304     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
 305   </index>
 306
 307   <index role="0.2">
 308     <title>Index of new symbols in 0.2</title>
 309     <xi:include href="xml/api-index-0.2.xml"><xi:fallback /></xi:include>
 310   </index>
 311
 312   <index role="0.4">
 313     <title>Index of new symbols in 0.4</title>
 314     <xi:include href="xml/api-index-0.4.xml"><xi:fallback /></xi:include>
 315   </index>
 316
 317   <index role="0.6">
 318     <title>Index of new symbols in 0.6</title>
 319     <xi:include href="xml/api-index-0.6.xml"><xi:fallback /></xi:include>
 320   </index>
 321
 322   <index role="0.8">
 323     <title>Index of new symbols in 0.8</title>
 324     <xi:include href="xml/api-index-0.8.xml"><xi:fallback /></xi:include>
 325   </index>
 326
 327   <index role="1.0">
 328     <title>Index of new symbols in 1.0</title>
 329     <xi:include href="xml/api-index-1.0.xml"><xi:fallback /></xi:include>
 330   </index>
 331
 332   <index role="1.2">
 333     <title>Index of new symbols in 1.2</title>
 334     <xi:include href="xml/api-index-1.2.xml"><xi:fallback /></xi:include>
 335   </index>
 336
 337   <index role="1.4">
 338     <title>Index of new symbols in 1.4</title>
 339     <xi:include href="xml/api-index-1.4.xml"><xi:fallback /></xi:include>
 340   </index>
 341
 342   <index role="1.6">
 343     <title>Index of new symbols in 1.6</title>
 344     <xi:include href="xml/api-index-1.6.xml"><xi:fallback /></xi:include>
 345   </index>
 346
 347   <index role="1.8">
 348     <title>Index of new symbols in 1.8</title>
 349     <xi:include href="xml/api-index-1.8.xml"><xi:fallback /></xi:include>
 350   </index>
 351
 352   <index role="1.10">
 353     <title>Index of new symbols in 1.10</title>
 354     <xi:include href="xml/api-index-1.10.xml"><xi:fallback /></xi:include>
 355   </index>
 356
 357   <appendix id="license">
 358     <title>License</title>
 359
 360     <para>
 361       This library is free software; you can redistribute it and/or
 362       modify it under the terms of the <citetitle>GNU Library General
 363       Public License</citetitle> as published by the Free Software
 364       Foundation; either version 2 of the License, or (at your option)
 365       any later version.
 366     </para>
 367
 368     <para>
 369       This library is distributed in the hope that it will be useful,
 370       but WITHOUT ANY WARRANTY; without even the implied warranty of
 371       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 372       <citetitle>GNU Library General Public License</citetitle> for
 373       more details.
 374     </para>
 375
 376     <para>
 377       You may obtain a copy of the <citetitle>GNU Library General
 378       Public License</citetitle> from the Free Software Foundation by
 379       visiting <ulink type="http" url="http://www.fsf.org">their Web
 380       site</ulink> or by writing to:
 381
 382       <address>
 383         Free Software Foundation, Inc.
 384         <street>59 Temple Place</street> - Suite 330
 385         <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>
 386         <country>USA</country>
 387       </address>
 388     </para>
 389   </appendix>
 390
 391 </book>