← Back to branch summary

~gdesklets-desklet-team/gdesklets/develbook-control-array

« back to all changes in this revision

Viewing changes to prefs-tag-button.xml

  • Committer: Joe Sapp
  • Date: 2010-06-18 01:28:55 UTC
  • mfrom: (8.1.2 develbook)
  • Revision ID: nixphoeni@gmail.com-20100618012855-9wvhtf9y1lzr7q11
Merged main branch

Show diffs side-by-side

added added

removed removed

Lines of Context:
prefs-tag-button.xml
 
1
<section id="prefs-tag-button" xmlns:xi="http://www.w3.org/2001/XInclude">
 
2
  <title>&lt;button&gt;</title>
 
3
 
 
4
  <para>A simple button. Its representation is a button widget.</para>
 
5
 
 
6
  <screenshot>
 
7
    <mediaobject>
 
8
      <imageobject>
 
9
        <imagedata fileref="gfx/prefs-button" format="PNG"/>
 
10
      </imageobject>
 
11
    </mediaobject>
 
12
  </screenshot>
 
13
 
 
14
 
 
15
  <section><title>Attributes</title>
 
16
 
 
17
    <informaltable frame="topbot">
 
18
    <tgroup>
 
19
 
 
20
    <thead>
 
21
      <row>
 
22
        <entry>Name</entry>
 
23
        <entry>Type</entry>
 
24
        <entry>Default Value</entry>
 
25
        <entry>Description</entry>
 
26
      </row>
 
27
    </thead>
 
28
 
 
29
    <tbody>
 
30
      <row>
 
31
        <entry valign="top">callback</entry>
 
32
        <entry valign="top">function</entry>
 
33
        <entry valign="top"></entry>
 
34
        <entry valign="top">A callback function which is called every time
 
35
          the button is clicked. The callback takes the name of the bound
 
36
          property and the new value as arguments.</entry>
 
37
      </row>
 
38
      <row>
 
39
        <entry valign="top">enabled</entry>
 
40
        <entry valign="top">boolean</entry>
 
41
        <entry valign="top">true</entry>
 
42
        <entry valign="top">Whether the config item is enabled. Disabled items
 
43
          appear greyed out.</entry>
 
44
      </row>
 
45
      <row>
 
46
        <entry valign="top">help</entry>
 
47
        <entry valign="top">string</entry>
 
48
        <entry valign="top"></entry>
 
49
        <entry valign="top">The tooltip text for the element in the
 
50
          configuration dialog.</entry>
 
51
      </row>
 
52
      <row>
 
53
        <entry valign="top">label</entry>
 
54
        <entry valign="top">string</entry>
 
55
        <entry valign="top"></entry>
 
56
        <entry valign="top">The label text for the element in the
 
57
          configuration dialog.</entry>
 
58
      </row>
 
59
    </tbody>
 
60
 
 
61
    </tgroup>
 
62
    </informaltable>
 
63
 
 
64
  </section>
 
65
 
 
66
 
 
67
 
 
68
  <section><title>Examples</title>
 
69
 
 
70
    <programlisting><![CDATA[
 
71
<button label="I am a button. Please click me ;)."
 
72
        help="Just a simple button."
 
73
        callback="my_personal_callback" />
 
74
    ]]></programlisting>
 
75
 
 
76
  </section>
 
77
 
 
78
</section>