← Back to branch summary

~gdesklets-desklet-team/gdesklets/develbook

« back to all changes in this revision

Viewing changes to tmp.xml

  • Committer: Bjoern Koch
  • Date: 2010-05-23 23:23:27 UTC
  • Revision ID: h.humpel@gmx.de-20100523232327-9ubq6xwfoojg8skt
Updating to 0.36.2 (there is ConfigToggle new) and lots of little cleaning-up and add-ons.

Show diffs side-by-side

added added

removed removed

Lines of Context:
tmp.xml
38
38
    <year>2006</year>
39
39
    <year>2007</year>
40
40
    <year>2008</year>
 
41
    <year>2009</year>
41
42
    <year>2010</year>
42
43
    <holder>The gDesklets Team</holder>
43
44
  </copyright>
2482
2483
 
2483
2484
</section>
2484
2485
  <section xmlns:xi="http://www.w3.org/2001/XInclude" id="script-menu">
2485
 
  <title>Custom Menus <emphasis>[new in 0.35]</emphasis></title>
 
2486
  <title>Custom Menus</title>
2486
2487
 
2487
2488
  <para>Each display element can have its own custom menu by setting the
2488
2489
    <property>menu</property> property.</para>
3892
3893
  </section>
3893
3894
 
3894
3895
</section>
 
3896
  <section xmlns:xi="http://www.w3.org/2001/XInclude" id="prefs-tag-button">
 
3897
  <title>&lt;button&gt;</title>
 
3898
 
 
3899
  <para>A simple button. Its representation is a button widget.</para>
 
3900
 
 
3901
  <screenshot>
 
3902
    <mediaobject>
 
3903
      <imageobject>
 
3904
        <imagedata fileref="gfx/prefs-button" format="PNG"/>
 
3905
      </imageobject>
 
3906
    </mediaobject>
 
3907
  </screenshot>
 
3908
 
 
3909
 
 
3910
  <section><title>Attributes</title>
 
3911
 
 
3912
    <informaltable frame="topbot">
 
3913
    <tgroup>
 
3914
 
 
3915
    <thead>
 
3916
      <row>
 
3917
        <entry>Name</entry>
 
3918
        <entry>Type</entry>
 
3919
        <entry>Default Value</entry>
 
3920
        <entry>Description</entry>
 
3921
      </row>
 
3922
    </thead>
 
3923
 
 
3924
    <tbody>
 
3925
      <row>
 
3926
        <entry valign="top">callback</entry>
 
3927
        <entry valign="top">function</entry>
 
3928
        <entry valign="top"/>
 
3929
        <entry valign="top">A callback function which is called every time
 
3930
          the button is clicked. The callback takes the name of the bound
 
3931
          property and the new value as arguments.</entry>
 
3932
      </row>
 
3933
      <row>
 
3934
        <entry valign="top">enabled</entry>
 
3935
        <entry valign="top">boolean</entry>
 
3936
        <entry valign="top">true</entry>
 
3937
        <entry valign="top">Whether the config item is enabled. Disabled items
 
3938
          appear greyed out.</entry>
 
3939
      </row>
 
3940
      <row>
 
3941
        <entry valign="top">help</entry>
 
3942
        <entry valign="top">string</entry>
 
3943
        <entry valign="top"/>
 
3944
        <entry valign="top">The tooltip text for the element in the
 
3945
          configuration dialog.</entry>
 
3946
      </row>
 
3947
      <row>
 
3948
        <entry valign="top">label</entry>
 
3949
        <entry valign="top">string</entry>
 
3950
        <entry valign="top"/>
 
3951
        <entry valign="top">The label text for the element in the
 
3952
          configuration dialog.</entry>
 
3953
      </row>
 
3954
    </tbody>
 
3955
 
 
3956
    </tgroup>
 
3957
    </informaltable>
 
3958
 
 
3959
  </section>
 
3960
 
 
3961
 
 
3962
 
 
3963
  <section><title>Examples</title>
 
3964
 
 
3965
    <programlisting><![CDATA[
 
3966
<button label="I am a button. Please click me ;)."
 
3967
        help="Just a simple button."
 
3968
        callback="my_personal_callback" />
 
3969
    ]]></programlisting>
 
3970
 
 
3971
  </section>
 
3972
 
 
3973
</section>
3895
3974
  <section xmlns:xi="http://www.w3.org/2001/XInclude" id="prefs-tag-color">
3896
3975
  <title>&lt;color&gt;</title>
3897
3976
 
4243
4322
          configuration dialog.</entry>
4244
4323
      </row>
4245
4324
      <row>
 
4325
        <entry valign="top">increment</entry>
 
4326
        <entry valign="top">float</entry>
 
4327
        <entry valign="top">1.0</entry>
 
4328
        <entry valign="top">The increment rate when the spin button's
 
4329
          arrows are activated.</entry>
 
4330
      </row>
 
4331
      <row>
4246
4332
        <entry valign="top">label</entry>
4247
4333
        <entry valign="top">string</entry>
4248
4334
        <entry valign="top"/>
4250
4336
          configuration dialog.</entry>
4251
4337
      </row>
4252
4338
      <row>
 
4339
        <entry valign="top">max</entry>
 
4340
        <entry valign="top">float</entry>
 
4341
        <entry valign="top">9999.0</entry>
 
4342
        <entry valign="top">The maximal value allowed.</entry>
 
4343
      </row>
 
4344
      <row>
4253
4345
        <entry valign="top">min</entry>
4254
4346
        <entry valign="top">float</entry>
4255
4347
        <entry valign="top">0.0</entry>
4256
4348
        <entry valign="top">The minimal value allowed.</entry>
4257
4349
      </row>
4258
 
      <row>
4259
 
        <entry valign="top">max</entry>
4260
 
        <entry valign="top">float</entry>
4261
 
        <entry valign="top">9999.0</entry>
4262
 
        <entry valign="top">The maximal value allowed.</entry>
4263
 
      </row>
4264
4350
    </tbody>
4265
4351
 
4266
4352
    </tgroup>
4274
4360
 
4275
4361
    <programlisting><![CDATA[
4276
4362
<float label="Size:" bind="size" min="0.5" max="50.0"
 
4363
       digits="2" increment="0.1" 
4277
4364
       help="The size of the clockface."/>
4278
4365
    ]]></programlisting>
4279
4366
 
4511
4598
          configuration dialog.</entry>
4512
4599
      </row>
4513
4600
      <row>
 
4601
        <entry valign="top">increment</entry>
 
4602
        <entry valign="top">integer</entry>
 
4603
        <entry valign="top">1</entry>
 
4604
        <entry valign="top">The increment rate when the spin button's
 
4605
          arrows are activated.</entry>
 
4606
      </row>
 
4607
      <row>
4514
4608
        <entry valign="top">label</entry>
4515
4609
        <entry valign="top">string</entry>
4516
4610
        <entry valign="top"/>
4518
4612
          configuration dialog.</entry>
4519
4613
      </row>
4520
4614
      <row>
4521
 
        <entry valign="top">min</entry>
4522
 
        <entry valign="top">integer</entry>
4523
 
        <entry valign="top">0</entry>
4524
 
        <entry valign="top">The minimal value allowed.</entry>
4525
 
      </row>
4526
 
      <row>
4527
4615
        <entry valign="top">max</entry>
4528
4616
        <entry valign="top">integer</entry>
4529
4617
        <entry valign="top">9999</entry>
4530
4618
        <entry valign="top">The maximal value allowed.</entry>
4531
4619
      </row>
 
4620
      <row>
 
4621
        <entry valign="top">min</entry>
 
4622
        <entry valign="top">integer</entry>
 
4623
        <entry valign="top">0</entry>
 
4624
        <entry valign="top">The minimal value allowed.</entry>
 
4625
      </row>
4532
4626
    </tbody>
4533
4627
 
4534
4628
    </tgroup>
4894
4988
  </section>
4895
4989
 
4896
4990
</section>
 
4991
  <section xmlns:xi="http://www.w3.org/2001/XInclude" id="prefs-tag-toggle">
 
4992
  <title>&lt;toggle&gt; <emphasis>[new in 0.36.2]</emphasis></title>
 
4993
 
 
4994
  <para>A toggle setting. Its representation is a toggle button widget
 
4995
    with items defined by <link linkend="prefs-tag-item">&lt;item&gt;</link>
 
4996
    child tags.
 
4997
    </para>
 
4998
 
 
4999
  <screenshot>
 
5000
    <mediaobject>
 
5001
      <imageobject>
 
5002
        <imagedata fileref="gfx/prefs-toggle" format="PNG"/>
 
5003
      </imageobject>
 
5004
    </mediaobject>
 
5005
  </screenshot>
 
5006
 
 
5007
 
 
5008
  <section><title>Attributes</title>
 
5009
 
 
5010
    <informaltable frame="topbot">
 
5011
    <tgroup>
 
5012
 
 
5013
    <thead>
 
5014
      <row>
 
5015
        <entry>Name</entry>
 
5016
        <entry>Type</entry>
 
5017
        <entry>Default Value</entry>
 
5018
        <entry>Description</entry>
 
5019
      </row>
 
5020
    </thead>
 
5021
 
 
5022
    <tbody>
 
5023
      <row>
 
5024
        <entry valign="top">bind</entry>
 
5025
        <entry valign="top">string</entry>
 
5026
        <entry valign="top"/>
 
5027
        <entry valign="top">The name of the variable or property to which the
 
5028
          configuration element is bound.</entry>
 
5029
      </row>
 
5030
      <row>
 
5031
        <entry valign="top">callback</entry>
 
5032
        <entry valign="top">function</entry>
 
5033
        <entry valign="top"/>
 
5034
        <entry valign="top">A callback function which is called every time
 
5035
          the value changes. The callback takes the name of the bound
 
5036
          property and the new value as arguments.</entry>
 
5037
      </row>
 
5038
      <row>
 
5039
        <entry valign="top">enabled</entry>
 
5040
        <entry valign="top">boolean</entry>
 
5041
        <entry valign="top">true</entry>
 
5042
        <entry valign="top">Whether the config item is enabled. Disabled items
 
5043
          appear greyed out.</entry>
 
5044
      </row>
 
5045
      <row>
 
5046
        <entry valign="top">help</entry>
 
5047
        <entry valign="top">string</entry>
 
5048
        <entry valign="top"/>
 
5049
        <entry valign="top">The tooltip text for the element in the
 
5050
          configuration dialog.</entry>
 
5051
      </row>
 
5052
      <row>
 
5053
        <entry valign="top">label</entry>
 
5054
        <entry valign="top">string</entry>
 
5055
        <entry valign="top"/>
 
5056
        <entry valign="top">The label text for the element in the
 
5057
          configuration dialog.</entry>
 
5058
      </row>
 
5059
      <row>
 
5060
        <entry valign="top">items</entry>
 
5061
        <entry valign="top">tuple</entry>
 
5062
        <entry valign="top"/>
 
5063
        <entry valign="top">The items which are children of an toggle can be accessed via this
 
5064
          variable. You will get a list of tuples in the form of 
 
5065
          (label, value).</entry>
 
5066
      </row>
 
5067
    </tbody>
 
5068
 
 
5069
    </tgroup>
 
5070
    </informaltable>
 
5071
 
 
5072
  </section>
 
5073
 
 
5074
 
 
5075
 
 
5076
  <section><title>Examples</title>
 
5077
 
 
5078
    <programlisting><![CDATA[
 
5079
<toggle id="mytoggle" label="Borders" bind="mytoggle" enabled="True" >
 
5080
    <item label="Left" value="left"/>
 
5081
    <item label="Right" value="right"/>
 
5082
    <item label="Top" value="top"/>
 
5083
    <item label="Bottom" value="bottom"/>
 
5084
</toggle>
 
5085
    ]]></programlisting>
 
5086
 
 
5087
  </section>
 
5088
 
 
5089
</section>
4897
5090
  <section xmlns:xi="http://www.w3.org/2001/XInclude" id="prefs-tag-unit">
4898
5091
  <title>&lt;unit&gt;</title>
4899
5092
 
4901
5094
    a value and select from the supported measurement units.
4902
5095
    </para>
4903
5096
 
4904
 
  <!--
4905
5097
  <screenshot>
4906
5098
    <mediaobject>
4907
5099
      <imageobject>
4909
5101
      </imageobject>
4910
5102
    </mediaobject>
4911
5103
  </screenshot>
4912
 
  -->
4913
5104
 
4914
5105
  <section><title>Attributes</title>
4915
5106
 
4993
5184
          configuration dialog.</entry>
4994
5185
      </row>
4995
5186
      <row>
 
5187
        <entry valign="top">increment</entry>
 
5188
        <entry valign="top">float</entry>
 
5189
        <entry valign="top">1.0</entry>
 
5190
        <entry valign="top">The increment rate when the spin button's
 
5191
          arrows are activated.</entry>
 
5192
      </row>
 
5193
      <row>
4996
5194
        <entry valign="top">label</entry>
4997
5195
        <entry valign="top">string</entry>
4998
5196
        <entry valign="top"/>
5000
5198
          configuration dialog.</entry>
5001
5199
      </row>
5002
5200
      <row>
 
5201
        <entry valign="top">max</entry>
 
5202
        <entry valign="top">float</entry>
 
5203
        <entry valign="top">9999.0</entry>
 
5204
        <entry valign="top">The maximal value allowed.</entry>
 
5205
      </row>
 
5206
      <row>
5003
5207
        <entry valign="top">min</entry>
5004
5208
        <entry valign="top">float</entry>
5005
5209
        <entry valign="top">0.0</entry>
5006
5210
        <entry valign="top">The minimal value allowed.</entry>
5007
5211
      </row>
5008
 
      <row>
5009
 
        <entry valign="top">max</entry>
5010
 
        <entry valign="top">float</entry>
5011
 
        <entry valign="top">9999.0</entry>
5012
 
        <entry valign="top">The maximal value allowed.</entry>
5013
 
      </row>
5014
5212
    </tbody>
5015
5213
 
5016
5214
    </tgroup>
6649
6847
 
6650
6848
</appendix>
6651
6849
  <appendix xmlns:xi="http://www.w3.org/2001/XInclude" id="apdx-cursors">
6652
 
  <title>Cursors <emphasis>[New in 0.35]</emphasis></title>
 
6850
  <title>Cursors</title>
6653
6851
 
6654
6852
  <para>The appearance of the cursors depends on the desktop cursor theme which
6655
6853
    the user has selected. Thus you should not choose cursors by their image but