From 7783635af3c78cf65fcb62ccb03478f1a9556b05 Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Thu, 3 Sep 2009 16:51:14 +0100 Subject: [PATCH] [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 --- doc/reference/clutter/Makefile.am | 2 + doc/reference/clutter/clutter-docs.xml.in | 45 ++++++- doc/reference/clutter/glossary.xml | 142 ++++++++++++++++++++++ 3 files changed, 184 insertions(+), 5 deletions(-) create mode 100644 doc/reference/clutter/glossary.xml diff --git a/doc/reference/clutter/Makefile.am b/doc/reference/clutter/Makefile.am index 3b702111b..31eaa93ea 100644 --- a/doc/reference/clutter/Makefile.am +++ b/doc/reference/clutter/Makefile.am @@ -113,6 +113,7 @@ HTML_IMAGES=\ # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). # e.g. content_files=running.sgml building.sgml changes-2.0.sgml content_files= \ + glossary.xml \ subclassing-ClutterActor.xml \ clutter-animation-tutorial.xml \ creating-behaviours.xml \ @@ -125,6 +126,7 @@ content_files= \ # These files must be listed here *and* in content_files # e.g. expand_content_files=running.sgml expand_content_files= \ + glossary.xml \ subclassing-ClutterActor.xml \ clutter-animation-tutorial.xml \ creating-behaviours.xml \ diff --git a/doc/reference/clutter/clutter-docs.xml.in b/doc/reference/clutter/clutter-docs.xml.in index 85a3ff6ec..5e43d3b29 100644 --- a/doc/reference/clutter/clutter-docs.xml.in +++ b/doc/reference/clutter/clutter-docs.xml.in @@ -115,7 +115,7 @@ - + Clutter Tools @@ -147,7 +147,7 @@ - + Clutter Backends @@ -164,7 +164,7 @@ - + Additional Documentation @@ -177,7 +177,7 @@ - + Migrating from previous version of Clutter @@ -190,32 +190,67 @@ + + Clutter Actors and Objects + + + Object Hierarchy + + + + + + Object Index + + + + + + + Glossaries + + + + + - Index + Index of all symbols + Index of deprecated symbols + Index of new symbols in 0.2 + Index of new symbols in 0.4 + Index of new symbols in 0.6 + Index of new symbols in 0.8 + Index of new symbols in 1.0 + + + + + Index of new symbols in 1.2 + diff --git a/doc/reference/clutter/glossary.xml b/doc/reference/clutter/glossary.xml new file mode 100644 index 000000000..5a71a8902 --- /dev/null +++ b/doc/reference/clutter/glossary.xml @@ -0,0 +1,142 @@ + + + + + Glossary + + + actor + + An item on the scenegraph. Every + actor has a parent, except the stage, and some actors can be containers. Every actor has a geometry and, when visible, it should paint its + contents. The base class for actors is #ClutterActor. + + + + + allocation + + The final size of an actor within its + parent. For example, an actor might have + a preferred minimum size of + 20×20 pixels and a natural + size of + 40×40 pixels, but its parent may decide to allocate 50×20 pixels for + it instead. + + minimum size + natural size + + + + + + child + + A container's child is an + actor contained inside it. + + + + + container + + An actor which can contain other + actors. If a container is meant to be extended using public API it should implement + the #ClutterContainer interface; otherwise it is a composite actor. A container + can let its children manage their geometry, like #ClutterGroup, or they can take care of + assigning one. + + + + + event + + Events are the way in which the Clutter backend informs Clutter about external + events like pointer motion, button clicks, key presses, etc. + + + + + geometry + + An actor's position and size. A + geometry can be expressed in actor-relative + untransformed coordinates; or in + stage-relative, transformed coordinates. + + + + + minimum size + + The minimum, useful size of an actor. + For instance, a button might have a minimum size of 20×20 millimeters on a + touch screen, to retain the ability for the user to press it. A container that manages the size of its children should always try to allocate at least their minimum size. + + natural size + allocation + + + + + + natural size + + The default size requested by an actor. + + minimum size + allocation + + + + + + parent + + An actor's parent is the + container inside which the actor + resides. + + + + + scenegraph + + The tree of all actors, starting + from the stage at the root and following + the containers. + + + + + stage + + The top-level container for + actors. Depending on the Clutter back end a + stage can be associated to a window or to a frame buffer; also depending on the back + end is the number of instantiatable stages. Stages in Clutter can be manipulated using + the #ClutterStage API. + + + + + transformation + + A rotation, scaling or traslation of an actor. Transformations are independent + of the actor's geometry. + + + +