summaryrefslogtreecommitdiff
path: root/doc/reference/glossary.xml
blob: 5a71a890216d77a993fb8d22c0adad8e221153cd (plain)
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
<?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" [
]>

<glossary>
  <title>Glossary</title>

  <glossentry id="actor">
    <glossterm>actor</glossterm>
    <glossdef>
      <para>An item on the <glossterm linkend="scenegraph">scenegraph</glossterm>. Every
      actor has a <glossterm linkend="parent">parent</glossterm>, except the <glossterm
      linkend="stage">stage</glossterm>, and some actors can be <glossterm
      linkend="container">containers</glossterm>. Every actor has a <glossterm
      linkend="geometry">geometry</glossterm> and, when visible, it should paint its
      contents. The base class for actors is #ClutterActor.</para>
    </glossdef>
  </glossentry>

  <glossentry id="allocation">
    <glossterm>allocation</glossterm>
    <glossdef>
      <para>The final size of an <glossterm linkend="actor">actor</glossterm> within its
      <glossterm linkend="parent">parent</glossterm>. For example, an actor might have
      a preferred <glossterm linkend="minimum-size">minimum size</glossterm> of
      20&times;20 pixels and a <glossterm linkend="natural-size">natural
      size</glossterm> of
      40&times;40 pixels, but its parent may decide to allocate 50&times;20 pixels for
      it instead.</para>
      <glossseealso>
        <glossterm linkend="minimum-size">minimum size</glossterm>
        <glossterm linkend="natural-size">natural size</glossterm>
      </glossseealso>
    </glossdef>
  </glossentry>

  <glossentry id="child">
    <glossterm>child</glossterm>
    <glossdef>
      <para>A <glossterm linkend="container">container's</glossterm> child is an
      <glossterm linkend="actor">actor</glossterm> contained inside it.</para>
    </glossdef>
  </glossentry>

  <glossentry id="container">
    <glossterm>container</glossterm>
    <glossdef>
      <para>An <glossterm linkend="actor">actor</glossterm> 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 <glossterm linkend="child">children</glossterm> manage their <glossterm
      linkend="geometry">geometry</glossterm>, like #ClutterGroup, or they can take care of
      assigning one.</para>
    </glossdef>
  </glossentry>

  <glossentry id="event">
    <glossterm>event</glossterm>
    <glossdef>
      <para>Events are the way in which the Clutter backend informs Clutter about external
      events like pointer motion, button clicks, key presses, etc.</para>
    </glossdef>
  </glossentry>

  <glossentry id="geometry">
    <glossterm>geometry</glossterm>
    <glossdef>
      <para>An <glossterm linkend="actor">actor's</glossterm> position and size. A
      geometry can be expressed in <glossterm linkend="actor">actor-relative</glossterm>
      <glossterm linkend="transformation">untransformed</glossterm> coordinates; or in
      <glossterm linkend="stage">stage-relative</glossterm>, <glossterm
      linkend="transformation">transformed</glossterm> coordinates.</para>
    </glossdef>
  </glossentry>

  <glossentry id="minimum-size">
    <glossterm>minimum size</glossterm>
    <glossdef>
      <para>The minimum, useful size of an <glossterm linkend="actor">actor</glossterm>.
      For instance, a button might have a minimum size of 20&times;20 millimeters on a
      touch screen, to retain the ability for the user to press it. A <glossterm
      linkend="container">container</glossterm> that manages the size of its <glossterm
      linkend="child">children</glossterm> should always try to <glossterm
      linkend="allocation">allocate</glossterm> at least their minimum size.</para>
      <glossseealso>
        <glossterm linkend="natural-size">natural size</glossterm>
        <glossterm linkend="allocation">allocation</glossterm>
      </glossseealso>
    </glossdef>
  </glossentry>

  <glossentry id="natural-size">
    <glossterm>natural size</glossterm>
    <glossdef>
      <para>The default size requested by an <glossterm linkend="actor">actor</glossterm>.</para>
      <glossseealso>
        <glossterm linkend="minimum-size">minimum size</glossterm>
        <glossterm linkend="allocation">allocation</glossterm>
      </glossseealso>
    </glossdef>
  </glossentry>

  <glossentry id="parent">
    <glossterm>parent</glossterm>
    <glossdef>
      <para>An <glossterm linkend="actor">actor's</glossterm> parent is the
      <glossterm linkend="container">container</glossterm> inside which the actor
      resides.</para>
    </glossdef>
  </glossentry>

  <glossentry id="scenegraph">
    <glossterm>scenegraph</glossterm>
    <glossdef>
      <para>The tree of all <glossterm linkend="actor">actors</glossterm>, starting
      from the <glossterm linkend="stage">stage</glossterm> at the root and following
      the <glossterm linkend="container">containers</glossterm>.</para>
    </glossdef>
  </glossentry>

  <glossentry id="stage">
    <glossterm>stage</glossterm>
    <glossdef>
      <para>The top-level <glossterm linkend="container">container</glossterm> for
      <glossterm linkend="actor">actors</glossterm>. 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.</para>
    </glossdef>
  </glossentry>

  <glossentry id="transformation">
    <glossterm>transformation</glossterm>
    <glossdef>
      <para>A rotation, scaling or traslation of an <glossterm
      linkend="actor">actor</glossterm>. Transformations are independent
      of the actor's <glossterm linkend="geometry">geometry</glossterm>.</para>
    </glossdef>
  </glossentry>

</glossary>