~gdesklets-desklet-team/gdesklets/0.36

« back to all changes in this revision

Viewing changes to doc/book/prefs-tag-page.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:
 
1
<section id="prefs-tag-page" xmlns:xi="http://www.w3.org/2001/XInclude">
 
2
  <title>&lt;page&gt;</title>
 
3
 
 
4
  <para>A page of settings in the configuration dialog. Pages can be used
 
5
    for grouping configuration elements together.</para>
 
6
 
 
7
  <screenshot>
 
8
    <mediaobject>
 
9
      <imageobject>
 
10
        <imagedata fileref="gfx/prefs-page" format="PNG"/>
 
11
      </imageobject>
 
12
    </mediaobject>
 
13
  </screenshot>
 
14
 
 
15
 
 
16
  <section><title>Attributes</title>
 
17
 
 
18
    <informaltable frame="topbot">
 
19
    <tgroup>
 
20
 
 
21
    <thead>
 
22
      <row>
 
23
        <entry>Name</entry>
 
24
        <entry>Type</entry>
 
25
        <entry>Default Value</entry>
 
26
        <entry>Description</entry>
 
27
      </row>
 
28
    </thead>
 
29
 
 
30
    <tbody>
 
31
      <row>
 
32
        <entry valign="top">icon</entry>
 
33
        <entry valign="top">URI</entry>
 
34
        <entry valign="top"></entry>
 
35
        <entry valign="top">URI where to load the icon from.</entry>
 
36
      </row>
 
37
 
 
38
      <row>
 
39
        <entry valign="top">label</entry>
 
40
        <entry valign="top">string</entry>
 
41
        <entry valign="top"></entry>
 
42
        <entry valign="top">The label text on the tab.</entry>
 
43
      </row>
 
44
    </tbody>
 
45
 
 
46
    </tgroup>
 
47
    </informaltable>
 
48
 
 
49
  </section>
 
50
 
 
51
 
 
52
 
 
53
  <section><title>Examples</title>
 
54
 
 
55
    <programlisting><![CDATA[
 
56
<prefs>
 
57
  <page label="gDesklets" icon="gdesklets.png">
 
58
    <boolean label="Foo:" bind="foo"/>
 
59
  </page>
 
60
 
 
61
  <page label="No Icon">
 
62
    <boolean label="Bar:" bind="bar"/>
 
63
  </page>
 
64
</prefs>
 
65
    ]]></programlisting>
 
66
 
 
67
  </section>
 
68
 
 
69
</section>