- graphic-forms-cvs@common-lisp.net - mailman3.common-lisp.net

[graphic-forms-cvs] r365 - trunk/docs/manual
by junrue＠common-lisp.net 20 Oct '06

20 Oct '06

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 @@  + <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> +   + <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-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> +  </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…"/> <entry name="CommDlgExtendedError" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/winui/winu…"/> <entry name="GetLastError" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/debug/base…"/> + <entry name="GetMessage" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/winui/winu…"/> <entry name="Icons in Win32" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnwui/html…"/> + <entry name="MSG" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/winui/winu…"/> </win32-api-table>

1 0

[graphic-forms-cvs] r364 - in trunk: . src src/tests/uitoolkit src/uitoolkit/widgets
by junrue＠common-lisp.net 20 Oct '06

20 Oct '06

Author: junrue Date: Fri Oct 20 00:28:30 2006 New Revision: 364 Added: trunk/src/uitoolkit/widgets/scrolling-helper.lisp - copied, changed from r346, trunk/src/uitoolkit/widgets/scrolling-event-dispatcher.lisp Removed: trunk/src/uitoolkit/widgets/scrolling-event-dispatcher.lisp Modified: trunk/graphic-forms-uitoolkit.asd trunk/src/packages.lisp trunk/src/tests/uitoolkit/scroll-tester.lisp trunk/src/uitoolkit/widgets/event.lisp trunk/src/uitoolkit/widgets/scrollbar.lisp trunk/src/uitoolkit/widgets/widget-classes.lisp Log: renamed scrolling-event-dispatcher to scrolling-helper Modified: trunk/graphic-forms-uitoolkit.asd ============================================================================== --- trunk/graphic-forms-uitoolkit.asd (original) +++ trunk/graphic-forms-uitoolkit.asd Fri Oct 20 00:28:30 2006 @@ -138,7 +138,7 @@ (:file "menu-item") (:file "menu-language") (:file "event") - (:file "scrolling-event-dispatcher") + (:file "scrolling-helper") (:file "scrollbar") (:file "slider") (:file "window") Modified: trunk/src/packages.lisp ============================================================================== --- trunk/src/packages.lisp (original) +++ trunk/src/packages.lisp Fri Oct 20 00:28:30 2006 @@ -265,7 +265,7 @@ #:panel #:root-window #:scrollbar - #:scrolling-event-dispatcher + #:scrolling-helper #:slider #:timer #:top-level Modified: trunk/src/tests/uitoolkit/scroll-tester.lisp ============================================================================== --- trunk/src/tests/uitoolkit/scroll-tester.lisp (original) +++ trunk/src/tests/uitoolkit/scroll-tester.lisp Fri Oct 20 00:28:30 2006 @@ -41,7 +41,7 @@ (setf *scroll-tester-win* nil) (gfw:shutdown 0)) -(defclass scroll-tester-events (gfw:scrolling-event-dispatcher) ()) +(defclass scroll-tester-events (gfw:scrolling-helper) ()) (defmethod gfw:event-close ((disp scroll-tester-events) window) (declare (ignore window)) Modified: trunk/src/uitoolkit/widgets/event.lisp ============================================================================== --- trunk/src/uitoolkit/widgets/event.lisp (original) +++ trunk/src/uitoolkit/widgets/event.lisp Fri Oct 20 00:28:30 2006 @@ -391,7 +391,7 @@ (disp (dispatcher widget))) (unwind-protect (let ((parent (gfw:parent widget))) - (when (and parent (typep (dispatcher parent) 'scrolling-event-dispatcher)) + (when (and parent (typep (dispatcher parent) 'scrolling-helper)) (let ((origin (slot-value (dispatcher parent) 'viewport-origin))) (set-window-origin gc origin) (incf (gfs:point-x pnt) (gfs:point-x origin)) Modified: trunk/src/uitoolkit/widgets/scrollbar.lisp ============================================================================== --- trunk/src/uitoolkit/widgets/scrollbar.lisp (original) +++ trunk/src/uitoolkit/widgets/scrollbar.lisp Fri Oct 20 00:28:30 2006 @@ -181,7 +181,7 @@ (error 'gfs:disposed-error)) (let ((disp (dispatcher (parent self)))) (cond - ((typep disp 'scrolling-event-dispatcher) + ((typep disp 'scrolling-helper) (if (eql (orientation-of self) :horizontal) (gfs:size-width (step-increments self)) (gfs:size-height (step-increments self)))) @@ -196,7 +196,7 @@ (warn 'gfs:toolkit-warning :detail "negative step increment")) (let ((disp (dispatcher (parent self)))) (cond - ((typep disp 'scrolling-event-dispatcher) + ((typep disp 'scrolling-helper) (if (eql (orientation-of self) :horizontal) (setf (gfs:size-width (step-increments self)) amount) (setf (gfs:size-height (step-increments self)) amount))) Copied: trunk/src/uitoolkit/widgets/scrolling-helper.lisp (from r346, trunk/src/uitoolkit/widgets/scrolling-event-dispatcher.lisp) ============================================================================== --- trunk/src/uitoolkit/widgets/scrolling-event-dispatcher.lisp (original) +++ trunk/src/uitoolkit/widgets/scrolling-helper.lisp Fri Oct 20 00:28:30 2006 @@ -1,5 +1,5 @@ ;;;; -;;;; scrolling-event-dispatcher.lisp +;;;; scrolling-helper.lisp ;;;; ;;;; Copyright (C) 2006, Jack D. Unrue ;;;; All rights reserved. @@ -130,7 +130,7 @@ ;;; methods ;;; -(defmethod event-pre-resize ((disp scrolling-event-dispatcher) (window window) rect type) +(defmethod event-pre-resize ((disp scrolling-helper) (window window) rect type) (let ((h-step (gfs:size-width (step-increments disp))) (v-step (gfs:size-height (step-increments disp))) (outer-size (gfw:size window)) @@ -153,27 +153,27 @@ (setf (gfs:size-height size) amount))) (setf (gfs:size rect) size))) -(defmethod event-resize ((disp scrolling-event-dispatcher) (window window) size type) +(defmethod event-resize ((disp scrolling-helper) (window window) size type) (declare (ignore size type)) (call-next-method) (when (typep (layout-of window) 'heap-layout) (update-scrollbar-page-sizes window) (update-viewport-origin-for-resize window))) -(defmethod event-scroll ((disp scrolling-event-dispatcher) (window window) axis detail) +(defmethod event-scroll ((disp scrolling-helper) (window window) axis detail) (declare (ignore disp)) (when (typep (layout-of window) 'heap-layout) (update-scrolling-state window axis detail))) -(defmethod initialize-instance :after ((self scrolling-event-dispatcher) &key) +(defmethod initialize-instance :after ((self scrolling-helper) &key) (validate-step-values (step-increments self))) -(defmethod print-object ((self scrolling-event-dispatcher) stream) +(defmethod print-object ((self scrolling-helper) stream) (print-unreadable-object (self stream :type t) (format stream "horizontal policy: ~a " (horizontal-policy-of self)) (format stream "vertical policy: ~a " (vertical-policy-of self)) (format stream "step increments: ~a" (step-increments self)))) -(defmethod (setf step-increment) :after (amounts (self scrolling-event-dispatcher)) +(defmethod (setf step-increment) :after (amounts (self scrolling-helper)) (validate-step-values amounts) (setf (slot-value self 'step-increment) (gfs:copy-size amounts))) Modified: trunk/src/uitoolkit/widgets/widget-classes.lisp ============================================================================== --- trunk/src/uitoolkit/widgets/widget-classes.lisp (original) +++ trunk/src/uitoolkit/widgets/widget-classes.lisp Fri Oct 20 00:28:30 2006 @@ -39,7 +39,7 @@ (defclass event-dispatcher () () (:documentation "Instances of this class receive events on behalf of user interface objects.")) -(defclass scrolling-event-dispatcher (event-dispatcher) +(defclass scrolling-helper (event-dispatcher) ((horizontal-policy :accessor horizontal-policy-of :initarg :horizontal-policy

1 0

[graphic-forms-cvs] r363 - trunk/docs/manual
by junrue＠common-lisp.net 20 Oct '06

20 Oct '06

Author: junrue Date: Thu Oct 19 23:56:22 2006 New Revision: 363 Modified: trunk/docs/manual/gfg-symbols.xml Log: Modified: trunk/docs/manual/gfg-symbols.xml ============================================================================== --- trunk/docs/manual/gfg-symbols.xml (original) +++ trunk/docs/manual/gfg-symbols.xml Thu Oct 19 23:56:22 2006 @@ -1484,6 +1484,76 @@ </seealso> </generic-function> + <generic-function name="draw-text"> + <syntax> + <arguments> + <argument name="graphics-context"> + <description> + A <reftopic>gfg:graphics-context</reftopic> on which to draw. + </description> + </argument> + <argument name="string"> + <description> + A <refclhs>string</refclhs> to be rendered, which may contain + characters that will be interpreted specially; see <arg3/>. + </description> + </argument> + <argument name="point"> + <description> + A <reftopic>gfg:point</reftopic> specifying the upper-left + corner of the rectangle bounding <arg1/>. + </description> + </argument> + <notarg name="&optional"/> + <argument name="style"> + <description> + A <refclhs>list</refclhs> containing one or more of the following + keyword symbols: + <enum> + <argument name=":mnemonic"> + <description> + Underline the mnemonic character, specified in <arg1/> with + an ampersand. + </description> + </argument> + <argument name=":tab"> + <description> + Expand tabs embedded in <arg1/>; see <arg4/>. + </description> + </argument> + <argument name=":transparent"> + <description> + The background of the drawing area where <arg1/> will be + rendered is preserved. + </description> + </argument> + </enum> + </description> + </argument> + <argument name="tab-width"> + <description> + A positive <refclhs>integer</refclhs> specifying the number of + pixels into which tabs should be expanded; the default is 8. + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Draws <arg1/>, optionally expanding tabs and underlining the mnemonic + character. + </description> + <seealso> + <reftopic>gfg:foreground-color</reftopic> + <reftopic>gfg:background-color</reftopic> + <reftopic>gfg:font</reftopic> + <reftopic>gfg:text-extent</reftopic> + <reftopic>gfg:metrics</reftopic> + </seealso> + </generic-function> + <generic-function name="load"> <syntax> <arguments>

1 0

[graphic-forms-cvs] r362 - trunk/docs/manual
by junrue＠common-lisp.net 20 Oct '06

20 Oct '06

Author: junrue Date: Thu Oct 19 23:41:51 2006 New Revision: 362 Modified: trunk/docs/manual/gfg-symbols.xml Log: Modified: trunk/docs/manual/gfg-symbols.xml ============================================================================== --- trunk/docs/manual/gfg-symbols.xml (original) +++ trunk/docs/manual/gfg-symbols.xml Thu Oct 19 23:41:51 2006 @@ -778,6 +778,8 @@ If <arg2/> and <arg3/> are the same, a complete ellipse is drawn. </description> <seealso> + <reftopic>gfg:draw-pie-wedge</reftopic> + <reftopic>gfg:draw-filled-pie-wedge</reftopic> <reftopic>gfg:foreground-color</reftopic> <reftopic>gfg:miter-limit</reftopic> <reftopic>gfg:pen-style</reftopic> @@ -855,6 +857,45 @@ <arg3/> and <arg4/> as control points. </description> <seealso> + <reftopic>gfg:draw-poly-bezier</reftopic> + <reftopic>gfg:foreground-color</reftopic> + <reftopic>gfg:miter-limit</reftopic> + <reftopic>gfg:pen-style</reftopic> + <reftopic>gfg:pen-width</reftopic> + </seealso> + </generic-function> + + <generic-function name="draw-poly-bezier"> + <syntax> + <arguments> + <argument name="graphics-context"> + <description> + A <reftopic>gfg:graphics-context</reftopic> on which to draw. + </description> + </argument> + <argument name="point"> + <description> + A <reftopic>gfs:point</reftopic> indicating the the starting + location of the curves. + </description> + </argument> + <argument name="list"> + <description> + A <refclhs>list</refclhs> of 3-element sublists, where (first sublist) + is the current segment's endpoint, and (second sublist) and + (third sublist) are the segments control points. + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Draws a series of connected Bézier curves starting at <arg1/>. + </description> + <seealso> + <reftopic>gfg:draw-bezier</reftopic> <reftopic>gfg:foreground-color</reftopic> <reftopic>gfg:miter-limit</reftopic> <reftopic>gfg:pen-style</reftopic> @@ -912,6 +953,9 @@ </para> </description> <seealso> + <reftopic>gfg:draw-filled-chord</reftopic> + <reftopic>gfg:draw-pie-wedge</reftopic> + <reftopic>gfg:draw-filled-pie-wedge</reftopic> <reftopic>gfg:foreground-color</reftopic> <reftopic>gfg:pen-style</reftopic> <reftopic>gfg:pen-width</reftopic> @@ -969,6 +1013,9 @@ </para> </description> <seealso> + <reftopic>gfg:draw-chord</reftopic> + <reftopic>gfg:draw-pie-wedge</reftopic> + <reftopic>gfg:draw-filled-pie-wedge</reftopic> <reftopic>gfg:background-color</reftopic> <reftopic>gfg:foreground-color</reftopic> <reftopic>gfg:pen-style</reftopic> @@ -976,6 +1023,123 @@ </seealso> </generic-function> + <generic-function name="draw-pie-wedge"> + <syntax> + <arguments> + <argument name="graphics-context"> + <description> + A <reftopic>gfg:graphics-context</reftopic> on which to draw. + </description> + </argument> + <argument name="rectangle"> + <description> + A bounding <reftopic>gfs:rectangle</reftopic> for an ellipse + from which the arc component of the wedge is obtained. + </description> + </argument> + <argument name="start-point"> + <description> + A <reftopic>gfs:point</reftopic> indicating the beginning of the + rendered arc. + </description> + </argument> + <argument name="end-point"> + <description> + A <reftopic>gfs:point</reftopic> indicating the end of the + rendered arc. + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Draws a pie-shaped wedge whose curve is formed by the ellipse bound + by <arg1/>, in a counter-clockwise direction from <arg2/> to <arg3/>. + </description> + <seealso> + <reftopic>gfg:draw-chord</reftopic> + <reftopic>gfg:draw-filled-chord</reftopic> + <reftopic>gfg:draw-filled-pie-wedge</reftopic> + <reftopic>gfg:foreground-color</reftopic> + <reftopic>gfg:pen-style</reftopic> + <reftopic>gfg:pen-width</reftopic> + </seealso> + </generic-function> + + <generic-function name="draw-filled-pie-wedge"> + <syntax> + <arguments> + <argument name="graphics-context"> + <description> + A <reftopic>gfg:graphics-context</reftopic> on which to draw. + </description> + </argument> + <argument name="rectangle"> + <description> + A bounding <reftopic>gfs:rectangle</reftopic> for an ellipse + from which the arc component of the wedge is obtained. + </description> + </argument> + <argument name="start-point"> + <description> + A <reftopic>gfs:point</reftopic> indicating the beginning of the + rendered arc. + </description> + </argument> + <argument name="end-point"> + <description> + A <reftopic>gfs:point</reftopic> indicating the end of the + rendered arc. + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Fills a pie-shaped wedge whose curve is formed by the ellipse bound + by <arg1/>, in a counter-clockwise direction from <arg2/> to <arg3/>. + The current background color is used for the interior. + </description> + <seealso> + <reftopic>gfg:draw-filled-chord</reftopic> + <reftopic>gfg:draw-filled-pie-wedge</reftopic> + <reftopic>gfg:background-color</reftopic> + <reftopic>gfg:foreground-color</reftopic> + <reftopic>gfg:pen-style</reftopic> + <reftopic>gfg:pen-width</reftopic> + </seealso> + </generic-function> + + <generic-function name="draw-point"> + <syntax> + <arguments> + <argument name="graphics-context"> + <description> + A <reftopic>gfg:graphics-context</reftopic> on which to draw. + </description> + </argument> + <argument name="point"> + <description> + A <reftopic>gfs:point</reftopic> identifying the pixel location. + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Sets a single pixel at <arg1/>. + </description> + <seealso> + <reftopic>gfg:foreground-color</reftopic> + </seealso> + </generic-function> + <generic-function name="draw-ellipse"> <syntax> <arguments> @@ -999,6 +1163,7 @@ Draws an ellipse bounded by <arg1/>. </description> <seealso> + <reftopic>gfg:draw-filled-ellipse</reftopic> <reftopic>gfg:foreground-color</reftopic> <reftopic>gfg:pen-style</reftopic> <reftopic>gfg:pen-width</reftopic> @@ -1028,6 +1193,151 @@ Fills an ellipse bounded by <arg1/> with the current background color. </description> <seealso> + <reftopic>gfg:draw-ellipse</reftopic> + <reftopic>gfg:background-color</reftopic> + <reftopic>gfg:foreground-color</reftopic> + <reftopic>gfg:pen-style</reftopic> + <reftopic>gfg:pen-width</reftopic> + </seealso> + </generic-function> + + <generic-function name="draw-rectangle"> + <syntax> + <arguments> + <argument name="graphics-context"> + <description> + A <reftopic>gfg:graphics-context</reftopic> on which to draw. + </description> + </argument> + <argument name="rectangle"> + <description> + The <reftopic>gfs:rectangle</reftopic> to be drawn. + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Draws a rectangle. + </description> + <seealso> + <reftopic>gfg:draw-polygon</reftopic> + <reftopic>gfg:draw-rounded-rectangle</reftopic> + <reftopic>gfg:draw-filled-rectangle</reftopic> + <reftopic>gfg:draw-filled-rounded-rectangle</reftopic> + <reftopic>gfg:foreground-color</reftopic> + <reftopic>gfg:pen-style</reftopic> + <reftopic>gfg:pen-width</reftopic> + </seealso> + </generic-function> + + <generic-function name="draw-rounded-rectangle"> + <syntax> + <arguments> + <argument name="graphics-context"> + <description> + A <reftopic>gfg:graphics-context</reftopic> on which to draw. + </description> + </argument> + <argument name="rectangle"> + <description> + The <reftopic>gfs:rectangle</reftopic> to be drawn. + </description> + </argument> + <argument name="size"> + <description> + The <reftopic>gfs:size</reftopic> of an ellipse determining + the arc used for rounding the rectangle's corners. + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Draws a rectangle with rounded corners. + </description> + <seealso> + <reftopic>gfg:draw-polygon</reftopic> + <reftopic>gfg:draw-rectangle</reftopic> + <reftopic>gfg:draw-filled-rectangle</reftopic> + <reftopic>gfg:draw-filled-rounded-rectangle</reftopic> + <reftopic>gfg:foreground-color</reftopic> + <reftopic>gfg:pen-style</reftopic> + <reftopic>gfg:pen-width</reftopic> + </seealso> + </generic-function> + + <generic-function name="draw-filled-rounded-rectangle"> + <syntax> + <arguments> + <argument name="graphics-context"> + <description> + A <reftopic>gfg:graphics-context</reftopic> on which to draw. + </description> + </argument> + <argument name="rectangle"> + <description> + The <reftopic>gfs:rectangle</reftopic> to be drawn. + </description> + </argument> + <argument name="size"> + <description> + The <reftopic>gfs:size</reftopic> of an ellipse determining + the arc used for rounding the rectangle's corners. + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Fills a rectangle having rounded corners with the current + background color. + </description> + <seealso> + <reftopic>gfg:draw-polygon</reftopic> + <reftopic>gfg:draw-rectangle</reftopic> + <reftopic>gfg:draw-rounded-rectangle</reftopic> + <reftopic>gfg:draw-filled-rectangle</reftopic> + <reftopic>gfg:draw-filled-rounded-rectangle</reftopic> + <reftopic>gfg:background-color</reftopic> + <reftopic>gfg:foreground-color</reftopic> + <reftopic>gfg:pen-style</reftopic> + <reftopic>gfg:pen-width</reftopic> + </seealso> + </generic-function> + + <generic-function name="draw-filled-rectangle"> + <syntax> + <arguments> + <argument name="graphics-context"> + <description> + A <reftopic>gfg:graphics-context</reftopic> on which to draw. + </description> + </argument> + <argument name="rectangle"> + <description> + The <reftopic>gfs:rectangle</reftopic> to be filled. + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Fills a rectangle with the current background color. + </description> + <seealso> + <reftopic>gfg:draw-polygon</reftopic> + <reftopic>gfg:draw-rectangle</reftopic> + <reftopic>gfg:draw-filled-rectangle</reftopic> + <reftopic>gfg:draw-filled-rounded-rectangle</reftopic> <reftopic>gfg:background-color</reftopic> <reftopic>gfg:foreground-color</reftopic> <reftopic>gfg:pen-style</reftopic> @@ -1064,6 +1374,109 @@ Draws a line between <arg1/> and <arg2/>. </description> <seealso> + <reftopic>gfg:draw-polyline</reftopic> + <reftopic>gfg:draw-polygon</reftopic> + <reftopic>gfg:foreground-color</reftopic> + <reftopic>gfg:miter-limit</reftopic> + <reftopic>gfg:pen-style</reftopic> + <reftopic>gfg:pen-width</reftopic> + </seealso> + </generic-function> + + <generic-function name="draw-polygon"> + <syntax> + <arguments> + <argument name="graphics-context"> + <description> + A <reftopic>gfg:graphics-context</reftopic> on which to draw. + </description> + </argument> + <argument name="list"> + <description> + A <refclhs>list</refclhs> of <reftopic>gfg:point</reftopic>s + defining the polygon's line segments. + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Draws a series of connected line segments determined by <arg1/>. The + last point in <arg1/> is connected with the first. If <arg1/> contains + less than three points, then this function does nothing. + </description> + <seealso> + <reftopic>gfg:draw-line</reftopic> + <reftopic>gfg:draw-polyline</reftopic> + <reftopic>gfg:foreground-color</reftopic> + <reftopic>gfg:pen-style</reftopic> + <reftopic>gfg:pen-width</reftopic> + </seealso> + </generic-function> + + <generic-function name="draw-filled-polygon"> + <syntax> + <arguments> + <argument name="graphics-context"> + <description> + A <reftopic>gfg:graphics-context</reftopic> on which to draw. + </description> + </argument> + <argument name="list"> + <description> + A <refclhs>list</refclhs> of <reftopic>gfg:point</reftopic>s + defining the polygon's line segments. + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Fills a closed shape defined by a series of connected line segments + determined by <arg1/>. The last point in <arg1/> is connected with + the first. The current background color is used. If <arg1/> contains + less than three points, then this function does nothing. + </description> + <seealso> + <reftopic>gfg:draw-filled-rectangle</reftopic> + <reftopic>gfg:foreground-color</reftopic> + <reftopic>gfg:background-color</reftopic> + <reftopic>gfg:pen-style</reftopic> + <reftopic>gfg:pen-width</reftopic> + </seealso> + </generic-function> + + <generic-function name="draw-polyline"> + <syntax> + <arguments> + <argument name="graphics-context"> + <description> + A <reftopic>gfg:graphics-context</reftopic> on which to draw. + </description> + </argument> + <argument name="list"> + <description> + A <refclhs>list</refclhs> of <reftopic>gfg:point</reftopic>s + defining line segments. + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Draws a series of connected line segments (the last point in + <arg1/> is not connected to the first). If <arg1/> contains less than + two points, then this function does nothing. + </description> + <seealso> + <reftopic>gfg:draw-line</reftopic> + <reftopic>gfg:draw-polygon</reftopic> <reftopic>gfg:foreground-color</reftopic> <reftopic>gfg:miter-limit</reftopic> <reftopic>gfg:pen-style</reftopic> @@ -1467,7 +1880,7 @@ <arguments> <argument name="graphics-context"> <description> - The <reftopic>gfg:graphics-context</reftopic> whose pen width + The <reftopic>gfg:graphics-context</reftopic> whose miter limit value is to be retrieved or set. </description> </argument>

1 0

[graphic-forms-cvs] r361 - trunk/docs/manual
by junrue＠common-lisp.net 20 Oct '06

20 Oct '06

Author: junrue Date: Thu Oct 19 22:50:56 2006 New Revision: 361 Modified: trunk/docs/manual/constants.xml trunk/docs/manual/gf-data.xsl trunk/docs/manual/gfg-symbols.xml Log: Modified: trunk/docs/manual/constants.xml ============================================================================== --- trunk/docs/manual/constants.xml (original) +++ trunk/docs/manual/constants.xml Thu Oct 19 22:50:56 2006 @@ -12,7 +12,7 @@ each package. </para> - <bridgehead renderas="sect2">character sets [GFG]</bridgehead> + <bridgehead renderas="sect2">Character Sets [GFG]</bridgehead> <informaltable frame="none"> <anchor id="character sets"/> @@ -43,7 +43,7 @@ </tgroup> </informaltable> - <bridgehead renderas="sect2">colors [GFG]</bridgehead> + <bridgehead renderas="sect2">Standard Colors [GFG]</bridgehead> <informaltable frame="none"> <anchor id="colors"/> @@ -59,7 +59,7 @@ </tgroup> </informaltable> - <bridgehead renderas="sect2">system icons [GFG]</bridgehead> + <bridgehead renderas="sect2">System Icons [GFG]</bridgehead> <informaltable frame="none"> <anchor id="system icons"/> @@ -75,6 +75,77 @@ </tgroup> </informaltable> + <bridgehead renderas="sect2">Virtual Key Codes [GFW]</bridgehead> + + <informaltable frame="none"> + <anchor id="virtual key codes"/> + <indexterm><primary>virtual key codes</primary></indexterm> + <tgroup cols="1"> + <tbody> + <row><entry><para role="normal">+vk-break+</para></entry></row> + <row><entry><para role="normal">+vk-backspace+</para></entry></row> + <row><entry><para role="normal">+vk-tab+</para></entry></row> + <row><entry><para role="normal">+vk-clear+</para></entry></row> + <row><entry><para role="normal">+vk-return+</para></entry></row> + <row><entry><para role="normal">+vk-shift+</para></entry></row> + <row><entry><para role="normal">+vk-control+</para></entry></row> + <row><entry><para role="normal">+vk-alt+</para></entry></row> + <row><entry><para role="normal">+vk-pause+</para></entry></row> + <row><entry><para role="normal">+vk-caps-lock+</para></entry></row> + <row><entry><para role="normal">+vk-escape+</para></entry></row> + <row><entry><para role="normal">+vk-page-up+</para></entry></row> + <row><entry><para role="normal">+vk-page-down+</para></entry></row> + <row><entry><para role="normal">+vk-end+</para></entry></row> + <row><entry><para role="normal">+vk-home+</para></entry></row> + <row><entry><para role="normal">+vk-left+</para></entry></row> + <row><entry><para role="normal">+vk-up+</para></entry></row> + <row><entry><para role="normal">+vk-right+</para></entry></row> + <row><entry><para role="normal">+vk-down+</para></entry></row> + <row><entry><para role="normal">+vk-insert+</para></entry></row> + <row><entry><para role="normal">+vk-delete+</para></entry></row> + <row><entry><para role="normal">+vk-help+</para></entry></row> + <row><entry><para role="normal">+vk-left-win+</para></entry></row> + <row><entry><para role="normal">+vk-right-win+</para></entry></row> + <row><entry><para role="normal">+vk-applications+</para></entry></row> + <row><entry><para role="normal">+vk-numpad-0+</para></entry></row> + <row><entry><para role="normal">+vk-numpad-1+</para></entry></row> + <row><entry><para role="normal">+vk-numpad-2+</para></entry></row> + <row><entry><para role="normal">+vk-numpad-3+</para></entry></row> + <row><entry><para role="normal">+vk-numpad-4+</para></entry></row> + <row><entry><para role="normal">+vk-numpad-5+</para></entry></row> + <row><entry><para role="normal">+vk-numpad-6+</para></entry></row> + <row><entry><para role="normal">+vk-numpad-7+</para></entry></row> + <row><entry><para role="normal">+vk-numpad-8+</para></entry></row> + <row><entry><para role="normal">+vk-numpad-9+</para></entry></row> + <row><entry><para role="normal">+vk-numpad-*+</para></entry></row> + <row><entry><para role="normal">+vk-numpad-++</para></entry></row> + <row><entry><para role="normal">+vk-numpad--+</para></entry></row> + <row><entry><para role="normal">+vk-numpad-.+</para></entry></row> + <row><entry><para role="normal">+vk-numpad-/+</para></entry></row> + <row><entry><para role="normal">+vk-numpad-f1+</para></entry></row> + <row><entry><para role="normal">+vk-numpad-f2+</para></entry></row> + <row><entry><para role="normal">+vk-numpad-f3+</para></entry></row> + <row><entry><para role="normal">+vk-numpad-f4+</para></entry></row> + <row><entry><para role="normal">+vk-numpad-f5+</para></entry></row> + <row><entry><para role="normal">+vk-numpad-f6+</para></entry></row> + <row><entry><para role="normal">+vk-numpad-f7+</para></entry></row> + <row><entry><para role="normal">+vk-numpad-f8+</para></entry></row> + <row><entry><para role="normal">+vk-numpad-f9+</para></entry></row> + <row><entry><para role="normal">+vk-numpad-f10+</para></entry></row> + <row><entry><para role="normal">+vk-numpad-f11+</para></entry></row> + <row><entry><para role="normal">+vk-numpad-f12+</para></entry></row> + <row><entry><para role="normal">+vk-num-lock+</para></entry></row> + <row><entry><para role="normal">+vk-scroll-lock+</para></entry></row> + <row><entry><para role="normal">+vk-left-shift+</para></entry></row> + <row><entry><para role="normal">+vk-right-shift+</para></entry></row> + <row><entry><para role="normal">+vk-left-control+</para></entry></row> + <row><entry><para role="normal">+vk-right-control+</para></entry></row> + <row><entry><para role="normal">+vk-left-alt+</para></entry></row> + <row><entry><para role="normal">+vk-right-alt+</para></entry></row> + </tbody> + </tgroup> + </informaltable> + <para role="normal"/> </chapter> Modified: trunk/docs/manual/gf-data.xsl ============================================================================== --- trunk/docs/manual/gf-data.xsl (original) +++ trunk/docs/manual/gf-data.xsl Thu Oct 19 22:50:56 2006 @@ -36,21 +36,14 @@ </xsl:element> </xsl:template> - <xsl:template match="para"> + <xsl:template match="para | emphasis | itemizedlist | listitem"> <xsl:copy> <xsl:copy-of select="@*"/> <xsl:apply-templates/> </xsl:copy> </xsl:template> - <xsl:template match="emphasis"> - <xsl:copy> - <xsl:copy-of select="@*"/> - <xsl:apply-templates/> - </xsl:copy> - </xsl:template> - - <xsl:template name="emit-table"> + <xsl:template name="emit-sorted-table"> <xsl:param name="col2-width"/> <xsl:element name="informaltable"> @@ -72,6 +65,26 @@ </xsl:element> </xsl:template> + <xsl:template name="emit-unsorted-table"> + <xsl:param name="col2-width"/> + + <xsl:element name="informaltable"> + <xsl:attribute name="frame">none</xsl:attribute> + <xsl:element name="tgroup"> + <xsl:attribute name="cols">2</xsl:attribute> + <xsl:element name="colspec"> + <xsl:attribute name="colwidth">*</xsl:attribute> + </xsl:element> + <xsl:element name="colspec"> + <xsl:attribute name="colwidth"><xsl:value-of select="$col2-width"/></xsl:attribute> + </xsl:element> + <xsl:element name="tbody"> + <xsl:apply-templates/> + </xsl:element> + </xsl:element> + </xsl:element> + </xsl:template> + <xsl:template name="find-arg"> <xsl:param name="index"/> <xsl:variable name="raw-text"> @@ -264,7 +277,7 @@ <xsl:attribute name="renderas">sect2</xsl:attribute> arguments </xsl:element> - <xsl:call-template name="emit-table"> + <xsl:call-template name="emit-unsorted-table"> <xsl:with-param name="col2-width">5*</xsl:with-param> </xsl:call-template> </xsl:template> @@ -281,7 +294,7 @@ </xsl:element> </xsl:element> </xsl:for-each> - <xsl:call-template name="emit-table"> + <xsl:call-template name="emit-sorted-table"> <xsl:with-param name="col2-width">5*</xsl:with-param> </xsl:call-template> </xsl:template> @@ -294,7 +307,7 @@ </xsl:element> </xsl:element> </xsl:for-each> - <xsl:call-template name="emit-table"> + <xsl:call-template name="emit-sorted-table"> <xsl:with-param name="col2-width">5*</xsl:with-param> </xsl:call-template> </xsl:template> @@ -340,7 +353,7 @@ </xsl:template> <xsl:template match="hierarchy"> - <xsl:call-template name="emit-table"> + <xsl:call-template name="emit-sorted-table"> <xsl:with-param name="col2-width">8*</xsl:with-param> </xsl:call-template> </xsl:template> Modified: trunk/docs/manual/gfg-symbols.xml ============================================================================== --- trunk/docs/manual/gfg-symbols.xml (original) +++ trunk/docs/manual/gfg-symbols.xml Thu Oct 19 22:50:56 2006 @@ -282,6 +282,7 @@ <reftopic>gfg:color-blue</reftopic> <reftopic>gfg:color->rgb</reftopic> <reftopic>gfg:rgb->color</reftopic> + <reftopic label="Standard Colors">colors</reftopic> </seealso> </structure> @@ -738,6 +739,338 @@  + <generic-function name="draw-arc"> + <syntax> + <arguments> + <argument name="graphics-context"> + <description> + A <reftopic>gfg:graphics-context</reftopic> on which to draw. + </description> + </argument> + <argument name="rectangle"> + <description> + A bounding <reftopic>gfs:rectangle</reftopic> for an ellipse + from which the rendered arc is obtained. + </description> + </argument> + <argument name="start-point"> + <description> + A <reftopic>gfs:point</reftopic> indicating the beginning of the + rendered arc. + </description> + </argument> + <argument name="end-point"> + <description> + A <reftopic>gfs:point</reftopic> indicating the end of the + rendered arc. + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Draws an arc whose curve is formed by the ellipse bound by <arg1/>, in + a counter-clockwise direction from <arg2/> where it intersects a radial + originating at the center of <arg1/>. The arc ends at <arg3/> where it + intersects another radial also originating at the center of <arg1/>. + If <arg2/> and <arg3/> are the same, a complete ellipse is drawn. + </description> + <seealso> + <reftopic>gfg:foreground-color</reftopic> + <reftopic>gfg:miter-limit</reftopic> + <reftopic>gfg:pen-style</reftopic> + <reftopic>gfg:pen-width</reftopic> + </seealso> + </generic-function> + + <generic-function name="draw-image"> + <syntax> + <arguments> + <argument name="graphics-context"> + <description> + A <reftopic>gfg:graphics-context</reftopic> on which to draw. + </description> + </argument> + <argument name="image"> + <description> + A <reftopic>gfg:image</reftopic> to be drawn. + </description> + </argument> + <argument name="point"> + <description> + A <reftopic>gfs:point</reftopic> specifying the location of the + upper-left corner of <arg1/>. + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + This function draws <arg1/> with its upper-left corner positioned + at <arg2/> in the drawing surface's coordinate system. + </description> + </generic-function> + + <generic-function name="draw-bezier"> + <syntax> + <arguments> + <argument name="graphics-context"> + <description> + A <reftopic>gfg:graphics-context</reftopic> on which to draw. + </description> + </argument> + <argument name="start-point"> + <description> + A <reftopic>gfs:point</reftopic> indicating the beginning of the + rendered arc. + </description> + </argument> + <argument name="end-point"> + <description> + A <reftopic>gfs:point</reftopic> indicating the end of the + rendered arc. + </description> + </argument> + <argument name="ctrl-point-1"> + <description> + The first control <reftopic>gfs:point</reftopic>. + </description> + </argument> + <argument name="ctrl-point-2"> + <description> + The second control <reftopic>gfs:point</reftopic>. + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Draws a Bézier curve between <arg1/> and <arg2/> using + <arg3/> and <arg4/> as control points. + </description> + <seealso> + <reftopic>gfg:foreground-color</reftopic> + <reftopic>gfg:miter-limit</reftopic> + <reftopic>gfg:pen-style</reftopic> + <reftopic>gfg:pen-width</reftopic> + </seealso> + </generic-function> + + <generic-function name="draw-chord"> + <syntax> + <arguments> + <argument name="graphics-context"> + <description> + A <reftopic>gfg:graphics-context</reftopic> on which to draw. + </description> + </argument> + <argument name="rectangle"> + <description> + A bounding <reftopic>gfs:rectangle</reftopic> for an ellipse + from which the rendered chord is obtained. + </description> + </argument> + <argument name="start-point"> + <description> + A <reftopic>gfs:point</reftopic> indicating the beginning of the + rendered arc. + </description> + </argument> + <argument name="end-point"> + <description> + A <reftopic>gfs:point</reftopic> indicating the end of the + rendered arc. + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Draws a closed shape comprised of: + <itemizedlist mark="bullet" spacing="compact"> + <listitem> + an arc whose curve is formed by the ellipse bound by <arg1/>, in + a counter-clockwise direction from <arg2/> where it intersects a + radial originating at the center of <arg1/>. The arc ends at + <arg3/>, where it intersects another radial also originating at + the center of <arg1/> + </listitem> + <listitem> + a line drawn between <arg2/> and <arg3/> + </listitem> + </itemizedlist> + <para role="normal"> + If <arg2/> and <arg3/> are the same, a complete ellipse is drawn. + </para> + </description> + <seealso> + <reftopic>gfg:foreground-color</reftopic> + <reftopic>gfg:pen-style</reftopic> + <reftopic>gfg:pen-width</reftopic> + </seealso> + </generic-function> + + <generic-function name="draw-filled-chord"> + <syntax> + <arguments> + <argument name="graphics-context"> + <description> + A <reftopic>gfg:graphics-context</reftopic> on which to draw. + </description> + </argument> + <argument name="rectangle"> + <description> + A bounding <reftopic>gfs:rectangle</reftopic> for an ellipse + from which the rendered chord is obtained. + </description> + </argument> + <argument name="start-point"> + <description> + A <reftopic>gfs:point</reftopic> indicating the beginning of the + rendered arc. + </description> + </argument> + <argument name="end-point"> + <description> + A <reftopic>gfs:point</reftopic> indicating the end of the + rendered arc. + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Fills a closed shape comprised of: + <itemizedlist mark="bullet" spacing="compact"> + <listitem> + an arc whose curve is formed by the ellipse bound by <arg1/>, in + a counter-clockwise direction from <arg2/> where it intersects a + radial originating at the center of <arg1/>. The arc ends at + <arg3/>, where it intersects another radial also originating at + the center of <arg1/> + </listitem> + <listitem> + a line drawn between <arg2/> and <arg3/> + </listitem> + </itemizedlist> + <para role="normal"> + with the current background color. If <arg2/> and <arg3/> are the + same, a complete ellipse is drawn. + </para> + </description> + <seealso> + <reftopic>gfg:background-color</reftopic> + <reftopic>gfg:foreground-color</reftopic> + <reftopic>gfg:pen-style</reftopic> + <reftopic>gfg:pen-width</reftopic> + </seealso> + </generic-function> + + <generic-function name="draw-ellipse"> + <syntax> + <arguments> + <argument name="graphics-context"> + <description> + A <reftopic>gfg:graphics-context</reftopic> on which to draw. + </description> + </argument> + <argument name="rectangle"> + <description> + A bounding <reftopic>gfs:rectangle</reftopic> for an ellipse + from which the rendered chord is obtained. + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Draws an ellipse bounded by <arg1/>. + </description> + <seealso> + <reftopic>gfg:foreground-color</reftopic> + <reftopic>gfg:pen-style</reftopic> + <reftopic>gfg:pen-width</reftopic> + </seealso> + </generic-function> + + <generic-function name="draw-filled-ellipse"> + <syntax> + <arguments> + <argument name="graphics-context"> + <description> + A <reftopic>gfg:graphics-context</reftopic> on which to draw. + </description> + </argument> + <argument name="rectangle"> + <description> + A bounding <reftopic>gfs:rectangle</reftopic> for an ellipse + from which the rendered chord is obtained. + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Fills an ellipse bounded by <arg1/> with the current background color. + </description> + <seealso> + <reftopic>gfg:background-color</reftopic> + <reftopic>gfg:foreground-color</reftopic> + <reftopic>gfg:pen-style</reftopic> + <reftopic>gfg:pen-width</reftopic> + </seealso> + </generic-function> + + <generic-function name="draw-line"> + <syntax> + <arguments> + <argument name="graphics-context"> + <description> + A <reftopic>gfg:graphics-context</reftopic> on which to draw. + </description> + </argument> + <argument name="start-point"> + <description> + A <reftopic>gfs:point</reftopic> indicating the beginning of the + line. + </description> + </argument> + <argument name="end-point"> + <description> + A <reftopic>gfs:point</reftopic> indicating the end of the + line. + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Draws a line between <arg1/> and <arg2/>. + </description> + <seealso> + <reftopic>gfg:foreground-color</reftopic> + <reftopic>gfg:miter-limit</reftopic> + <reftopic>gfg:pen-style</reftopic> + <reftopic>gfg:pen-width</reftopic> + </seealso> + </generic-function> + <generic-function name="load"> <syntax> <arguments>

1 0

[graphic-forms-cvs] r360 - trunk/docs/manual
by junrue＠common-lisp.net 20 Oct '06

20 Oct '06

Author: junrue Date: Thu Oct 19 20:40:25 2006 New Revision: 360 Added: trunk/docs/manual/constants.xml Modified: trunk/docs/manual/Makefile trunk/docs/manual/api.xml trunk/docs/manual/clhs-table.xml trunk/docs/manual/gfg-symbols.xml trunk/docs/manual/graphic-forms.xml Log: Modified: trunk/docs/manual/Makefile ============================================================================== --- trunk/docs/manual/Makefile (original) +++ trunk/docs/manual/Makefile Thu Oct 19 20:40:25 2006 @@ -5,6 +5,9 @@ # Copyright (c) 2006, Jack D. Unrue # +CHM-DEPS = gfs-tmp-pkg.xml gfg-tmp-pkg.xml gfw-tmp-pkg.xml constants.xml api.xml \ + catalog.xml glossary.xml graphic-forms.xml image-data-plugins.xml \ + introduction.xml legal.xml miscellaneous-topics.xml COMMON-DEPS = gf-data.xsl gf-package.xsl clhs-table.xml win32-api-table.xml TMP-XML = gfs-tmp-pkg.xml gfs-tmp-syms.xml gfg-tmp-pkg.xml gfg-tmp-syms.xml \ @@ -12,7 +15,7 @@ XSLT-PROC = xsltproc --nonet -graphic-forms.chm: gfs-tmp-pkg.xml gfg-tmp-pkg.xml gfw-tmp-pkg.xml +graphic-forms.chm: $(CHM-DEPS) $(XSLT-PROC) graphic-forms.xsl graphic-forms.xml -hhc htmlhelp.hhp; exit 0 # muffle Error Ignored msg due to hhc exit value 1 find . $ -name "*~" -o -name "*.html" -o -name "*.hhk" -o -name "*.hhc" -o -name "*.hhp" $ -exec rm {} \; Modified: trunk/docs/manual/api.xml ============================================================================== --- trunk/docs/manual/api.xml (original) +++ trunk/docs/manual/api.xml Thu Oct 19 20:40:25 2006 @@ -10,6 +10,7 @@ This chapter documents the Graphic-Forms programming interface. </para> + &constants; &gfgpkg; &gfspkg; &gfwpkg; Modified: trunk/docs/manual/clhs-table.xml ============================================================================== --- trunk/docs/manual/clhs-table.xml (original) +++ trunk/docs/manual/clhs-table.xml Thu Oct 19 20:40:25 2006 @@ -8,6 +8,7 @@ <clhs-table> <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"/> Added: trunk/docs/manual/constants.xml ============================================================================== --- (empty file) +++ trunk/docs/manual/constants.xml Thu Oct 19 20:40:25 2006 @@ -0,0 +1,80 @@ + +<chapter> + <title>Constants and Variables</title> + <indexterm><primary>constants</primary></indexterm> + + <para role="normal"> + This section lists the symbols for constants and variables exported from + each package. + </para> + + <bridgehead renderas="sect2">character sets [GFG]</bridgehead> + + <informaltable frame="none"> + <anchor id="character sets"/> + <indexterm><primary>character sets</primary></indexterm> + <tgroup cols="1"> + <tbody> + <row><entry><para role="normal">+ansi-charset+</para></entry></row> + <row><entry><para role="normal">+arabic-charset+</para></entry></row> + <row><entry><para role="normal">+baltic-charset+</para></entry></row> + <row><entry><para role="normal">+chinesebig5-charset+</para></entry></row> + <row><entry><para role="normal">+default-charset+</para></entry></row> + <row><entry><para role="normal">+easteurope-charset+</para></entry></row> + <row><entry><para role="normal">+gb2312-charset+</para></entry></row> + <row><entry><para role="normal">+greek-charset+</para></entry></row> + <row><entry><para role="normal">+hangeul-charset+</para></entry></row> + <row><entry><para role="normal">+hangul-charset+</para></entry></row> + <row><entry><para role="normal">+hebrew-charset+</para></entry></row> + <row><entry><para role="normal">+johab-charset+</para></entry></row> + <row><entry><para role="normal">+mac-charset+</para></entry></row> + <row><entry><para role="normal">+oem-charset+</para></entry></row> + <row><entry><para role="normal">+russian-charset+</para></entry></row> + <row><entry><para role="normal">+shiftjis-charset+</para></entry></row> + <row><entry><para role="normal">+symbol-charset+</para></entry></row> + <row><entry><para role="normal">+thai-charset+</para></entry></row> + <row><entry><para role="normal">+turkish-charset+</para></entry></row> + <row><entry><para role="normal">+vietnamese-charset+</para></entry></row> + </tbody> + </tgroup> + </informaltable> + + <bridgehead renderas="sect2">colors [GFG]</bridgehead> + + <informaltable frame="none"> + <anchor id="colors"/> + <indexterm><primary>colors</primary></indexterm> + <tgroup cols="1"> + <tbody> + <row><entry><para role="normal">*color-black*</para></entry></row> + <row><entry><para role="normal">*color-blue*</para></entry></row> + <row><entry><para role="normal">*color-green*</para></entry></row> + <row><entry><para role="normal">*color-red*</para></entry></row> + <row><entry><para role="normal">*color-white*</para></entry></row> + </tbody> + </tgroup> + </informaltable> + + <bridgehead renderas="sect2">system icons [GFG]</bridgehead> + + <informaltable frame="none"> + <anchor id="system icons"/> + <indexterm><primary>system icons</primary></indexterm> + <tgroup cols="1"> + <tbody> + <row><entry><para role="normal">+application-icon+</para></entry></row> + <row><entry><para role="normal">+error-icon+</para></entry></row> + <row><entry><para role="normal">+information-icon+</para></entry></row> + <row><entry><para role="normal">+question-icon+</para></entry></row> + <row><entry><para role="normal">+warning-icon+</para></entry></row> + </tbody> + </tgroup> + </informaltable> + + <para role="normal"/> + +</chapter> Modified: trunk/docs/manual/gfg-symbols.xml ============================================================================== --- trunk/docs/manual/gfg-symbols.xml (original) +++ trunk/docs/manual/gfg-symbols.xml Thu Oct 19 20:40:25 2006 @@ -143,7 +143,7 @@ </argument> <argument name=":system"> <description> - An icon identifier constant. + A <reftopic label="system icon">system icons</reftopic> constant. </description> </argument> <argument name=":transparency-pixel"> @@ -437,7 +437,7 @@ <arguments> <argument name=":char-set"> <description> - A <reftopic label="character set">xxx</reftopic> constant value. + A <reftopic>character sets</reftopic> constant value. </description> </argument> <notarg name="integer"/> @@ -738,6 +738,47 @@  + <generic-function name="load"> + <syntax> + <arguments> + <argument name="self"> + <description> + The object to be populated with data. + </description> + </argument> + <argument name="pathname"> + <description> + A <refclhs>string</refclhs> or <refclhs>pathname</refclhs> + identifying the graphics data file to be loaded. + </description> + </argument> + </arguments> + <return> + <refclhs>list</refclhs> + </return> + </syntax> + <description> + <para role="normal"> + Certain graphics objects have a persistent representation, which may + be deserialized with the appropriate implementation of this function. + <arg0/> will be re-initialized with data from the file identified by + <arg1/>. Certain serialized object formats (e.g., ICO) may actually + describe multiple instances. To facilitate such formats, this function + returns <arg0/> plus any additional instances in a <refclhs>list</refclhs>, + ordered the same as they are read from the file. + </para> + + <para role="normal"> + Note: this symbol shadows the Common Lisp symbol of the same name. + </para> + </description> + <seealso> + <reftopic>gfg:image-data</reftopic> + <reftopic>Image Data Plugins</reftopic> + <reftopic>gfg:image</reftopic> + </seealso> + </generic-function> + <generic-function name="font"> <syntax with-setf="t"> <arguments> @@ -1088,6 +1129,34 @@ </seealso> </slot-accessor> + <slot-accessor name="miter-limit"> + <syntax with-setf="t"> + <arguments> + <argument name="graphics-context"> + <description> + The <reftopic>gfg:graphics-context</reftopic> whose pen width + value is to be retrieved or set. + </description> + </argument> + </arguments> + <return> + <refclhs>float</refclhs> + </return> + </syntax> + <description> + Returns (sets) a <refclhs>float</refclhs> value describing the allowable + ratio of miter length to line width. The miter length is the distance + from the intersection of the line walls on the inside of a join to the + intersection of the line walls on the outside of the same join. The + default value is 10.0. This value affects the :miter-join pen style. + </description> + <seealso> + <reftopic>gfg:pen-style</reftopic> + <reftopic>gfg:pen-width</reftopic> + <reftopic>gfg:draw-line</reftopic> + </seealso> + </slot-accessor> +  <macro name="with-image-transparency"> Modified: trunk/docs/manual/graphic-forms.xml ============================================================================== --- trunk/docs/manual/graphic-forms.xml (original) +++ trunk/docs/manual/graphic-forms.xml Thu Oct 19 20:40:25 2006 @@ -9,6 +9,7 @@ <!ENTITY legal SYSTEM "legal.xml"> <!ENTITY introduction SYSTEM "introduction.xml"> <!ENTITY api SYSTEM "api.xml"> + <!ENTITY constants SYSTEM "constants.xml"> <!ENTITY gfgpkg SYSTEM "gfg-tmp-pkg.xml">  <!ENTITY gfspkg SYSTEM "gfs-tmp-pkg.xml">  <!ENTITY gfwpkg SYSTEM "gfw-tmp-pkg.xml">

1 0

[graphic-forms-cvs] r359 - trunk/docs/manual
by junrue＠common-lisp.net 19 Oct '06

19 Oct '06

Author: junrue Date: Thu Oct 19 19:30:29 2006 New Revision: 359 Modified: trunk/docs/manual/gfg-symbols.xml trunk/docs/manual/gfs-symbols.xml Log: Modified: trunk/docs/manual/gfg-symbols.xml ============================================================================== --- trunk/docs/manual/gfg-symbols.xml (original) +++ trunk/docs/manual/gfg-symbols.xml Thu Oct 19 19:30:29 2006 @@ -321,21 +321,134 @@  + <function name="icon-bundle-length"> + <syntax> + <arguments> + <argument name="icon-bundle"> + <description> + The <reftopic>gfg:icon-bundle</reftopic> whose length is to + be returned. + </description> + </argument> + </arguments> + <return> + <refclhs>integer</refclhs> + </return> + </syntax> + <description> + Returns the number of images in <arg0/>. + </description> + <seealso> + <reftopic>gfg:icon-image-ref</reftopic> + <reftopic>gfg:push-icon-image</reftopic> + <reftopic>gfg:image</reftopic> + </seealso> + </function> + + <function name="push-icon-image"> + <syntax> + <arguments> + <argument name="image"> + <description> + The <reftopic>gfg:image</reftopic> being added to <arg1/>. + </description> + </argument> + <argument name="icon-bundle"> + <description> + The <reftopic>gfg:icon-bundle</reftopic> taking ownership of + <arg0/>. + </description> + </argument> + <notarg name="&optional"/> + <argument name="point"> + <description> + The <reftopic>gfs:point</reftopic> specifying the location of + a pixel within <arg0/> whose color will be used to compute a + transparency mask. By default, the pixel at (0, 0) will be used. + </description> + </argument> + </arguments> + <return> + <reftopic>gfg:icon-bundle</reftopic> + </return> + </syntax> + <description> + Use this function to add a new <reftopic>gfg:image</reftopic> to + <arg1/> (which assumes ownership of <arg0/>). + </description> + <seealso> + <reftopic>gfg:icon-image-ref</reftopic> + <reftopic>gfg:icon-bundle-length</reftopic> + </seealso> + </function> + + <function name="icon-image-ref"> + <syntax with-setf="t"> + <arguments> + <argument name="icon-bundle"> + <description> + The <reftopic>gfg:icon-bundle</reftopic> from (into) which + a <reftopic>gfg:image</reftopic> is to be retrieved (set). + </description> + </argument> + <argument name="subscript"> + <description> + Either a zero-based integer subscript, or one of the following + keyword symbols: + <enum> + <argument name=":large"> + <description> + Selects the largest image in <arg0/>. + </description> + </argument> + <argument name=":small"> + <description> + Selects the smallest image in <arg0/>. + </description> + </argument> + </enum> + </description> + </argument> + </arguments> + <return> + <reftopic>gfg:image</reftopic> + </return> + </syntax> + <description> + <para role="normal"> + This function allows images within <arg0/> to be retrieved or + set via a subscript. + </para> + <para role="normal"> + Note: there are actually four icon sizes that Windows defines + for use in various contexts. A future release of Graphic-Forms + will add keywords to better distinguish amongst all four, and + to help ensure selection of the appropriate size. + </para> + </description> + <seealso> + <reftopic>gfg:icon-bundle-length</reftopic> + <reftopic>gfg:push-icon-image</reftopic> + </seealso> + </function> + <function name="make-font-data"> <syntax> <arguments> - <argument name=":char-set integer"> + <argument name=":char-set"> <description> A <reftopic label="character set">xxx</reftopic> constant value. </description> </argument> - <argument name=":face-name string"> + <notarg name="integer"/> + <argument name=":face-name"> <description> A <refclhs>string</refclhs> representing a font face name, such as "Times New Roman". </description> </argument> - <argument name=":point-size integer"> + <notarg name="string"/> + <argument name=":point-size"> <description> An <refclhs>integer</refclhs> value representing a font point size. The value 0 is a special instruction to the font mapper to @@ -343,7 +456,8 @@ <arg0/> and <arg3/> values. </description> </argument> - <argument name=":style list"> + <notarg name="integer"/> + <argument name=":style"> <description> A <refclhs>list</refclhs> of keyword symbols that further specify attributes of the desired font: @@ -378,6 +492,7 @@ </enum> </description> </argument> + <notarg name="list"/> </arguments> <return> <reftopic>gfg:font-data</reftopic> @@ -415,24 +530,104 @@ </seealso> </function> + <function name="make-font-metrics"> + <syntax> + <arguments> + <argument name=":ascent"> + <description> + An <refclhs>integer</refclhs> specifying units above the character + baseline. + </description> + </argument> + <notarg name="integer"/> + <argument name=":avg-char-width"> + <description> + An <refclhs>integer</refclhs> specifying the average width of + characters. Does not include overhang required for bold or italic. + </description> + </argument> + <notarg name="integer"/> + <argument name=":descent"> + <description> + An <refclhs>integer</refclhs> specifying units below the + character baseline. + </description> + </argument> + <notarg name="integer"/> + <argument name=":leading"> + <description> + An <refclhs>integer</refclhs> specifying the amount of extra space + added between rows of text. + </description> + </argument> + <notarg name="integer"/> + <argument name=":max-char-width"> + <description> + An <refclhs>integer</refclhs> specifying the width of the widest + character in the font. + </description> + </argument> + <notarg name="integer"/> + </arguments> + <return> + <reftopic label="new font-metrics">gfg:font-metrics</reftopic> + </return> + </syntax> + <description> + Returns a new <reftopic>gfg:font-metrics</reftopic> object. + </description> + <seealso> + <reftopic>gfg:copy-font-metrics</reftopic> + <reftopic>gfg:font</reftopic> + <reftopic>gfg:metrics</reftopic> + </seealso> + </function> + + <function name="copy-font-metrics"> + <syntax> + <arguments> + <argument name="font-metrics"> + <description> + The <reftopic>gfg:font-metrics</reftopic> structure to be copied. + </description> + </argument> + </arguments> + <return> + <reftopic label="new font-metrics">gfg:font-metrics</reftopic> + </return> + </syntax> + <description> + Returns a new <reftopic>gfg:font-metrics</reftopic> whose slot values + were copied from <arg0/>. + </description> + <seealso> + <reftopic>gfg:make-font-metrics</reftopic> + <reftopic>gfg:font</reftopic> + <reftopic>gfg:metrics</reftopic> + </seealso> + </function> + <function name="make-color"> <syntax> <arguments> - <argument name=":blue integer"> + <argument name=":blue"> <description> An <refclhs>integer</refclhs> specifying the blue color component. </description> </argument> - <argument name=":green integer"> + <notarg name="integer"/> + <argument name=":green"> <description> An <refclhs>integer</refclhs> specifying the green color component. </description> </argument> - <argument name=":red integer"> + <notarg name="integer"/> + <argument name=":red"> <description> An <refclhs>integer</refclhs> specifying the red color component. </description> </argument> + <notarg name="integer"/> </arguments> <return> <reftopic>gfg:color</reftopic> @@ -543,6 +738,24 @@  + <generic-function name="font"> + <syntax with-setf="t"> + <arguments> + <argument name="self"> + <description> + The object whose font is to be set or queried. + </description> + </argument> + </arguments> + <return> + <reftopic>gfg:font</reftopic> + </return> + </syntax> + <description> + Returns (sets) the <reftopic>gfg:font</reftopic> of <arg0/>. + </description> + </generic-function> + <generic-function name="transparency-mask"> <syntax> <arguments> @@ -772,6 +985,109 @@  + <slot-accessor name="pen-style"> + <syntax with-setf="t"> + <arguments> + <argument name="graphics-context"> + <description> + The <reftopic>gfg:graphics-context</reftopic> whose pen style + is to be retrieved or set. + </description> + </argument> + </arguments> + <return> + <refclhs>list</refclhs> + </return> + </syntax> + <description> + <para role="normal"> + Returns (sets) a list of keyword symbols that configure <arg0/>'s + line drawing mode, as described below. + </para> + + <para role="normal">One of the following primary styles:</para> + <enum> + <argument name=":alternate"> + <description>Every other pixel is set.</description> + </argument> + <argument name=":dash"> + <description>Dashed line.</description> + </argument> + <argument name=":dashdot"> + <description>Alternating dashes and dots.</description> + </argument> + <argument name=":dashdotdot"> + <description>Alternating dashes and double dots.</description> + </argument> + <argument name=":dot"> + <description>Dotted line.</description> + </argument> + <argument name=":solid"> + <description>Solid line.</description> + </argument> + </enum> + + <para role="normal">One of the following end cap styles:</para> + <enum> + <argument name=":flat-endcap"/> + <argument name=":round-endcap"/> + <argument name=":square-endcap"/> + </enum> + + <para role="normal">One of the following end cap styles:</para> + <enum> + <argument name=":bevel-join"> + <description>Beveled joins.</description> + </argument> + <argument name=":miter-join"> + <description> + Mitered joins if the ratio of miter length to + line width is within <reftopic>gfg:miter-limit</reftopic>. + </description> + </argument> + <argument name=":round-join"> + <description>Rounded joins.</description> + </argument> + </enum> + + <para role="normal"> + The default style is '(:flat :square-endcap :round-bevel). Specifying + NIL is equivalent to selecting the Win32 PS_NULL pen style, meaning + that the pen is invisible. + </para> + </description> + <seealso> + <reftopic>gfg:miter-limit</reftopic> + <reftopic>gfg:pen-width</reftopic> + </seealso> + </slot-accessor> + + <slot-accessor name="pen-width"> + <syntax with-setf="t"> + <arguments> + <argument name="graphics-context"> + <description> + The <reftopic>gfg:graphics-context</reftopic> whose pen width + value is to be retrieved or set. + </description> + </argument> + </arguments> + <return> + <refclhs>integer</refclhs> + </return> + </syntax> + <description> + Returns (sets) an <refclhs>integer</refclhs> value determining the width + of a drawn line. The minimum supported value is 0, which configures the + underlying device context to draw 1-pixel-wide lines using an optimized + drawing algorithm. + </description> + <seealso> + <reftopic>gfg:pen-style</reftopic> + <reftopic>gfg:draw-line</reftopic> + </seealso> + </slot-accessor> +  <macro name="with-image-transparency"> Modified: trunk/docs/manual/gfs-symbols.xml ============================================================================== --- trunk/docs/manual/gfs-symbols.xml (original) +++ trunk/docs/manual/gfs-symbols.xml Thu Oct 19 19:30:29 2006 @@ -303,16 +303,18 @@ <function name="make-point"> <syntax> <arguments> - <argument name=":x integer"> + <argument name=":x"> <description> An <refclhs>integer</refclhs> specifying the X coordinate. </description> </argument> - <argument name=":y integer"> + <notarg name="integer"/> + <argument name=":y"> <description> An <refclhs>integer</refclhs> specifying the Y coordinate. </description> </argument> + <notarg name="integer"/> </arguments> <return> <reftopic label="new point">gfs:point</reftopic> @@ -399,18 +401,20 @@ <function name="make-rectangle"> <syntax> <arguments> - <argument name=":location point"> + <argument name=":location"> <description> An <reftopic>gfs:point</reftopic> specifying the coordinates of the upper-left corner of the rectangle. </description> </argument> - <argument name=":size size"> + <notarg name="point"/> + <argument name=":size"> <description> A <reftopic>gfs:size</reftopic> specifing the dimensions of the rectangle. </description> </argument> + <notarg name="size"/> </arguments> <return> <reftopic label="new rectangle">gfs:rectangle</reftopic> @@ -472,16 +476,18 @@ <function name="make-size"> <syntax> <arguments> - <argument name=":height integer"> + <argument name=":height"> <description> An <refclhs>integer</refclhs> specifying the height. </description> </argument> - <argument name=":width integer"> + <notarg name="integer"/> + <argument name=":width"> <description> An <refclhs>integer</refclhs> specifying the width. </description> </argument> + <notarg name="integer"/> </arguments> <return> <reftopic label="new size">gfs:size</reftopic> @@ -521,16 +527,18 @@ <function name="make-span"> <syntax> <arguments> - <argument name=":end integer"> + <argument name=":end"> <description> An <refclhs>integer</refclhs> specifying the ending value. </description> </argument> - <argument name=":start integer"> + <notarg name="integer"/> + <argument name=":start"> <description> An <refclhs>integer</refclhs> specifying the starting value. </description> </argument> + <notarg name="integer"/> </arguments> <return> <reftopic label="new span">gfs:span</reftopic>

1 0

[graphic-forms-cvs] r358 - trunk/docs/manual
by junrue＠common-lisp.net 19 Oct '06

19 Oct '06

Author: junrue Date: Thu Oct 19 18:06:04 2006 New Revision: 358 Modified: trunk/docs/manual/gf-data.xsl trunk/docs/manual/gfg-symbols.xml Log: better handling of optional and macro body argument specifications Modified: trunk/docs/manual/gf-data.xsl ============================================================================== --- trunk/docs/manual/gf-data.xsl (original) +++ trunk/docs/manual/gf-data.xsl Thu Oct 19 18:06:04 2006 @@ -200,7 +200,7 @@ <xsl:attribute name="role">normal</xsl:attribute> (<xsl:value-of select="concat(../../@name,':',../@name)"/> <xsl:element name="emphasis"> - <xsl:for-each select="arguments/argument"> + <xsl:for-each select="arguments/argument | arguments/notarg"> <xsl:value-of select="concat(' ', @name)"/> </xsl:for-each> </xsl:element>) => Modified: trunk/docs/manual/gfg-symbols.xml ============================================================================== --- trunk/docs/manual/gfg-symbols.xml (original) +++ trunk/docs/manual/gfg-symbols.xml Thu Oct 19 18:06:04 2006 @@ -543,14 +543,126 @@  + <generic-function name="transparency-mask"> + <syntax> + <arguments> + <argument name="self"> + <description> + The object from which a transparency mask is to be computed. + </description> + </argument> + </arguments> + <return> + <reftopic>gfg:image</reftopic> + </return> + </syntax> + <description> + Returns a <reftopic label="new image">gfg:image</reftopic> that can + serve as the transparency mask for <arg0/>, based on the value of + <arg0/>'s transparency-pixel slot. + </description> + <seealso> + <reftopic>gfg:with-transparency-pixel</reftopic> + </seealso> + </generic-function> + + <generic-function name="depth"> + <syntax> + <arguments> + <argument name="self"> + <description> + The object whose bits-per-pixel depth value is to be queried. + </description> + </argument> + </arguments> + <return> + <refclhs>integer</refclhs> + </return> + </syntax> + <description> + Returns the bits-per-pixel depth of <arg0/>. + </description> + <seealso> + <reftopic>gfg:size</reftopic> + </seealso> + </generic-function> + + <generic-function name="size"> + <syntax> + <arguments> + <argument name="self"> + <description> + The object whose dimensions are to be set or queried. + </description> + </argument> + </arguments> + <return> + <reftopic>gfs:size</reftopic> + </return> + </syntax> + <description> + Returns (sets) the size of <arg0/>. + </description> + <seealso> + <reftopic>gfg:depth</reftopic> + </seealso> + </generic-function> + + <generic-function name="background-color"> + <syntax with-setf="t"> + <arguments> + <argument name="self"> + <description> + The object whose background color is to be set or queried. + </description> + </argument> + </arguments> + <return> + <reftopic>gfg:color</reftopic> + </return> + </syntax> + <description> + Returns (sets) the background color of <arg0/>, used when filling the + interior of closed shapes. + </description> + <seealso> + <reftopic>gfg:foreground-color</reftopic> + <reftopic>gfg:graphics-context</reftopic> + </seealso> + </generic-function> + + <generic-function name="foreground-color"> + <syntax with-setf="t"> + <arguments> + <argument name="self"> + <description> + The object whose foreground color is to be set or queried. + </description> + </argument> + </arguments> + <return> + <reftopic>gfg:color</reftopic> + </return> + </syntax> + <description> + Returns (sets) the foreground color of <arg0/>, used when drawing + lines and rendering text. + </description> + <seealso> + <reftopic>gfg:background-color</reftopic> + <reftopic>gfg:graphics-context</reftopic> + </seealso> + </generic-function> + <generic-function name="data-object"> <syntax> <arguments> - <argument name="self &optional"> + <argument name="self"> <description> The object from which to retrieve (or set) an abstract representation. </description> </argument> + <notarg name="&optional"/> <argument name="graphics-context"> <description> A <reftopic>gfg:graphics-context</reftopic> object. @@ -610,11 +722,12 @@ The context for measuring the extent of <arg1/>. </description> </argument> - <argument name="string &optional"> + <argument name="string"> <description> The <refclhs>string</refclhs> whose pixel dimensions are to be computed. </description> </argument> + <notarg name="&optional"/> <argument name="style"> <description> A <refclhs>list</refclhs> containing zero or more of the following @@ -661,6 +774,45 @@  + <macro name="with-image-transparency"> + <syntax> + <arguments> + <notarg name="("/> + <argument name="image"> + <description> + A <reftopic>gfg:image</reftopic> to have its transparency + pixel set and then used in <arg2/>. + </description> + </argument> + <argument name="point"> + <description> + A <reftopic>gfs:point</reftopic> identifying the pixel of + <arg0/> whose color will be used to create a transparency + mask. + </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 wraps <arg2/> in an unwind-protect form with <arg1/> + set as the transparency pixel for <arg0/>. The original point + set in <arg0/>, if any, is restored after <arg2/> completes. + </description> + <seealso> + <reftopic>gfg:transparency-mask</reftopic> + </seealso> + </macro> + <macro name="color->rgb"> <syntax> <arguments>

1 0

[graphic-forms-cvs] r357 - trunk/docs/manual
by junrue＠common-lisp.net 19 Oct '06

19 Oct '06

Author: junrue Date: Thu Oct 19 16:48:21 2006 New Revision: 357 Modified: trunk/docs/manual/Makefile trunk/docs/manual/gf-data.xsl trunk/docs/manual/gfg-symbols.xml Log: fixed bug with multi-argument function syntaxes and setf syntax generation; more symbols documented Modified: trunk/docs/manual/Makefile ============================================================================== --- trunk/docs/manual/Makefile (original) +++ trunk/docs/manual/Makefile Thu Oct 19 16:48:21 2006 @@ -15,6 +15,7 @@ graphic-forms.chm: gfs-tmp-pkg.xml gfg-tmp-pkg.xml gfw-tmp-pkg.xml $(XSLT-PROC) graphic-forms.xsl graphic-forms.xml -hhc htmlhelp.hhp; exit 0 # muffle Error Ignored msg due to hhc exit value 1 + find . $ -name "*~" -o -name "*.html" -o -name "*.hhk" -o -name "*.hhc" -o -name "*.hhp" $ -exec rm {} \; gfs-tmp-syms.xml: gfs-symbols.xml $(COMMON-DEPS) $(XSLT-PROC) --output $@ gf-data.xsl gfs-symbols.xml Modified: trunk/docs/manual/gf-data.xsl ============================================================================== --- trunk/docs/manual/gf-data.xsl (original) +++ trunk/docs/manual/gf-data.xsl Thu Oct 19 16:48:21 2006 @@ -43,6 +43,13 @@ </xsl:copy> </xsl:template> + <xsl:template match="emphasis"> + <xsl:copy> + <xsl:copy-of select="@*"/> + <xsl:apply-templates/> + </xsl:copy> + </xsl:template> + <xsl:template name="emit-table"> <xsl:param name="col2-width"/> @@ -205,18 +212,27 @@ <xsl:if test="@with-setf"> <xsl:element name="para"> <xsl:attribute name="role">normal</xsl:attribute> - (setf (<xsl:value-of select="concat(../../@name,':',../@name)"/> - <xsl:element name="emphasis"> - <xsl:for-each select="arguments/argument"> - <xsl:value-of select="concat(' ', @name)"/> - </xsl:for-each> - </xsl:element>) + (setf (<xsl:value-of select="concat(../../@name,':',../@name,' ')"/> + <emphasis> + <xsl:call-template name="first-word"> + <xsl:with-param name="raw-text" select="arguments/argument[1]/@name"/> + </xsl:call-template> + </emphasis>) + <emphasis> + <xsl:for-each select="arguments/argument"> + <xsl:if test="position() > 1"> + <xsl:value-of select="concat(' ', @name)"/> + </xsl:if> + </xsl:for-each> + </emphasis> <xsl:element name="emphasis"> <xsl:apply-templates select="return"/> </xsl:element>) </xsl:element> </xsl:if> + <xsl:apply-templates select="para"/> + <xsl:apply-templates select="arguments"/> </xsl:template> Modified: trunk/docs/manual/gfg-symbols.xml ============================================================================== --- trunk/docs/manual/gfg-symbols.xml (original) +++ trunk/docs/manual/gfg-symbols.xml Thu Oct 19 16:48:21 2006 @@ -321,8 +321,260 @@  + <function name="make-font-data"> + <syntax> + <arguments> + <argument name=":char-set integer"> + <description> + A <reftopic label="character set">xxx</reftopic> constant value. + </description> + </argument> + <argument name=":face-name string"> + <description> + A <refclhs>string</refclhs> representing a font face name, such + as "Times New Roman". + </description> + </argument> + <argument name=":point-size integer"> + <description> + An <refclhs>integer</refclhs> value representing a font point + size. The value 0 is a special instruction to the font mapper to + return a font in the default size corresponding to the specified + <arg0/> and <arg3/> values. + </description> + </argument> + <argument name=":style list"> + <description> + A <refclhs>list</refclhs> of keyword symbols that further specify + attributes of the desired font: + <enum> + <argument name=":bold"> + <description>weight, see also :normal</description> + </argument> + <argument name=":fixed"> + <description>pitch, see also :variable</description> + </argument> + <argument name=":italic"> + <description></description> + </argument> + <argument name=":normal"> + <description>weight, see also :bold</description> + </argument> + <argument name=":outline"> + <description>precision, see also :truetype-only</description> + </argument> + <argument name=":strikeout"> + <description></description> + </argument> + <argument name=":truetype-only"> + <description>precision, see also :outline</description> + </argument> + <argument name=":underline"> + <description></description> + </argument> + <argument name=":variable"> + <description>pitch, see also :fixed</description> + </argument> + </enum> + </description> + </argument> + </arguments> + <return> + <reftopic>gfg:font-data</reftopic> + </return> + </syntax> + <description> + Returns a new <reftopic>gfg:font-data</reftopic>. + </description> + <seealso> + <reftopic>gfg:copy-font-data</reftopic> + <reftopic>gfg:font</reftopic> + </seealso> + </function> + + <function name="copy-font-data"> + <syntax> + <arguments> + <argument name="font-data"> + <description> + The <reftopic>gfg:font-data</reftopic> structure to be copied. + </description> + </argument> + </arguments> + <return> + <reftopic label="new font-data">gfg:font-data</reftopic> + </return> + </syntax> + <description> + Returns a new <reftopic>gfg:font-data</reftopic> whose slot values + were copied from <arg0/>. + </description> + <seealso> + <reftopic>gfg:make-font-data</reftopic> + <reftopic>gfg:font</reftopic> + </seealso> + </function> + + <function name="make-color"> + <syntax> + <arguments> + <argument name=":blue integer"> + <description> + An <refclhs>integer</refclhs> specifying the blue color component. + </description> + </argument> + <argument name=":green integer"> + <description> + An <refclhs>integer</refclhs> specifying the green color component. + </description> + </argument> + <argument name=":red integer"> + <description> + An <refclhs>integer</refclhs> specifying the red color component. + </description> + </argument> + </arguments> + <return> + <reftopic>gfg:color</reftopic> + </return> + </syntax> + <description> + Returns a new <reftopic>gfg:color</reftopic>. Note that all color component + values are specified in the range 0 - 255. + </description> + <seealso> + <reftopic>gfg:copy-color</reftopic> + </seealso> + </function> + + <function name="copy-color"> + <syntax> + <arguments> + <argument name="color"> + <description> + The <reftopic>gfg:color</reftopic> structure to be copied. + </description> + </argument> + </arguments> + <return> + <reftopic label="new color">gfg:color</reftopic> + </return> + </syntax> + <description> + Returns a new <reftopic>gfg:color</reftopic> whose blue, green, and + red values were copied from <arg0/>. + </description> + <seealso> + <reftopic>gfg:make-color</reftopic> + </seealso> + </function> + + <function name="color-blue"> + <syntax with-setf="t"> + <arguments> + <argument name="color"> + <description> + The <reftopic>gfg:color</reftopic> object whose blue component is + to be queried. + </description> + </argument> + </arguments> + <return> + <refclhs>integer</refclhs> + </return> + </syntax> + <description> + Returns (sets) the blue component of <arg0/>. + </description> + <seealso> + <reftopic>gfg:color-green</reftopic> + <reftopic>gfg:color-red</reftopic> + <reftopic>gfg:make-color</reftopic> + </seealso> + </function> + + <function name="color-green"> + <syntax with-setf="t"> + <arguments> + <argument name="color"> + <description> + The <reftopic>gfg:color</reftopic> object whose green component is + to be queried. + </description> + </argument> + </arguments> + <return> + <refclhs>integer</refclhs> + </return> + </syntax> + <description> + Returns (sets) the green component of <arg0/>. + </description> + <seealso> + <reftopic>gfg:color-red</reftopic> + <reftopic>gfg:color-blue</reftopic> + <reftopic>gfg:make-color</reftopic> + </seealso> + </function> + + <function name="color-red"> + <syntax with-setf="t"> + <arguments> + <argument name="color"> + <description> + The <reftopic>gfg:color</reftopic> object whose red component is + to be queried. + </description> + </argument> + </arguments> + <return> + <refclhs>integer</refclhs> + </return> + </syntax> + <description> + Returns (sets) the red component of <arg0/>. + </description> + <seealso> + <reftopic>gfg:color-green</reftopic> + <reftopic>gfg:color-blue</reftopic> + <reftopic>gfg:make-color</reftopic> + </seealso> + </function> +  + <generic-function name="data-object"> + <syntax> + <arguments> + <argument name="self &optional"> + <description> + The object from which to retrieve (or set) an abstract representation. + </description> + </argument> + <argument name="graphics-context"> + <description> + A <reftopic>gfg:graphics-context</reftopic> object. + </description> + </argument> + </arguments> + <return> + <emphasis>object</emphasis> + </return> + <para role="normal"> + (setf (gfg:data-object <emphasis>self</emphasis>) <emphasis>object</emphasis>) + </para> + </syntax> + <description> + Returns (sets) the abstract representation of <arg0/>. <arg1/> is + required when <arg0/> is a <reftopic>gfg:font</reftopic>. + </description> + <seealso> + <reftopic>gfg:font-data</reftopic> + <reftopic>gfg:image-data</reftopic> + <reftopic>gfg:image</reftopic> + </seealso> + </generic-function> + <generic-function name="metrics"> <syntax> <arguments> @@ -424,7 +676,7 @@ </return> </syntax> <description> - This macro converts a <reftopic>gfg:color</reftopic> to the Win32 + This macro converts <arg0/> to the Win32 <refwin32api>COLORREF</refwin32api> representation, which in CFFI terms is defined as an alias for the :unsigned-long type. </description>

1 0

[graphic-forms-cvs] r356 - trunk/docs/manual
by junrue＠common-lisp.net 19 Oct '06

19 Oct '06

Author: junrue Date: Thu Oct 19 15:15:23 2006 New Revision: 356 Modified: trunk/docs/manual/gf-data.xsl trunk/docs/manual/gf-utils.xsl trunk/docs/manual/gfg-symbols.xml trunk/docs/manual/gfs-symbols.xml Log: replaced refargument template with arg0-arg6 templates Modified: trunk/docs/manual/gf-data.xsl ============================================================================== --- trunk/docs/manual/gf-data.xsl (original) +++ trunk/docs/manual/gf-data.xsl Thu Oct 19 15:15:23 2006 @@ -65,24 +65,88 @@ </xsl:element> </xsl:template> - - <xsl:template match="refargument"> - <xsl:element name="emphasis"> - <xsl:value-of select="."/> - </xsl:element> + <xsl:template match="arg1"> + <xsl:call-template name="find-arg"> + <xsl:with-param name="index">2</xsl:with-param> + </xsl:call-template> + </xsl:template> + + <xsl:template match="arg2"> + <xsl:call-template name="find-arg"> + <xsl:with-param name="index">3</xsl:with-param> + </xsl:call-template> + </xsl:template> + + <xsl:template match="arg3"> + <xsl:call-template name="find-arg"> + <xsl:with-param name="index">4</xsl:with-param> + </xsl:call-template> + </xsl:template> + + <xsl:template match="arg4"> + <xsl:call-template name="find-arg"> + <xsl:with-param name="index">5</xsl:with-param> + </xsl:call-template> + </xsl:template> + + <xsl:template match="arg5"> + <xsl:call-template name="find-arg"> + <xsl:with-param name="index">6</xsl:with-param> + </xsl:call-template> + </xsl:template> + + <xsl:template match="arg6"> + <xsl:call-template name="find-arg"> + <xsl:with-param name="index">7</xsl:with-param> + </xsl:call-template> </xsl:template> <xsl:template match="reftopic"> @@ -163,14 +227,9 @@ <xsl:element name="para"> <xsl:attribute name="role">normal</xsl:attribute> <xsl:element name="emphasis"> - <xsl:choose> - <xsl:when test="contains(@name,' ')"> - <xsl:value-of select="substring-before(@name,' ')"/> - </xsl:when> - <xsl:otherwise> - <xsl:value-of select="@name"/> - </xsl:otherwise> - </xsl:choose> + <xsl:call-template name="first-word"> + <xsl:with-param name="raw-text"><xsl:value-of select="@name"/></xsl:with-param> + </xsl:call-template> </xsl:element> </xsl:element> </xsl:element> Modified: trunk/docs/manual/gf-utils.xsl ============================================================================== --- trunk/docs/manual/gf-utils.xsl (original) +++ trunk/docs/manual/gf-utils.xsl Thu Oct 19 15:15:23 2006 @@ -18,4 +18,16 @@ <xsl:value-of select="translate($orig-text,'abcdefghijklmnopqrstuvwxyz','ABCDEFGHIJKLMNOPQRSTUVWXYZ')"/> </xsl:template> + <xsl:template name="first-word"> + <xsl:param name="raw-text"/> + <xsl:choose> + <xsl:when test="contains($raw-text,' ')"> + <xsl:value-of select="substring-before($raw-text,' ')"/> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$raw-text"/> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + </xsl:stylesheet> Modified: trunk/docs/manual/gfg-symbols.xml ============================================================================== --- trunk/docs/manual/gfg-symbols.xml (original) +++ trunk/docs/manual/gfg-symbols.xml Thu Oct 19 15:15:23 2006 @@ -30,7 +30,7 @@ <argument name=":data"> <description> A <reftopic>gfg:font-data</reftopic> object. If this initarg - is specified, then a value for the <refargument>:gc</refargument> + is specified, then a value for the :gc initarg is also required. </description> </argument> @@ -38,7 +38,7 @@ <description> A <reftopic>gfg:graphics-context</reftopic> object. If this initarg is specified, then a value for the - <refargument>:data</refargument> initarg is also required. + :data initarg is also required. </description> </argument> <argument name=":handle"> @@ -125,7 +125,7 @@ that the ICO format can store multiple images, all of which will be loaded. Since icon-bundle needs a transparency mask for each image in order to create Windows icons, a value may be supplied for the - <refargument>:transparency-pixel</refargument> initarg of this class; + :transparency-pixel initarg of this class; otherwise, the pixel color at location (0, 0) in each image is used by default. </description> @@ -137,7 +137,7 @@ the application may either SETF <reftopic>gfg:transparency-pixel</reftopic> for each image ahead of time (especially important when the proper pixel location is different from one image to the next), or provide a value for - the <refargument>:transparency-pixel</refargument> initarg of this class. + the :transparency-pixel initarg of this class. By default, the pixel color at location (0, 0) in each image will be used. </description> </argument> @@ -328,7 +328,7 @@ <arguments> <argument name="context"> <description> - The context for retrieving the metrics of <refargument>font</refargument>. + The context for retrieving the metrics of <arg1/>. </description> </argument> <argument name="font"> @@ -343,7 +343,7 @@ </syntax> <description> Returns a <reftopic>gfg:font-metrics</reftopic> object describing - attributes of <refargument>font</refargument>. + attributes of <arg1/> using <arg0/>. </description> <seealso> <reftopic>gfg:text-extent</reftopic> @@ -355,7 +355,7 @@ <arguments> <argument name="context"> <description> - The context for measuring the extent of <refargument>string</refargument>. + The context for measuring the extent of <arg1/>. </description> </argument> <argument name="string &optional"> @@ -371,12 +371,12 @@ <argument name=":mnemonic"> <description> Underline the mnemonic character if any (preceded in - <refargument>string</refargument> with an ampersand). + <arg1/> with an ampersand). </description> </argument> <argument name=":tab"> <description> - Expand tabs when <refargument>string</refargument> is rendered; + Expand tabs when <arg1/> is rendered; by default the tab width is 8 characters. </description> </argument> @@ -396,9 +396,9 @@ </syntax> <description> Returns the size of a rectangular region that would enclose - <refargument>string</refargument> if it were drawn. These dimensions + <arg1/> if it were drawn. These dimensions are dependent on the <reftopic>gfg:font</reftopic> currently selected - in <refargument>context</refargument>. + in <arg0/>. </description> <seealso> <reftopic>gfg:font-metrics</reftopic> Modified: trunk/docs/manual/gfs-symbols.xml ============================================================================== --- trunk/docs/manual/gfs-symbols.xml (original) +++ trunk/docs/manual/gfs-symbols.xml Thu Oct 19 15:15:23 2006 @@ -341,7 +341,7 @@ </syntax> <description> Returns a new <reftopic>gfs:point</reftopic> whose X and Y coordinates - were copied from the original. + were copied from <arg0/>. </description> <seealso> <reftopic>gfs:make-point</reftopic> @@ -363,9 +363,8 @@ </syntax> <description> Returns (sets) the <reftopic>gfs:point</reftopic> identifying the coordinates - of the upper-left corner of <refargument>rectangle</refargument>. For - performance reasons, the existing slot value is returned directly rather - than being copied. + of the upper-left corner of <arg0/>. For performance reasons, the existing + slot value is returned directly rather than being copied. </description> <seealso> <reftopic>gfs:make-rectangle</reftopic> @@ -388,8 +387,8 @@ </syntax> <description> Returns (sets) the <reftopic>gfs:size</reftopic> identifying the dimensions - of <refargument>rectangle</refargument>. For performance reasons, the - existing slot value is returned directly rather than being copied. + of <arg0/>. For performance reasons, the existing slot value is returned + directly rather than being copied. </description> <seealso> <reftopic>gfs:make-rectangle</reftopic> @@ -440,7 +439,7 @@ </syntax> <description> Returns a new <reftopic>gfs:rectangle</reftopic> whose location and - dimension values were (shallow) copied from the original. + dimension values were (shallow) copied from <arg0/>. </description> <seealso> <reftopic>gfs:make-rectangle</reftopic> @@ -462,7 +461,7 @@ </syntax> <description> Returns a new <reftopic>gfs:size</reftopic> whose width and - height values were copied from the original. + height values were copied from <arg0/>. </description> <seealso> <reftopic>gfs:make-size</reftopic> @@ -512,7 +511,7 @@ </syntax> <description> Returns a new <reftopic>gfs:span</reftopic> whose start and - end values were copied from the original. + end values were copied from <arg0/>. </description> <seealso> <reftopic>gfs:make-span</reftopic> @@ -560,8 +559,7 @@ </return> </syntax> <description> - Returns T if the start and end of <refargument>span</refargument> - are the same value. + Returns T if the start and end of <arg0/> are the same value. </description> <seealso> <reftopic>gfs:span-start</reftopic> @@ -588,9 +586,7 @@ </return> </syntax> <description> - Returns T if <refargument>size1</refargument> and - <refargument>size2</refargument> have the same height and - width values. + Returns T if <arg0/> and <arg1/> have the same height and width values. </description> <seealso> <reftopic>gfs:copy-size</reftopic> @@ -617,9 +613,8 @@ </syntax> <description> <para role="normal"> - Returns T if <refargument>native-object</refargument> has not yet been - initialized or has been discarded via <reftopic>gfs:dispose</reftopic>; - NIL otherwise. + Returns T if <arg0/> has not yet been initialized or has been discarded + via <reftopic>gfs:dispose</reftopic>; NIL otherwise. </para> <para role="normal"> @@ -647,9 +642,9 @@ </syntax> <description> <para role="normal"> - Discards the system resource encapsulated by <reftopic>gfs:native-object</reftopic> - and cleans up various data structures internal to Graphic-Forms. For certain - objects, this method has visual side effects (for example, disposing + Discards the system resource held by <arg0/> and cleans up various + data structures internal to Graphic-Forms. For certain objects, this + method has visual side effects (for example, disposing a window will remove that window from the display). A <reftopic>gfs:disposed-error</reftopic> will be raised if application code attempts to manipulate the object @@ -684,7 +679,7 @@ </return> </syntax> <description> - Returns (sets) the X coordinate of <refargument>point</refargument>. + Returns (sets) the X coordinate of <arg0/>. </description> <seealso> <reftopic>gfs:point-y</reftopic> @@ -706,7 +701,7 @@ </return> </syntax> <description> - Returns (sets) the Y coordinate of <refargument>point</refargument>. + Returns (sets) the Y coordinate of <arg0/>. </description> <seealso> <reftopic>gfs:point-x</reftopic> @@ -728,7 +723,7 @@ </return> </syntax> <description> - Returns (sets) the width value of <refargument>size</refargument>. + Returns (sets) the width value of <arg0/>. </description> <seealso> <reftopic>gfs:size-height</reftopic> @@ -750,7 +745,7 @@ </return> </syntax> <description> - Returns (sets) the height value of <refargument>size</refargument>. + Returns (sets) the height value of <arg0/>. </description> <seealso> <reftopic>gfs:size-width</reftopic> @@ -772,7 +767,7 @@ </return> </syntax> <description> - Returns (sets) the starting value of <refargument>span</refargument>. + Returns (sets) the starting value of <arg0/>. </description> <seealso> <reftopic>gfs:span-end</reftopic> @@ -794,7 +789,7 @@ </return> </syntax> <description> - Returns (sets) the ending value of <refargument>span</refargument>. + Returns (sets) the ending value of <arg0/>. </description> <seealso> <reftopic>gfs:span-start</reftopic> @@ -816,8 +811,7 @@ </return> </syntax> <description> - Returns the Win32 HANDLE or foreign pointer associated with - <refargument>native-object</refargument>. + Returns the Win32 HANDLE or foreign pointer associated with <arg0/>. </description> <seealso> <reftopic>gfs:dispose</reftopic> @@ -840,9 +834,8 @@ </return> </syntax> <description> - Returns the Win32 error code for <refargument>condition</refargument> - as determined by the Common Dialog API function - <refwin32api>CommDlgExtendedError</refwin32api>. + Returns the Win32 error code for <arg0/> as determined by the Common + Dialog API function <refwin32api>CommDlgExtendedError</refwin32api>. </description> </slot-reader> @@ -861,8 +854,8 @@ </return> </syntax> <description> - Returns the Win32 error code for <refargument>condition</refargument> - as determined by <refwin32api>GetLastError</refwin32api>. + Returns the Win32 error code for <arg0/> as determined by + <refwin32api>GetLastError</refwin32api>. </description> </slot-reader> @@ -881,7 +874,7 @@ </return> </syntax> <description> - Returns the detail <refclhs>string</refclhs> for <refargument>condition</refargument>. + Returns the detail <refclhs>string</refclhs> for <arg0/>. </description> </slot-reader>

1 0