Author: junrue Date: Sat Oct 21 23:38:55 2006 New Revision: 381

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 23:38:55 2006 @@ -2396,6 +2396,190 @@

<!-- GENERIC FUNCTIONS -->

+ <generic-function name="menu-bar"> + <syntax with-setf="t"> + <arguments> + <argument name="self"> + <description> + An instance of a subclass of <reftopic>gfw:window</reftopic>. + </description> + </argument> + </arguments> + <return> + <reftopic>gfw:menu</reftopic> + </return> + </syntax> + <description> + Returns (sets) the <reftopic>gfw:menu</reftopic> serving as the + menu bar for <arg0/>. The SETF function automatically refreshes + the menu bar. + </description> + <seealso> + <reftopic>gfw:defmenu</reftopic> + </seealso> + </generic-function> + + <generic-function name="maximum-size"> + <syntax with-setf="t"> + <arguments> + <argument name="self"> + <description> + An object that has a size attribute which may be altered by + the user. + </description> + </argument> + </arguments> + <return> + <reftopic>gfs:size</reftopic> + </return> + </syntax> + <description> + <para role="normal"> + Returns (sets) the largest dimensions to which the user may resize + <arg0/>. By default, <reftopic>gfw:window</reftopic>s and + <reftopic>gfw:control</reftopic>s return NIL indicating that there + is effectively no constraint. + </para> + <para role="normal"> + If the new maximum size provided via the SETF function is smaller + than the current size, the widget is resized to the new maximum. + </para> + </description> + <seealso> + <reftopic>gfw:size</reftopic> + <reftopic>gfw:preferred-size</reftopic> + <reftopic>gfw:minimum-size</reftopic> + </seealso> + </generic-function> + + <generic-function name="minimum-size"> + <syntax with-setf="t"> + <arguments> + <argument name="self"> + <description> + An object that has a size attribute which may be altered by + the user. + </description> + </argument> + </arguments> + <return> + <reftopic>gfs:size</reftopic> + </return> + </syntax> + <description> + <para role="normal"> + Returns (sets) the smallest dimensions to which the user may resize + <arg0/>. By default, <reftopic>gfw:window</reftopic>s return NIL + indicating that the minimum constraint is determined by the windowing + system's configuration; whereas, <reftopic>gfw:control</reftopic>s + return the same value by default as would <reftopic>gfw:preferred-size</reftopic>. + </para> + <para role="normal"> + If the new minimum size provided via the SET function is larger than the + current size, the widget is resized to the new minimum. + </para> + </description> + <seealso> + <reftopic>gfw:size</reftopic> + <reftopic>gfw:preferred-size</reftopic> + <reftopic>gfw:maximum-size</reftopic> + </seealso> + </generic-function> + + <generic-function name="mapchildren"> + <syntax> + <arguments> + <argument name="self"> + <description> + A container for children. + </description> + </argument> + <argument name="func"> + <description> + A function of two arguments. + </description> + </argument> + </arguments> + <return> + <refclhs>list</refclhs> + </return> + </syntax> + <description> + Calls <arg1/> for each child of <arg0/> and places <arg1/>'s + return value in the result <refclhs>list</refclhs>. <arg1/>'s + two arguments are <arg0/> and the current child. Note that + mapchildren accesses <arg0/>'s actual children as determined + by the underlying windowing system, regardless of any + <reftopic>gfw:layout-manager</reftopic> assigned to <arg0/>. + </description> + </generic-function> + + <generic-function name="location"> + <syntax with-setf="t"> + <arguments> + <argument name="self"> + <description> + An object that can be positioned. + </description> + </argument> + </arguments> + <return> + <reftopic>gfs:point</reftopic> + </return> + </syntax> + <description> + Returns (sets) the location of the top-left corner of <arg0/> within + its parent's coordinate system. + </description> + <seealso> + <reftopic>gfw:size</reftopic> + <reftopic>gfw:parent</reftopic> + </seealso> + </generic-function> + + <generic-function name="line-count"> + <syntax> + <arguments> + <argument name="self"> + <description> + An object whose content is logically organized into lines. + </description> + </argument> + </arguments> + <return> + <refclhs>integer</refclhs> + </return> + </syntax> + <description> + Returns the total number of lines (e.g., of text) contained by <arg0/>. + </description> + <seealso> + <reftopic>gfw:edit</reftopic> + </seealso> + </generic-function> + + <generic-function name="layout"> + <syntax> + <arguments> + <argument name="self"> + <description> + An instance of a subclass of <reftopic>gfw:layout-managed</reftopic>. + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Causes <arg0/>'s layout manager to update the sizes and locations of + <arg0/>'s children. + </description> + <seealso> + <reftopic>gfw:layout-manager</reftopic> + </seealso> + </generic-function> + <generic-function name="item-count"> <syntax> <arguments> @@ -3069,6 +3253,9 @@ <seealso> <reftopic>gfw:client-size</reftopic> <reftopic>gfw:size</reftopic> + <reftopic>gfw:preferred-size</reftopic> + <reftopic>gfw:maximum-size</reftopic> + <reftopic>gfw:minimum-size</reftopic> </seealso> </generic-function>

@@ -3128,6 +3315,9 @@ </description> <seealso> <reftopic>gfw:size</reftopic> + <reftopic>gfw:preferred-size</reftopic> + <reftopic>gfw:maximum-size</reftopic> + <reftopic>gfw:minimum-size</reftopic> </seealso> </generic-function>

@@ -3147,6 +3337,10 @@ <seealso> <reftopic>gfw:client-size</reftopic> <reftopic>gfw:parent</reftopic> + <reftopic>gfw:location</reftopic> + <reftopic>gfw:preferred-size</reftopic> + <reftopic>gfw:maximum-size</reftopic> + <reftopic>gfw:minimum-size</reftopic> </seealso> </generic-function>