[graphic-forms-cvs] r373 - trunk/docs/manual
junrue at common-lisp.net
junrue at common-lisp.net
Sat Oct 21 06:00:46 UTC 2006
Author: junrue
Date: Sat Oct 21 02:00:46 2006
New Revision: 373
Modified:
trunk/docs/manual/gfw-symbols.xml
Log:
Modified: trunk/docs/manual/gfw-symbols.xml
==============================================================================
--- trunk/docs/manual/gfw-symbols.xml (original)
+++ trunk/docs/manual/gfw-symbols.xml Sat Oct 21 02:00:46 2006
@@ -1525,7 +1525,7 @@
</argument>
<argument name=":parent">
<description>
- This initarg specifies the parent of the control.
+ See <reftopic>gfw:control</reftopic>.
</description>
</argument>
<argument name=":dispatcher">
@@ -1563,13 +1563,14 @@
<description>
The function supplied via this initarg will be used as the
implementation of <reftopic>gfw:event-modify</reftopic> in
- a <reftopic>gfw:event-dispatcher</reftopic> configured for the button.
+ a <reftopic>gfw:event-dispatcher</reftopic> configured for
+ the edit control.
</description>
</argument>
<argument name=":style">
<description>
This is a <refclhs>list</refclhs> of keyword symbols that define
- the look-and-feel of the button. Zero or more of the following
+ the look-and-feel of the edit control. Zero or more of the following
may be specified:
<enum>
<argument name=":auto-hscroll">
@@ -1655,7 +1656,7 @@
</argument>
<argument name=":parent">
<description>
- This initarg specifies the parent of the control.
+ See <reftopic>gfw:control</reftopic>.
</description>
</argument>
<argument name=":dispatcher">
@@ -1679,6 +1680,358 @@
</seealso>
</class>
+ <class name="label">
+ <description>
+ <hierarchy>
+ <inherits>
+ <reftopic>gfw:control</reftopic>
+ </inherits>
+ </hierarchy>
+ This class represents non-selectable controls that display a string, image,
+ or etched line
+ </description>
+ <initargs>
+ <argument name=":separator">
+ <description>
+ Specify T to configure the label to render itself as an etched
+ horizontal (or vertical) divider. The :style initarg is used to
+ select the desired orientation.
+ </description>
+ </argument>
+ <argument name=":image">
+ <description>
+ Accepts a <reftopic>gfg:image</reftopic> to be rendered inside
+ the label.
+ </description>
+ </argument>
+ <argument name=":style">
+ <description>
+ This is a <refclhs>list</refclhs> of keyword symbols that define
+ the look-and-feel of the label. The symbols appropriate for a
+ label depend on which mode (image, separator, or text) is
+ configured:
+ <enum>
+ <argument name=":beginning">
+ <description>text mode</description>
+ </argument>
+ <argument name=":center">
+ <description>text mode</description>
+ </argument>
+ <argument name=":ellipsis">
+ <description>text mode</description>
+ </argument>
+ <argument name=":end">
+ <description>text mode</description>
+ </argument>
+ <argument name=":wrap">
+ <description>text mode</description>
+ </argument>
+ <argument name=":raised">
+ <description>text or image mode</description>
+ </argument>
+ <argument name=":sunken">
+ <description>text or image mode</description>
+ </argument>
+ <argument name=":horizontal">
+ <description>separator mode</description>
+ </argument>
+ <argument name=":vertical">
+ <description>separator mode</description>
+ </argument>
+ </enum>
+ </description>
+ </argument>
+ <argument name=":text">
+ <description>
+ Accepts a <refclhs>string</refclhs> supplying the text for the
+ label.
+ </description>
+ </argument>
+ <argument name=":parent">
+ <description>
+ See <reftopic>gfw:control</reftopic>.
+ </description>
+ </argument>
+ <argument name=":handle">
+ <description>
+ See <reftopic>gfs:native-object</reftopic>.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfs:dispose</reftopic>
+ </seealso>
+ </class>
+
+ <class name="list-box">
+ <description>
+ <hierarchy>
+ <inherits>
+ <reftopic>gfw:control</reftopic>
+ <reftopic>gfw:item-manager</reftopic>
+ </inherits>
+ </hierarchy>
+ This class represents a list of selectable items. The list is always visible,
+ unlike a <reftopic>gfw:combo-box</reftopic>.
+ </description>
+ <initargs>
+ <argument name=":callback">
+ <description>
+ The function supplied via this initarg will be used as the
+ implementation of <reftopic>gfw:event-select</reftopic> in
+ a <reftopic>gfw:event-dispatcher</reftopic> configured for the
+ list-box.
+ </description>
+ </argument>
+ <argument name=":style">
+ <description>
+ This is a <refclhs>list</refclhs> of keyword symbols that define
+ the look-and-feel of the list-box. One of the following primary
+ styles may be specified:
+ <enum>
+ <argument name=":extend-select">
+ <description>
+ Causes the list-box to allow multiple items to be selected
+ by use of the <Shift> key and the mouse or special keys.
+ </description>
+ </argument>
+ <argument name=":multiple-select">
+ <description>
+ Enables individual toggling of multiple item selections within
+ the list-box.
+ </description>
+ </argument>
+ <argument name=":no-select">
+ <description>
+ This style keyword configures the list-box to display items
+ but not allow any selections.
+ </description>
+ </argument>
+ </enum>
+ Zero or more of the following optional styles may be specified:
+ <enum>
+ <argument name=":scrollbar-always">
+ <description>
+ Configures the list-box to show a disabled vertical scrollbar
+ when it does not contain enough items to scroll. By default,
+ the scrollbar will be hidden until needed.
+ </description>
+ </argument>
+ <argument name=":tab-stops">
+ <description>
+ This style keyword configures the list-box to to expand tab
+ characters when rendering <reftopic>gfw:list-item</reftopic>
+ text.
+ </description>
+ </argument>
+ <argument name=":want-keys">
+ <description>
+ Allows the application to perform special processing when the
+ list-box has focus and the user presses a key.
+ </description>
+ </argument>
+ </enum>
+ </description>
+ </argument>
+ <argument name=":estimated-count">
+ <description>
+ A positive <refclhs>integer</refclhs> value indicating the expected
+ number of items that the list-box will hold. If supplied, it enables
+ an optimization in storage allocation by the underlying native control.
+ As the name of the initarg implies, this is an estimate, which may be
+ too high (in which case heap space may be wasted) or too low (in which
+ case the control will re-allocate storage as necessary).
+ </description>
+ </argument>
+ <argument name=":items">
+ <description>
+ This initarg accepts a list of application-defined objects
+ for populating the contents of the list-box; each one is
+ automatically wrapped with an instance of <reftopic>gfw:list-item</reftopic>.
+ The list-box will hold references to the supplied objects.
+ </description>
+ </argument>
+ <argument name=":parent">
+ <description>
+ See <reftopic>gfw:control</reftopic>.
+ </description>
+ </argument>
+ <argument name=":dispatcher">
+ <description>
+ See <reftopic>gfw:event-source</reftopic>.
+ </description>
+ </argument>
+ <argument name=":handle">
+ <description>
+ See <reftopic>gfs:native-object</reftopic>.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfs:dispose</reftopic>
+ <reftopic>gfw:dialog</reftopic>
+ <reftopic>gfw:auto-vscroll-p</reftopic>
+ <reftopic>gfw:append-item</reftopic>
+ </seealso>
+ </class>
+
+ <class name="scrollbar">
+ <description>
+ <hierarchy>
+ <inherits>
+ <reftopic>gfw:control</reftopic>
+ </inherits>
+ </hierarchy>
+ This class represents a control having a proportional sliding-thumb
+ component and step arrows at either end. Unlike a
+ <reftopic>gfw:standard-scrollbar</reftopic>, scrollbar controls can
+ be placed anywhere inside a container.
+ </description>
+ <initargs>
+ <argument name=":callback">
+ <description>
+ The function supplied via this initarg will be used as the
+ implementation of <reftopic>gfw:event-scroll</reftopic> in
+ a <reftopic>gfw:event-dispatcher</reftopic> configured for the
+ scrollbar.
+ </description>
+ </argument>
+ <argument name=":style">
+ <description>
+ This is a <refclhs>list</refclhs> of keyword symbols that define
+ the look-and-feel of the scrollbar. Currently, only one of the
+ following styles may be specified:
+ <enum>
+ <argument name=":horizontal"/>
+ <argument name=":vertical"/>
+ </enum>
+ </description>
+ </argument>
+ <argument name=":parent">
+ <description>
+ See <reftopic>gfw:control</reftopic>.
+ </description>
+ </argument>
+ <argument name=":dispatcher">
+ <description>
+ See <reftopic>gfw:event-source</reftopic>.
+ </description>
+ </argument>
+ <argument name=":handle">
+ <description>
+ See <reftopic>gfs:native-object</reftopic>.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfs:dispose</reftopic>
+ <reftopic>gfs:event-scroll</reftopic>
+ </seealso>
+ </class>
+
+ <class name="slider">
+ <description>
+ <hierarchy>
+ <inherits>
+ <reftopic>gfw:control</reftopic>
+ </inherits>
+ </hierarchy>
+ This class represents a control having a sliding-thumb component
+ and optional tick marks.
+ </description>
+ <initargs>
+ <argument name=":callback">
+ <description>
+ The function supplied via this initarg will be used as the
+ implementation of <reftopic>gfw:event-scroll</reftopic> in
+ a <reftopic>gfw:event-dispatcher</reftopic> configured for the
+ slider.
+ </description>
+ </argument>
+ <argument name=":outer-limit">
+ <description>
+ Accepts an <refclhs>integer</refclhs> describing the maximum possible
+ slider positions (the minimum is 0).
+ </description>
+ </argument>
+ <argument name=":style">
+ <description>
+ This is a <refclhs>list</refclhs> of keyword symbols that define
+ the look-and-feel of the slider. By default, sliders are oriented
+ horizontally with a tick mark below the control at the beginning
+ and end. One of the following primary
+ styles may be specified:
+ <enum>
+ <argument name=":auto-ticks">
+ <description>
+ Specifies that the slider will display a tick mark for each
+ increment in its value range; the opposite of :no-ticks.
+ </description>
+ </argument>
+ <argument name=":horizontal">
+ <description>
+ Configures the slider to be oriented horizontally.
+ </description>
+ </argument>
+ <argument name=":no-ticks">
+ <description>
+ Specifies that the slider will not display any tick marks;
+ the oppposite of :auto-ticks.
+ </description>
+ </argument>
+ <argument name=":vertical">
+ <description>
+ Configures the slider to be oriented vertically.
+ </description>
+ </argument>
+ </enum>
+ Zero or more of the following optional styles may be specified:
+ <enum>
+ <argument name=":border">
+ <description>
+ By default, a slider is drawn without a border; this style
+ enables a border around the control.
+ </description>
+ </argument>
+ <argument name=":ticks-after">
+ <description>
+ Specifies that the slider should display its tick marks to
+ the right of (or below) the control. This style can be
+ combined with :ticks-before.
+ </description>
+ </argument>
+ <argument name=":ticks-before">
+ <description>
+ Specifies that the slider should display its tick marks to the
+ left of (or above) the control. This style can be combined with
+ :ticks-after.
+ </description>
+ </argument>
+ </enum>
+ </description>
+ </argument>
+ <argument name=":parent">
+ <description>
+ See <reftopic>gfw:control</reftopic>.
+ </description>
+ </argument>
+ <argument name=":dispatcher">
+ <description>
+ See <reftopic>gfw:event-source</reftopic>.
+ </description>
+ </argument>
+ <argument name=":handle">
+ <description>
+ See <reftopic>gfs:native-object</reftopic>.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfs:dispose</reftopic>
+ <reftopic>gfs:event-scroll</reftopic>
+ </seealso>
+ </class>
+
<!-- STRUCTURES -->
<!-- FUNCTIONS -->
More information about the Graphic-forms-cvs
mailing list