[graphic-forms-cvs] r379 - trunk/docs/manual
junrue at common-lisp.net
junrue at common-lisp.net
Sun Oct 22 02:05:50 UTC 2006
Author: junrue
Date: Sat Oct 21 22:05:49 2006
New Revision: 379
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 22:05:49 2006
@@ -535,6 +535,9 @@
<reftopic>gfs:dispose</reftopic>
<reftopic>gfw:obtain-horizontal-scrollbar</reftopic>
<reftopic>gfw:obtain-vertical-scrollbar</reftopic>
+ <reftopic>gfw:enable-scrollbars</reftopic>
+ <reftopic>gfw:horizontal-scrollbar-p</reftopic>
+ <reftopic>gfw:vertical-scrollbar-p</reftopic>
</seealso>
</class>
@@ -2393,6 +2396,307 @@
<!-- GENERIC FUNCTIONS -->
+ <generic-function name="enabled-p">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ The object whose enabled state is to be queried.
+ </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="enable-redraw">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ A <reftopic>gfw:widget</reftopic>.
+ </description>
+ </argument>
+ <argument name="flag">
+ <description>
+ A <refclhs>boolean</refclhs> flag specifying whether redrawing
+ within <arg0/> is enabled.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Any non-NIL value for <arg1/> enables <arg0/> to be updated and invalidates
+ its client area; NIL disables redrawing.
+ </description>
+ <seealso>
+ <reftopic>gfw:with-drawing-disabled</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="enable-layout">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ A <reftopic>gfw:window</reftopic>.
+ </description>
+ </argument>
+ <argument name="flag">
+ <description>
+ A <refclhs>boolean</refclhs> flag specifying whether layout within
+ <arg0/> is enabled.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Any non-NIL value for <arg1/> enables layout within <arg0/>; NIL
+ disables layout.
+ </description>
+ <seealso>
+ <reftopic>gfw:layout</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="enable-auto-scrolling">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object that supports scrolling functionality.
+ </description>
+ </argument>
+ <argument name="horizontal">
+ <description>
+ A <refclhs>boolean</refclhs> flag controlling the horizontal axis.
+ </description>
+ </argument>
+ <argument name="vertical">
+ <description>
+ A <refclhs>boolean</refclhs> flag controlling the vertical axis.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Configures the object to allow (or disallow) automatic scrolling in
+ the horizontal or vertical directions.
+ </description>
+ <seealso>
+ <reftopic>gfw:auto-hscroll-p</reftopic>
+ <reftopic>gfw:auto-vscroll-p</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="enable-scrollbars">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object that supports scrolling functionality.
+ </description>
+ </argument>
+ <argument name="horizontal">
+ <description>
+ A <refclhs>boolean</refclhs> flag controlling the scrollbar
+ on the horizontal axis.
+ </description>
+ </argument>
+ <argument name="vertical">
+ <description>
+ A <refclhs>boolean</refclhs> flag controlling the scrollbar
+ on the vertical axis.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Specifying T for <arg1/> (<arg2/>) configures <arg0/> to have a
+ <reftopic>gfw:standard-scrollbar</reftopic> to attached to the
+ right-hand (bottom) edge. The visibility of each scrollbar then
+ depends on the scrollbar visibility policy configured for <arg0/>
+ and the state of the scrolling viewport. Specifying NIL disables
+ the scrollbar.
+ </description>
+ <seealso>
+ <reftopic>gfw:horizontal-scrollbar-p</reftopic>
+ <reftopic>gfw:vertical-scrollbar-p</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="enable">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ The object to be enabled or disabled.
+ </description>
+ </argument>
+ <argument name="flag">
+ <description>
+ A <refclhs>boolean</refclhs> indicating whether to enable
+ or disable <arg0/>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ For widgets, this function causes <arg0/> to stop (or re-enable)
+ input event processing and changes its look from the default to
+ grayed or vice versa. For a <reftopic>gfw:timer</reftopic>, this
+ function starts or stops event generation.
+ </description>
+ <seealso>
+ <reftopic>gfw:enabled-p</reftopic>
+ </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>
+ <argument name="self">
+ <description>
+ An object that allows the user to edit text content.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>character</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) the character used to mask text content, such as
+ inside a <reftopic>gfw:edit</reftopic> created with the :password
+ style symbol.
+ </description>
+ </generic-function>
+
+ <generic-function name="delete-all">
+ <syntax>
+ <arguments>
+ <argument name="self"/>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Removes all content from <arg0/>.
+ </description>
+ </generic-function>
+
+ <generic-function name="delete-item">
+ <syntax>
+ <arguments>
+ <argument name="item-manager">
+ <description>
+ A <reftopic>gfw:item-manager</reftopic>.
+ </description>
+ </argument>
+ <argument name="index">
+ <description>
+ A zero-based <refclhs>integer</refclhs> index into the items
+ contained within <arg0/>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Removes the item at <arg1/> from <arg0/>.
+ </description>
+ <seealso>
+ <reftopic>gfw:append-item</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="delete-selection">
+ <syntax>
+ <arguments>
+ <argument name="self"/>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Removes the subset of items from <arg0/> that are in the selected
+ state. For a control with a text field component, such as an edit control,
+ this function deletes selected text.
+ </description>
+ </generic-function>
+
+ <generic-function name="delete-span">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object with a contiguous range of content to be removed.
+ </description>
+ </argument>
+ <argument name="span">
+ <description>
+ A <reftopic>gfs:span</reftopic> identifying a range of content.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Removes the content from <arg0/> whose zero-based indices lie within
+ <arg1/>.
+ </description>
+ </generic-function>
+
<generic-function name="copy-text">
<syntax>
<arguments>
@@ -2843,6 +3147,7 @@
<reftopic>gfw:append-separator</reftopic>
<reftopic>gfw:append-submenu</reftopic>
<reftopic>gfw:defmenu</reftopic>
+ <reftopic>gfw:delete-item</reftopic>
</seealso>
</generic-function>
More information about the Graphic-forms-cvs
mailing list