← Back to branch summary

~gdesklets-desklet-team/gdesklets/0.36

« back to all changes in this revision

Viewing changes to doc/book/apdx-datatypes.xml

  • Committer: Robert Pastierovic
  • Date: 2007-10-07 10:08:42 UTC
  • Revision ID: pastierovic@gmail.com-20071007100842-fdvp2vzmqgh1j87k
merged 0.3x branch and basic documentation and some other changes

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/book/apdx-datatypes.xml
 
1
<appendix id="apdx-datatypes"  xmlns:xi="http://www.w3.org/2001/XInclude">
 
2
  <title>Datatypes in gDesklets</title>
 
3
 
 
4
  <informaltable frame="topbot">
 
5
  <tgroup>
 
6
 
 
7
  <thead>
 
8
    <row>
 
9
      <entry>Datatype</entry>
 
10
      <entry>Description</entry>
 
11
    </row>
 
12
  </thead>
 
13
 
 
14
  <tbody>
 
15
    <row>
 
16
      <entry valign="top">boolean</entry>
 
17
      <entry valign="top">Either <literal>true</literal> or
 
18
        <literal>false</literal>.</entry>
 
19
    </row>
 
20
  </tbody>
 
21
 
 
22
  <tbody>
 
23
    <row>
 
24
      <entry valign="top">color</entry>
 
25
      <entry valign="top">Can either be a textual name such as "red", or
 
26
        a hexadecimal value initiated by a hash sign (#), consisting of red,
 
27
        green, blue, and alpha values. Each value is 8 bit (between
 
28
        <literal>00</literal> and <literal>FF</literal>. The alpha byte is
 
29
        optional and not supported always.</entry>
 
30
    </row>
 
31
  </tbody>
 
32
 
 
33
  <tbody>
 
34
    <row>
 
35
      <entry valign="top">direction</entry>
 
36
      <entry valign="top">One of the strings <literal>nw, n, ne, e, se, s,
 
37
        sw, w, center</literal>. The strings represent the directions
 
38
        north-west, north, north-east, east, south-east, south, south-west,
 
39
        west, center, respectively.</entry>
 
40
    </row>
 
41
  </tbody>
 
42
 
 
43
  <tbody>
 
44
    <row>
 
45
      <entry valign="top">float</entry>
 
46
      <entry valign="top">A floating point value.</entry>
 
47
    </row>
 
48
  </tbody>
 
49
 
 
50
  <tbody>
 
51
    <row>
 
52
      <entry valign="top">font</entry>
 
53
      <entry valign="top">A font string consists of the font family,
 
54
        some styles (like <literal>bold</literal> or
 
55
        <literal>italic</literal>), and a size value, which is a valid
 
56
        <link linkend="apdx-datatypes-unit">unit</link> value.</entry>
 
57
    </row>
 
58
  </tbody>
 
59
 
 
60
  <tbody>
 
61
    <row>
 
62
      <entry valign="top">integer</entry>
 
63
      <entry valign="top">An integer value.</entry>
 
64
    </row>
 
65
  </tbody>
 
66
 
 
67
  <tbody>
 
68
    <row>
 
69
      <entry valign="top">object</entry>
 
70
      <entry valign="top">An object with which you can interact with.</entry>
 
71
    </row>
 
72
  </tbody>
 
73
 
 
74
  <tbody>
 
75
    <row>
 
76
      <entry valign="top">script</entry>
 
77
      <entry valign="top">A string of Python script.</entry>
 
78
    </row>
 
79
  </tbody>
 
80
 
 
81
  <tbody>
 
82
    <row>
 
83
      <entry valign="top">string</entry>
 
84
      <entry valign="top">A string of characters enclosed in single (') or
 
85
        double quotes (").</entry>
 
86
    </row>
 
87
  </tbody>
 
88
 
 
89
  <tbody>
 
90
    <row id="apdx-datatypes-unit">
 
91
      <entry valign="top">unit</entry>
 
92
      <entry valign="top">A size or coordinate value with a measurement unit.
 
93
        The measurement units can be <literal>cm, in, pt, %</literal> for
 
94
        centimeters, inches, DTP points, or percentage values, respectively.
 
95
        If no unit is given, pixels are used.</entry>
 
96
    </row>
 
97
  </tbody>
 
98
 
 
99
  <tbody>
 
100
    <row>
 
101
      <entry valign="top">URI</entry>
 
102
      <entry valign="top">A Uniform Resource Identifier. This can be a
 
103
        valid URL, a local file path, or a valid VFS path.</entry>
 
104
    </row>
 
105
  </tbody>
 
106
 
 
107
  </tgroup>
 
108
  </informaltable>
 
109
 
 
110
</appendix>