1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
%gtkdocentities;
]>
<book id="clutter" lang="en">
<bookinfo>
<title>Clutter Reference Manual</title>
<releaseinfo>for Clutter &package_version;</releaseinfo>
<copyright>
<year>2006</year>
<year>2007</year>
<year>2008</year>
<holder>OpenedHand LTD</holder>
</copyright>
<copyright>
<year>2009</year>
<year>2010</year>
<year>2011</year>
<year>2012</year>
<holder>Intel Corporation</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>
<xi:include href="xml/clutter-overview.xml"/>
<xi:include href="xml/building-clutter.xml"/>
<xi:include href="xml/running-clutter.xml"/>
<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-child-meta.xml"/>
<xi:include href="xml/clutter-media.xml"/>
<xi:include href="xml/clutter-layout-manager.xml"/>
<xi:include href="xml/clutter-layout-meta.xml"/>
<xi:include href="xml/clutter-actor-meta.xml"/>
<xi:include href="xml/clutter-action.xml"/>
<xi:include href="xml/clutter-constraint.xml"/>
<xi:include href="xml/clutter-effect.xml"/>
<xi:include href="xml/clutter-content.xml"/>
</chapter>
<chapter>
<title>Base actors</title>
<xi:include href="xml/clutter-stage.xml"/>
<xi:include href="xml/clutter-clone.xml"/>
<xi:include href="xml/clutter-text.xml"/>
<xi:include href="xml/clutter-scroll-actor.xml"/>
</chapter>
<chapter>
<title>Layout managers</title>
<xi:include href="xml/clutter-fixed-layout.xml"/>
<xi:include href="xml/clutter-bin-layout.xml"/>
<xi:include href="xml/clutter-flow-layout.xml"/>
<xi:include href="xml/clutter-box-layout.xml"/>
<xi:include href="xml/clutter-grid-layout.xml"/>
</chapter>
<chapter>
<title>Actions</title>
<xi:include href="xml/clutter-click-action.xml"/>
<xi:include href="xml/clutter-drag-action.xml"/>
<xi:include href="xml/clutter-drop-action.xml"/>
<xi:include href="xml/clutter-gesture-action.xml"/>
<xi:include href="xml/clutter-pan-action.xml"/>
<xi:include href="xml/clutter-swipe-action.xml"/>
<xi:include href="xml/clutter-rotate-action.xml"/>
<xi:include href="xml/clutter-zoom-action.xml"/>
<xi:include href="xml/clutter-tap-action.xml"/>
</chapter>
<chapter>
<title>Constraints</title>
<xi:include href="xml/clutter-align-constraint.xml"/>
<xi:include href="xml/clutter-bind-constraint.xml"/>
<xi:include href="xml/clutter-path-constraint.xml"/>
<xi:include href="xml/clutter-snap-constraint.xml"/>
</chapter>
<chapter>
<title>Effects</title>
<xi:include href="xml/clutter-offscreen-effect.xml"/>
<xi:include href="xml/clutter-shader-effect.xml"/>
<xi:include href="xml/clutter-deform-effect.xml"/>
<xi:include href="xml/clutter-blur-effect.xml"/>
<xi:include href="xml/clutter-brightness-contrast-effect.xml"/>
<xi:include href="xml/clutter-colorize-effect.xml"/>
<xi:include href="xml/clutter-desaturate-effect.xml"/>
<xi:include href="xml/clutter-page-turn-effect.xml"/>
</chapter>
<chapter>
<title>Content</title>
<xi:include href="xml/clutter-canvas.xml"/>
<xi:include href="xml/clutter-image.xml"/>
</chapter>
<chapter>
<title>Paint Objects</title>
<xi:include href="xml/clutter-paint-node.xml"/>
<xi:include href="xml/clutter-paint-nodes.xml"/>
</chapter>
</part>
<part id="clutteranimation">
<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>
<chapter>
<title>Base classes</title>
<xi:include href="xml/clutter-timeline.xml"/>
<xi:include href="xml/clutter-interval.xml"/>
<xi:include href="xml/clutter-animatable.xml"/>
<xi:include href="xml/clutter-transition.xml"/>
<xi:include href="xml/clutter-property-transition.xml"/>
<xi:include href="xml/clutter-keyframe-transition.xml"/>
<xi:include href="xml/clutter-transition-group.xml"/>
</chapter>
</part>
<part id="cluttertools">
<title>Clutter Tools</title>
<chapter>
<title>General purpose API</title>
<xi:include href="xml/clutter-color.xml"/>
<xi:include href="xml/clutter-binding-pool.xml"/>
<xi:include href="xml/clutter-device-manager.xml"/>
<xi:include href="xml/clutter-event.xml"/>
<xi:include href="xml/clutter-feature.xml"/>
<xi:include href="xml/clutter-geometric-types.xml"/>
<xi:include href="xml/clutter-input-device.xml"/>
<xi:include href="xml/clutter-main.xml"/>
<xi:include href="xml/clutter-path.xml"/>
<xi:include href="xml/clutter-settings.xml"/>
<xi:include href="xml/clutter-stage-manager.xml"/>
<xi:include href="xml/clutter-text-buffer.xml"/>
<xi:include href="xml/clutter-units.xml"/>
<xi:include href="xml/clutter-cairo.xml"/>
<xi:include href="xml/clutter-util.xml"/>
<xi:include href="xml/clutter-version.xml"/>
</chapter>
<chapter>
<title>User interface definition</title>
<xi:include href="xml/clutter-script.xml"/>
<xi:include href="xml/clutter-scriptable.xml"/>
</chapter>
<chapter>
<title>Generic list model</title>
<xi:include href="xml/clutter-model.xml"/>
<xi:include href="xml/clutter-model-iter.xml"/>
<xi:include href="xml/clutter-list-model.xml"/>
</chapter>
</part>
<part id="clutterbackends">
<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-x11.xml"/>
<xi:include href="xml/clutter-x11-texture-pixmap.xml"/>
<xi:include href="xml/clutter-glx-texture-pixmap.xml"/>
<xi:include href="xml/clutter-win32.xml"/>
<xi:include href="xml/clutter-egl.xml"/>
<xi:include href="xml/clutter-cex100.xml"/>
<xi:include href="xml/clutter-gdk.xml"/>
<xi:include href="xml/clutter-wayland.xml"/>
<xi:include href="xml/clutter-wayland-compositor.xml"/>
<xi:include href="xml/clutter-wayland-surface.xml"/>
<xi:include href="xml/clutter-mir.xml"/>
</part>
<part id="cally">
<title>Accessibility</title>
<partintro>
<para>Clutter provides support for accessibility technologies by
implementing the ATK interfaces. Since Clutter is a low-level tool
kit, and developers are supposed to create more complex actor
classes, we expose a low level API under the Cally namespace; this
API can be used as the base to build more accessibility features
inside custom derived ClutterActor classes.</para>
</partintro>
<chapter>
<title>Base Classes</title>
<xi:include href="xml/cally-actor.xml"/>
<xi:include href="xml/cally-group.xml"/>
<xi:include href="xml/cally-stage.xml"/>
<xi:include href="xml/cally-texture.xml"/>
<xi:include href="xml/cally-rectangle.xml"/>
<xi:include href="xml/cally-text.xml"/>
<xi:include href="xml/cally-clone.xml"/>
</chapter>
<chapter>
<title>Utility API</title>
<xi:include href="xml/cally.xml"/>
<xi:include href="xml/cally-util.xml"/>
<xi:include href="xml/cally-root.xml"/>
</chapter>
</part>
<part id="migration">
<title>Migrating from previous version of Clutter</title>
<partintro>
<part>This section describes the changes that need to be
done in applications using Clutter to use new features or
to migrate from old, deprecated API to the new ones.</part>
</partintro>
<xi:include href="xml/migrating-ClutterEffect.xml"/>
<xi:include href="xml/migrating-ClutterPath.xml"/>
<xi:include href="xml/migrating-ClutterBehaviour.xml"/>
<xi:include href="xml/migrating-ClutterAnimation.xml"/>
</part>
<part id="deprecated">
<title>Deprecated Classes</title>
<xi:include href="xml/clutter-alpha.xml"/>
<xi:include href="xml/clutter-animation.xml"/>
<xi:include href="xml/clutter-animator.xml"/>
<xi:include href="xml/clutter-behaviour.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"/>
<xi:include href="xml/clutter-box.xml"/>
<xi:include href="xml/clutter-cairo-texture.xml"/>
<xi:include href="xml/clutter-group.xml"/>
<xi:include href="xml/clutter-rectangle.xml"/>
<xi:include href="xml/clutter-score.xml"/>
<xi:include href="xml/clutter-shader.xml"/>
<xi:include href="xml/clutter-state.xml"/>
<xi:include href="xml/clutter-table-layout.xml"/>
<xi:include href="xml/clutter-texture.xml"/>
</part>
<part id="clutterobjects">
<title>Clutter Actors and Objects</title>
<chapter id="clutterobjecthierarchy">
<title>Object Hierarchy</title>
<xi:include href="xml/tree_index.sgml"><xi:fallback /></xi:include>
</chapter>
<chapter id="clutterobjectindex">
<title>Object Index</title>
<xi:include href="xml/object_index.sgml"><xi:fallback /></xi:include>
</chapter>
</part>
<part id="clutterglossary">
<title>Glossaries</title>
<xi:include href="xml/glossary.xml"><xi:fallback /></xi:include>
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
</part>
<index>
<title>Index of all symbols</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
</index>
<index role="deprecated">
<title>Index of deprecated symbols</title>
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
</index>
<index role="0.2">
<title>Index of new symbols in 0.2</title>
<xi:include href="xml/api-index-0.2.xml"><xi:fallback /></xi:include>
</index>
<index role="0.4">
<title>Index of new symbols in 0.4</title>
<xi:include href="xml/api-index-0.4.xml"><xi:fallback /></xi:include>
</index>
<index role="0.6">
<title>Index of new symbols in 0.6</title>
<xi:include href="xml/api-index-0.6.xml"><xi:fallback /></xi:include>
</index>
<index role="0.8">
<title>Index of new symbols in 0.8</title>
<xi:include href="xml/api-index-0.8.xml"><xi:fallback /></xi:include>
</index>
<index role="1.0">
<title>Index of new symbols in 1.0</title>
<xi:include href="xml/api-index-1.0.xml"><xi:fallback /></xi:include>
</index>
<index role="1.2">
<title>Index of new symbols in 1.2</title>
<xi:include href="xml/api-index-1.2.xml"><xi:fallback /></xi:include>
</index>
<index role="1.4">
<title>Index of new symbols in 1.4</title>
<xi:include href="xml/api-index-1.4.xml"><xi:fallback /></xi:include>
</index>
<index role="1.6">
<title>Index of new symbols in 1.6</title>
<xi:include href="xml/api-index-1.6.xml"><xi:fallback /></xi:include>
</index>
<index role="1.8">
<title>Index of new symbols in 1.8</title>
<xi:include href="xml/api-index-1.8.xml"><xi:fallback /></xi:include>
</index>
<index role="1.10">
<title>Index of new symbols in 1.10</title>
<xi:include href="xml/api-index-1.10.xml"><xi:fallback /></xi:include>
</index>
<index role="1.12">
<title>Index of new symbols in 1.12</title>
<xi:include href="xml/api-index-1.12.xml"><xi:fallback /></xi:include>
</index>
<index role="1.14">
<title>Index of new symbols in 1.14</title>
<xi:include href="xml/api-index-1.14.xml"><xi:fallback /></xi:include>
</index>
<index role="1.16">
<title>Index of new symbols in 1.16</title>
<xi:include href="xml/api-index-1.16.xml"><xi:fallback /></xi:include>
</index>
<index role="1.18">
<title>Index of new symbols in 1.18</title>
<xi:include href="xml/api-index-1.18.xml"><xi:fallback /></xi:include>
</index>
<index role="1.20">
<title>Index of new symbols in 1.20</title>
<xi:include href="xml/api-index-1.20.xml"><xi:fallback /></xi:include>
</index>
<index role="1.22">
<title>Index of new symbols in 1.22</title>
<xi:include href="xml/api-index-1.22.xml"><xi:fallback /></xi:include>
</index>
<index role="1.24">
<title>Index of new symbols in 1.24</title>
<xi:include href="xml/api-index-1.24.xml"><xi:fallback /></xi:include>
</index>
<index role="1.26">
<title>Index of new symbols in 1.26</title>
<xi:include href="xml/api-index-1.26.xml"><xi:fallback /></xi:include>
</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>
|