Author: junrue Date: Fri Oct 20 23:23:05 2006 New Revision: 372
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 Fri Oct 20 23:23:05 2006 @@ -1384,6 +1384,301 @@ </seealso> </class>
+ <class name="control"> + <description> + <hierarchy> + <inherits> + <reftopic>gfw:widget</reftopic> + </inherits> + <inheritedby> + <reftopic>gfw:button</reftopic> + <reftopic>gfw:edit</reftopic> + <reftopic>gfw:label</reftopic> + <reftopic>gfw:listbox</reftopic> + <reftopic>gfw:scrollbar</reftopic> + <reftopic>gfw:slider</reftopic> + </inheritedby> + </hierarchy> + This is the base class for widgets associated with an underlying native + control. + </description> + <initargs> + <argument name=":callback"> + <description> + This initarg associates a function with a <reftopic>gfw:event-dispatcher</reftopic> + subclass that is generated behind-the-scenes and then instantiated to serve as + the control's event dispatcher. Each control subclass specifies the particular + event function (e.g., <reftopic>gfw:event-select</reftopic>) that this callback + will implement; see the documentation for specific control subclasses for more + information on this initarg. + </description> + </argument> + <argument name=":parent"> + <description> + This initarg specifies the parent of the control. + </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> + </seealso> + </class> + + <class name="button"> + <description> + <hierarchy> + <inherits> + <reftopic>gfw:control</reftopic> + </inherits> + </hierarchy> + This class represents selectable controls that generate an event when clicked. + </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 button. + </description> + </argument> + <argument name=":image"> + <description> + Accepts a <reftopic>gfg:image</reftopic> to be used as the button's + label. + </description> + </argument> + <argument name=":style"> + <description> + This is a <refclhs>list</refclhs> of keyword symbols that define + the look-and-feel of the button. The :push-button style is the + default. Currently, only one of the following may be specified: + <enum> + <argument name=":cancel-button"> + <description> + Placing a :cancel-button in a dialog enables the escape key + accelerator for dismissing the dialog. This action should be + interpreted as the user discarding the content of the dialog. + </description> + </argument> + <argument name=":check-box"> + <description> + This style specifies a button having a small box, which may + contain a check mark depending on the button's selection state, + adjacent to a text label. + </description> + </argument> + <argument name=":default-button"> + <description> + Placing a :default-button in a dialog enables the return key + accelerator for dismissing the dialog. This action should be + interpreted as the user accepting the content of the dialog. + Also, the button is rendered with an extra thick border. + </description> + </argument> + <argument name=":push-button"> + <description> + This style specifies a traditional push button control. No + special keyboard accelerators are enabled. + </description> + </argument> + <argument name=":radio-button"> + <description> + This style specifies a button having a small circle, which may + be filled or unfilled depending on the button's selection state, + adjacent to a text label. Radio buttons are typically used in + groups and are managed such that only one member of the group + is enabled at a time. + </description> + </argument> + <argument name=":toggle-button"> + <description> + This style specifies a control that when unselected looks like + a push button. But when in the selected state, the button + maintains a sunken look. It is similar in function to a :check-box. + </description> + </argument> + <argument name=":tri-state"> + <description> + This style specifies a control that looks similar to a :check-box, + but the box can be grayed as well as checked or cleared. The grayed + look indicates an undetermined state. + </description> + </argument> + </enum> + </description> + </argument> + <argument name=":text"> + <description> + Accepts a <refclhs>string</refclhs> supplying the text for the + button label. + </description> + </argument> + <argument name=":parent"> + <description> + This initarg specifies the parent of the control. + </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> + </seealso> + </class> + + <class name="edit"> + <description> + <hierarchy> + <inherits> + <reftopic>gfw:control</reftopic> + </inherits> + </hierarchy> + This class represents a rectangular area that permits the user to enter + and edit text. The <reftopic>gfw:event-focus-gain</reftopic> and + <reftopic>gfw:event-focus-loss</reftopic> methods of each edit control's + <reftopic>gfw:event-dispatcher</reftopic> are invoked when focus is given + or taken away. The <reftopic>gfw:event-modify</reftopic> method is invoked + when the user edits text. + </description> + <initargs> + <argument name=":callback"> + <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. + </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 + may be specified: + <enum> + <argument name=":auto-hscroll"> + <description> + Specifies that the edit control will scroll text content to + the right (by 10 characters, an amount defined by the system) + when the user types a character at the end of the line. For + single-line edit controls, this style is automatically set by + Graphic-Forms. + </description> + </argument> + <argument name=":auto-vscroll"> + <description> + Specifies that the edit control will scroll text up by a page + when the user types enter on the last line. This style + is only meaningful when :multi-line is also specified. + </description> + </argument> + <argument name=":horizontal-scrollbar"> + <description> + Specifies that a horizontal scrollbar should be displayed. + </description> + </argument> + <argument name=":mask-characters"> + <description> + Specifies that each character of text be masked by a configurable + echo character instead of the one literally typed. The asterisk + character is used by default. + </description> + </argument> + <argument name=":multi-line"> + <description> + Edit controls default to single-line text fields. By specifying + :multi-line, multiple lines of text can be supplied. When the + edit control is in a dialog, the <Enter> key will invoke + the default button's <reftopic>gfw:event-dispatcher</reftopic>, + unless :want-return is also specified. If :auto-hscroll is not + specified, then text will be automatically word-wrapped. + </description> + </argument> + <argument name=":no-border"> + <description> + By default, an edit control is rendered with a border; this style + disables that feature. + </description> + </argument> + <argument name=":no-hide-selection"> + <description> + This specifies that any selection remain rendered even when the + edit control loses input focus. By default, the selection is hidden + when focus is lost. + </description> + </argument> + <argument name=":read-only"> + <description> + Specifies that the edit control's contents cannot be modified by the + user. + </description> + </argument> + <argument name=":vertical-scrollbar"> + <description> + Specifies that a vertical scrollbar should be displayed. This style + is only meaningful when :multi-line is also specified. + </description> + </argument> + <argument name=":want-return"> + <description> + Specifies that a carriage return be inserted when the user types + <Enter>. This style only applies when the :multi-line style + is also specified. Without this style, within a dialog the act of + typing enter has the same effect as pressing the dialog's default + button. + </description> + </argument> + </enum> + </description> + </argument> + <argument name=":text"> + <description> + Accepts a <refclhs>string</refclhs> supplying the text for the + button label. + </description> + </argument> + <argument name=":parent"> + <description> + This initarg specifies the parent of the control. + </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-hscroll-p</reftopic> + <reftopic>gfw:auto-vscroll-p</reftopic> + <reftopic>gfw:echo-character</reftopic> + <reftopic>gfw:enable-auto-scrolling</reftopic> + </seealso> + </class> + <!-- STRUCTURES -->
<!-- FUNCTIONS -->