Skip to content

Commit 688c936

Browse files
authored
xlet-settings-ref.xml: Updates datechooser, timechooser and layout (#12864)
1 parent ffc1411 commit 688c936

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed

docs/reference/cinnamon-tutorials/xlet-settings-ref.xml

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@
155155
<title>datechooser</title>
156156
<itemizedlist>
157157
<listitem><code>type</code>: should be <code>datechooser</code></listitem>
158-
<listitem><code>default</code>: default date - should be of the form <code>{d: '1', m: '1', y: '2000'}</code></listitem>
158+
<listitem><code>default</code>: default date - should be of the form <code>{'d': 1, 'm': 1, 'y': 2025}</code></listitem>
159159
<listitem><code>description</code>: String describing the setting</listitem>
160160
</itemizedlist>
161161

@@ -167,7 +167,7 @@
167167
<title>timechooser</title>
168168
<itemizedlist>
169169
<listitem><code>type</code>: should be <code>timechooser</code></listitem>
170-
<listitem><code>default</code>: default time - should be of the form <code>{h: '12', m: '0', s: '0'}</code></listitem>
170+
<listitem><code>default</code>: default time - should be of the form <code>{'h': 12, 'm': 0, 's': 0}</code></listitem>
171171
<listitem><code>description</code>: String describing the setting</listitem>
172172
</itemizedlist>
173173

@@ -226,7 +226,8 @@
226226
<para>Here is an example of what a layout object might look like:</para>
227227
<informalexample>
228228
<programlisting>
229-
"layout" : {
229+
"customLayout" : {
230+
"type" : "layout",
230231
"pages" : ["page1", "page2"],
231232
"page1" : {
232233
"type" : "page",
@@ -260,6 +261,25 @@
260261
}
261262
}</programlisting>
262263
</informalexample>
264+
265+
<para>All settings (here "setting1" to "setting8") must be defined after the layout definition.</para>
266+
<informalexample>
267+
<programlisting>
268+
{
269+
"customLayout" : {
270+
"type" : "layout",
271+
[...]
272+
},
273+
"setting1" : {
274+
[...]
275+
},
276+
[...]
277+
"setting8" : {
278+
[...]
279+
}
280+
}</programlisting>
281+
</informalexample>
282+
263283
<para>New in Cinnamon 3.2</para>
264284

265285
</sect3>
@@ -465,7 +485,7 @@ xlet-settings &lt;type&gt; &lt;uuid&gt; &lt;instanceid&gt;</programlisting>
465485
xlet-settings &lt;type&gt; &lt;uuid&gt; -i &lt;instanceid&gt; -t &lt;tabnumber&gt;</programlisting>
466486
</informalexample>
467487
<para>
468-
Where <code>type</code> is <code>applet</code>, <code>desklet</code> or <code>extension</code> depending on what type it is. The <code>instanceid</code> is optional. The <code>tabnumber</code> is optional and designates the tab (or page) you want to access; the tabs are numbered from <code>0</code> to <code>number of tabs - 1</code>.
488+
Where <code>type</code> is <code>applet</code>, <code>desklet</code> or <code>extension</code> depending on what type it is. The <code>instanceid</code> is optional. The <code>tabnumber</code> is optional and designates the tab (or page) you want to access; the tabs are numbered from <code>0</code> to <code>number of tabs - 1</code>.
469489
</para>
470490
<para>
471491
The second command is new in Cinnamon 4.2.

0 commit comments

Comments
 (0)