Author: junrue Date: Sun Oct 22 00:44:07 2006 New Revision: 382

Modified: trunk/docs/manual/api.xml trunk/docs/manual/constants.xml trunk/docs/manual/gfw-symbols.xml trunk/docs/manual/introduction.xml trunk/docs/manual/legal.xml trunk/docs/manual/miscellaneous-topics.xml Log:

Modified: trunk/docs/manual/api.xml ============================================================================== --- trunk/docs/manual/api.xml (original) +++ trunk/docs/manual/api.xml Sun Oct 22 00:44:07 2006 @@ -3,7 +3,7 @@

Copyright (c) 2006, Jack D. Unrue --> -<chapter> +<chapter id="api"> <title>API Reference</title>

<para role="normal">

Modified: trunk/docs/manual/constants.xml ============================================================================== --- trunk/docs/manual/constants.xml (original) +++ trunk/docs/manual/constants.xml Sun Oct 22 00:44:07 2006 @@ -3,7 +3,7 @@

Copyright (c) 2006, Jack D. Unrue --> -<chapter> +<chapter id="constants"> <title>Constants and Variables</title> <indexterm><primary>constants</primary></indexterm>

Modified: trunk/docs/manual/gfw-symbols.xml ============================================================================== --- trunk/docs/manual/gfw-symbols.xml (original) +++ trunk/docs/manual/gfw-symbols.xml Sun Oct 22 00:44:07 2006 @@ -362,6 +362,9 @@ </initargs> <seealso> <reftopic>gfw:event-source</reftopic> + <reftopic>gfw:page-increment</reftopic> + <reftopic>gfw:step-increment</reftopic> + <reftopic>gfw:scroll</reftopic> </seealso> </class>

@@ -2396,6 +2399,203 @@

<!-- GENERIC FUNCTIONS -->

+ <generic-function name="page-increment"> + <syntax with-setf="t"> + <arguments> + <argument name="self"> + <description> + A <reftopic>gfw:scrollbar</reftopic>, <reftopic>gfw:slider</reftopic>, + or <reftopic>gfw:standard-scrollbar</reftopic>. + </description> + </argument> + </arguments> + <return> + <refclhs>integer</refclhs> + </return> + </syntax> + <description> + This function returns the amount by which the viewport origin is incremented + forward (or backward) when a user gesture causes a scroll event of type + :page-forward (or :page-back). The returned value determines the size of the + proportional thumb. The <reftopic>gfw:scrolling-helper</reftopic> manages + this value on behalf of windows with standard scrollbars. + </description> + <seealso> + <reftopic>gfw:event-scroll</reftopic> + <reftopic>gfw:scroll</reftopic> + <reftopic>gfw:step-increment</reftopic> + </seealso> + </generic-function> + + <generic-function name="step-increment"> + <syntax with-setf="t"> + <arguments> + <argument name="self"> + <description> + A <reftopic>gfw:scrollbar</reftopic>, <reftopic>gfw:slider</reftopic>, + or <reftopic>gfw:standard-scrollbar</reftopic>. + </description> + </argument> + </arguments> + <return> + <refclhs>integer</refclhs> + </return> + </syntax> + <description> + This function returns the amount by which the viewport origin is incremented + forward (or backward) when a user gesture causes a scroll event of type + :step-forward (or :step-back). The <reftopic>gfw:scrolling-helper</reftopic> + manages this value on behalf of windows with standard scrollbars. + </description> + <seealso> + <reftopic>gfw:event-scroll</reftopic> + <reftopic>gfw:scroll</reftopic> + <reftopic>gfw:page-increment</reftopic> + </seealso> + </generic-function> + + <generic-function name="pack"> + <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/> to be resized to the smallest possible dimensions given + the locations and sizes of its children, as determined by <arg0/>'s + <reftopic>gfw:layout-manager</reftopic>. + </description> + <seealso> + <reftopic>gfw:layout</reftopic> + <reftopic>gfw:layout-p</reftopic> + <reftopic>gfw:enable-layout</reftopic> + </seealso> + </generic-function> + + <generic-function name="owner"> + <syntax> + <arguments> + <argument name="self"> + <description> + An "owned" object such as a <reftopic>gfw:top-level</reftopic>. + </description> + </argument> + </arguments> + <return> + <reftopic>gfw:window</reftopic> + </return> + </syntax> + <description> + <para role="normal"> + Returns the owner of <arg0/>, which may be different from <arg0/>'s + parent because the window ownership hierarchy includes the relationships + between physically separate top-level windows and dialogs. It is possible + for a window to be unowned but still have a parent. Consequently, calling + <reftopic>gfw:parent</reftopic> on a <reftopic>gfw:top-level</reftopic> + will return an instance of <reftopic>gfw:root-window</reftopic>, but + calling this function may return NIL. + </para> + <para role="normal"> + <ulink url="http://blogs.msdn.com/oldnewthing/archive/2004/02/24/79212.aspx"> + This blog entry</ulink> provides more information. + </para> + </description> + <seealso> + <reftopic>gfw:parent</reftopic> + </seealso> + </generic-function> + + <generic-function name="parent"> + <syntax> + <arguments> + <argument name="self"> + <description> + An object capable of being the child of another container. + </description> + </argument> + </arguments> + <return> + <reftopic>gfw:window</reftopic> + </return> + </syntax> + <description> + <para role="normal"> + Returns the parent of <arg0/>. In the case of <reftopic>gfw:panel</reftopic> + and <reftopic>gfw:control</reftopic>, this will be the ancestor + <reftopic>gfw:dialog</reftopic>, <reftopic>gfw:panel</reftopic>, or + <reftopic>gfw:top-level</reftopic>. In the case of a <reftopic>gfw:dialog</reftopic> + or <reftopic>gfw:top-level</reftopic>, then a <reftopic>gfw:root-window</reftopic> + is returned. In the case of a submenu, this will be the + <reftopic>gfw:menu</reftopic>'s ancestor in the hierarchy; but for a menubar or + context menu, this function returns NIL. + </para> + <para role="normal"> + <ulink url="http://blogs.msdn.com/oldnewthing/archive/2004/02/24/79212.aspx"> + This blog entry</ulink> provides more information. + </para> + </description> + <seealso> + <reftopic>gfw:owner</reftopic> + </seealso> + </generic-function> + + <generic-function name="obtain-horizontal-scrollbar"> + <syntax> + <arguments> + <argument name="self"> + <description> + An object configured with a horizontal scrollbar. + </description> + </argument> + </arguments> + <return> + <reftopic>gfw:standard-scrollbar</reftopic> + </return> + </syntax> + <description> + Returns the horizontal <reftopic>gfw:standard-scrollbar</reftopic> + attached to the bottom of <arg0/>, if <arg0/> is configured to + have one and whether or not said scrollbar is currently visible; + returns NIL otherwise. + </description> + <seealso> + <reftopic>gfw:obtain-vertical-scrollbar</reftopic> + <reftopic>gfw:horizontal-scrollbar-p</reftopic> + </seealso> + </generic-function> + + <generic-function name="obtain-vertical-scrollbar"> + <syntax> + <arguments> + <argument name="self"> + <description> + An object configured with a vertical scrollbar. + </description> + </argument> + </arguments> + <return> + <reftopic>gfw:standard-scrollbar</reftopic> + </return> + </syntax> + <description> + Returns the vertical <reftopic>gfw:standard-scrollbar</reftopic> + attached to the bottom of <arg0/>, if <arg0/> is configured to + have one and whether or not said scrollbar is currently visible; + returns NIL otherwise. + </description> + <seealso> + <reftopic>gfw:obtain-horizontal-scrollbar</reftopic> + <reftopic>gfw:vertical-scrollbar-p</reftopic> + </seealso> + </generic-function> + <generic-function name="menu-bar"> <syntax with-setf="t"> <arguments>

Modified: trunk/docs/manual/introduction.xml ============================================================================== --- trunk/docs/manual/introduction.xml (original) +++ trunk/docs/manual/introduction.xml Sun Oct 22 00:44:07 2006 @@ -3,7 +3,7 @@

Copyright (c) 2006, Jack D. Unrue --> -<chapter> +<chapter id="introduction"> <title>Introduction</title> <indexterm><primary>Introduction</primary></indexterm>

Modified: trunk/docs/manual/legal.xml ============================================================================== --- trunk/docs/manual/legal.xml (original) +++ trunk/docs/manual/legal.xml Sun Oct 22 00:44:07 2006 @@ -3,7 +3,7 @@

Copyright (c) 2006, Jack D. Unrue --> -<chapter> +<chapter id="legal"> <title>Legal Notices</title> <para> Copyright &#x00A9; 2006, Jack D. Unrue &lt;jdunrue at gmail dot com&gt;

Modified: trunk/docs/manual/miscellaneous-topics.xml ============================================================================== --- trunk/docs/manual/miscellaneous-topics.xml (original) +++ trunk/docs/manual/miscellaneous-topics.xml Sun Oct 22 00:44:07 2006 @@ -3,7 +3,7 @@

Copyright (c) 2006, Jack D. Unrue --> -<chapter> +<chapter id="misc-topics"> <title>Miscellaneous Topics</title>

<para role="normal">