← Back to branch summary

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

« back to all changes in this revision

Viewing changes to xibook.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:
xibook.xml
4894
4894
  </section>
4895
4895
 
4896
4896
</section>
 
4897
  <section xmlns:xi="http://www.w3.org/2001/XInclude" id="prefs-tag-toggle">
 
4898
  <title>&lt;radio&gt;</title>
 
4899
 
 
4900
  <para>A toggle setting. Its representation is a toggle selection widget
 
4901
    with items defined by <link linkend="prefs-tag-item">&lt;item&gt;</link>
 
4902
    child tags.
 
4903
    </para>
 
4904
 
 
4905
  <screenshot>
 
4906
    <mediaobject>
 
4907
      <imageobject>
 
4908
        <imagedata fileref="gfx/prefs-toggle" format="PNG"/>
 
4909
      </imageobject>
 
4910
    </mediaobject>
 
4911
  </screenshot>
 
4912
 
 
4913
 
 
4914
  <section><title>Attributes</title>
 
4915
 
 
4916
    <informaltable frame="topbot">
 
4917
    <tgroup>
 
4918
 
 
4919
    <thead>
 
4920
      <row>
 
4921
        <entry>Name</entry>
 
4922
        <entry>Type</entry>
 
4923
        <entry>Default Value</entry>
 
4924
        <entry>Description</entry>
 
4925
      </row>
 
4926
    </thead>
 
4927
 
 
4928
    <tbody>
 
4929
      <row>
 
4930
        <entry valign="top">bind</entry>
 
4931
        <entry valign="top">string</entry>
 
4932
        <entry valign="top"/>
 
4933
        <entry valign="top">The name of the variable or property to which the
 
4934
          configuration element is bound.</entry>
 
4935
      </row>
 
4936
      <row>
 
4937
        <entry valign="top">callback</entry>
 
4938
        <entry valign="top">function</entry>
 
4939
        <entry valign="top"/>
 
4940
        <entry valign="top">A callback function which is called every time
 
4941
          the value changes. The callback takes the name of the bound
 
4942
          property and the new value as arguments.</entry>
 
4943
      </row>
 
4944
      <row>
 
4945
        <entry valign="top">enabled</entry>
 
4946
        <entry valign="top">boolean</entry>
 
4947
        <entry valign="top">true</entry>
 
4948
        <entry valign="top">Whether the config item is enabled. Disabled items
 
4949
          appear greyed out.</entry>
 
4950
      </row>
 
4951
      <row>
 
4952
        <entry valign="top">help</entry>
 
4953
        <entry valign="top">string</entry>
 
4954
        <entry valign="top"/>
 
4955
        <entry valign="top">The tooltip text for the element in the
 
4956
          configuration dialog.</entry>
 
4957
      </row>
 
4958
      <row>
 
4959
        <entry valign="top">label</entry>
 
4960
        <entry valign="top">string</entry>
 
4961
        <entry valign="top"/>
 
4962
        <entry valign="top">The label text for the element in the
 
4963
          configuration dialog.</entry>
 
4964
      </row>
 
4965
      <row>
 
4966
        <entry valign="top">items</entry>
 
4967
        <entry valign="top">tuple</entry>
 
4968
        <entry valign="top"/>
 
4969
        <entry valign="top">The items which are children of an toggle can be accessed via this
 
4970
          variable. You will get a list of tuples in the form of 
 
4971
          (label, value).</entry>
 
4972
      </row>
 
4973
    </tbody>
 
4974
 
 
4975
    </tgroup>
 
4976
    </informaltable>
 
4977
 
 
4978
  </section>
 
4979
 
 
4980
 
 
4981
 
 
4982
  <section><title>Examples</title>
 
4983
 
 
4984
    <programlisting><![CDATA[
 
4985
<toggle id="mytoggle" label="Borders" bind="mytoggle" enabled="True" >
 
4986
    <item label="Left" value="left"/>
 
4987
    <item label="Right" value="right"/>
 
4988
    <item label="Top" value="top"/>
 
4989
    <item label="Bottom" value="bottom"/>
 
4990
</toggle>
 
4991
    ]]></programlisting>
 
4992
 
 
4993
  </section>
 
4994
 
 
4995
</section>
4897
4996
  <section xmlns:xi="http://www.w3.org/2001/XInclude" id="prefs-tag-unit">
4898
4997
  <title>&lt;unit&gt;</title>
4899
4998