[graphic-forms-cvs] r378 - trunk/docs/manual
junrue at common-lisp.net
junrue at common-lisp.net
Sat Oct 21 23:55:07 UTC 2006
Author: junrue
Date: Sat Oct 21 19:55:04 2006
New Revision: 378
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 19:55:04 2006
@@ -2393,6 +2393,360 @@
<!-- GENERIC FUNCTIONS -->
+ <generic-function name="copy-text">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object that can interact with the system clipboard.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ This function is a shortcut for a common clipboard transfer operation,
+ namely the transfer of text from <arg0/> to the system clipboard. The
+ existing content of <arg0/> remains undisturbed. Some controls like
+ the edit control have built-in clipboard functionality, and in such
+ cases, the implementation of this function delegates to such functionality
+ directly.
+ </para>
+ <para role="normal">
+ Note: an upcoming release will include more general infrastructure for
+ clipboard operations.
+ </para>
+ </description>
+ <seealso>
+ <reftopic>gfw:cut-text</reftopic>
+ <reftopic>gfw:paste-text</reftopic>
+ <reftopic>gfw:text-for-pasting-p</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="cut-text">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object that can interact with the system clipboard.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ This function is a shortcut for a common clipboard transfer operation,
+ namely the transfer of text from <arg0/> to the system clipboard and
+ removal of that content of <arg0/>. Some controls like
+ the edit control have built-in clipboard functionality, and in such
+ cases, the implementation of this function delegates to such functionality
+ directly. For other widgets, this operation is a wrapper around a
+ copy/delete sequence.
+ </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:paste-text</reftopic>
+ <reftopic>gfw:text-for-pasting-p</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="paste-text">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object that can interact with the system clipboard.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ This function is a shortcut for a common clipboard transfer operation,
+ namely the transfer of text from the system clipboard to <arg0/>.
+ Some controls like the edit control have built-in clipboard functionality,
+ and in such cases, the implementation of this function delegates to such
+ functionality directly.
+ </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:text-for-pasting-p</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="compute-outer-size">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object with border decorations.
+ </description>
+ </argument>
+ <argument name="size">
+ <description>
+ A <reftopic>gfs:size</reftopic> describing the desired
+ client size.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic>gfs:size</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns the dimensions of the area required to enclose <arg0/>
+ assuming <arg1/> is the desired client area, taking into account
+ the trim and other decorations which <arg0/> is configured to have.
+ </description>
+ <seealso>
+ <reftopic>gfw:client-size</reftopic>
+ <reftopic>gfw:size</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="compute-style-flags">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object having style flags that must be translated prior to
+ <arg0/>'s native handle being created.
+ </description>
+ </argument>
+ <notarg name="&rest"/>
+ <argument name="extra-data">
+ <description>
+ Additional translation data.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ Converts <arg0/>'s style keyword symbols to a pair of native bitmasks;
+ the first conveys normal/standard flags, whereas the second any extended
+ flags that the system supports.
+ </para>
+ <para role="normal">
+ This function is not usually called by application code. A method is
+ defined on it for each control, standard dialog, or similar widgets
+ having a native system resource. Library extensions that add new widget
+ types, on the other hand, are required to provide appropriate
+ implementations.
+ </para>
+ </description>
+ <seealso>
+ <reftopic>gfw:style-of</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="client-size">
+ <syntax>
+ <arguments>
+ <argument name="self"/>
+ </arguments>
+ <return>
+ <reftopic>gfs:size</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns the dimensions of the client area within <arg0/>, which
+ is the area typically drawn within or serving as a container for
+ children.
+ </description>
+ <seealso>
+ <reftopic>gfw:size</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="size">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self"/>
+ </arguments>
+ <return>
+ <reftopic>gfs:size</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) the dimensions of <arg0/> within the parent coordinate
+ system, including any border trim or other decoration.
+ </description>
+ <seealso>
+ <reftopic>gfw:client-size</reftopic>
+ <reftopic>gfw:parent</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="check">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object supporting check/uncheck behavior.
+ </description>
+ </argument>
+ <argument name="flag">
+ <description>
+ A <refclhs>boolean</refclhs>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Sets <arg0/> into the checked state.
+ </description>
+ <seealso>
+ <reftopic>gfw:checked-p</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="checked-p">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object supporting check/uncheck behavior.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns T if <arg0/> is in the checked state; NIL otherwise.
+ </description>
+ <seealso>
+ <reftopic>gfw:check</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="center-on-owner">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a <reftopic>gfw:widget</reftopic> subclass.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Positions <arg0/> such that it is centrally-located relative to
+ the bounds of <arg0/>'s owner, based on <arg0/>'s current outermost
+ size.
+ </description>
+ <seealso>
+ <reftopic>gfw:center-on-parent</reftopic>
+ <reftopic>gfw:owner</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="center-on-parent">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a <reftopic>gfw:widget</reftopic> subclass.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Positions <arg0/> such that it is centrally-located relative to
+ the bounds of <arg0/>'s parent, based on <arg0/>'s current outermost
+ size.
+ </description>
+ <seealso>
+ <reftopic>gfw:center-on-owner</reftopic>
+ <reftopic>gfw:parent</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="cancel-widget">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a <reftopic>gfw:window</reftopic> subclass.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic>gfw:widget</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) the <reftopic>gfw:widget</reftopic> that is invoked by
+ the <Esc> key or otherwise acts to dismiss <arg0/>. In a
+ <reftopic>gfw:dialog</reftopic>, the widget must be a
+ <reftopic>gfw:button</reftopic> and is typically labelled "Cancel".
+ </description>
+ <seealso>
+ <reftopic>gfw:default-widget</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="default-widget">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a <reftopic>gfw:window</reftopic> subclass.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic>gfw:widget</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) the <reftopic>gfw:widget</reftopic> that represents
+ the default action for <arg0/>. Passing NIL to the SETF function
+ clears the default widget binding. The default action is invoked when
+ the user presses <Enter> within <arg0/>.
+ </description>
+ <seealso>
+ <reftopic>gfw:cancel-widget</reftopic>
+ <reftopic>gfw:event-default-action</reftopic>
+ </seealso>
+ </generic-function>
+
<generic-function name="auto-hscroll-p">
<syntax>
<arguments>
More information about the Graphic-forms-cvs
mailing list