Author: junrue Date: Fri Oct 20 15:48:08 2006 New Revision: 368

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 Fri Oct 20 15:48:08 2006 @@ -231,6 +231,17 @@ </seealso> </function>

+ <function name="obtain-event-time"> + <syntax> + <return> + <emphasis>milliseconds</emphasis> + </return> + </syntax> + <description> + Returns the millisecond timestamp of the event currently being processed. + </description> + </function> + <!-- GENERIC FUNCTIONS -->

<generic-function name="event-activate"> @@ -334,6 +345,61 @@ </seealso> </generic-function>

+ <generic-function name="event-timer"> + <syntax> + <arguments> + <argument name="event-dispatcher"> + <description> + The <reftopic>gfw:event-dispatcher</reftopic> that will process + this event. + </description> + </argument> + <argument name="timer"> + <description> + The <reftopic>gfw:timer</reftopic> that generated this event. + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Implement a method for this generic function to handle timer notifications. + </description> + <seealso> + <reftopic>gfw:event-source</reftopic> + </seealso> + </generic-function> + + <generic-function name="event-modify"> + <syntax> + <arguments> + <argument name="event-dispatcher"> + <description> + The <reftopic>gfw:event-dispatcher</reftopic> that will process + this event. + </description> + </argument> + <argument name="widget"> + <description> + The <reftopic>gfw:widget</reftopic> modified by the user. + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Implement this method to respond to changes due to user input within <arg1/>, + for example when the user types text inside an edit control. + </description> + <seealso> + <reftopic>gfw:event-source</reftopic> + </seealso> + </generic-function> + <generic-function name="event-close"> <syntax> <arguments> @@ -434,6 +500,36 @@ </seealso> </generic-function>

+ <generic-function name="event-select"> + <syntax> + <arguments> + <argument name="event-dispatcher"> + <description> + The <reftopic>gfw:event-dispatcher</reftopic> that will process + this event. + </description> + </argument> + <argument name="widget"> + <description> + The <reftopic>gfw:widget</reftopic> that was selected, or whose + sub-element was selected. + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Implement a method for this generic function to handle notification that + <arg1/> or some sub-element of <arg1/> has been selected. Selection may + occur via the mouse or keyboard. + </description> + <seealso> + <reftopic>gfw:event-source</reftopic> + </seealso> + </generic-function> + <generic-function name="event-focus-gain"> <syntax> <arguments> @@ -993,6 +1089,197 @@ </seealso> </generic-function>

+ <generic-function name="event-scroll"> + <syntax> + <arguments> + <argument name="event-dispatcher"> + <description> + The <reftopic>gfw:event-dispatcher</reftopic> that will process + this event. + </description> + </argument> + <argument name="widget"> + <description> + The <reftopic>gfw:widget</reftopic> that was scrolled. + </description> + </argument> + <argument name="axis"> + <description> + One of the following keyword symbols describing orientation: + <enum> + <argument name=":horizontal"/> + <argument name=":vertical"/> + </enum> + </description> + </argument> + <argument name="detail"> + <description> + One of the following keyword symbols describing the requested scrolling + action: + <enum> + <argument name=":end"> + <description> + Move the viewport such that the bottom or right-most content is + revealed. + </description> + </argument> + <argument name=":page-back"> + <description> + Move the viewport backwards by an amount equal to the viewport's + height or width, or the amount remaining between the current + viewport origin and the model origin, whichever is smaller. + </description> + </argument> + <argument name=":page-forward"> + <description> + Move the viewport forward by an amount equal to the viewport's + height or width, or the amount remaining between the current + viewport origin and the model extent, whichever is smaller. + </description> + </argument> + <argument name=":start"> + <description> + Move the viewport such that the top or left-most model content is + revealed. + </description> + </argument> + <argument name=":step-back"> + <description> + Move the viewport backwards by an application-defined amount, or + the amount remaining between the current viewport origin and the + model origin, whichever is smaller. + </description> + </argument> + <argument name=":step-forward"> + <description> + Move the viewport forward by an application-defined amount, or the + amount remaining between the current viewport origin and the model + extent, whichever is smaller. + </description> + </argument> + <argument name=":thumb-position"> + <description> + Move the viewport to an absolute position. + </description> + </argument> + <argument name=":thumb-track"> + <description> + The user is adjusting the viewport origin continuously, as when + dragging the scrollbar thumb. + </description> + </argument> + </enum> + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Implement a method for this generic function to handle scrolling notifications + for <arg1/>. + </description> + <seealso> + <reftopic>gfw:event-source</reftopic> + </seealso> + </generic-function> + + <generic-function name="event-session"> + <syntax> + <arguments> + <argument name="event-dispatcher"> + <description> + The <reftopic>gfw:event-dispatcher</reftopic> that will process + this event. + </description> + </argument> + <argument name="widget"> + <description> + The <reftopic>gfw:widget</reftopic> receiving this event. + </description> + </argument> + <argument name="phase"> + <description> + <enum> + <argument name=":query"> + <description> + This symbol means that the system is querying the application + for permission to proceed. Return nil if there is a reason to + veto the process, or non-nil otherwise. + </description> + </argument> + <argument name=":end"> + <description> + This symbol is specified in the subsequent call to event-session. + It means that the system is going ahead with ending the session, + therefore this is an opportunity for graceful cleanup. + </description> + </argument> + </enum> + </description> + </argument> + <argument name="reason"> + <description> + <enum> + <argument name=":logoff"> + <description> + The user is logging off. + </description> + </argument> + <argument name=":replacing-file"> + <description> + The application must exit because a file it is using is being + replaced. + </description> + </argument> + <argument name=":shutdown"> + <description> + The system is shutting down or restarting. + </description> + </argument> + </enum> + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + <para role="normal"> + Implement this method to participate in the system's session shutdown + protocol. When the user chooses to end the session (by logging out or + by shutting down), or if an application calls one of the Win32 shutdown + functions, every application is given a veto option. This event function + will be called at least once for each top-level window in the application. + </para> + <para role="normal"> + The MSDN documentation makes the following recommendations for handling + this event: + </para> + <itemizedlist mark="bullet" spacing="compact"> + <listitem> + Whenever possible, applications should respect the user's intentions by + allowing the session to end. + </listitem> + <listitem> + In the case of a critical operation, provide a dialog or other feedback + with information for the user as to consequences if the application is + interrupted at this time. + </listitem> + <listitem> + Respond to the :query phase as quickly as possible, leaving time-consuming + cleanup to be done in the session :end phase. + </listitem> + </itemizedlist> + </description> + <seealso> + <reftopic>gfw:event-source</reftopic> + <reftopic>gfw:top-level</reftopic> + </seealso> + </generic-function> + <!-- ACCESSORS -->

</package>