[graphic-forms-cvs] r384 - trunk/docs/manual
junrue at common-lisp.net
junrue at common-lisp.net
Sun Oct 22 06:52:07 UTC 2006
Author: junrue
Date: Sun Oct 22 02:52:06 2006
New Revision: 384
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 Sun Oct 22 02:52:06 2006
@@ -361,6 +361,7 @@
</argument>
</initargs>
<seealso>
+ <reftopic>gfw:thumb-position</reftopic>
<reftopic>gfw:event-source</reftopic>
<reftopic>gfw:page-increment</reftopic>
<reftopic>gfw:step-increment</reftopic>
@@ -583,6 +584,12 @@
</initargs>
<seealso>
<reftopic>gfs:dispose</reftopic>
+ <reftopic>gfw:update-from-items</reftopic>
+ <reftopic>gfw:item-count</reftopic>
+ <reftopic>gfw:append-item</reftopic>
+ <reftopic>gfw:delete-item</reftopic>
+ <reftopic>gfw:item-index</reftopic>
+ <reftopic>gfw:selected-items</reftopic>
</seealso>
</class>
@@ -1443,6 +1450,9 @@
</initargs>
<seealso>
<reftopic>gfs:dispose</reftopic>
+ <reftopic>gfw:update-native-style</reftopic>
+ <reftopic>gfw:parent</reftopic>
+ <reftopic>gfw:style-of</reftopic>
</seealso>
</class>
@@ -2395,11 +2405,289 @@
<seealso>
<reftopic>gfw:standard-scrollbar</reftopic>
<reftopic>gfw:scrollbar</reftopic>
+ <reftopic>gfw:thumb-position</reftopic>
+ <reftopic>gfw:page-increment</reftopic>
+ <reftopic>gfw:step-increment</reftopic>
+ <reftopic>gfw:event-scroll</reftopic>
</seealso>
</function>
<!-- GENERIC FUNCTIONS -->
+ <generic-function name="update-native-style">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a <reftopic>gfw:control</reftopic> subclass.
+ </description>
+ </argument>
+ <argument name="integer">
+ <description>
+ An <refclhs>integer</refclhs> specifying replacement style flags.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ This function replaces the native style flags of <arg0/> with
+ <arg1/> and calls any additional API needed to ensure that
+ <arg0/>'s visual representation is refreshed. <arg1/>
+ is returned.
+ </para>
+ <para role="normal">
+ This function is not intended to be called from application code.
+ </para>
+ </description>
+ <seealso>
+ <reftopic>gfw:style-of</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="update-from-items">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a <reftopic>gfw:item-manager</reftopic> subclass.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ Synchronizes <arg0/>'s internal model (i.e., a native control's
+ data structures) with data derived from the <emphasis>items</emphasis>
+ slot. If <arg0/> has been assigned a sorting predicate, the array of
+ items will be sorted prior to the internal model update.
+ </para>
+ <para role="normal">
+ This function is not intended to be called from application code.
+ However, applications defining new control types may need to implement
+ this.
+ </para>
+ </description>
+ <seealso>
+ <reftopic>gfw:items-of</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="update">
+ <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>
+ Forces all outstanding paint requests for <arg0/> to be processed
+ before this function returns.
+ </description>
+ <seealso>
+ <reftopic>gfw:redraw</reftopic>
+ <reftopic>gfw:with-drawing-disabled</reftopic>
+ <reftopic>gfw:enable-drawing</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="thumb-position">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of <reftopic>gfw:scrollbar</reftopic>, <reftopic>gfw:slider</reftopic>,
+ or <reftopic>gfw:standard-scrollbar</reftopic>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) an <refclhs>integer</refclhs> value representing the
+ position of the scroll thumb for <arg0/>. A
+ <reftopic>gfw:scrolling-helper</reftopic> instance will manage the
+ thumb position for the <reftopic>gfw:window</reftopic> to which it is
+ assigned.
+ </description>
+ </generic-function>
+
+ <generic-function name="text-modified-p">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ An object with a text component that can be modified by
+ the user.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns T if the text component of <arg0/> has been modified by the user;
+ NIL otherwise. The corresponding SETF function updates the dirty state flag.
+ This function is not implemented for all <reftopic>gfw:widget</reftopic>s,
+ since in some cases there are multiple text components and in other cases
+ there is no text component at all.
+ </description>
+ <seealso>
+ <reftopic>gfw:text</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="text-for-pasting-p">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ The object to be queried for readiness to accept text from
+ the system clipboard.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ This function is a shortcut means of checking the clipboard for
+ existence of data of a specific type (text). This status information
+ is typically used to enable or disable a "Paste" menu item.
+ </para>
+ <para role="normal">
+ Note: an upcoming release will include more general infrastructure
+ for clipboard operations.
+ </para>
+ </description>
+ <seealso>
+ <reftopic>gfw:copy-text</reftopic>
+ <reftopic>gfw:cut-text</reftopic>
+ <reftopic>gfw:paste-text</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="text-baseline">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a <reftopic>gfw:widget</reftopic> subclass
+ having text content.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ Returns the Y coordinate value (in <arg0/>'s coordinate system)
+ that correlates to the baseline of the text of the control, if any.
+ For controls in which a text baseline is not meaningful, such as a
+ <reftopic>gfw:label</reftopic> with a <reftopic>gfg:image</reftopic>,
+ this function returns the control's height.
+ </para>
+ <para role="normal">
+ By default, Graphic-Forms does not implement this function for
+ <reftopic>gfw:window</reftopic> subclasses. However, custom controls
+ should implement this if the custom control will be used as a child
+ within a container using a <reftopic>gfw:layout-manager</reftopic>.
+ </para>
+ </description>
+ <seealso>
+ <reftopic>gfw:preferred-size</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="text">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ An object having a text attribute, such as a window title.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>string</refclhs>
+ </return>
+ </syntax>
+ <description>
+ For a <reftopic>gfw:window</reftopic> or <reftopic>gfw:dialog</reftopic>,
+ this function returns (sets) <arg0/>'s titlebar text (which may be blank). For
+ other widgets that have a text component, this function returns (sets) that
+ text component. For anything else, this function returns nil.
+ </description>
+ </generic-function>
+
+ <generic-function name="show">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object whose visibility is to be configured.
+ </description>
+ </argument>
+ <argument name="boolean">
+ <description>
+ A <refclhs>boolean</refclhs> flag.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Causes <arg0/> to be visible if <arg1/> is non-NIL (but not necessarily
+ top-most in the display Z-order), or hidden if <arg1/> is NIL.
+ </description>
+ <seealso>
+ <reftopic>gfw:visible-p</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="visible-p">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object whose visibility is to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns T if <arg0/> is visible (not necessarily top-most);
+ NIL otherwise.
+ </description>
+ <seealso>
+ <reftopic>gfw:show</reftopic>
+ </seealso>
+ </generic-function>
+
<generic-function name="selected-span">
<syntax with-setf="t">
<arguments>
@@ -2655,6 +2943,7 @@
will be generated so that <arg0/> can update itself visually.
</description>
<seealso>
+ <reftopic>gfw:update</reftopic>
<reftopic>gfw:enable-redraw</reftopic>
<reftopic>gfw:with-drawing-disabled</reftopic>
</seealso>
@@ -2763,6 +3052,7 @@
this value on behalf of windows with standard scrollbars.
</description>
<seealso>
+ <reftopic>gfw:thumb-position</reftopic>
<reftopic>gfw:event-scroll</reftopic>
<reftopic>gfw:scroll</reftopic>
<reftopic>gfw:step-increment</reftopic>
@@ -2790,6 +3080,7 @@
manages this value on behalf of windows with standard scrollbars.
</description>
<seealso>
+ <reftopic>gfw:thumb-position</reftopic>
<reftopic>gfw:event-scroll</reftopic>
<reftopic>gfw:scroll</reftopic>
<reftopic>gfw:page-increment</reftopic>
@@ -3177,7 +3468,7 @@
</generic-function>
<generic-function name="items-of">
- <syntax>
+ <syntax with-setf="t">
<arguments>
<argument name="self">
<description>
@@ -3408,6 +3699,8 @@
its client area; NIL disables redrawing.
</description>
<seealso>
+ <reftopic>gfw:update</reftopic>
+ <reftopic>gfw:redraw</reftopic>
<reftopic>gfw:with-drawing-disabled</reftopic>
</seealso>
</generic-function>
@@ -5378,6 +5671,9 @@
queued so that when the lock is lifted, <arg0/> will be repainted.
</description>
<seealso>
+ <reftopic>gfw:redraw</reftopic>
+ <reftopic>gfw:update</reftopic>
+ <reftopic>gfw:enable-redraw</reftopic>
</seealso>
</macro>
More information about the Graphic-forms-cvs
mailing list