[graphic-forms-cvs] r365 - trunk/docs/manual
junrue at common-lisp.net
junrue at common-lisp.net
Fri Oct 20 06:04:28 UTC 2006
Author: junrue
Date: Fri Oct 20 02:04:27 2006
New Revision: 365
Modified:
trunk/docs/manual/README.txt
trunk/docs/manual/clhs-table.xml
trunk/docs/manual/gf-data.xsl
trunk/docs/manual/gfw-symbols.xml
trunk/docs/manual/win32-api-table.xml
Log:
Modified: trunk/docs/manual/README.txt
==============================================================================
--- trunk/docs/manual/README.txt (original)
+++ trunk/docs/manual/README.txt Fri Oct 20 02:04:27 2006
@@ -1,10 +1,15 @@
-The Programming Reference source consists of XML-based DocBook files,
-custom XSLT and CSS files, and a catalog file for resolving URIs. Two
-sets of utilities are used to translate the sources into HTML Help
-(CHM) format.
+The Programming Reference source consists of XML-based source files,
+some of which are DocBook files and others which are transformed
+into DocBook, along with custom XSLT and CSS files, and a catalog
+file for resolving URIs. Several utilities comprise the translation
+process from sources into HTML Help (CHM) format.
+
+Before anything else, you should install a version of GNU Make
+for Windows, since the docs build process is managed with a
+makefile. Just install MSYS or Cygwin, if you haven't already.
-First, you will need a version of xsltproc and its dependencies. The
+Next, you will need a version of xsltproc and its dependencies. The
version of xsltproc that I have had success using is available from:
http://www.zlatkovic.com/libxml.en.html
@@ -19,7 +24,7 @@
Note: I did not have success with libxslt from GnuWin32 so I would not
recommend using that version.
-Second, you will need the hhc.exe command-line compiler from the
+Third, you will need the hhc.exe command-line compiler from the
HTML Help Workshop, available here:
http://go.microsoft.com/fwlink/?LinkId=14188
@@ -29,22 +34,14 @@
In order to translate from DocBook into HTML Help source and then into
a CHM file, open a command prompt and cd into the docs/manual
-subdirectory where you installed the Graphic-Forms source.
+subdirectory underneath where you installed the Graphic-Forms source.
Modify the URI values in catalog.xml to suit your particular
-environment, then run the following commands (note that I am using
-MSYS, so these are run from my bash prompt, translate appropriately
-if you are in a Windows CMD prompt):
-
-% export XML_CATALOG_FILES=catalog.xml
-% xsltproc --nonet graphic-forms.xsl graphic-forms.xml
-% hhc htmlhelp.hhp
+environment, then run make on Makefile.
Then double-click on graphic-forms.chm and you should see the
Programming Reference appear.
-The provided Makefile automates the above commands.
-
More information about configuring DocBook and xsltproc, as well
as a quick tutorial on the whole process, see these links:
Modified: trunk/docs/manual/clhs-table.xml
==============================================================================
--- trunk/docs/manual/clhs-table.xml (original)
+++ trunk/docs/manual/clhs-table.xml Fri Oct 20 02:04:27 2006
@@ -6,6 +6,7 @@
-->
<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"/>
Modified: trunk/docs/manual/gf-data.xsl
==============================================================================
--- trunk/docs/manual/gf-data.xsl (original)
+++ trunk/docs/manual/gf-data.xsl Fri Oct 20 02:04:27 2006
@@ -343,11 +343,13 @@
</xsl:element>
<xsl:element name="entry">
<xsl:attribute name="valign">top</xsl:attribute>
+ <para role="normal">
<xsl:for-each select="*">
<xsl:sort select="substring-after(.,':')" order="ascending" case-order="upper-first"/>
<xsl:apply-templates select="."/>
<xsl:if test="not(position()=last())">, </xsl:if>
</xsl:for-each>
+ </para>
</xsl:element>
</xsl:element>
</xsl:template>
Modified: trunk/docs/manual/gfw-symbols.xml
==============================================================================
--- trunk/docs/manual/gfw-symbols.xml (original)
+++ trunk/docs/manual/gfw-symbols.xml Fri Oct 20 02:04:27 2006
@@ -17,12 +17,321 @@
<!-- CLASSES -->
+ <class name="display">
+ <description>
+ <hierarchy>
+ <inherits>
+ <reftopic>gfs:native-object</reftopic>
+ </inherits>
+ </hierarchy>
+ <para role="normal">
+ Instances of this class describe characteristics of monitors attached
+ to the system.
+ </para>
+ <para role="normal">
+ This class is not meant to be instantiated by application code.
+ </para>
+ </description>
+ <initargs>
+ <argument name=":handle">
+ <description>
+ See <reftopic>gfs:native-object</reftopic>
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfs:dispose</reftopic>
+ <reftopic>gfw:obtain-displays</reftopic>
+ <reftopic>gfs:obtain-primary-display</reftopic>
+ </seealso>
+ </class>
+
+ <class name="event-dispatcher">
+ <description>
+ <hierarchy>
+ <inheritedby>
+ <reftopic>gfw:scrolling-helper</reftopic>
+ </inheritedby>
+ </hierarchy>
+ Applications define subclasses of this class and implement one
+ or more of the event generic functions.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
+ </seealso>
+ </class>
+
+ <class name="scrolling-helper">
+ <description>
+ <hierarchy>
+ <inherits>
+ <reftopic>gfw:event-dispatcher</reftopic>
+ </inherits>
+ </hierarchy>
+ This is an event dispatcher specialized for processing scroll events
+ on behalf of windows.
+ </description>
+ <initargs>
+ <argument name=":step-increments">
+ <description>
+ A <reftopic>gfs:size</reftopic> object describing how large a
+ single step represents in pixels. The default is 1 pixel.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
+ </seealso>
+ </class>
+
+ <class name="layout-managed">
+ <description>
+ <hierarchy>
+ <inheritedby>
+ <reftopic>gfw:window</reftopic>
+ </inheritedby>
+ </hierarchy>
+ This is a mix-in for widgets that employ a <reftopic>gfw:layout-manager</reftopic>
+ to position children.
+ </description>
+ <initargs>
+ <argument name=":layout">
+ <description>
+ An instance of a <reftopic>gfw:layout-manager</reftopic> subclass.
+ </description>
+ </argument>
+ </initargs>
+ <seealso/>
+ </class>
+
+ <class name="event-source">
+ <description>
+ <hierarchy>
+ <inherits>
+ <reftopic>gfs:native-object</reftopic>
+ </inherits>
+ <inheritedby>
+ <reftopic>gfw:item</reftopic>
+ <reftopic>gfw:standard-scrollbar</reftopic>
+ <reftopic>gfw:timer</reftopic>
+ <reftopic>gfw:widget</reftopic>
+ </inheritedby>
+ </hierarchy>
+ <para role="normal">
+ This is the base class for user interface objects having a native
+ system resource that generates events.
+ </para>
+ <para role="normal">
+ This class defines a class-allocated slot holding a symbol
+ identifying an event function (e.g., <reftopic>gfw:event-select</reftopic>),
+ to be supplied along with a function pointer in calls to the internal
+ define-dispatcher function. The purpose of this is to facilitate
+ implementation of shortcuts for defining dispatchers where definition of
+ a primary event function is sufficient, as is the case when a control
+ class wants to support a :callback initarg. The choice of event function
+ is determined by each subclass, hence this slot is shadowed by each such
+ subclass. Application code typically is not concerned with this slot,
+ except when an application defines new kinds of event sources.
+ </para>
+ </description>
+ <initargs>
+ <argument name=":handle">
+ <description>
+ See <reftopic>gfs:native-object</reftopic>
+ </description>
+ </argument>
+ <argument name=":callbacks">
+ <description>
+ An <refclhs>alist</refclhs> where the CAR of each entry is a
+ symbol identifying one of the event generic functions and the
+ CDR is a function with congruent arguments. This constitutes
+ a specification for a new <reftopic>gfw:event-dispatcher</reftopic>
+ subclass and event methods.
+ </description>
+ </argument>
+ <argument name=":dispatcher">
+ <description>
+ The <reftopic>gfw:event-dispatcher</reftopic> instance wrapping
+ responsibility for processing events on behalf of this object.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfs:dispose</reftopic>
+ </seealso>
+ </class>
+
<!-- STRUCTURES -->
<!-- FUNCTIONS -->
+ <function name="default-message-filter">
+ <syntax>
+ <arguments>
+ <argument name="gm-code">
+ <description>
+ The value returned by the Win32 API function
+ <refwin32api>GetMessage</refwin32api>.
+ </description>
+ </argument>
+ <argument name="msg-ptr">
+ <description>
+ A foreign pointer to a Win32 <refwin32api>MSG</refwin32api>
+ structure, filled in by <refwin32api>GetMessage</refwin32api>,
+ containing raw event data to be translated and dispatched.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ Processes messages for all windows, non-modal dialogs, and controls.
+ Accelerator keys are translated by this function. Returns NIL
+ so that <reftopic>gfw:message-loop</reftopic> will continue, unless
+ <arg0/> is less than or equal to 0, in which case T is returned
+ so that <reftopic>gfw:message-loop</reftopic> will exit. More
+ specifically, when <arg0/> is 0, <arg1/> identifies a WM_QUIT
+ message indicating normal shutdown; if <arg0/> is -1, then the system
+ has reported an error during message retrieval; in this situation,
+ the application should attempt a graceful shutdown.
+ </para>
+ <para role="normal">
+ This function is not intended to be called by application code; rather,
+ it is passed to <reftopic>gfw:message-loop</reftopic>.
+ </para>
+ </description>
+ </function>
+
+ <function name="message-loop">
+ <syntax>
+ <arguments>
+ <argument name="msg-filter">
+ <description>
+ A function to process each message.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ This function retrieves messages from the queue associated with the
+ current thread, passing each one to the function specified by <arg0/>
+ so that it may be translated and dispatched. The return value of the
+ <arg0/> function determines whether message-loop continues or returns
+ -- it must return NIL if message-loop should continue, or non-NIL if
+ message-loop should exit.
+ </description>
+ <seealso>
+ <reftopic>gfw:default-message-filter</reftopic>
+ </seealso>
+ </function>
+
<!-- GENERIC FUNCTIONS -->
+ <generic-function name="event-activate">
+ <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 activated.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Implement a method for this generic function to respond to the activation
+ of <arg1/>. For top-level windows or dialogs, this means that <arg1/> was
+ brought to the foreground and its trim (title bar and border) have become
+ highlighted. For a menu, it means the user has clicked on the menu item
+ serving as the anchor for the menu which is therefore about to be shown.
+ In the menu case, event-activate is an opportunity to adjust the menu's
+ contents.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
+ <reftopic>gfw:top-level</reftopic>
+ <reftopic>gfw:dialog</reftopic>
+ <reftopic>gfw:menu</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="event-arm">
+ <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> about to be selected.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Implement a method for this generic function to respond to notification
+ that <arg1/> is about to be selected. Arming events are not always
+ followed by selection events, such as when the user is moving the mouse
+ across multiple items on a menu.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
+ <reftopic>gfw:event-select</reftopic>
+ <reftopic>gfw:menu</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="event-close">
+ <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 closed.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Implement a method for this generic function to respond to <arg1/>
+ being closed by the user. Only top-level windows and dialogs receive
+ close events.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
+ <reftopic>gfw:top-level</reftopic>
+ <reftopic>gfw:dialog</reftopic>
+ </seealso>
+ </generic-function>
+
<!-- ACCESSORS -->
</package>
Modified: trunk/docs/manual/win32-api-table.xml
==============================================================================
--- trunk/docs/manual/win32-api-table.xml (original)
+++ trunk/docs/manual/win32-api-table.xml Fri Oct 20 02:04:27 2006
@@ -9,5 +9,7 @@
<entry name="COLORREF" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/gdi/colors_9xiq.asp"/>
<entry name="CommDlgExtendedError" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/winui/winui/windowsuserinterface/userinput/commondialogboxlibrary/commondialogboxreference/commondialogboxfunctions/commdlgextendederror.asp"/>
<entry name="GetLastError" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/debug/base/getlasterror.asp"/>
+ <entry name="GetMessage" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/winui/winui/windowsuserinterface/windowing/messagesandmessagequeues/messagesandmessagequeuesreference/messagesandmessagequeuesfunctions/getmessage.asp"/>
<entry name="Icons in Win32" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnwui/html/msdn_icons.asp"/>
+ <entry name="MSG" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/winui/winui/windowsuserinterface/windowing/messagesandmessagequeues/messagesandmessagequeuesreference/messageandmessagequeuestructures/msg.asp"/>
</win32-api-table>
More information about the Graphic-forms-cvs
mailing list