Author: junrue Date: Sat Oct 21 23:12:38 2006 New Revision: 380

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:12:38 2006 @@ -2396,6 +2396,204 @@

<!-- GENERIC FUNCTIONS -->

+ <generic-function name="item-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 maintained by <arg0/>. + </description> + <seealso> + <reftopic>gfw:append-item</reftopic> + <reftopic>gfw:delete-item</reftopic> + <reftopic>gfw:item-index</reftopic> + <reftopic>gfw:items-of</reftopic> + </seealso> + </generic-function> + + <generic-function name="item-index"> + <syntax> + <arguments> + <argument name="self"> + <description> + An instance of a subclass of <reftopic>gfw:item-manager</reftopic>. + </description> + </argument> + <argument name="item"> + <description> + The <reftopic>gfw:item</reftopic> subclass instance to be + located within <arg0/>. + </description> + </argument> + </arguments> + <return> + <refclhs>integer</refclhs> + </return> + </syntax> + <description> + Returns the zero-based index of <arg1/> within <arg0/>. + </description> + <seealso> + <reftopic>gfw:append-item</reftopic> + <reftopic>gfw:delete-item</reftopic> + <reftopic>gfw:item-count</reftopic> + <reftopic>gfw:items-of</reftopic> + </seealso> + </generic-function> + + <generic-function name="items-of"> + <syntax> + <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 a <refclhs>list</refclhs> of <reftopic>gfw:item</reftopic> + 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. + </description> + <seealso> + <reftopic>gfw:append-item</reftopic> + <reftopic>gfw:delete-item</reftopic> + <reftopic>gfw:item-count</reftopic> + <reftopic>gfw:item-index</reftopic> + </seealso> + </generic-function> + + <generic-function name="inner-limits"> + <syntax with-setf="t"> + <arguments> + <argument name="self"> + <description> + The object whose inner range of values is to be returned or set. + </description> + </argument> + </arguments> + <return> + <reftopic>gfs:span</reftopic> + </return> + </syntax> + <description> + Certain controls having the concept of a range of values within which a + selector may be positioned also allow the indicator to be further + constrained to a narrower range, e.g., <reftopic>gfw:slider</reftopic>. + If the SETF function is used to set a sub-range, <arg0/>'s visual style + will be updated and the indicator restricted appropriately. + </description> + <seealso> + <reftopic>gfw:outer-limit</reftopic> + </seealso> + </generic-function> + + <generic-function name="outer-limit"> + <syntax with-setf="t"> + <arguments> + <argument name="self"> + <description> + The object whose maximum value is to be returned or set. + </description> + </argument> + </arguments> + <return> + <refclhs>integer</refclhs> + </return> + </syntax> + <description> + Returns (sets) an <refclhs>integer</refclhs> representing the maximum + value or position to which the indicator in <arg0/> may be set by the + user. Application code is responsible for synchronizing this maximum + with its content model. + </description> + <seealso> + <reftopic>gfw:inner-limits</reftopic> + </seealso> + </generic-function> + + <generic-function name="image"> + <syntax with-setf="t"> + <arguments> + <argument name="self"> + <description> + An object that owns (or will own) a <reftopic>gfg:image</reftopic>. + </description> + </argument> + </arguments> + <return> + <reftopic>gfg:image</reftopic> + </return> + </syntax> + <description> + Returns the <reftopic>gfg:image</reftopic> currently associated with + <arg0/>. If <arg0/> is a <reftopic>gfw:window</reftopic>, then this + function returns a <reftopic>gfg:icon-bundle</reftopic>; in that case, + the SETF function accepts either type. + </description> + </generic-function> + + <generic-function name="horizontal-scrollbar-p"> + <syntax> + <arguments> + <argument name="self"> + <description> + The object whose scrollbar configuration is to be queried. + </description> + </argument> + </arguments> + <return> + <refclhs>boolean</refclhs> + </return> + </syntax> + <description> + Returns T if <arg0/> has been configured with a horizontal scrollbar, + even if said scrollbar is not currently visible; NIL otherwise. + </description> + <seealso> + <reftopic>gfw:enable-scrollbars</reftopic> + <reftopic>gfw:vertical-scrollbar-p</reftopic> + </seealso> + </generic-function> + + <generic-function name="vertical-scrollbar-p"> + <syntax> + <arguments> + <argument name="self"> + <description> + The object whose scrollbar configuration is to be queried. + </description> + </argument> + </arguments> + <return> + <refclhs>boolean</refclhs> + </return> + </syntax> + <description> + Returns T if <arg0/> has been configured with a vertical scrollbar, + even if said scrollbar is not currently visible; NIL otherwise. + </description> + <seealso> + <reftopic>gfw:enable-scrollbars</reftopic> + <reftopic>gfw:horizontal-scrollbar-p</reftopic> + </seealso> + </generic-function> + <generic-function name="enabled-p"> <syntax> <arguments> @@ -2417,6 +2615,48 @@ </seealso> </generic-function>

+ <generic-function name="focus-p"> + <syntax> + <arguments> + <argument name="self"> + <description> + The object whose focus ownership is to be queried. + </description> + </argument> + </arguments> + <return> + <refclhs>boolean</refclhs> + </return> + </syntax> + <description> + Returns T if <arg0/> has the keyboard focus; NIL otherwise. + </description> + <seealso> + <reftopic>gfw:give-focus</reftopic> + </seealso> + </generic-function> + + <generic-function name="give-focus"> + <syntax> + <arguments> + <argument name="self"> + <description> + The destination for keyboard focus. + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Places keyboard focus on <arg0/>. + </description> + <seealso> + <reftopic>gfw:focus-p</reftopic> + </seealso> + </generic-function> + <generic-function name="enable-redraw"> <syntax> <arguments> @@ -2654,6 +2894,9 @@ </description> <seealso> <reftopic>gfw:append-item</reftopic> + <reftopic>gfw:item-count</reftopic> + <reftopic>gfw:items-of</reftopic> + <reftopic>gfw:item-index</reftopic> </seealso> </generic-function>

@@ -3148,6 +3391,8 @@ <reftopic>gfw:append-submenu</reftopic> <reftopic>gfw:defmenu</reftopic> <reftopic>gfw:delete-item</reftopic> + <reftopic>gfw:item-count</reftopic> + <reftopic>gfw:items-of</reftopic> </seealso> </generic-function>