~gdesklets-desklet-team/gdesklets/0.36

« back to all changes in this revision

Viewing changes to doc/book/prefs-tag-font.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-font" xmlns:xi="http://www.w3.org/2001/XInclude">
 
2
  <title>&lt;font&gt;</title>
 
3
 
 
4
  <para>A font setting. Its representation is a font selection widget.
 
5
    </para>
 
6
 
 
7
  <screenshot>
 
8
    <mediaobject>
 
9
      <imageobject>
 
10
        <imagedata fileref="gfx/prefs-font" 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">bind</entry>
 
33
        <entry valign="top">string</entry>
 
34
        <entry valign="top"></entry>
 
35
        <entry valign="top">The name of the variable or property to which the
 
36
          configuration element is bound.</entry>
 
37
      </row>
 
38
      <row>
 
39
        <entry valign="top">callback</entry>
 
40
        <entry valign="top">function</entry>
 
41
        <entry valign="top"></entry>
 
42
        <entry valign="top"><emph>[new in 0.34]</emph>
 
43
          A callback function
 
44
          which is called every time
 
45
          the value changes. The callback takes the name of the bound
 
46
          property and the new value as arguments.</entry>
 
47
      </row>
 
48
      <row>
 
49
        <entry valign="top">enabled</entry>
 
50
        <entry valign="top">boolean</entry>
 
51
        <entry valign="top">true</entry>
 
52
        <entry valign="top"><emph>[new in 0.34]</emph> 
 
53
          Whether the config item is enabled. Disabled items appear greyed
 
54
          out.</entry>
 
55
      </row>
 
56
      <row>
 
57
        <entry valign="top">help</entry>
 
58
        <entry valign="top">string</entry>
 
59
        <entry valign="top"></entry>
 
60
        <entry valign="top">The tooltip text for the element in the
 
61
          configuration dialog.</entry>
 
62
      </row>
 
63
      <row>
 
64
        <entry valign="top">label</entry>
 
65
        <entry valign="top">string</entry>
 
66
        <entry valign="top"></entry>
 
67
        <entry valign="top">The label text for the element in the
 
68
          configuration dialog.</entry>
 
69
      </row>
 
70
    </tbody>
 
71
 
 
72
    </tgroup>
 
73
    </informaltable>
 
74
 
 
75
  </section>
 
76
 
 
77
 
 
78
 
 
79
  <section><title>Examples</title>
 
80
 
 
81
    <programlisting><![CDATA[
 
82
<font label="Font:" bind="Dsp.tz.font"/>
 
83
    ]]></programlisting>
 
84
 
 
85
  </section>
 
86
 
 
87
</section>