Author: junrue
Date: Sun Oct 22 02:00:35 2006
New Revision: 383
Modified:
trunk/docs/manual/gfg-symbols.xml
trunk/docs/manual/gfw-symbols.xml
Log:
Modified: trunk/docs/manual/gfg-symbols.xml
==============================================================================
--- trunk/docs/manual/gfg-symbols.xml (original)
+++ trunk/docs/manual/gfg-symbols.xml Sun Oct 22 02:00:35 2006
@@ -1393,7 +1393,7 @@
</argument>
<argument name="list">
<description>
- A <refclhs>list</refclhs> of <reftopic>gfg:point</reftopic>s
+ A <refclhs>list</refclhs> of <reftopic>gfs:point</reftopic>s
defining the polygon's line segments.
</description>
</argument>
@@ -1426,7 +1426,7 @@
</argument>
<argument name="list">
<description>
- A <refclhs>list</refclhs> of <reftopic>gfg:point</reftopic>s
+ A <refclhs>list</refclhs> of <reftopic>gfs:point</reftopic>s
defining the polygon's line segments.
</description>
</argument>
@@ -1460,7 +1460,7 @@
</argument>
<argument name="list">
<description>
- A <refclhs>list</refclhs> of <reftopic>gfg:point</reftopic>s
+ A <refclhs>list</refclhs> of <reftopic>gfs:point</reftopic>s
defining line segments.
</description>
</argument>
@@ -1500,7 +1500,7 @@
</argument>
<argument name="point">
<description>
- A <reftopic>gfg:point</reftopic> specifying the upper-left
+ A <reftopic>gfs:point</reftopic> specifying the upper-left
corner of the rectangle bounding <arg1/>.
</description>
</argument>
Modified: trunk/docs/manual/gfw-symbols.xml
==============================================================================
--- trunk/docs/manual/gfw-symbols.xml (original)
+++ trunk/docs/manual/gfw-symbols.xml Sun Oct 22 02:00:35 2006
@@ -622,11 +622,13 @@
<reftopic>gfw:control</reftopic>
<reftopic>gfw:color-dialog</reftopic>
<reftopic>gfw:file-dialog</reftopic>
+ <reftopic>gfw:font-dialog</reftopic>
<reftopic>gfw:menu</reftopic>
<reftopic>gfw:window</reftopic>
</inheritedby>
</hierarchy>
- The widget class is the base class for all windowed user interface objects.
+ This is the base class for all windowed user interface objects whose
+ behavior can be extended by applications.
</description>
<initargs>
<argument name=":style">
@@ -751,7 +753,7 @@
The <reftopic>gfw:with-file-dialog</reftopic> macro wraps the creation
of a file-dialog and subsequent retrieval of the file paths selected by
the user. However, applications may choose to implement these steps
- manually, in which case the <reftopic>gfw:file-dialog-paths</reftopic>
+ manually, in which case the <reftopic>gfw:obtain-chosen-files</reftopic>
function can be used to obtain the user's selection(s). Unless the
:multiple-select style keyword is specified, there will at most be one
selected file returned. In either case, zero is returned if the user
@@ -886,7 +888,7 @@
The <reftopic>gfw:with-font-dialog</reftopic> macro wraps the creation
of a font-dialog and provides a new <reftopic>gfg:font</reftopic> object
based on the user's selections. However, applications may choose to implement
- these steps manually, in which case the <reftopic>gfw:font-dialog-results</reftopic>
+ these steps manually, in which case the <reftopic>gfw:obtain-chosen-font</reftopic>
function can be called to obtain the results of the user's selections. Manual
construction of an instance must be followed by an explicit call to
<reftopic>gfs:dispose</reftopic>.
@@ -1404,7 +1406,7 @@
<reftopic>gfw:button</reftopic>
<reftopic>gfw:edit</reftopic>
<reftopic>gfw:label</reftopic>
- <reftopic>gfw:listbox</reftopic>
+ <reftopic>gfw:list-box</reftopic>
<reftopic>gfw:scrollbar</reftopic>
<reftopic>gfw:slider</reftopic>
</inheritedby>
@@ -1683,10 +1685,9 @@
<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>
+ <reftopic>gfw:text</reftopic>
</seealso>
</class>
@@ -2399,6 +2400,347 @@
<!-- GENERIC FUNCTIONS -->
+ <generic-function name="selected-span">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ An object having selectable content.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>object</emphasis>
+ <reftopic>gfs:span</reftopic>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ Returns a <reftopic>gfs:span</reftopic> describing a range of data
+ within <arg0/> that is in the selected state, as well as an object
+ to return the selected data. If there is no selection, this function
+ returns NIL for both values. This function is defined only for widgets
+ whose notion of selection is a contiguous range of simple data
+ (e.g., <refclhs>character</refclhs>s in a <refclhs>string</refclhs>).
+ </para>
+ <para role="normal">
+ The corresponding SETF function sets the content of <arg0/> whose
+ indices lie within <emphasis>span</emphasis> to the selected state.
+ An existing selection's extent is modified to match the new span.
+ Passing NIL for <emphasis>span</emphasis> will unselect all content.
+ </para>
+ </description>
+ <seealso>
+ <reftopic>gfw:selected-count</reftopic>
+ <reftopic>gfw:select-all</reftopic>
+ <reftopic>gfw:edit</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="selected-p">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object having selectable state as an attribute.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns T if <arg0/> is in the selected state; nil otherwise.
+ </description>
+ <seealso>
+ <reftopic>gfw:select</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="selected-count">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a subclass of <reftopic>gfw:item-manager</reftopic>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns the number of items contained by <arg0/> that are in the
+ selected state.
+ </description>
+ <seealso>
+ <reftopic>gfw:select-all</reftopic>
+ <reftopic>gfw:selected-items</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="selected-items">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a subclass of <reftopic>gfw:item-manager</reftopic>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>list</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) the <reftopic>gfw:item</reftopic> subclass instances
+ that are in the selected state. Passing NIL will unselect all items,
+ equivalent to calling <reftopic>gfw:select-all</reftopic>.
+ </description>
+ <seealso>
+ <reftopic>gfw:selected-count</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="select">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object having selectable state as an attribute.
+ </description>
+ </argument>
+ <argument name="boolean">
+ <description>
+ A <refclhs>boolean</refclhs> specifying whether <arg0/>'s
+ selection state is to be set or unset.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Sets <arg0/> to the selected state if <arg1/> is not NIL or to the
+ unselected state if NIL.
+ </description>
+ <seealso>
+ <reftopic>gfw:selected-p</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="select-all">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object having content that may be selected.
+ </description>
+ </argument>
+ <argument name="boolean">
+ <description>
+ A <refclhs>boolean</refclhs> specifying whether <arg0/>'s
+ content is to be selected or unselected.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Sets the content of <arg0/> to the selected state if <arg1/> is
+ not NIL or to the unselected state if NIL. For <reftopic>gfw:item-manager</reftopic>
+ subclasses, this means all items within <arg0/> are affected. For
+ controls with editable content, like <reftopic>gfw:edit</reftopic>, this
+ function affects all of the content.
+ </description>
+ <seealso>
+ <reftopic>gfw:selected-span</reftopic>
+ <reftopic>gfw:selected-items</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="scroll">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a subclass of <reftopic>gfw:window</reftopic>.
+ </description>
+ </argument>
+ <argument name="delta-x">
+ <description>
+ An <refclhs>integer</refclhs> specifying how many pixels to
+ scroll on the horizontal axis.
+ </description>
+ </argument>
+ <argument name="delta-y">
+ <description>
+ An <refclhs>integer</refclhs> specifying how many pixels to
+ scroll on the vertical axis.
+ </description>
+ </argument>
+ <argument name="children-p">
+ <description>
+ Not yet implemented, must be NIL.
+ </description>
+ </argument>
+ <argument name="milliseconds">
+ <description>
+ Not yet implemented, must be 0.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Scrolls <arg0/> by a number of pixels right or down equal to the
+ <refclhs>integer</refclhs> values <arg1/> and <arg2/>; either delta
+ value may be negative in order to scroll left or up. Paint events
+ are delivered for the areas exposed due to scrolling.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-paint</reftopic>
+ <reftopic>gfw:scrolling-helper</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="resizable-p">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a subclass of <reftopic>gfw:widget</reftopic>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns T if <arg0/> can be resized by the user; NIL otherwise.
+ The corresponding SETF function is implemented for <reftopic>gfw:top-level</reftopic>
+ (but only has meaning when the :frame or :workspace styles are set),
+ allowing the application to modify the resizability of <arg0/>, whereupon the
+ frame decorations are modified appropriately.
+ </description>
+ <seealso>
+ <reftopic>gfw:style-of</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="redraw">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a subclass of <reftopic>gfw:widget</reftopic>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Causes the entire bounds of <arg0/> to be marked as needing to be redrawn.
+ For <reftopic>gfw:window</reftopic> subclasses, an <reftopic>gfw:event-paint</reftopic>
+ will be generated so that <arg0/> can update itself visually.
+ </description>
+ <seealso>
+ <reftopic>gfw:enable-redraw</reftopic>
+ <reftopic>gfw:with-drawing-disabled</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="redo-available-p">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object that supports undo/redo.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns T if <arg0/> has undo/redo capability and has an operation that
+ can be redone; NIL otherwise.
+ </description>
+ <seealso>
+ <reftopic>gfw:undo-available-p</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="undo-available-p">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object that supports undo/redo.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns T if <arg0/> has undo/redo capability and has an operation that
+ can be undone; NIL otherwise.
+ </description>
+ <seealso>
+ <reftopic>gfw:redo-available-p</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="preferred-size">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a subclass of <reftopic>gfw:widget</reftopic>.
+ </description>
+ </argument>
+ <argument name="width-hint">
+ <description>
+ An <refclhs>integer</refclhs>.
+ </description>
+ </argument>
+ <argument name="height-hint">
+ <description>
+ An <refclhs>integer</refclhs>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic>gfs:size</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Implement this function to return <arg0/>'s preferred dimensions -- that is,
+ the dimensions that <arg0/> computes as being the best fit for itself and/or
+ its children. If one or both of <arg1/> and <arg2/> are positive, then each
+ such argument is used as a constraint on the size calculation.
+ </description>
+ <seealso>
+ <reftopic>gfw:layout</reftopic>
+ <reftopic>gfw:minimum-size</reftopic>
+ <reftopic>gfw:maximum-size</reftopic>
+ <reftopic>gfw:size</reftopic>
+ </seealso>
+ </generic-function>
+
<generic-function name="page-increment">
<syntax with-setf="t">
<arguments>
@@ -2852,7 +3194,8 @@
subclass instances. The SETF function provides a <refclhs>list</refclhs>
of data objects to be wrapped by instances of the appropriate
<reftopic>gfw:item</reftopic> subclass, which replaces the existing items
- within <arg0/> and then causes <arg0/> to be repainted.
+ within <arg0/>. Call <reftopic>gfw:update-from-items</reftopic> to repaint
+ <arg0/>.
</description>
<seealso>
<reftopic>gfw:append-item</reftopic>
@@ -3199,27 +3542,6 @@
</seealso>
</generic-function>
- <generic-function name="enabled-p">
- <syntax>
- <arguments>
- <argument name="self">
- <description>
- The object to query for its state.
- </description>
- </argument>
- </arguments>
- <return>
- <refclhs>boolean</refclhs>
- </return>
- </syntax>
- <description>
- Returns T if <arg0/> is enabled; NIL otherwise.
- </description>
- <seealso>
- <reftopic>gfw:enable</reftopic>
- </seealso>
- </generic-function>
-
<generic-function name="echo-character">
<syntax with-setf="t">
<arguments>
@@ -4922,6 +5244,52 @@
<!-- ACCESSORS -->
+ <slot-accessor name="style-of">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a subclass of <reftopic>gfw:widget</reftopic>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>list</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns a <refclhs>list</refclhs> of widget-specific keyword symbols
+ that configure the look-and-feel of <arg0/>.
+ </description>
+ <seealso>
+ <reftopic>gfw:update-native-style</reftopic>
+ </seealso>
+ </slot-accessor>
+
+ <slot-accessor name="layout-p">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a subclass of <reftopic>gfw:layout-managed</reftopic>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) a <refclhs>boolean</refclhs> controlling whether layout
+ management is enabled within <arg0/>.
+ </description>
+ <seealso>
+ <reftopic>gfw:layout</reftopic>
+ <reftopic>gfw:preferred-size</reftopic>
+ <reftopic>gfw:enable-layout</reftopic>
+ </seealso>
+ </slot-accessor>
+
<!-- MACROS -->
<macro name="with-color-dialog">
