[graphic-forms-cvs] r367 - trunk/docs/manual

junrue at common-lisp.net junrue at common-lisp.net
Fri Oct 20 19:06:37 UTC 2006


Author: junrue
Date: Fri Oct 20 15:06:37 2006
New Revision: 367

Modified:
   trunk/docs/manual/clhs-table.xml
   trunk/docs/manual/gfw-symbols.xml
Log:
 

Modified: trunk/docs/manual/clhs-table.xml
==============================================================================
--- trunk/docs/manual/clhs-table.xml	(original)
+++ trunk/docs/manual/clhs-table.xml	Fri Oct 20 15:06:37 2006
@@ -6,13 +6,14 @@
 -->
 
 <clhs-table>
-  <entry name="alist"    url="http://www.lispworks.com/documentation/HyperSpec/Body/26_glo_a.htm#alist"/>
-  <entry name="boolean"  url="http://www.lispworks.com/documentation/HyperSpec/Body/t_ban.htm"/>
-  <entry name="error"    url="http://www.lispworks.com/documentation/HyperSpec/Body/e_error.htm"/>
-  <entry name="float"    url="http://www.lispworks.com/documentation/HyperSpec/Body/t_float.htm"/>
-  <entry name="integer"  url="http://www.lispworks.com/documentation/HyperSpec/Body/t_intege.htm"/>
-  <entry name="list"     url="http://www.lispworks.com/documentation/HyperSpec/Body/t_list.htm"/>
-  <entry name="pathname" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_pn.htm"/>
-  <entry name="string"   url="http://www.lispworks.com/documentation/HyperSpec/Body/t_string.htm"/>
-  <entry name="warning"  url="http://www.lispworks.com/documentation/HyperSpec/Body/e_warnin.htm"/>
+  <entry name="alist"     url="http://www.lispworks.com/documentation/HyperSpec/Body/26_glo_a.htm#alist"/>
+  <entry name="boolean"   url="http://www.lispworks.com/documentation/HyperSpec/Body/t_ban.htm"/>
+  <entry name="character" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_ch.htm"/>
+  <entry name="error"     url="http://www.lispworks.com/documentation/HyperSpec/Body/e_error.htm"/>
+  <entry name="float"     url="http://www.lispworks.com/documentation/HyperSpec/Body/t_float.htm"/>
+  <entry name="integer"   url="http://www.lispworks.com/documentation/HyperSpec/Body/t_intege.htm"/>
+  <entry name="list"      url="http://www.lispworks.com/documentation/HyperSpec/Body/t_list.htm"/>
+  <entry name="pathname"  url="http://www.lispworks.com/documentation/HyperSpec/Body/t_pn.htm"/>
+  <entry name="string"    url="http://www.lispworks.com/documentation/HyperSpec/Body/t_string.htm"/>
+  <entry name="warning"   url="http://www.lispworks.com/documentation/HyperSpec/Body/e_warnin.htm"/>
 </clhs-table>

Modified: trunk/docs/manual/gfw-symbols.xml
==============================================================================
--- trunk/docs/manual/gfw-symbols.xml	(original)
+++ trunk/docs/manual/gfw-symbols.xml	Fri Oct 20 15:06:37 2006
@@ -266,6 +266,7 @@
       <reftopic>gfw:top-level</reftopic>
       <reftopic>gfw:dialog</reftopic>
       <reftopic>gfw:menu</reftopic>
+      <reftopic>gfw:event-deactivate</reftopic>
     </seealso>
   </generic-function>
 
@@ -297,6 +298,7 @@
       <reftopic>gfw:event-source</reftopic>
       <reftopic>gfw:top-level</reftopic>
       <reftopic>gfw:dialog</reftopic>
+      <reftopic>gfw:event-activate</reftopic>
     </seealso>
   </generic-function>
 
@@ -457,6 +459,7 @@
     </description>
     <seealso>
       <reftopic>gfw:event-source</reftopic>
+      <reftopic>gfw:event-focus-loss</reftopic>
     </seealso>
   </generic-function>
 
@@ -485,6 +488,508 @@
     </description>
     <seealso>
       <reftopic>gfw:event-source</reftopic>
+      <reftopic>gfw:event-focus-gain</reftopic>
+    </seealso>
+  </generic-function>
+
+  <generic-function name="event-key-down">
+    <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> in which a key was pressed.
+          </description>
+        </argument>
+        <argument name="keycode">
+          <description>
+            The virtual key code of the key that was pressed. Constants for
+            certain special keys are described
+            <reftopic label="here">virtual key codes</reftopic>.
+          </description>
+        </argument>
+        <argument name="char">
+          <description>
+            The <refclhs>character</refclhs> value resulting from translation
+            of the virtual key code, or NIL if the key code cannot be translated.
+          </description>
+        </argument>
+      </arguments>
+      <return>
+        <emphasis>undefined</emphasis>
+      </return>
+    </syntax>
+    <description>
+      Implement a method for this generic function to respond to a key being
+      pressed within <arg1/>.
+    </description>
+    <seealso>
+      <reftopic>gfw:event-source</reftopic>
+      <reftopic>gfw:event-key-up</reftopic>
+    </seealso>
+  </generic-function>
+
+  <generic-function name="event-key-up">
+    <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> in which a key was released.
+          </description>
+        </argument>
+        <argument name="keycode">
+          <description>
+            The virtual key code of the key that was released. Constants for
+            certain special keys are described
+            <reftopic label="here">virtual key codes</reftopic>.
+          </description>
+        </argument>
+        <argument name="char">
+          <description>
+            The <refclhs>character</refclhs> value resulting from translation
+            of the virtual key code, or NIL if the key code cannot be translated.
+          </description>
+        </argument>
+      </arguments>
+      <return>
+        <emphasis>undefined</emphasis>
+      </return>
+    </syntax>
+    <description>
+      Implement a method for this generic function to respond to a key being
+      released within <arg1/>.
+    </description>
+    <seealso>
+      <reftopic>gfw:event-source</reftopic>
+      <reftopic>gfw:event-key-down</reftopic>
+    </seealso>
+  </generic-function>
+
+  <generic-function name="event-mouse-double">
+    <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> in which the mouse was double-clicked.
+          </description>
+        </argument>
+        <argument name="point">
+          <description>
+            A <reftopic>gfs:point</reftopic> indicating the location of the mouse
+            cursor.
+          </description>
+        </argument>
+        <argument name="button">
+          <description>
+            A keyword symbol identifying which mouse button was used:
+            <enum>
+              <argument name=":left-button"/>
+              <argument name=":middle-button"/>
+              <argument name=":right-button"/>
+            </enum>
+          </description>
+        </argument>
+      </arguments>
+      <return>
+        <emphasis>undefined</emphasis>
+      </return>
+    </syntax>
+    <description>
+      Implement a method for this generic function to respond to a mouse
+      double-click within <arg1/>.
+    </description>
+    <seealso>
+      <reftopic>gfw:event-source</reftopic>
+      <reftopic>gfw:event-mouse-up</reftopic>
+      <reftopic>gfw:event-mouse-down</reftopic>
+      <reftopic>gfw:event-mouse-move</reftopic>
+    </seealso>
+  </generic-function>
+
+  <generic-function name="event-mouse-down">
+    <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> in which the mouse was clicked.
+          </description>
+        </argument>
+        <argument name="point">
+          <description>
+            A <reftopic>gfs:point</reftopic> indicating the location of the mouse
+            cursor.
+          </description>
+        </argument>
+        <argument name="button">
+          <description>
+            A keyword symbol identifying which mouse button was used:
+            <enum>
+              <argument name=":left-button"/>
+              <argument name=":middle-button"/>
+              <argument name=":right-button"/>
+            </enum>
+          </description>
+        </argument>
+      </arguments>
+      <return>
+        <emphasis>undefined</emphasis>
+      </return>
+    </syntax>
+    <description>
+      Implement a method for this generic function to respond to a mouse
+      button click within <arg1/>.
+    </description>
+    <seealso>
+      <reftopic>gfw:event-source</reftopic>
+      <reftopic>gfw:event-mouse-double</reftopic>
+      <reftopic>gfw:event-mouse-up</reftopic>
+      <reftopic>gfw:event-mouse-move</reftopic>
+    </seealso>
+  </generic-function>
+
+  <generic-function name="event-mouse-move">
+    <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> in which the mouse was moved.
+          </description>
+        </argument>
+        <argument name="point">
+          <description>
+            A <reftopic>gfs:point</reftopic> indicating the location of the mouse
+            cursor.
+          </description>
+        </argument>
+        <argument name="button">
+          <description>
+            A keyword symbol identifying which mouse button was pressed, if any:
+            <enum>
+              <argument name=":left-button"/>
+              <argument name=":middle-button"/>
+              <argument name=":right-button"/>
+            </enum>
+            Otherwise, this argument is NIL.
+          </description>
+        </argument>
+      </arguments>
+      <return>
+        <emphasis>undefined</emphasis>
+      </return>
+    </syntax>
+    <description>
+      Implement a method for this generic function to respond to the mouse moving
+      within <arg1/>.
+    </description>
+    <seealso>
+      <reftopic>gfw:event-source</reftopic>
+      <reftopic>gfw:event-mouse-double</reftopic>
+      <reftopic>gfw:event-mouse-down</reftopic>
+      <reftopic>gfw:event-mouse-up</reftopic>
+    </seealso>
+  </generic-function>
+
+  <generic-function name="event-mouse-up">
+    <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> in which the mouse was released.
+          </description>
+        </argument>
+        <argument name="point">
+          <description>
+            A <reftopic>gfs:point</reftopic> indicating the location of the mouse
+            cursor.
+          </description>
+        </argument>
+        <argument name="button">
+          <description>
+            A keyword symbol identifying which mouse button was released:
+            <enum>
+              <argument name=":left-button"/>
+              <argument name=":middle-button"/>
+              <argument name=":right-button"/>
+            </enum>
+          </description>
+        </argument>
+      </arguments>
+      <return>
+        <emphasis>undefined</emphasis>
+      </return>
+    </syntax>
+    <description>
+      Implement a method for this generic function to respond to the mouse being
+      released within <arg1/>.
+    </description>
+    <seealso>
+      <reftopic>gfw:event-source</reftopic>
+      <reftopic>gfw:event-mouse-double</reftopic>
+      <reftopic>gfw:event-mouse-down</reftopic>
+      <reftopic>gfw:event-mouse-move</reftopic>
+    </seealso>
+  </generic-function>
+
+  <generic-function name="event-move">
+    <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> being moved.
+          </description>
+        </argument>
+        <argument name="point">
+          <description>
+            A <reftopic>gfs:point</reftopic> indicating <arg1/>'s new location.
+          </description>
+        </argument>
+      </arguments>
+      <return>
+        <emphasis>undefined</emphasis>
+      </return>
+    </syntax>
+    <description>
+      Implement a method for this generic function to respond to <arg1/> being
+      moved.
+    </description>
+    <seealso>
+      <reftopic>gfw:event-source</reftopic>
+      <reftopic>gfw:event-pre-move</reftopic>
+    </seealso>
+  </generic-function>
+
+  <generic-function name="event-pre-move">
+    <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> being moved.
+          </description>
+        </argument>
+        <argument name="rectangle">
+          <description>
+            A <reftopic>gfs:rectangle</reftopic> describing the move drag rectangle,
+            which may be modified by the application.
+          </description>
+        </argument>
+      </arguments>
+      <return>
+        <emphasis>undefined</emphasis>
+      </return>
+    </syntax>
+    <description>
+      Implement a method for this generic function to respond to <arg1/> being
+      moved. This event function gives the application an opportunity to modify
+      the move drag outline prior to the move event being delivered, thus
+      controlling the ultimate location of <arg1/>.
+    </description>
+    <seealso>
+      <reftopic>gfw:event-source</reftopic>
+      <reftopic>gfw:event-move</reftopic>
+      <reftopic>gfw:top-level</reftopic>
+      <reftopic>gfw:dialog</reftopic>
+    </seealso>
+  </generic-function>
+
+  <generic-function name="event-resize">
+    <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> being resized.
+          </description>
+        </argument>
+        <argument name="point">
+          <description>
+            A <reftopic>gfs:size</reftopic> indicating <arg1/>'s new dimensions.
+          </description>
+        </argument>
+        <argument name="type">
+          <description>
+            One of the following keyword symbols describing the resize action
+            in more detail:
+            <enum>
+              <argument name=":maximized">
+                <description>
+                  Indicates that <arg1/> was expanded to its maximum size, such
+                  as when the user clicks on the maximize button in a window frame. 
+                </description>
+              </argument>
+              <argument name=":minimized">
+                <description>
+                  Indicates that <arg1/> was minimized to the taskbar.
+                </description>
+              </argument>
+              <argument name=":restored">
+                <description>
+                  Indicates that <arg1/> was either restored from a minimized state,
+                  or that resizing occurred while widget was already in a visible,
+                  non-maximized state.
+                </description>
+              </argument>
+            </enum>
+          </description>
+        </argument>
+      </arguments>
+      <return>
+        <emphasis>undefined</emphasis>
+      </return>
+    </syntax>
+    <description>
+      Implement a method for this generic function to respond to <arg1/> being
+      resized.
+    </description>
+    <seealso>
+      <reftopic>gfw:event-source</reftopic>
+      <reftopic>gfw:event-pre-move</reftopic>
+    </seealso>
+  </generic-function>
+
+  <generic-function name="event-pre-resize">
+    <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> being resized.
+          </description>
+        </argument>
+        <argument name="rectangle">
+          <description>
+            A <reftopic>gfs:rectangle</reftopic> describing the resize drag rectangle,
+            which may be modified by the application.
+          </description>
+        </argument>
+        <argument name="type">
+          <description>
+            One of the following keyword symbols describing which of eight possible
+            areas of <arg1/>'s frame is being dragged:
+            <enum>
+              <argument name=":bottom"/>
+              <argument name=":bottom-left"/>
+              <argument name=":bottom-right"/>
+              <argument name=":left"/>
+              <argument name=":right"/>
+              <argument name=":top"/>
+              <argument name=":top-left"/>
+              <argument name=":top-right"/>
+            </enum>
+          </description>
+        </argument>
+      </arguments>
+      <return>
+        <emphasis>undefined</emphasis>
+      </return>
+    </syntax>
+    <description>
+      Implement a method for this generic function to respond to <arg1/> being
+      resized. This event function gives the application an opportunity to modify
+      the resize drag outline prior to the resize event being delivered, thus
+      controlling the resulting dimensions of <arg1/>.
+    </description>
+    <seealso>
+      <reftopic>gfw:event-source</reftopic>
+      <reftopic>gfw:event-resize</reftopic>
+      <reftopic>gfw:top-level</reftopic>
+      <reftopic>gfw:dialog</reftopic>
+    </seealso>
+  </generic-function>
+
+  <generic-function name="event-paint">
+    <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> whose contents need repainting.
+          </description>
+        </argument>
+        <argument name="graphics-context">
+          <description>
+            A <reftopic>gfg:graphics-context</reftopic> initialized for use during
+            this event.
+          </description>
+        </argument>
+        <argument name="rectangle">
+          <description>
+            A <reftopic>gfs:rectangle</reftopic> specifying the region within
+            <arg1/> that needs repainting.
+          </description>
+        </argument>
+      </arguments>
+      <return>
+        <emphasis>undefined</emphasis>
+      </return>
+    </syntax>
+    <description>
+      Implement a method for this generic function to respond to system requests
+      to repaint <arg1/>.
+    </description>
+    <seealso>
+      <reftopic>gfw:event-source</reftopic>
     </seealso>
   </generic-function>
 



More information about the Graphic-forms-cvs mailing list