[doc] misc. patchs & small improvements
[scilab.git] / scilab / modules / gui / help / en_US / uicontrol_properties.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="uicontrol_properties" xml:lang="en">
3     <refnamediv>
4         <refname>uicontrol properties</refname>
5         <refpurpose>Description of the uicontrol properties.</refpurpose>
6     </refnamediv>
7     <refsection>
8         <title>Description</title>
9         <para>
10             These properties can be set using the <link linkend="set">set</link> or <link linkend="uicontrol">uicontrol</link>
11             functions and their value can be obtained with the <link linkend="get">get</link>.
12         </para>
13     </refsection>
14     <refsection>
15         <title>Properties</title>
16         <variablelist>
17             <varlistentry>
18                 <term>BackgroundColor</term>
19                 <listitem>
20                     <para>[1,3] real vector or string</para>
21                     <para>Background color of the uicontrol. A color is specified as
22                         Red, Green and Blue values. Those values are real in [0,1]. The
23                         color can be given as a real vector, ie [R,G,B] or a string where
24                         each value is separated by a "|", ie "R|G|B".
25                     </para>
26                     <para>
27                         Setting this property to <literal>[-1 -1 -1]</literal> will let the look and feel set the default background color.
28                     </para>
29                 </listitem>
30             </varlistentry>
31             <varlistentry>
32                 <term>Border</term>
33                 <listitem>
34                     <para>A Border object.</para>
35                     <para>
36                         Only used for <literal>frame</literal> style uicontrols, this object is created using <link linkend="createBorder">createBorder</link>.
37                     </para>
38                     <para>
39                         Setting this value to <literal>[]</literal> removes the border of the frame.
40                     </para>
41                 </listitem>
42             </varlistentry>
43             <varlistentry>
44                 <term>Callback</term>
45                 <listitem>
46                     <para>String</para>
47                     <para>Instruction evaluated by the Scilab interpreter when an uicontrol is activated (for example when you click on a button).</para>
48                     <para>
49                         This property is not used for <literal>layer</literal>, <literal>frame</literal> and <literal>text</literal> style uicontrols.
50                     </para>
51                 </listitem>
52             </varlistentry>
53             <varlistentry>
54                 <term>Callback_Type</term>
55                 <listitem>
56                     <para>Scalar</para>
57                     <para>The type of callback transmitted to the uicontrol (see example below).</para>
58                     <variablelist>
59                         <varlistentry>
60                             <term>
61                                 <literal>-1</literal>
62                             </term>
63                             <listitem>
64                                 <para>none (callback deactivated)</para>
65                             </listitem>
66                         </varlistentry>
67                         <varlistentry>
68                             <term>
69                                 <literal>0</literal> (by default)
70                             </term>
71                             <listitem>
72                                 <para>non prioritary (or interruptible) Scilab instructions</para>
73                             </listitem>
74                         </varlistentry>
75                         <varlistentry>
76                             <term>
77                                 <literal>1</literal>
78                             </term>
79                             <listitem>
80                                 <para>Cor a Fortran function</para>
81                             </listitem>
82                         </varlistentry>
83                         <varlistentry>
84                             <term>
85                                 <literal>2</literal>
86                             </term>
87                             <listitem>
88                                 <para>non prioritary (or interruptible) Scilab function</para>
89                             </listitem>
90                         </varlistentry>
91                         <varlistentry>
92                             <term>
93                                 <literal>10</literal>
94                             </term>
95                             <listitem>
96                                 <para>prioritary (or non-interruptible) Scilab instructions</para>
97                             </listitem>
98                         </varlistentry>
99                         <varlistentry>
100                             <term>
101                                 <literal>12</literal>
102                             </term>
103                             <listitem>
104                                 <para>prioritary (or non-interruptible) Scilab function</para>
105                             </listitem>
106                         </varlistentry>
107                     </variablelist>
108                 </listitem>
109             </varlistentry>
110             <varlistentry>
111                 <term>Constraints</term>
112                 <listitem>
113                     <para>A Constraints object.</para>
114                     <para>
115                         This object is created using <link linkend="createConstraints">createConstraints</link>
116                         and describes the constraints on the position and size of the uicontrol regarding to its parent.
117                     </para>
118                     <para>
119                         Setting this value to <literal>[]</literal> clears the constraints.
120                     </para>
121                 </listitem>
122             </varlistentry>
123             <varlistentry>
124                 <term>Enable</term>
125                 <listitem>
126                     <para>{on} | off</para>
127                     <para>
128                         Enable or disable the uicontrol. If this property is set to <literal>"on"</literal> (default), the uicontrol is operational,
129                         but if this property is set to <literal>"off"</literal>, the uicontrol will not respond to the mouse actions and will be grayed out.
130                     </para>
131                 </listitem>
132             </varlistentry>
133             <varlistentry>
134                 <term>FontAngle</term>
135                 <listitem>
136                     <para>{normal} | italic | oblique</para>
137                     <para>For a control containing some text, this property sets the slant of the font.</para>
138                 </listitem>
139             </varlistentry>
140             <varlistentry>
141                 <term>FontSize</term>
142                 <listitem>
143                     <para>Scalar</para>
144                     <para>For a control containing some text, this property sets the size of the font in FontUnits.
145                     </para>
146                 </listitem>
147             </varlistentry>
148             <varlistentry>
149                 <term>FontUnits</term>
150                 <listitem>
151                     <para>{points} | pixels | normalized</para>
152                     <para>For a control containing some text, this property sets the
153                         units with which the FontSize is specified.
154                     </para>
155                 </listitem>
156             </varlistentry>
157             <varlistentry>
158                 <term>FontWeight</term>
159                 <listitem>
160                     <para>light | {normal} | demi | bold</para>
161                     <para>For a control containing some text, this property sets the
162                         weight of the used font.
163                     </para>
164                 </listitem>
165             </varlistentry>
166             <varlistentry>
167                 <term>FontName</term>
168                 <listitem>
169                     <para>String</para>
170                     <para>Used to choose the name of the font selected to display the
171                         text of the control.
172                     </para>
173                 </listitem>
174             </varlistentry>
175             <varlistentry>
176                 <term>ForegroundColor</term>
177                 <listitem>
178                     <para>[1,3] real vector or string</para>
179                     <para>Foreground color of the uicontrol. A color is specified as
180                         Red, Green and Blue values. Those values are real in [0,1]. The
181                         color can be given as a real vector, ie [R,G,B] or a string where
182                         each value is separated by a "|", ie "R|G|B".
183                     </para>
184                     <para>
185                         Setting this property to <literal>[-1 -1 -1]</literal> will let the look and feel set the default foreground color.
186                     </para>
187                 </listitem>
188             </varlistentry>
189             <varlistentry>
190                 <term>Groupname</term>
191                 <listitem>
192                     <para>String</para>
193                     <para>
194                         Used for <literal>radiobutton</literal> and <literal>checkbox</literal> style uicontrols,
195                         this property allow to manage uicontrols of the same group as a whole. For example, <literal>checkbox</literal> uicontrols of a group
196                         will manage selection unicity automatically.
197                     </para>
198                 </listitem>
199             </varlistentry>
200             <varlistentry>
201                 <term>HorizontalAlignment</term>
202                 <listitem>
203                     <para>left | {center} | right</para>
204                     <para>Set text horizontal alignment in the uicontrol.</para>
205                 </listitem>
206             </varlistentry>
207             <varlistentry>
208                 <term>Icon</term>
209                 <listitem>
210                     <para>String.</para>
211                     <para>
212                         This property represents the relative (to <link linkend="pwd">Scilab working directory</link>) or absolute path of the image file to be
213                         used as icon for a <literal>pushbutton</literal> or <literal>text</literal> uicontrol.
214                     </para>
215                     <para>
216                         For <literal>frame</literal> uicontrols in <literal>tab</literal> uicontrols, the icon property sets the icon of its sheet.
217                     </para>
218                 </listitem>
219             </varlistentry>
220             <varlistentry>
221                 <term>Layout: </term>
222                 <listitem>
223                     <para>
224                         This property sets the layout used to dispose <literal>frame</literal> uicontrols children.
225                         See <link linkend="layout">layout</link> page for more information about available layouts.
226                     </para>
227                 </listitem>
228             </varlistentry>
229             <varlistentry>
230                 <term>Layout_options: </term>
231                 <listitem>
232                     <para>
233                         This property sets the options of the layout used to dispose <literal>frame</literal> children. See <link linkend="layout">layout</link> page for more information about available options.
234                     </para>
235                 </listitem>
236             </varlistentry>
237             <varlistentry>
238                 <term>ListboxTop</term>
239                 <listitem>
240                     <para>Scalar</para>
241                     <para>
242                         Only used for <literal>listbox</literal> uicontrols, this property tells which item of the list appears on the first line of the visible area of the list.
243                     </para>
244                 </listitem>
245             </varlistentry>
246             <varlistentry>
247                 <term>Margins</term>
248                 <listitem>
249                     <para>[1,4] real vector.</para>
250                     <para>
251                         Sets an empty space around the uicontrol under the form <literal>[top, left, bottom, right]</literal> (in pixels).
252                     </para>
253                 </listitem>
254             </varlistentry>
255             <varlistentry>
256                 <term>Max</term>
257                 <listitem>
258                     <para>Scalar</para>
259                     <para>Specifies the largest value the "Value" property can be set
260                         to. It has however different meaning on each uicontrol:
261                     </para>
262                     <itemizedlist>
263                         <listitem>
264                             <para>
265                                 <literal>checkbox</literal> and <literal>radiobutton</literal> uicontrols: Max is the value the "Value" property take when control is checked.
266                             </para>
267                         </listitem>
268                         <listitem>
269                             <para>
270                                 <literal>slider</literal> and <literal>spinner</literal> uicontrols: Maximum value of the component.
271                             </para>
272                         </listitem>
273                         <listitem>
274                             <para>
275                                 <literal>listbox</literal> uicontrols: if (Max-Min)&gt;1 the list allows multiple selection.
276                             </para>
277                         </listitem>
278                         <listitem>
279                             <para>
280                                 <literal>edit</literal> uicontrols: if (Max-Min)&gt;1 the edit allows multiple line edition.
281                             </para>
282                         </listitem>
283                     </itemizedlist>
284                 </listitem>
285             </varlistentry>
286             <varlistentry>
287                 <term>Min</term>
288                 <listitem>
289                     <para>Scalar</para>
290                     <para>Specifies the lowest value the "Value" property can be set to.
291                         It has however different meaning on each uicontrol:
292                     </para>
293                     <itemizedlist>
294                         <listitem>
295                             <para>
296                                 <literal>checkbox</literal> and <literal>radiobutton</literal> uicontrols: Min is the value the "Value" property take when control is unchecked.
297                             </para>
298                         </listitem>
299                         <listitem>
300                             <para>
301                                 <literal>slider</literal> and <literal>spinner</literal> uicontrols: Minimum value of the component.
302                             </para>
303                         </listitem>
304                         <listitem>
305                             <para>
306                                 <literal>listbox</literal> uicontrols: if (Max-Min)&gt;1 the list allows multiple selection.
307                             </para>
308                         </listitem>
309                         <listitem>
310                             <para>
311                                 <literal>edit</literal> uicontrols: if (Max-Min)&gt;1 the edit allows multiple line edition.
312                             </para>
313                         </listitem>
314                     </itemizedlist>
315                 </listitem>
316             </varlistentry>
317             <varlistentry>
318                 <term>Parent</term>
319                 <listitem>
320                     <para>Handle</para>
321                     <para>Handle of the uicontrol parent. Changing this property allows
322                         to move a control from a figure to another.
323                     </para>
324                 </listitem>
325             </varlistentry>
326             <varlistentry>
327                 <term>Position</term>
328                 <listitem>
329                     <para>[1,4] real vector or string.</para>
330                     <para>This property is used to set or get the geometrical
331                         configuration of a control. It is a vector [x y w h] where the
332                         letters stand for the x location of the left bottom corner, the y
333                         location of the left bottom corner, the width and the height of the
334                         uicontrol or a character string where each value is separated by a
335                         "|", ie "x|y|w|h". The units are determined by the "Units"
336                         property.
337                     </para>
338                     <para>The width and height values determine the orientation of sliders. If width is greater than height, then the slider is oriented horizontally, otherwise the slider is oriented vertically.</para>
339                 </listitem>
340             </varlistentry>
341             <varlistentry>
342                 <term>Relief</term>
343                 <listitem>
344                     <para>{default} | flat | groove | raised | ridge | solid | sunken</para>
345                     <para>
346                         Appearance of the border of the uicontrol. <literal>"default"</literal> means that the application look and feel will be used to set the relief.
347                     </para>
348                     <para>When using the deprecated skin for uicontrols, default values are related to uicontrol style:</para>
349                     <itemizedlist>
350                         <listitem>
351                             <para>
352                                 <literal>pushbutton</literal> uicontrols: the default value for "Relief" property is "raised".
353                             </para>
354                         </listitem>
355                         <listitem>
356                             <para>
357                                 <literal>edit</literal> uicontrols: the default value for "Relief" property is "sunken".
358                             </para>
359                         </listitem>
360                         <listitem>
361                             <para>Other uicontrols: the default value for "Relief" property is relief by default provided by java language.</para>
362                         </listitem>
363                     </itemizedlist>
364                 </listitem>
365             </varlistentry>
366             <varlistentry>
367                 <term>Scrollable</term>
368                 <listitem>
369                     <para>Boolean.</para>
370                     <para>
371                         Used for <literal>frame</literal> and <literal>edit</literal> style uicontrols, this property indicates if the uicontrol must have scrolling capabilities (<literal>%T</literal>) or not (default <literal>%F</literal>).
372                     </para>
373                     <para>
374                         For <literal>frame</literal> this value must be set at creation.
375                     </para>
376                 </listitem>
377             </varlistentry>
378             <varlistentry>
379                 <term>SliderStep</term>
380                 <listitem>
381                     <para>[1,2] real vector</para>
382                     <para>[small big], the small step represents the movement achieved
383                         when clicking on the slider trough or tapping on the keyboard arrows
384                         (when the slider has focus); the big step is the amount moved when
385                         using Ctrl-keyboard-arrows. If the big step is omitted, it is
386                         defaulted to 1/10 of the scale.
387                     </para>
388                     <para>
389                         For <literal>spinner</literal> uicontrol, the first value of this property is used as fixed step.
390                     </para>
391                 </listitem>
392             </varlistentry>
393             <varlistentry>
394                 <term>SnapToTicks</term>
395                 <listitem>
396                     <para>on | {off}</para>
397                     <para>If <literal>SnapToTicks</literal> is <literal>"on"</literal>, the Slider knob will always snap to the closest position associated to a value given by the "Min" property plus an integer multiple of small step (see SliderStep above). The default value of this property is "off".
398                     </para>
399                 </listitem>
400             </varlistentry>
401             <varlistentry>
402                 <term>String</term>
403                 <listitem>
404                     <para>String.</para>
405                     <para>
406                         This property represents the text appearing in a uicontrol
407                         (Except for Frame and Slider styles). For tables, the value is a string matrix. For ListBoxes and PopupMenus,
408                         the value can be a vector of string or a string where the items are
409                         separated by a "|". For Text uicontrols, this string can contain HTML code to format the text.
410                     </para>
411                     <itemizedlist>
412                         <listitem>
413                             <para>
414                                 For <literal>pushbutton</literal> or <literal>text</literal> uicontrols, if the text is enclosed between two $ (dollar sign), then it will be
415                                 considered as a LaTeX expression, and if it is enclosed between &lt; and &gt;, it will be considered
416                                 as a MathML one.
417                             </para>
418                         </listitem>
419                         <listitem>
420                             <para>
421                                 For <literal>layer</literal> and <literal>tab</literal> uicontrols, the value specifies the tag of the selected child.
422                             </para>
423                         </listitem>
424                         <listitem>
425                             <para>
426                                 For <literal>image</literal> uicontrols, the value specifies the path of the image file.
427                             </para>
428                         </listitem>
429                         <listitem>
430                             <para>
431                                 For <literal>table</literal> uicontrols, the value specifies the whole table data: <literal>[IGNORED COL1-HEADER...COLN-HEADER;ROW1-HEADER, ROW1COL1-DATA, ROW1COLN-DATA;...;ROWM-HEADER, ROWMCOL1-DATA, ROWMCOLN-DATA]</literal>.
432                             </para>
433                         </listitem>
434                         <listitem>
435                             <para>
436                                 For <literal>listbox</literal> and <literal>popupmenu</literal> uicontrols which manage colors selection, icons, background
437                                 and foreground colors, the <literal>String</literal> property can be set to a matrix matching the format:
438                                 <literal>["#color1", "Item1", "#background1", "#foreground1"; "#color2", "Item2", ..., ...]</literal>
439                                 <literal>["icon1", "Item1", "#background1", "#foreground1"; "icon2", "Item2", ..., ...]</literal>
440                                 with <literal>"#color1"</literal>, <literal>"#background1"</literal> and <literal>"#foreground1"</literal> in HTML format <literal>#XXXXXX</literal>.
441                                 Then the component will display a colored box or icon on the left of the associated string,
442                                 and different background/foreground colors for items.
443                             </para>
444                         </listitem>
445                     </itemizedlist>
446                     
447                 </listitem>
448             </varlistentry>
449             <varlistentry>
450                 <term>Tag</term>
451                 <listitem>
452                     <para>String</para>
453                     <para>This property is generally used to identify the control. It
454                         allows to give it a "name". Mainly used in conjunction with
455                         <literal>findobj()</literal>.
456                     </para>
457                 </listitem>
458             </varlistentry>
459             <varlistentry>
460                 <term>Title_position</term>
461                 <listitem>
462                     <para>{top} | left | bottom | right</para>
463                     <para>
464                         The position of the tabs of a <literal>tab</literal> style uicontrol.
465                     </para>
466                 </listitem>
467             </varlistentry>
468             <varlistentry>
469                 <term>Title_scroll</term>
470                 <listitem>
471                     <para>Boolean</para>
472                     <para>
473                         Indicates whether the tabs of a <literal>tab</literal> style uicontrol
474                         must be wrapped (<literal>title_scroll=%F</literal>) or scrolled (<literal>title_scroll=%T</literal>).
475                     </para>
476                 </listitem>
477             </varlistentry>
478             <varlistentry>
479                 <term>TooltipString</term>
480                 <listitem>
481                     <para>String or String vector</para>
482                     <para>
483                         This property represents the text of the uicontrol tooltip appearing when the mouse is over the uicontrol.
484                     </para>
485                 </listitem>
486             </varlistentry>
487             <varlistentry>
488                 <term>Units</term>
489                 <listitem>
490                     <para>{points} | pixels | normalized</para>
491                     <para>Set the units used to specify the "Position" property.</para>
492                 </listitem>
493             </varlistentry>
494             <varlistentry>
495                 <term>Userdata</term>
496                 <listitem>
497                     <para>Scilab data</para>
498                     <para>This can be used to associate some Scilab objects
499                         (string,string matrix, matrix mxn) to an uicontrol.
500                     </para>
501                 </listitem>
502             </varlistentry>
503             <varlistentry>
504                 <term>Value</term>
505                 <listitem>
506                     <para>Scalar or vector</para>
507                     <para>Value of the uicontrol. The exact meaning depends on the style
508                         of the uicontrol:
509                     </para>
510                     <itemizedlist>
511                         <listitem>
512                             <para>
513                                 <literal>checkbox</literal> and <literal>radiobutton</literal> uicontrols: value is set to Max (see above)
514                                 when on and Min when off.
515                             </para>
516                         </listitem>
517                         <listitem>
518                             <para>
519                                 <literal>listbox</literal> and <literal>popupmenu</literal> uicontrols: value is a vector of indexes
520                                 corresponding to the indexes of the selected entries in the list. 1 is the first item of the list.
521                             </para>
522                         </listitem>
523                         <listitem>
524                             <para>
525                                 <literal>slider</literal> and <literal>spinner</literal> uicontrols: value indicated by the component.
526                             </para>
527                         </listitem>
528                         <listitem>
529                             <para>
530                                 <literal>layer</literal> and <literal>tab</literal> uicontrols: index of displayed component.
531                             </para>
532                         </listitem>
533                         <listitem>
534                             <para>
535                                 <literal>image</literal> uicontrols: value is used to set some image properties <literal>[X-Scale Y-Scale X-Shear Y-Shear RotationAngle]</literal>
536                             </para>
537                         </listitem>
538                     </itemizedlist>
539                 </listitem>
540             </varlistentry>
541             <varlistentry>
542                 <term>Verticalalignment</term>
543                 <listitem>
544                     <para>top | {middle} | bottom</para>
545                     <para>Set text vertical alignment in the uicontrol. This property
546                         has only effect with Text and CheckBoxes styles.
547                     </para>
548                 </listitem>
549             </varlistentry>
550             <varlistentry>
551                 <term>Visible</term>
552                 <listitem>
553                     <para>{on} | off</para>
554                     <para>
555                         Set the visibility of the uicontrol. If this property is set to <literal>"on"</literal> (default), the uicontrol is visible,
556                         but if this property is set to <literal>"off"</literal>, the uicontrol will not appear in its parent figure.
557                     </para>
558                 </listitem>
559             </varlistentry>
560         </variablelist>
561     </refsection>
562     <refsection>
563         <title>Example for callback_type property</title>
564         <programlisting role="example"><![CDATA[
565 function counter_start()
566     // Callback called after a click on start pushbutton
567     global Stop
568     Stop=%f;
569     while %t
570         i = evstr(get("count", "string"));
571         set("count", "string", string(i+1));
572         if Stop then
573             break
574         end
575     end
576 endfunction
577
578 function counter_stop()
579     // Callback called after a click on stop pushbutton
580     global Stop
581     Stop=%t
582 endfunction
583
584 function counter_reinit()
585     // Callback called after a click on reset pushbutton
586     Stop=%t
587     set("count", "string", "0");
588 endfunction
589
590
591 counter_main_fig = figure( ...
592 "dockable", "off", ...
593 "infobar_visible", "off", ...
594 "toolbar_visible", "off", ...
595 "toolbar", "none", ...
596 "menubar_visible", "off", ...
597 "menubar", "none", ...
598 "layout", "none", ...
599 "visible", "off", ...
600 "resize", "off", ...
601 "figure_position", [0 0], ...
602 "axes_size", [400, 150], ...
603 "figure_name", "Counter", ...
604 "layout", "gridbag", ...
605 "tag", "counter_main_figure");
606
607
608 // Counter frame
609 counter_frame = uicontrol(counter_main_fig, ...
610 "layout", "gridbag", ...
611 "style", "frame", ...
612 "constraints", createConstraints("gridbag", [1, 1, 1, 1], [1, 0.5], "both"));
613
614 uicontrol(counter_frame, ...
615 "style", "text", ...
616 "string", "Counter : ", ...
617 "constraints", createConstraints("gridbag", [1, 1, 1, 1], [0.5, 1], "horizontal", "center"), ...
618 "margins", [5 5 5 5], ...
619 "horizontalAlignment", "center");
620
621 uicontrol(counter_frame, ...
622 "style", "text", ...
623 "string", "0", ...
624 "constraints", createConstraints("gridbag", [2, 1, 1, 1], [1, 1], "horizontal", "center"), ...
625 "tag", "count", ...
626 "margins", [5 5 5 5]);
627
628 // Buttons frame
629 buttons_frame = uicontrol(counter_main_fig, ...
630 "layout", "gridbag", ...
631 "style", "frame", ...
632 "constraints", createConstraints("gridbag", [1, 2, 1, 1], [1, 1], "both"));
633
634 // The associated callback needs to be interruptible (when clicking on stop or reset for example)
635 uicontrol("parent", buttons_frame, ...
636 "Style"     , "pushbutton", ...
637 "String"    , "Start", ...
638 "callback"  , "counter_start()", ...
639 "margins", [5 5 5 5], ...
640 "constraints", createConstraints("gridbag", [1, 1, 1, 1], [1, 1], "horizontal", "center"));
641
642 // The associated callback needs to have priority in order to interrupt the current callback (in other words to stop the counter)
643 uicontrol("parent", buttons_frame, ...
644 "Style"     , "pushbutton", ...
645 "String"    , "Stop", ...
646 "callback"  , "counter_stop()", ...
647 "callback_type", 10, ...
648 "constraints", createConstraints("gridbag", [2, 1, 1, 1], [1, 1], "horizontal", "center"), ...
649 "margins", [5 5 5 5]);
650
651 // The same for the callback which reset the counter: it must have the priority over the callback which has started the counter
652 uicontrol("parent", buttons_frame, ...
653 "Style"     , "pushbutton", ...
654 "String"    , "Reset", ...
655 "callback"  , "counter_reinit()", ...
656 "callback_type", 10, ...
657 "constraints", createConstraints("gridbag", [3, 1, 1, 1], [1, 1], "horizontal", "center"), ...
658 "margins", [5 5 5 5]);
659
660 counter_main_fig.visible = "on";
661  ]]></programlisting>
662     </refsection>
663     <refsection role="see also">
664         <title>See also</title>
665         <simplelist type="inline">
666             <member>
667                 <link linkend="set">set</link>
668             </member>
669             <member>
670                 <link linkend="get">get</link>
671             </member>
672             <member>
673                 <link linkend="uicontrol">uicontrol</link>
674             </member>
675         </simplelist>
676     </refsection>
677     <refsection>
678         <title>History</title>
679         <revhistory>
680             <revision>
681                 <revnumber>6.0.0</revnumber>
682                 <revremark>
683                     <para>
684                         By default, callback_type property is now interruptible but non prioritary.
685                     </para>
686                 </revremark>
687             </revision>
688             <revision>
689                 <revnumber>5.5.0</revnumber>
690                 <revremark>
691                     <para>
692                         Properties added and updated:
693                     </para>
694                     <itemizedlist>
695                         <listitem>Border property added.</listitem>
696                         <listitem>Scrollable property added.</listitem>
697                         <listitem>Groupname property added.</listitem>
698                         <listitem>Icon property added.</listitem>
699                         <listitem>Margins property added.</listitem>
700                         <listitem>Layout property added.</listitem>
701                         <listitem>Layout_properties property added.</listitem>
702                         <listitem>
703                             String property is now used to set colors on <literal>listbox</literal> and <literal>combobox</literal> uicontrols.
704                         </listitem>
705                         <listitem>Backgroundcolor and Foregroundcolor properties now manage Operating System specific values.</listitem>
706                     </itemizedlist>
707                 </revremark>
708             </revision>
709         </revhistory>
710     </refsection>
711 </refentry>