[Thinlet-development] thinlet/doc/widget button.xml,1.1,1.2 checkbox.xml,1.1,1.2 combobox.xml,1.1,1.
Brought to you by:
bajzat
Menu
▾
▴
[Thinlet-development] thinlet/doc/widget button.xml,1.1,1.2 checkbox.xml,1.1,1.2 combobox.xml,1.1,1.2 component.xml,1.1,1.2 list.xml,1.1,1.2 menubar.xml,1.1,1.2 panel.xml,1.1,1.2 spinbox.xml,1.1,1.2 tabbedpane.xml,1.1,1.2 table.xml,1.1,1.2 textarea.xml,1.1,1.2 textfield.xml,1.1,1.2 tree.xml,1.1,1.2
|
From: <ab...@us...> - 2003-06-23 12:04:40
|
Update of /cvsroot/thinlet/thinlet/doc/widget
In directory sc8-pr-cvs1:/tmp/cvs-serv12459
Modified Files:
button.xml checkbox.xml combobox.xml component.xml list.xml
menubar.xml panel.xml spinbox.xml tabbedpane.xml table.xml
textarea.xml textfield.xml tree.xml
Log Message:
Update widget docs to reflect recent changes.
Index: button.xml
===================================================================
RCS file: /cvsroot/thinlet/thinlet/doc/widget/button.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- button.xml 10 May 2003 20:51:54 -0000 1.1
+++ button.xml 23 Jun 2003 12:04:35 -0000 1.2
@@ -8,14 +8,14 @@
The text string that the button displays.
</parameter>
<parameter name="icon" type="icon">
- The icon image that the button displays.
+ The icon image that the button displays. Icons are always displayed to the left of text (if any).
</parameter>
<parameter name="alignment" type="choice" default="center">
The alignment of the text and image similar to label.
Possible values are: center, left, and right. The default value is center.
</parameter>
<parameter name="mnemonic" type="integer" default="-1">
- Specifies the underlined char and the key combination (alt+mnemonic)
+ Specifies the index of underlined char, and the key combination (alt+mnemonic)
which invokes the (not necessarily focused, but enabled and visible)
button's action listener.
</parameter>
@@ -24,10 +24,11 @@
</parameter>
<parameter name="type" type="choice" default="normal">
Possible values are: normal, default, cancel, and link. The default value is normal.
- Default, and cancel values are for dialog control.
+ Default, and cancel values are for dialog control. Link changes the appearance of
+ button so that it resembles HTML link.
</parameter>
<parameter extend="component">
- name, enabled, visible, tooltip, property, width, height, colspan, rowspan,
+ name, enabled, visible, tooltip, property, i18n, width, height, colspan, rowspan,
weightx, weighty, halign, and valign parameters are similar to component
</parameter>
</parameters>
Index: checkbox.xml
===================================================================
RCS file: /cvsroot/thinlet/thinlet/doc/widget/checkbox.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- checkbox.xml 10 May 2003 20:51:54 -0000 1.1
+++ checkbox.xml 23 Jun 2003 12:04:36 -0000 1.2
@@ -2,7 +2,7 @@
<widget class="checkbox" title="CheckBox">
<p>The first checkbox has a short text and an icon, its state is selected.
The second one is a deselected radio button,
- one of a set of buttons identified by a string id.</p>
+ one of a set of buttons identified by a group name.</p>
<xul><![CDATA[<checkbox text="CheckBox" icon="image.gif" selected="true"/>
<checkbox text="RadioButton" group="group"/>]]></xul>
<parameters>
@@ -17,7 +17,7 @@
Possible values are: left, center, and right.
</parameter>
<parameter name="mnemonic" type="integer" default="-1">
- Specifies the underlined char and the key combination
+ Specifies the index of underlined char, and the key combination
which change the checkboxs's state and invokes the action listener.
</parameter>
<parameter name="selected" type="boolean" default="false">
@@ -34,7 +34,7 @@
by mouse or keyboard event.
</parameter>
<parameter extend="component">
- name, enabled, visible, tooltip, property, width, height, colspan, rowspan,
+ name, enabled, visible, tooltip, property, i18n, width, height, colspan, rowspan,
weightx, weighty, halign, and valign parameters are similar to component
</parameter>
</parameters>
Index: combobox.xml
===================================================================
RCS file: /cvsroot/thinlet/thinlet/doc/widget/combobox.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- combobox.xml 10 May 2003 20:51:54 -0000 1.1
+++ combobox.xml 23 Jun 2003 12:04:36 -0000 1.2
@@ -22,17 +22,17 @@
text, columns, and editable parameters are described at textfield
</parameter>
<parameter extend="component">
- name, enabled, visible, tooltip, property, width, height, colspan, rowspan,
+ name, enabled, visible, tooltip, property, i18n, width, height, colspan, rowspan,
weightx, weighty, halign, and valign parameters are similar to component
</parameter>
</parameters>
<!-- - - - choice - - - -->
<widget class="choice" title="Choice">
<p>The drop down list of a combobox contains choices.
- The popup combolist internally handles scrolling.</p>
+ The combolist popup internally handles scrolling.</p>
<parameters>
<parameter name="name" type="string">
- Identifies the item.
+ Identifies the choice item.
</parameter>
<parameter name="enabled" type="boolean" default="true">
Enables or disables the item. A disabled item is painted gray,
@@ -53,17 +53,17 @@
otherwise the tooltip text of the component.
</parameter>
<parameter name="font" type="font" default="">
- [Pending]
+ Custom font to use for text.
</parameter>
<parameter name="foreground" type="color" default="">
- [Pending]
+ Custom foreground (text) color.
</parameter>
<parameter name="background" type="color" default="">
- [Pending]
+ Custom background color.
</parameter>
<parameter name="property" type="property">
Adds an arbitrary key/value client property stored in a hashtable of the item.
- The format of its value is key=value, both are string objects.
+ The format of its value is key=value (or key=value;key=value ... for multiple keys), both are string objects.
</parameter>
</parameters>
</widget>
Index: component.xml
===================================================================
RCS file: /cvsroot/thinlet/thinlet/doc/widget/component.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- component.xml 10 May 2003 20:51:54 -0000 1.1
+++ component.xml 23 Jun 2003 12:04:36 -0000 1.2
@@ -17,13 +17,21 @@
The text pops up when the mouse lingers inside the component.
</parameter>
<parameter name="font" type="font" default="">
- [Pending]
+ Custom font for texts. The format of this parameter is: font="[NAME] [SIZE] [italic] [bold]", where NAME is the font name, and SIZE is integer font size in points. At least one font parameter must be present.
</parameter>
<parameter name="foreground" type="color" default="">
- [Pending]
+ Custom foreground (text) color to use, instead of the
+ default text color set with setColors(). The format of
+ this parameter is: foreground="#RRGGBB", with RGB
+ values in hexadecimal.
</parameter>
<parameter name="background" type="color" default="">
- [Pending]
+ Custom background color to use, instead of the
+ default background color set with setColors().
+ Parameter format is the same as for foreground.
+ NOTE: for components with gradients (buttons, menubars,
+ etc...) this means that the background will be
+ filled with SOLID color, and not a custom gradient.
</parameter>
<parameter name="width" type="integer" default="0">
Fixed preferred width of the component irrespectively of its content.
@@ -58,9 +66,11 @@
<parameter name="property" type="property">
Binds an arbitrary key/value client property. The format of its value
is key=value, both are strings and stored in a hashtable of the component.
+ Use format property="key1=value1;key2=value2" for multiple properties.
</parameter>
<parameter name="init" type="method">
- [Pending]
+ A method to invoke when the loading of this component
+ is finished.
</parameter>
<parameter name="focuslost" type="method">
[Pending]
@@ -71,7 +81,7 @@
</parameters>
<!-- - - - popupmenu - - - -->
<widget class="popupmenu" title="PopupMenu">
- <p>[Pending].</p>
+ <p>Popup menus resemble in functionality normal menus, and can be added to most container components. Popupmenu component can have the same sub-components as menubar. Popup menus are invoked with mouse right-click.</p>
<parameters>
<parameter name="menushown" type="method">
[Pending]
Index: list.xml
===================================================================
RCS file: /cvsroot/thinlet/thinlet/doc/widget/list.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- list.xml 10 May 2003 20:51:54 -0000 1.1
+++ list.xml 23 Jun 2003 12:04:36 -0000 1.2
@@ -20,10 +20,10 @@
Calls the method whenever the selection changes.
</parameter>
<parameter name="perform" type="method">
- [Pending]
+ Calls the method whenever a perform event (double-click) occurs.
</parameter>
<parameter name="line" type="boolean" default="true">
- [Pending]
+ If present and set to false, don't draw lines separating the list items.
</parameter>
<parameter extend="component">
name, enabled, visible, tooltip, property, width, height, colspan, rowspan,
Index: menubar.xml
===================================================================
RCS file: /cvsroot/thinlet/thinlet/doc/widget/menubar.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- menubar.xml 10 May 2003 20:51:54 -0000 1.1
+++ menubar.xml 23 Jun 2003 12:04:36 -0000 1.2
@@ -18,6 +18,12 @@
<textarea weighty="1" />
</panel>]]></xul>
<parameters>
+ <parameter name="placement" type="choice" default="top">
+ Menubar may unfold the menus either downwards (default -
+ for menubars placed at the top of the container), or
+ upwards from the menubar position (placement="bottom" -
+ for menubars placed at the bottom of the container).
+ </parameter>
<parameter extend="component">
name, enabled, visible, tooltip, property, width, height, colspan, rowspan,
weightx, weighty, halign, and valign parameters are similar to component
@@ -25,11 +31,12 @@
</parameters>
<!-- - - - menu - - - -->
<widget class="menu" title="Menu">
- <p>Menubar includes menu, and menu could contain menuitems, check or radio
+ <p>Menubar includes menu, and menu may contain menuitems, check or radio
button items, separators, and menus.</p>
<parameters>
<parameter name="mnemonic" type="integer" default="-1">
- Specifies the index of the underlined char and the key combination
+ Specifies the index of the underlined char and
+ the key combination (Alt + underlined character)
which selects the menu.
</parameter>
<parameter extend="choice">
@@ -62,7 +69,7 @@
</widget>
<!-- - - - checkboxmenuitem - - - -->
<widget class="checkboxmenuitem" title="CheckBoxMenuItem">
- <p>A menu item that can be selected or deselected. The selecte menuitem
+ <p>A menu item that can be selected or deselected. The selected menuitem
appears with a checkmark next to it. A radio-button menu-item is a
menu item that is part of a group of menu items in which
only one item in the group can be selected.</p>
Index: panel.xml
===================================================================
RCS file: /cvsroot/thinlet/thinlet/doc/widget/panel.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- panel.xml 10 May 2003 20:51:54 -0000 1.1
+++ panel.xml 23 Jun 2003 12:04:36 -0000 1.2
@@ -43,7 +43,8 @@
Border painted if true.
</parameter>
<parameter name="scrollable" type="boolean" default="false">
- [Pending]
+ If present and set to true, add scrollbars to the panel
+ if its contents is bigger than the panel's bounds.
</parameter>
<parameter extend="component">
name, enabled, visible, tooltip, property, width, height, colspan, rowspan,
Index: spinbox.xml
===================================================================
RCS file: /cvsroot/thinlet/thinlet/doc/widget/spinbox.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- spinbox.xml 10 May 2003 20:51:54 -0000 1.1
+++ spinbox.xml 23 Jun 2003 12:04:36 -0000 1.2
@@ -4,17 +4,19 @@
(increase, and decrease by 1) its integer value.</p>
<xul><![CDATA[<spinbox text="100" />]]></xul>
<parameters>
- <parameter name="minimum" type="integer" default="0">
- [Pending]
+ <parameter name="minimum" type="integer" default="0">
+ Minimum value (0 by default). It's not possible to
+ set the spinbox below this value.
</parameter>
<parameter name="maximum" type="integer" default="100">
- [Pending]
+ Maximum value (100 by default). It's not possible to
+ set the spinbox above this value.
</parameter>
<parameter name="step" type="integer" default="1">
- [Pending]
+ Increment step when using spinbox arrows. 1 by default.
</parameter>
<parameter name="value" type="integer" default="0">
- [Pending]
+ Spinbox value. 0 by default.
</parameter>
<parameter name="action" type="method">
Invokes the given method when there was change in the text or a new
Index: tabbedpane.xml
===================================================================
RCS file: /cvsroot/thinlet/thinlet/doc/widget/tabbedpane.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- tabbedpane.xml 10 May 2003 20:51:54 -0000 1.1
+++ tabbedpane.xml 23 Jun 2003 12:04:36 -0000 1.2
@@ -18,7 +18,7 @@
<parameters>
<parameter name="placement" type="choice" default="top">
The placement for the tabs relative to the content. Possible values are:
- top, left, bottom, right, and stack. The default value, if not set, is top.
+ top, left, bottom, right, and stack. The default value, if not set, is top. The stack placement arranges tabs so that they resemble a sidebar.
</parameter>
<parameter name="selected" type="integer" default="0">
The index of the currently selected tab, and the visible content
Index: table.xml
===================================================================
RCS file: /cvsroot/thinlet/thinlet/doc/widget/table.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- table.xml 10 May 2003 20:51:54 -0000 1.1
+++ table.xml 23 Jun 2003 12:04:36 -0000 1.2
@@ -32,19 +32,29 @@
</parameters>
<!-- - - - header - - - -->
<widget class="header" title="Header">
- <p>Table header includes the column texts, these items defines the column
- widths. The key for the list of columns is 'column'.</p>
+ <p>Table header includes the columns. They define the column
+ texts and widths. The key for the list of columns is 'column'.</p>
</widget>
<!-- - - - column - - - -->
<widget class="column" title="Column">
- <p>Table header includes the column texts, these items defines the column
- widths. The key for the list of columns is 'column'.</p>
+ <p>Table header includes the columns. They define the column
+ texts and widths. The key for the list of columns is 'column'.
+ If the total sum of column widths exceeds table bounds set by
+ a parent container, horizontal scrollbar is drawn.</p>
<parameters>
<parameter name="width" type="integer" default="80">
- The width of the column.
+ The width of the column. The last (rightmost)
+ column always extends to fill in the remaining
+ width of the table, as determined by the parent
+ container.
</parameter>
<parameter name="sort" type="choice" default="none">
- [Pending]
+ If present, and set to either "ascent" or "descent",
+ an arrow is drawn near right end
+ of the column, as a visual indication of
+ sorting order. NOTE: for now this is just a
+ visual decoration, application still needs to
+ do the sorting.
</parameter>
<parameter extend="label">
name, text, icon, and alignment parameters are described at label
Index: textarea.xml
===================================================================
RCS file: /cvsroot/thinlet/thinlet/doc/widget/textarea.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- textarea.xml 10 May 2003 20:51:54 -0000 1.1
+++ textarea.xml 23 Jun 2003 12:04:36 -0000 1.2
@@ -15,11 +15,18 @@
</parameter>
<parameter name="editable" type="boolean" default="true">
The specified boolean to indicate whether or not this textarea
- should be editable. A not editable area is focusable, and selectable.
+ should be editable. A non-editable area is focusable, and selectable.
</parameter>
<parameter name="wrap" type="boolean" default="false">
If set to true the lines will be wrapped at word boundaries (whitespace)
if they are too long to fit within the allocated width.
+ </parameter>
+ <parameter name="border" type="boolean" default="true">
+ If set to false, no border will be drawn around the
+ textarea, and its background will be set to the default
+ background color, to visually "blend" with its
+ container. You can still override this by setting a
+ custom background color.
</parameter>
<parameter name="start" type="integer" default="0">
Start index of the selection.
Index: textfield.xml
===================================================================
RCS file: /cvsroot/thinlet/thinlet/doc/widget/textfield.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- textfield.xml 10 May 2003 20:51:54 -0000 1.1
+++ textfield.xml 23 Jun 2003 12:04:36 -0000 1.2
@@ -13,7 +13,7 @@
</parameter>
<parameter name="editable" type="boolean" default="true">
The specified boolean to indicate whether or not this textfield
- should be editable. A not editable field is focusable, and selectable.
+ should be editable. A non-editable field is focusable, and selectable.
</parameter>
<parameter name="start" type="integer" default="0">
Start index of the selection.
Index: tree.xml
===================================================================
RCS file: /cvsroot/thinlet/thinlet/doc/widget/tree.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- tree.xml 10 May 2003 20:51:54 -0000 1.1
+++ tree.xml 23 Jun 2003 12:04:36 -0000 1.2
@@ -1,8 +1,8 @@
<!-- - - - tree - - - -->
<widget class="tree" title="Tree">
<p>Tree displays a set of hierarchical data, contains nodes
- (not only one root node is allowed), and a node could have subnodes.
- It internally handles scrolling.
+ (not only one root node is allowed), and nodes can have subnodes.
+ It handles scrolling internally.
The following example shows a tree with 2 root nodes ('Node A', and 'Node D'),
the first has 2 subnodes (a selected 'Node B' and 'Node C'), the collapsed
'Node D' includes one node.</p>
@@ -25,6 +25,9 @@
</parameter>
<parameter name="action" type="method">
Calls the method whenever the selection changes.
+ </parameter>
+ <parameter name="perform" type="method">
+ Calls the method whenever a perform event (double-click) occurs.
</parameter>
<parameter name="expand" type="method">
The listener that's notified when the tree expands a node.
|
