Author: junrue Date: Sat Oct 21 16:51:18 2006 New Revision: 376
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 16:51:18 2006 @@ -346,7 +346,7 @@ </inherits> </hierarchy> This is an event dispatcher specialized for processing scroll events - on behalf of windows. + on behalf of windows. It uses <reftopic>gfw:update-scrolling-state</reftopic>. </description> <initargs> <argument name=":step-increments"> @@ -1925,7 +1925,8 @@ </initargs> <seealso> <reftopic>gfs:dispose</reftopic> - <reftopic>gfs:event-scroll</reftopic> + <reftopic>gfw:event-scroll</reftopic> + <reftopic>gfw:update-scrolling-state</reftopic> </seealso> </class>
@@ -2028,7 +2029,8 @@ </initargs> <seealso> <reftopic>gfs:dispose</reftopic> - <reftopic>gfs:event-scroll</reftopic> + <reftopic>gfw:event-scroll</reftopic> + <reftopic>gfw:update-scrolling-state</reftopic> </seealso> </class>
@@ -2274,6 +2276,117 @@ </seealso> </function>
+ <function name="obtain-displays"> + <syntax> + <return> + <refclhs>list</refclhs> + </return> + </syntax> + <description> + Returns a <refclhs>list</refclhs> of <reftopic>gfw:display</reftopic> + objects, each of which describes a monitor attached to the system. The + system specifies that one of these is the primary display. + </description> + <seealso> + <reftopic>gfw:obtain-primary-display</reftopic> + <reftopic>gfw:primary-p</reftopic> + </seealso> + </function> + + <function name="obtain-primary-display"> + <syntax> + <return> + <reftopic>gfw:display</reftopic> + </return> + </syntax> + <description> + Returns a <reftopic>gfw:display</reftopic> object that is regarded + by the system as being the primary. + </description> + <seealso> + <reftopic>gfw:obtain-displays</reftopic> + <reftopic>gfw:primary-p</reftopic> + </seealso> + </function> + + <function name="primary-p"> + <syntax> + <arguments> + <argument name="display"> + <description> + The <reftopic>gfw:display</reftopic> to test for primary status. + </description> + </argument> + </arguments> + <return> + <refclhs>boolean</refclhs> + </return> + </syntax> + <description> + Returns T if the system regards <arg0/> as the primary display; NIL otherwise. + </description> + <seealso> + <reftopic>gfw:obtain-displays</reftopic> + <reftopic>gfw:primary-p</reftopic> + </seealso> + </function> + + <function name="update-scrolling-state"> + <syntax> + <arguments> + <argument name="window"> + <description> + The <reftopic>gfw:window</reftopic> that was scrolled. + </description> + </argument> + <notarg name="&optional"/> + <argument name="axis"> + <description> + NIL or one of the following keyword symbols as described + for <reftopic>gfw:event-scroll</reftopic>: + <enum> + <argument name=":horizontal"/> + <argument name=":vertical"/> + </enum> + </description> + </argument> + <argument name="detail"> + <description> + See <reftopic>gfw:event-scroll</reftopic>. + </description> + </argument> + </arguments> + <return> + <refclhs>symbol</refclhs> + </return> + </syntax> + <description> + <para role="normal"> + Call this function to respond to a scrolling event so that the content + of <arg0/> can be scrolled and <arg0/>'s scrollbar state(s) updated. + The dispatcher assigned to <arg0/> must be an instance of (or an + instance of a subclass of) <reftopic>gfw:scrolling-helper</reftopic>. + </para> + <para role="normal"> + <arg1/> can be :horizontal or :vertical to request processing in the + corresponding direction; or if unspecified, scroll processing will + occur in both directions. <arg2/> can be one of the values described + for <reftopic>gfw:event-scroll</reftopic>; or if unspecified, + :thumb-position will be assumed. This function returns the value of + <arg2/>. + </para> + <para role="normal"> + Note that <reftopic>gfw:scrolling-helper</reftopic> calls this function + on behalf of a window when set as that window's dispatcher. Application + code may also call this function as needed. + </para> + </description> + <seealso> + <reftopic>gfw:standard-scrollbar</reftopic> + <reftopic>gfw:scrollbar</reftopic> + </seealso> + </function> + <!-- GENERIC FUNCTIONS -->
<generic-function name="event-activate"> @@ -3214,6 +3327,7 @@ </description> <seealso> <reftopic>gfw:event-source</reftopic> + <reftopic>gfw:update-scrolling-state</reftopic> </seealso> </generic-function>
@@ -3314,4 +3428,264 @@
<!-- ACCESSORS -->
+ <!-- MACROS --> + + <macro name="with-color-dialog"> + <syntax> + <arguments> + <notarg name="("/> + <argument name="owner"> + <description> + A <reftopic>gfw:top-level</reftopic> or <reftopic>gfw:dialog</reftopic> + that will own the color dialog. + </description> + </argument> + <argument name="style"> + <description> + See :style for <reftopic>gfw:color-dialog</reftopic> + </description> + </argument> + <argument name="color"> + <description> + The selected <reftopic>gfg:color</reftopic> will be bound to + this argument. + </description> + </argument> + <argument name="custom-colors"> + <description> + A <refclhs>list</refclhs> of any custom <reftopic>gfg:color</reftopic>s + will be bound to this argument. + </description> + </argument> + <notarg name="&key"/> + <argument name=":initial-color"> + <description> + See <reftopic>gfw:color-dialog</reftopic>. + </description> + </argument> + <argument name=":initial-custom-colors"> + <description> + See <reftopic>gfw:color-dialog</reftopic>. + </description> + </argument> + <notarg name=")"/> + <notarg name="&body"/> + <argument name="body"> + <description> + Application code to make use of <arg2/> and <arg3/>. + </description> + </argument> + </arguments> + <return> + <emphasis>results</emphasis> + </return> + </syntax> + <description> + This macro wraps the instantiation of a standard color dialog and the subsequent + retrieval of the user's color selection. + </description> + <seealso> + <reftopic>gfw:obtain-chosen-color</reftopic> + </seealso> + </macro> + + <macro name="with-drawing-disabled"> + <syntax> + <arguments> + <notarg name="("/> + <argument name="widget"> + <description> + A <reftopic>gfw:widget</reftopic> to modify. + </description> + </argument> + <notarg name=")"/> + <notarg name="&body"/> + <argument name="body"> + <description> + Application code to make use of <arg0/>. + </description> + </argument> + </arguments> + <return> + <emphasis>results</emphasis> + </return> + </syntax> + <description> + This macro executes <arg1/> while updates of <arg0/> are disabled. + Drawing operations attempted in the scope of the macro will be + queued so that when the lock is lifted, <arg0/> will be repainted. + </description> + <seealso> + </seealso> + </macro> + + <macro name="with-file-dialog"> + <syntax> + <arguments> + <notarg name="("/> + <argument name="owner"> + <description> + The <reftopic>gfw:top-level</reftopic> or <reftopic>gfw:dialog</reftopic> + that will own the file dialog. + </description> + </argument> + <argument name="style"> + <description> + See :style for <reftopic>gfw:file-dialog</reftopic>. + </description> + </argument> + <argument name="paths"> + <description> + Any file <refclhs>namestring</refclhs>s chosen by the user will provided + as a <refclhs>list</refclhs> bound to this argument. + </description> + </argument> + <notarg name="&key"/> + <argument name=":default-extension"> + <description> + See <reftopic>gfw:file-dialog</reftopic>. + </description> + </argument> + <argument name=":filters"> + <description> + See <reftopic>gfw:file-dialog</reftopic>. + </description> + </argument> + <argument name=":initial-directory"> + <description> + See <reftopic>gfw:file-dialog</reftopic>. + </description> + </argument> + <argument name=":initial-filename"> + <description> + See <reftopic>gfw:file-dialog</reftopic>. + </description> + </argument> + <argument name=":text"> + <description> + See <reftopic>gfw:file-dialog</reftopic>. + </description> + </argument> + <notarg name=")"/> + <notarg name="&body"/> + <argument name="body"> + <description> + Application code to make use of <arg2/>. + </description> + </argument> + </arguments> + <return> + <emphasis>results</emphasis> + </return> + </syntax> + <description> + This macro wraps the instantiation of a standard file open/save dialog + and the subsequent retrieval of the user's file selections. + </description> + <seealso> + <reftopic>gfw:obtain-chosen-files</reftopic> + </seealso> + </macro> + + <macro name="with-font-dialog"> + <syntax> + <arguments> + <notarg name="("/> + <argument name="owner"> + <description> + The <reftopic>gfw:top-level</reftopic> or <reftopic>gfw:dialog</reftopic> + that will own the font dialog. + </description> + </argument> + <argument name="style"> + <description> + See :style for <reftopic>gfw:font-dialog</reftopic>. + </description> + </argument> + <argument name="font"> + <description> + Any <reftopic>gfg:font</reftopic> chosen by the user will be + bound to this argument. + </description> + </argument> + <argument name="color"> + <description> + Any <reftopic>gfg:color</reftopic> chosen by the user will be + bound to this argument; will be NIL if the :no-effects style + was specified. + </description> + </argument> + <notarg name="&key"/> + <argument name=":gc"> + <description> + See <reftopic>gfw:font-dialog</reftopic>. + </description> + </argument> + <argument name=":initial-color"> + <description> + See <reftopic>gfw:font-dialog</reftopic>. + </description> + </argument> + <argument name=":initial-font"> + <description> + See <reftopic>gfw:font-dialog</reftopic>. + </description> + </argument> + <notarg name=")"/> + <notarg name="&body"/> + <argument name="body"> + <description> + Application code to make use of <arg2/> and <arg3/>. + </description> + </argument> + </arguments> + <return> + <emphasis>results</emphasis> + </return> + </syntax> + <description> + This macro wraps the instantiation of a standard font dialog + and the subsequent retrieval of the user's font selection. + </description> + <seealso> + <reftopic>gfw:obtain-chosen-font</reftopic> + </seealso> + </macro> + + <macro name="with-graphics-context"> + <syntax> + <arguments> + <notarg name="("/> + <argument name="graphics-context"> + <description> + A <refclhs>symbol</refclhs> naming the <reftopic>gfg:graphics-context</reftopic> + to be created. + </description> + </argument> + <notarg name="&optional"/> + <argument name="thing"> + <description> + A <reftopic>gfg:image</reftopic> or <reftopic>gfw:widget</reftopic>. + </description> + </argument> + <notarg name=")"/> + <notarg name="&body"/> + <argument name="body"> + <description> + Application code to make use of <arg0/>. + </description> + </argument> + </arguments> + <return> + <emphasis>results</emphasis> + </return> + </syntax> + <description> + This macro manages the lifetime of a <reftopic>gfg:graphics-context</reftopic> + for use within <arg2/>. The context will be created using <arg1/> if that + argument is specified. Otherwise, this macro creates a context compatible with + the <reftopic>gfw:display</reftopic>. + </description> + </macro> + </package>