October 2006 - graphic-forms-cvs@common-lisp.net

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

21 Oct '06

Author: junrue Date: Sat Oct 21 18:38:30 2006 New Revision: 377 Modified: trunk/docs/manual/gf-data.xsl trunk/docs/manual/gf-package.xsl trunk/docs/manual/gfw-symbols.xml Log: Modified: trunk/docs/manual/gf-data.xsl ============================================================================== --- trunk/docs/manual/gf-data.xsl (original) +++ trunk/docs/manual/gf-data.xsl Sat Oct 21 18:38:30 2006 @@ -36,7 +36,7 @@ </xsl:element> </xsl:template> - <xsl:template match="para | emphasis | itemizedlist | listitem | ulink"> + <xsl:template match="para | emphasis | itemizedlist | listitem | ulink | code | programlisting"> <xsl:copy> <xsl:copy-of select="@*"/> <xsl:apply-templates/> Modified: trunk/docs/manual/gf-package.xsl ============================================================================== --- trunk/docs/manual/gf-package.xsl (original) +++ trunk/docs/manual/gf-package.xsl Sat Oct 21 18:38:30 2006 @@ -49,41 +49,75 @@ </xsl:element> </xsl:for-each> - <bridgehead renderas="sect2">classes and structures</bridgehead> - <para role="normal"> - <xsl:for-each select="/package/class | /package/structure"> - <xsl:sort select="@name" order="ascending" case-order="upper-first"/> - <xsl:element name="link"> - <xsl:attribute name="linkend"><xsl:value-of select="../@name"/>:<xsl:value-of select="@name"/></xsl:attribute> - <xsl:value-of select="@name"/> - </xsl:element> - <xsl:if test="not(position()=last())">, </xsl:if> - </xsl:for-each> - </para> - - <bridgehead renderas="sect2">accessors, functions, and macros</bridgehead> - <para role="normal"> - <xsl:for-each select="/package/function | /package/generic-function | /package/slot-accessor | /package/slot-reader | /package/macro"> - <xsl:sort select="@name" order="ascending" case-order="upper-first"/> - <xsl:element name="link"> - <xsl:attribute name="linkend"><xsl:value-of select="../@name"/>:<xsl:value-of select="@name"/></xsl:attribute> - <xsl:value-of select="@name"/> - </xsl:element> - <xsl:if test="not(position()=last())">, </xsl:if> - </xsl:for-each> - </para> - - <bridgehead renderas="sect2">conditions</bridgehead> - <para role="normal"> - <xsl:for-each select="/package/condition"> - <xsl:sort select="@name" order="ascending" case-order="upper-first"/> - <xsl:element name="link"> - <xsl:attribute name="linkend"><xsl:value-of select="../@name"/>:<xsl:value-of select="@name"/></xsl:attribute> - <xsl:value-of select="@name"/> - </xsl:element> - <xsl:if test="not(position()=last())">, </xsl:if> - </xsl:for-each> - </para> + <xsl:if test="/package/class | /package/structure"> + <bridgehead renderas="sect2">classes and structures</bridgehead> + <para role="normal"> + <xsl:for-each select="/package/class | /package/structure"> + <xsl:sort select="@name" order="ascending" case-order="upper-first"/> + <xsl:element name="link"> + <xsl:attribute name="linkend"><xsl:value-of select="../@name"/>:<xsl:value-of select="@name"/></xsl:attribute> + <xsl:value-of select="@name"/> + </xsl:element> + <xsl:if test="not(position()=last())">, </xsl:if> + </xsl:for-each> + </para> + </xsl:if> + + <xsl:if test="/package/generic-function"> + <bridgehead renderas="sect2">generic functions</bridgehead> + <para role="normal"> + <xsl:for-each select="/package/generic-function"> + <xsl:sort select="@name" order="ascending" case-order="upper-first"/> + <xsl:element name="link"> + <xsl:attribute name="linkend"><xsl:value-of select="../@name"/>:<xsl:value-of select="@name"/></xsl:attribute> + <xsl:value-of select="@name"/> + </xsl:element> + <xsl:if test="not(position()=last())">, </xsl:if> + </xsl:for-each> + </para> + </xsl:if> + + <xsl:if test="/package/function | /package/slot-accessor | /package/slot-reader"> + <bridgehead renderas="sect2">accessors and simple functions</bridgehead> + <para role="normal"> + <xsl:for-each select="/package/function | /package/slot-accessor | /package/slot-reader"> + <xsl:sort select="@name" order="ascending" case-order="upper-first"/> + <xsl:element name="link"> + <xsl:attribute name="linkend"><xsl:value-of select="../@name"/>:<xsl:value-of select="@name"/></xsl:attribute> + <xsl:value-of select="@name"/> + </xsl:element> + <xsl:if test="not(position()=last())">, </xsl:if> + </xsl:for-each> + </para> + </xsl:if> + + <xsl:if test="/package/macro"> + <bridgehead renderas="sect2">macros</bridgehead> + <para role="normal"> + <xsl:for-each select="/package/macro"> + <xsl:sort select="@name" order="ascending" case-order="upper-first"/> + <xsl:element name="link"> + <xsl:attribute name="linkend"><xsl:value-of select="../@name"/>:<xsl:value-of select="@name"/></xsl:attribute> + <xsl:value-of select="@name"/> + </xsl:element> + <xsl:if test="not(position()=last())">, </xsl:if> + </xsl:for-each> + </para> + </xsl:if> + + <xsl:if test="/package/condition"> + <bridgehead renderas="sect2">conditions</bridgehead> + <para role="normal"> + <xsl:for-each select="/package/condition"> + <xsl:sort select="@name" order="ascending" case-order="upper-first"/> + <xsl:element name="link"> + <xsl:attribute name="linkend"><xsl:value-of select="../@name"/>:<xsl:value-of select="@name"/></xsl:attribute> + <xsl:value-of select="@name"/> + </xsl:element> + <xsl:if test="not(position()=last())">, </xsl:if> + </xsl:for-each> + </para> + </xsl:if> <xsl:for-each select="document($symbol-file)/data/section"> <xsl:copy-of select="current()"/> Modified: trunk/docs/manual/gfw-symbols.xml ============================================================================== --- trunk/docs/manual/gfw-symbols.xml (original) +++ trunk/docs/manual/gfw-symbols.xml Sat Oct 21 18:38:30 2006 @@ -265,6 +265,10 @@ <seealso> <reftopic>gfs:dispose</reftopic> <reftopic>gfw:menu-item</reftopic> + <reftopic>gfw:append-item</reftopic> + <reftopic>gfw:append-separator</reftopic> + <reftopic>gfw:append-submenu</reftopic> + <reftopic>gfw:defmenu</reftopic> </seealso> </class> @@ -2389,6 +2393,198 @@  + <generic-function name="auto-hscroll-p"> + <syntax> + <arguments> + <argument name="self"> + <description> + An object with scrolling functionality. + </description> + </argument> + </arguments> + <return> + <refclhs>boolean</refclhs> + </return> + </syntax> + <description> + Returns T if <arg0/> is configured for automatic horizontal scrolling; + NIL otherwise. + </description> + <seealso> + <reftopic>gfw:enable-auto-scrolling</reftopic> + <reftopic>gfw:auto-vscroll-p</reftopic> + </seealso> + </generic-function> + + <generic-function name="auto-vscroll-p"> + <syntax> + <arguments> + <argument name="self"> + <description> + An object with scrolling functionality. + </description> + </argument> + </arguments> + <return> + <refclhs>boolean</refclhs> + </return> + </syntax> + <description> + Returns T if <arg0/> is configured for automatic vertical scrolling; + NIL otherwise. + </description> + <seealso> + <reftopic>gfw:enable-auto-scrolling</reftopic> + <reftopic>gfw:auto-hscroll-p</reftopic> + </seealso> + </generic-function> + + <generic-function name="append-item"> + <syntax> + <arguments> + <argument name="self"> + <description> + An instance of a subclass of <reftopic>gfw:item-manager</reftopic>. + </description> + </argument> + <argument name="thing"> + <description> + Any application-defined object. + </description> + </argument> + <argument name="dispatcher"> + <description> + Either an instance of <reftopic>gfw:event-dispatcher</reftopic> (or + a subclass thereof), or a function whose argument list matches the + event method identified by the <emphasis>callback-event-name</emphasis> + class-allocated slot of <arg0/>. + </description> + </argument> + <notarg name="&optional"/> + <argument name="disabled"> + <description> + A <refclhs>boolean</refclhs> indicating whether the item should be + initially disabled. + </description> + </argument> + <argument name="checked"> + <description> + A <refclhs>boolean</refclhs> indicating whether the item should be + initially checked. + </description> + </argument> + </arguments> + <return> + <reftopic>gfw:item</reftopic> + </return> + </syntax> + <description> + Adds a new item wrapping <arg1/> to <arg0/>. The newly-created + item is returned. Note that not all <reftopic>gfw:item-manager</reftopic> + subclasses support enabled or checked states for individual items. + </description> + <seealso> + <reftopic>gfw:menu</reftopic> + <reftopic>gfw:list-box</reftopic> + <reftopic>gfw:append-separator</reftopic> + <reftopic>gfw:append-submenu</reftopic> + <reftopic>gfw:defmenu</reftopic> + </seealso> + </generic-function> + + <generic-function name="append-separator"> + <syntax> + <arguments> + <argument name="self"> + <description> + An instance of a subclass of <reftopic>gfw:item-manager</reftopic>. + </description> + </argument> + </arguments> + <return> + <reftopic>gfw:item</reftopic> + </return> + </syntax> + <description> + Adds a separator to <arg0/>, and returns a newly-created item to wrap + the separator. A separator is a thin etched divider that serves to visually + separate groups of items; it generates no events. + </description> + <seealso> + <reftopic>gfw:append-item</reftopic> + <reftopic>gfw:append-submenu</reftopic> + <reftopic>gfw:menu</reftopic> + <reftopic>gfw:defmenu</reftopic> + </seealso> + </generic-function> + + <generic-function name="append-submenu"> + <syntax> + <arguments> + <argument name="self"> + <description> + A <reftopic>gfw:menu</reftopic> to which append a submenu. + </description> + </argument> + <argument name="text"> + <description> + A <refclhs>string</refclhs> providing the text for the submenu's + anchor. + </description> + </argument> + <argument name="submenu"> + <description> + A <reftopic>gfw:menu</reftopic> comprising a submenu to be + attached to <arg0/>. + </description> + </argument> + <argument name="dispatcher"> + <description> + Either an instance of <reftopic>gfw:event-dispatcher</reftopic> (or + a subclass thereof), or a function whose argument list matches the + event method identified by the <emphasis>callback-event-name</emphasis> + class-allocated slot of <arg0/>. + </description> + </argument> + <notarg name="&optional"/> + <argument name="disabled"> + <description> + A <refclhs>boolean</refclhs> indicating whether the submenu's + anchor should be initially disabled. + </description> + </argument> + </arguments> + <return> + <reftopic>gfw:menu-item</reftopic> + </return> + </syntax> + <description> + Adds <arg2/> anchored to <arg0/> and returns the corresponding + <reftopic>gfw:menu-item</reftopic>. + </description> + <seealso> + <reftopic>gfw:append-item</reftopic> + <reftopic>gfw:append-submenu</reftopic> + <reftopic>gfw:menu</reftopic> + <reftopic>gfw:defmenu</reftopic> + </seealso> + </generic-function> + + <generic-function name="ancestor-p"> + <syntax> + <arguments> + <argument name="ancestor"/> + <argument name="descendant"/> + </arguments> + <return> + <refclhs>boolean</refclhs> + </return> + </syntax> + <description> + Returns T if <arg0/> is the parent of <arg1/>; NIL otherwise. + </description> + </generic-function> + <generic-function name="event-activate"> <syntax> <arguments> @@ -3688,4 +3884,37 @@ </description> </macro> + <macro name="defmenu"> + <syntax> + <arguments> + <notarg name="("/> + <argument name="forms"> + <description> + Menu definition forms. + </description> + </argument> + <notarg name=")"/> + </arguments> + <return> + <reftopic>gfw:menu</reftopic> + </return> + </syntax> + <description> + This macro defines a language for constructing menu hierarchies. For example: + <programlisting language="lisp"> +(gfw:defmenu + ((:item "&File" :submenu ((:item "&Open...") + (:item "&Save..." :disabled) + (:item :separator) + (:item "E&xit" :callback #'some-fn))) + (:item "&Tools" :submenu ((:item "&Fonts" :disabled) + (:item "&Colors" :checked))) + (:item "&Help" :submenu ((:item "&About" :image some-image))))) + </programlisting> + </description> + <seealso> + <reftopic>gfw:menu-bar</reftopic> + </seealso> + </macro> + </package>

1 0

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

21 Oct '06

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

1 0

[graphic-forms-cvs] r375 - in trunk: . docs/manual src src/uitoolkit/widgets
by junrue＠common-lisp.net 21 Oct '06

21 Oct '06

Author: junrue Date: Sat Oct 21 14:46:35 2006 New Revision: 375 Modified: trunk/NEWS.txt trunk/docs/manual/gfw-symbols.xml trunk/src/packages.lisp trunk/src/uitoolkit/widgets/file-dialog.lisp trunk/src/uitoolkit/widgets/font-dialog.lisp Log: Modified: trunk/NEWS.txt ============================================================================== --- trunk/NEWS.txt (original) +++ trunk/NEWS.txt Sat Oct 21 14:46:35 2006 @@ -35,6 +35,9 @@ . Implemented stand-alone scrollbar and slider control types. +. Renamed functions that query the standard color, file, and font dialogs + to make their naming scheme more consistent. + . Implemented GFW:EVENT-PRE-RESIZE function so that applications can customize the behavior of a window's size drag rectangle. Modified: trunk/docs/manual/gfw-symbols.xml ============================================================================== --- trunk/docs/manual/gfw-symbols.xml (original) +++ trunk/docs/manual/gfw-symbols.xml Sat Oct 21 14:46:35 2006 @@ -2188,7 +2188,7 @@ </description> </function> - <function name="obtain-file-dialog-paths"> + <function name="obtain-chosen-files"> <syntax> <arguments> <argument name="file-dialog"> @@ -2212,7 +2212,7 @@ </seealso> </function> - <function name="obtain-font-dialog-results"> + <function name="obtain-chosen-font"> <syntax> <arguments> <argument name="font-dialog"> @@ -2222,7 +2222,7 @@ </argument> <argument name="graphic-context"> <description> - A <reftopic>gfg:graphic-context</reftopic> object. + A <reftopic>gfg:graphics-context</reftopic> object. </description> </argument> </arguments> @@ -2247,6 +2247,33 @@ </seealso> </function> + <function name="obtain-chosen-color"> + <syntax> + <arguments> + <argument name="color-dialog"> + <description> + The <reftopic>gfw:color-dialog</reftopic> to be queried. + </description> + </argument> + </arguments> + <return> + <reftopic>gfg:color</reftopic> + <refclhs>list</refclhs> + </return> + </syntax> + <description> + Interrogates the data structure associated with <arg0/> to retrieve + the selected color. The secondary value is a <refclhs>list</refclhs> + of <reftopic>gfg:color</reftopic> objects corresponding to custom + colors displayed by the dialog. If the user cancelled the dialog, + NIL is returned for both values. Use this function when manually + constructing a color dialog. + </description> + <seealso> + <reftopic>gfw:with-color-dialog</reftopic> + </seealso> + </function> +  <generic-function name="event-activate"> Modified: trunk/src/packages.lisp ============================================================================== --- trunk/src/packages.lisp (original) +++ trunk/src/packages.lisp Sat Oct 21 14:46:35 2006 @@ -470,10 +470,10 @@ #:move-below #:moveable-p #:obtain-chosen-color + #:obtain-chosen-files + #:obtain-chosen-font #:obtain-displays #:obtain-event-time - #:obtain-file-dialog-paths - #:obtain-font-dialog-results #:obtain-horizontal-scrollbar #:obtain-primary-display #:obtain-vertical-scrollbar Modified: trunk/src/uitoolkit/widgets/file-dialog.lisp ============================================================================== --- trunk/src/uitoolkit/widgets/file-dialog.lisp (original) +++ trunk/src/uitoolkit/widgets/file-dialog.lisp Sat Oct 21 14:46:35 2006 @@ -37,7 +37,7 @@ ;;; helper functions ;;; -(defun obtain-file-dialog-paths (dlg) +(defun obtain-chosen-files (dlg) (let ((ofn-ptr (gfs:handle dlg))) (if (cffi:null-pointer-p ofn-ptr) (error 'gfs:disposed-error)) @@ -65,7 +65,7 @@ (unwind-protect (progn (show ,dlg t) - (setf ,paths (obtain-file-dialog-paths ,dlg)) + (setf ,paths (obtain-chosen-files ,dlg)) ,@body) (gfs:dispose ,dlg))))) Modified: trunk/src/uitoolkit/widgets/font-dialog.lisp ============================================================================== --- trunk/src/uitoolkit/widgets/font-dialog.lisp (original) +++ trunk/src/uitoolkit/widgets/font-dialog.lisp Sat Oct 21 14:46:35 2006 @@ -39,7 +39,7 @@ ;;; helper functions ;;; -(defun obtain-font-dialog-results (dlg gc) +(defun obtain-chosen-font (dlg gc) (if (or (gfs:disposed-p dlg) (gfs:disposed-p gc)) (error 'gfs:disposed-error)) (cffi:with-foreign-slots ((gfs::logfont gfs::color) (gfs:handle dlg) gfs::choosefont) @@ -66,7 +66,7 @@ :style ,style))) (unwind-protect (unless (zerop (show ,dlg t)) - (multiple-value-bind (f c) (obtain-font-dialog-results ,dlg ,gc) + (multiple-value-bind (f c) (obtain-chosen-font ,dlg ,gc) (setf ,font f) (setf ,color c)) ,@body)

1 0

[graphic-forms-cvs] r374 - in trunk: docs/manual src src/uitoolkit/widgets
by junrue＠common-lisp.net 21 Oct '06

21 Oct '06

Author: junrue Date: Sat Oct 21 12:56:48 2006 New Revision: 374 Modified: trunk/docs/manual/clhs-table.xml trunk/docs/manual/gf-data.xsl trunk/docs/manual/gfs-symbols.xml trunk/docs/manual/gfw-symbols.xml trunk/src/packages.lisp trunk/src/uitoolkit/widgets/file-dialog.lisp trunk/src/uitoolkit/widgets/font-dialog.lisp Log: Modified: trunk/docs/manual/clhs-table.xml ============================================================================== --- trunk/docs/manual/clhs-table.xml (original) +++ trunk/docs/manual/clhs-table.xml Sat Oct 21 12:56:48 2006 @@ -17,5 +17,6 @@ <entry name="namestring" url="http://www.lispworks.com/documentation/HyperSpec/Body/26_glo_n.htm#namestri…"/> <entry name="pathname" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_pn.htm"/> <entry name="string" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_string.htm"/> + <entry name="symbol" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_symbol.htm"/> <entry name="warning" url="http://www.lispworks.com/documentation/HyperSpec/Body/e_warnin.htm"/> </clhs-table> Modified: trunk/docs/manual/gf-data.xsl ============================================================================== --- trunk/docs/manual/gf-data.xsl (original) +++ trunk/docs/manual/gf-data.xsl Sat Oct 21 12:56:48 2006 @@ -218,7 +218,10 @@ </xsl:for-each> </xsl:element>) => <xsl:element name="emphasis"> - <xsl:apply-templates select="return"/> + <xsl:for-each select="return/*"> + <xsl:apply-templates select="."/> + <xsl:if test="not(position()=last())">, </xsl:if> + </xsl:for-each> </xsl:element> </xsl:element> Modified: trunk/docs/manual/gfs-symbols.xml ============================================================================== --- trunk/docs/manual/gfs-symbols.xml (original) +++ trunk/docs/manual/gfs-symbols.xml Sat Oct 21 12:56:48 2006 @@ -816,7 +816,7 @@ </argument> </arguments> <return> - foreign pointer + <emphasis>foreign pointer</emphasis> </return> </syntax> <description> Modified: trunk/docs/manual/gfw-symbols.xml ============================================================================== --- trunk/docs/manual/gfw-symbols.xml (original) +++ trunk/docs/manual/gfw-symbols.xml Sat Oct 21 12:56:48 2006 @@ -2036,6 +2036,81 @@  + <function name="capture-mouse"> + <syntax> + <arguments> + <argument name="window"> + <description> + The <reftopic>gfw:window</reftopic> in which to capture the mouse. + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Enables <arg0/> to receive mouse input events even when the mouse pointer + is outside its bounds, and at the same time, prevent other windows from + receiving those mouse events. Only one window at a time can capture the + mouse. This function is primarily intended for use with a window in the + foreground; background windows may still capture the mouse, but only mouse + move events will be received and those only when the mouse hotspot is within + the visible portions of such a window. + </description> + <seealso> + <reftopic>gfw:release-mouse</reftopic> + </seealso> + </function> + + <function name="release-mouse"> + <syntax> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Clears the mouse capture state to restore normal mouse input processing. + </description> + <seealso> + <reftopic>gfw:capture-mouse</reftopic> + </seealso> + </function> + + <function name="layout-attribute"> + <syntax with-setf="t"> + <arguments> + <argument name="layout-manager"> + <description> + The <reftopic>gfw:layout-manager</reftopic> responsible for + positioning <arg1/>'s children. + </description> + </argument> + <argument name="container"> + <description> + A <reftopic>gfw:window</reftopic> or other type containing + children. + </description> + </argument> + <argument name="symbol"> + <description> + A <refclhs>symbol</refclhs> identifying an attribute supported by + <arg0/>. + </description> + </argument> + </arguments> + <return> + <emphasis>object</emphasis> + </return> + </syntax> + <description> + Each <reftopic>gfw:layout-manager</reftopic> subclass can support attributes + that apply to each child of <arg1/>, which this function allows to be set + or retrieved. After setting attribute values, call <reftopic>gfw:layout</reftopic> + on <arg1/>. + </description> + </function> + <function name="default-message-filter"> <syntax> <arguments> @@ -2113,6 +2188,65 @@ </description> </function> + <function name="obtain-file-dialog-paths"> + <syntax> + <arguments> + <argument name="file-dialog"> + <description> + The <reftopic>gfw:file-dialog</reftopic> to query. + </description> + </argument> + </arguments> + <return> + <refclhs>list</refclhs> + </return> + </syntax> + <description> + Interrogates the data structure associated with <arg0/> to obtain the + <refclhs>namestring</refclhs>s for selected files. This return value is + NIL if the user cancelled the dialog. Use this function when manually + constructing a file dialog. + </description> + <seealso> + <reftopic>gfw:with-file-dialog</reftopic> + </seealso> + </function> + + <function name="obtain-font-dialog-results"> + <syntax> + <arguments> + <argument name="font-dialog"> + <description> + The <reftopic>gfw:font-dialog</reftopic> to query. + </description> + </argument> + <argument name="graphic-context"> + <description> + A <reftopic>gfg:graphic-context</reftopic> object. + </description> + </argument> + </arguments> + <return> + <reftopic>gfg:font</reftopic> + <reftopic>gfg:color</reftopic> + </return> + </syntax> + <description> + Interrogates the data structure associated with an instance of + <reftopic>gfw:font-dialog</reftopic> to obtain the font and color + corresponding to selections made by the user. <arg1/> should be the + same context with which the dialog was created. If the user cancelled + the dialog, the <emphasis>font</emphasis> + and <emphasis>color</emphasis> values will be NIL. Also, the + <emphasis>color</emphasis> value will be NIL if the dialog was created + with the :no-effects style keyword. Use this function when manually + constructing a font dialog. + </description> + <seealso> + <reftopic>gfw:with-font-dialog</reftopic> + </seealso> + </function> +  <generic-function name="event-activate"> Modified: trunk/src/packages.lisp ============================================================================== --- trunk/src/packages.lisp (original) +++ trunk/src/packages.lisp Sat Oct 21 12:56:48 2006 @@ -425,10 +425,8 @@ #:event-timer #:expand #:expanded-p - #:file-dialog-paths #:focus-index #:focus-p - #:font-dialog-results #:foreground-color #:give-focus #:grid-line-width @@ -474,6 +472,8 @@ #:obtain-chosen-color #:obtain-displays #:obtain-event-time + #:obtain-file-dialog-paths + #:obtain-font-dialog-results #:obtain-horizontal-scrollbar #:obtain-primary-display #:obtain-vertical-scrollbar Modified: trunk/src/uitoolkit/widgets/file-dialog.lisp ============================================================================== --- trunk/src/uitoolkit/widgets/file-dialog.lisp (original) +++ trunk/src/uitoolkit/widgets/file-dialog.lisp Sat Oct 21 12:56:48 2006 @@ -37,7 +37,7 @@ ;;; helper functions ;;; -(defun file-dialog-paths (dlg) +(defun obtain-file-dialog-paths (dlg) (let ((ofn-ptr (gfs:handle dlg))) (if (cffi:null-pointer-p ofn-ptr) (error 'gfs:disposed-error)) @@ -65,7 +65,7 @@ (unwind-protect (progn (show ,dlg t) - (setf ,paths (file-dialog-paths ,dlg)) + (setf ,paths (obtain-file-dialog-paths ,dlg)) ,@body) (gfs:dispose ,dlg))))) Modified: trunk/src/uitoolkit/widgets/font-dialog.lisp ============================================================================== --- trunk/src/uitoolkit/widgets/font-dialog.lisp (original) +++ trunk/src/uitoolkit/widgets/font-dialog.lisp Sat Oct 21 12:56:48 2006 @@ -39,7 +39,7 @@ ;;; helper functions ;;; -(defun font-dialog-results (dlg gc) +(defun obtain-font-dialog-results (dlg gc) (if (or (gfs:disposed-p dlg) (gfs:disposed-p gc)) (error 'gfs:disposed-error)) (cffi:with-foreign-slots ((gfs::logfont gfs::color) (gfs:handle dlg) gfs::choosefont) @@ -66,7 +66,7 @@ :style ,style))) (unwind-protect (unless (zerop (show ,dlg t)) - (multiple-value-bind (f c) (font-dialog-results ,dlg ,gc) + (multiple-value-bind (f c) (obtain-font-dialog-results ,dlg ,gc) (setf ,font f) (setf ,color c)) ,@body)

1 0

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

21 Oct '06

Author: junrue Date: Sat Oct 21 02:00:46 2006 New Revision: 373 Modified: trunk/docs/manual/gfw-symbols.xml Log: Modified: trunk/docs/manual/gfw-symbols.xml ============================================================================== --- trunk/docs/manual/gfw-symbols.xml (original) +++ trunk/docs/manual/gfw-symbols.xml Sat Oct 21 02:00:46 2006 @@ -1525,7 +1525,7 @@ </argument> <argument name=":parent"> <description> - This initarg specifies the parent of the control. + See <reftopic>gfw:control</reftopic>. </description> </argument> <argument name=":dispatcher"> @@ -1563,13 +1563,14 @@ <description> The function supplied via this initarg will be used as the implementation of <reftopic>gfw:event-modify</reftopic> in - a <reftopic>gfw:event-dispatcher</reftopic> configured for the button. + a <reftopic>gfw:event-dispatcher</reftopic> configured for + the edit control. </description> </argument> <argument name=":style"> <description> This is a <refclhs>list</refclhs> of keyword symbols that define - the look-and-feel of the button. Zero or more of the following + the look-and-feel of the edit control. Zero or more of the following may be specified: <enum> <argument name=":auto-hscroll"> @@ -1655,7 +1656,7 @@ </argument> <argument name=":parent"> <description> - This initarg specifies the parent of the control. + See <reftopic>gfw:control</reftopic>. </description> </argument> <argument name=":dispatcher"> @@ -1679,6 +1680,358 @@ </seealso> </class> + <class name="label"> + <description> + <hierarchy> + <inherits> + <reftopic>gfw:control</reftopic> + </inherits> + </hierarchy> + This class represents non-selectable controls that display a string, image, + or etched line + </description> + <initargs> + <argument name=":separator"> + <description> + Specify T to configure the label to render itself as an etched + horizontal (or vertical) divider. The :style initarg is used to + select the desired orientation. + </description> + </argument> + <argument name=":image"> + <description> + Accepts a <reftopic>gfg:image</reftopic> to be rendered inside + the label. + </description> + </argument> + <argument name=":style"> + <description> + This is a <refclhs>list</refclhs> of keyword symbols that define + the look-and-feel of the label. The symbols appropriate for a + label depend on which mode (image, separator, or text) is + configured: + <enum> + <argument name=":beginning"> + <description>text mode</description> + </argument> + <argument name=":center"> + <description>text mode</description> + </argument> + <argument name=":ellipsis"> + <description>text mode</description> + </argument> + <argument name=":end"> + <description>text mode</description> + </argument> + <argument name=":wrap"> + <description>text mode</description> + </argument> + <argument name=":raised"> + <description>text or image mode</description> + </argument> + <argument name=":sunken"> + <description>text or image mode</description> + </argument> + <argument name=":horizontal"> + <description>separator mode</description> + </argument> + <argument name=":vertical"> + <description>separator mode</description> + </argument> + </enum> + </description> + </argument> + <argument name=":text"> + <description> + Accepts a <refclhs>string</refclhs> supplying the text for the + label. + </description> + </argument> + <argument name=":parent"> + <description> + See <reftopic>gfw:control</reftopic>. + </description> + </argument> + <argument name=":handle"> + <description> + See <reftopic>gfs:native-object</reftopic>. + </description> + </argument> + </initargs> + <seealso> + <reftopic>gfs:dispose</reftopic> + </seealso> + </class> + + <class name="list-box"> + <description> + <hierarchy> + <inherits> + <reftopic>gfw:control</reftopic> + <reftopic>gfw:item-manager</reftopic> + </inherits> + </hierarchy> + This class represents a list of selectable items. The list is always visible, + unlike a <reftopic>gfw:combo-box</reftopic>. + </description> + <initargs> + <argument name=":callback"> + <description> + The function supplied via this initarg will be used as the + implementation of <reftopic>gfw:event-select</reftopic> in + a <reftopic>gfw:event-dispatcher</reftopic> configured for the + list-box. + </description> + </argument> + <argument name=":style"> + <description> + This is a <refclhs>list</refclhs> of keyword symbols that define + the look-and-feel of the list-box. One of the following primary + styles may be specified: + <enum> + <argument name=":extend-select"> + <description> + Causes the list-box to allow multiple items to be selected + by use of the <Shift> key and the mouse or special keys. + </description> + </argument> + <argument name=":multiple-select"> + <description> + Enables individual toggling of multiple item selections within + the list-box. + </description> + </argument> + <argument name=":no-select"> + <description> + This style keyword configures the list-box to display items + but not allow any selections. + </description> + </argument> + </enum> + Zero or more of the following optional styles may be specified: + <enum> + <argument name=":scrollbar-always"> + <description> + Configures the list-box to show a disabled vertical scrollbar + when it does not contain enough items to scroll. By default, + the scrollbar will be hidden until needed. + </description> + </argument> + <argument name=":tab-stops"> + <description> + This style keyword configures the list-box to to expand tab + characters when rendering <reftopic>gfw:list-item</reftopic> + text. + </description> + </argument> + <argument name=":want-keys"> + <description> + Allows the application to perform special processing when the + list-box has focus and the user presses a key. + </description> + </argument> + </enum> + </description> + </argument> + <argument name=":estimated-count"> + <description> + A positive <refclhs>integer</refclhs> value indicating the expected + number of items that the list-box will hold. If supplied, it enables + an optimization in storage allocation by the underlying native control. + As the name of the initarg implies, this is an estimate, which may be + too high (in which case heap space may be wasted) or too low (in which + case the control will re-allocate storage as necessary). + </description> + </argument> + <argument name=":items"> + <description> + This initarg accepts a list of application-defined objects + for populating the contents of the list-box; each one is + automatically wrapped with an instance of <reftopic>gfw:list-item</reftopic>. + The list-box will hold references to the supplied objects. + </description> + </argument> + <argument name=":parent"> + <description> + See <reftopic>gfw:control</reftopic>. + </description> + </argument> + <argument name=":dispatcher"> + <description> + See <reftopic>gfw:event-source</reftopic>. + </description> + </argument> + <argument name=":handle"> + <description> + See <reftopic>gfs:native-object</reftopic>. + </description> + </argument> + </initargs> + <seealso> + <reftopic>gfs:dispose</reftopic> + <reftopic>gfw:dialog</reftopic> + <reftopic>gfw:auto-vscroll-p</reftopic> + <reftopic>gfw:append-item</reftopic> + </seealso> + </class> + + <class name="scrollbar"> + <description> + <hierarchy> + <inherits> + <reftopic>gfw:control</reftopic> + </inherits> + </hierarchy> + This class represents a control having a proportional sliding-thumb + component and step arrows at either end. Unlike a + <reftopic>gfw:standard-scrollbar</reftopic>, scrollbar controls can + be placed anywhere inside a container. + </description> + <initargs> + <argument name=":callback"> + <description> + The function supplied via this initarg will be used as the + implementation of <reftopic>gfw:event-scroll</reftopic> in + a <reftopic>gfw:event-dispatcher</reftopic> configured for the + scrollbar. + </description> + </argument> + <argument name=":style"> + <description> + This is a <refclhs>list</refclhs> of keyword symbols that define + the look-and-feel of the scrollbar. Currently, only one of the + following styles may be specified: + <enum> + <argument name=":horizontal"/> + <argument name=":vertical"/> + </enum> + </description> + </argument> + <argument name=":parent"> + <description> + See <reftopic>gfw:control</reftopic>. + </description> + </argument> + <argument name=":dispatcher"> + <description> + See <reftopic>gfw:event-source</reftopic>. + </description> + </argument> + <argument name=":handle"> + <description> + See <reftopic>gfs:native-object</reftopic>. + </description> + </argument> + </initargs> + <seealso> + <reftopic>gfs:dispose</reftopic> + <reftopic>gfs:event-scroll</reftopic> + </seealso> + </class> + + <class name="slider"> + <description> + <hierarchy> + <inherits> + <reftopic>gfw:control</reftopic> + </inherits> + </hierarchy> + This class represents a control having a sliding-thumb component + and optional tick marks. + </description> + <initargs> + <argument name=":callback"> + <description> + The function supplied via this initarg will be used as the + implementation of <reftopic>gfw:event-scroll</reftopic> in + a <reftopic>gfw:event-dispatcher</reftopic> configured for the + slider. + </description> + </argument> + <argument name=":outer-limit"> + <description> + Accepts an <refclhs>integer</refclhs> describing the maximum possible + slider positions (the minimum is 0). + </description> + </argument> + <argument name=":style"> + <description> + This is a <refclhs>list</refclhs> of keyword symbols that define + the look-and-feel of the slider. By default, sliders are oriented + horizontally with a tick mark below the control at the beginning + and end. One of the following primary + styles may be specified: + <enum> + <argument name=":auto-ticks"> + <description> + Specifies that the slider will display a tick mark for each + increment in its value range; the opposite of :no-ticks. + </description> + </argument> + <argument name=":horizontal"> + <description> + Configures the slider to be oriented horizontally. + </description> + </argument> + <argument name=":no-ticks"> + <description> + Specifies that the slider will not display any tick marks; + the oppposite of :auto-ticks. + </description> + </argument> + <argument name=":vertical"> + <description> + Configures the slider to be oriented vertically. + </description> + </argument> + </enum> + Zero or more of the following optional styles may be specified: + <enum> + <argument name=":border"> + <description> + By default, a slider is drawn without a border; this style + enables a border around the control. + </description> + </argument> + <argument name=":ticks-after"> + <description> + Specifies that the slider should display its tick marks to + the right of (or below) the control. This style can be + combined with :ticks-before. + </description> + </argument> + <argument name=":ticks-before"> + <description> + Specifies that the slider should display its tick marks to the + left of (or above) the control. This style can be combined with + :ticks-after. + </description> + </argument> + </enum> + </description> + </argument> + <argument name=":parent"> + <description> + See <reftopic>gfw:control</reftopic>. + </description> + </argument> + <argument name=":dispatcher"> + <description> + See <reftopic>gfw:event-source</reftopic>. + </description> + </argument> + <argument name=":handle"> + <description> + See <reftopic>gfs:native-object</reftopic>. + </description> + </argument> + </initargs> + <seealso> + <reftopic>gfs:dispose</reftopic> + <reftopic>gfs:event-scroll</reftopic> + </seealso> + </class> +

1 0

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

21 Oct '06

Author: junrue Date: Fri Oct 20 23:23:05 2006 New Revision: 372 Modified: trunk/docs/manual/gfw-symbols.xml Log: Modified: trunk/docs/manual/gfw-symbols.xml ============================================================================== --- trunk/docs/manual/gfw-symbols.xml (original) +++ trunk/docs/manual/gfw-symbols.xml Fri Oct 20 23:23:05 2006 @@ -1384,6 +1384,301 @@ </seealso> </class> + <class name="control"> + <description> + <hierarchy> + <inherits> + <reftopic>gfw:widget</reftopic> + </inherits> + <inheritedby> + <reftopic>gfw:button</reftopic> + <reftopic>gfw:edit</reftopic> + <reftopic>gfw:label</reftopic> + <reftopic>gfw:listbox</reftopic> + <reftopic>gfw:scrollbar</reftopic> + <reftopic>gfw:slider</reftopic> + </inheritedby> + </hierarchy> + This is the base class for widgets associated with an underlying native + control. + </description> + <initargs> + <argument name=":callback"> + <description> + This initarg associates a function with a <reftopic>gfw:event-dispatcher</reftopic> + subclass that is generated behind-the-scenes and then instantiated to serve as + the control's event dispatcher. Each control subclass specifies the particular + event function (e.g., <reftopic>gfw:event-select</reftopic>) that this callback + will implement; see the documentation for specific control subclasses for more + information on this initarg. + </description> + </argument> + <argument name=":parent"> + <description> + This initarg specifies the parent of the control. + </description> + </argument> + <argument name=":dispatcher"> + <description> + See <reftopic>gfw:event-source</reftopic>. + </description> + </argument> + <argument name=":handle"> + <description> + See <reftopic>gfs:native-object</reftopic>. + </description> + </argument> + </initargs> + <seealso> + <reftopic>gfs:dispose</reftopic> + </seealso> + </class> + + <class name="button"> + <description> + <hierarchy> + <inherits> + <reftopic>gfw:control</reftopic> + </inherits> + </hierarchy> + This class represents selectable controls that generate an event when clicked. + </description> + <initargs> + <argument name=":callback"> + <description> + The function supplied via this initarg will be used as the + implementation of <reftopic>gfw:event-select</reftopic> in + a <reftopic>gfw:event-dispatcher</reftopic> configured for the button. + </description> + </argument> + <argument name=":image"> + <description> + Accepts a <reftopic>gfg:image</reftopic> to be used as the button's + label. + </description> + </argument> + <argument name=":style"> + <description> + This is a <refclhs>list</refclhs> of keyword symbols that define + the look-and-feel of the button. The :push-button style is the + default. Currently, only one of the following may be specified: + <enum> + <argument name=":cancel-button"> + <description> + Placing a :cancel-button in a dialog enables the escape key + accelerator for dismissing the dialog. This action should be + interpreted as the user discarding the content of the dialog. + </description> + </argument> + <argument name=":check-box"> + <description> + This style specifies a button having a small box, which may + contain a check mark depending on the button's selection state, + adjacent to a text label. + </description> + </argument> + <argument name=":default-button"> + <description> + Placing a :default-button in a dialog enables the return key + accelerator for dismissing the dialog. This action should be + interpreted as the user accepting the content of the dialog. + Also, the button is rendered with an extra thick border. + </description> + </argument> + <argument name=":push-button"> + <description> + This style specifies a traditional push button control. No + special keyboard accelerators are enabled. + </description> + </argument> + <argument name=":radio-button"> + <description> + This style specifies a button having a small circle, which may + be filled or unfilled depending on the button's selection state, + adjacent to a text label. Radio buttons are typically used in + groups and are managed such that only one member of the group + is enabled at a time. + </description> + </argument> + <argument name=":toggle-button"> + <description> + This style specifies a control that when unselected looks like + a push button. But when in the selected state, the button + maintains a sunken look. It is similar in function to a :check-box. + </description> + </argument> + <argument name=":tri-state"> + <description> + This style specifies a control that looks similar to a :check-box, + but the box can be grayed as well as checked or cleared. The grayed + look indicates an undetermined state. + </description> + </argument> + </enum> + </description> + </argument> + <argument name=":text"> + <description> + Accepts a <refclhs>string</refclhs> supplying the text for the + button label. + </description> + </argument> + <argument name=":parent"> + <description> + This initarg specifies the parent of the control. + </description> + </argument> + <argument name=":dispatcher"> + <description> + See <reftopic>gfw:event-source</reftopic>. + </description> + </argument> + <argument name=":handle"> + <description> + See <reftopic>gfs:native-object</reftopic>. + </description> + </argument> + </initargs> + <seealso> + <reftopic>gfs:dispose</reftopic> + </seealso> + </class> + + <class name="edit"> + <description> + <hierarchy> + <inherits> + <reftopic>gfw:control</reftopic> + </inherits> + </hierarchy> + This class represents a rectangular area that permits the user to enter + and edit text. The <reftopic>gfw:event-focus-gain</reftopic> and + <reftopic>gfw:event-focus-loss</reftopic> methods of each edit control's + <reftopic>gfw:event-dispatcher</reftopic> are invoked when focus is given + or taken away. The <reftopic>gfw:event-modify</reftopic> method is invoked + when the user edits text. + </description> + <initargs> + <argument name=":callback"> + <description> + The function supplied via this initarg will be used as the + implementation of <reftopic>gfw:event-modify</reftopic> in + a <reftopic>gfw:event-dispatcher</reftopic> configured for the button. + </description> + </argument> + <argument name=":style"> + <description> + This is a <refclhs>list</refclhs> of keyword symbols that define + the look-and-feel of the button. Zero or more of the following + may be specified: + <enum> + <argument name=":auto-hscroll"> + <description> + Specifies that the edit control will scroll text content to + the right (by 10 characters, an amount defined by the system) + when the user types a character at the end of the line. For + single-line edit controls, this style is automatically set by + Graphic-Forms. + </description> + </argument> + <argument name=":auto-vscroll"> + <description> + Specifies that the edit control will scroll text up by a page + when the user types enter on the last line. This style + is only meaningful when :multi-line is also specified. + </description> + </argument> + <argument name=":horizontal-scrollbar"> + <description> + Specifies that a horizontal scrollbar should be displayed. + </description> + </argument> + <argument name=":mask-characters"> + <description> + Specifies that each character of text be masked by a configurable + echo character instead of the one literally typed. The asterisk + character is used by default. + </description> + </argument> + <argument name=":multi-line"> + <description> + Edit controls default to single-line text fields. By specifying + :multi-line, multiple lines of text can be supplied. When the + edit control is in a dialog, the <Enter> key will invoke + the default button's <reftopic>gfw:event-dispatcher</reftopic>, + unless :want-return is also specified. If :auto-hscroll is not + specified, then text will be automatically word-wrapped. + </description> + </argument> + <argument name=":no-border"> + <description> + By default, an edit control is rendered with a border; this style + disables that feature. + </description> + </argument> + <argument name=":no-hide-selection"> + <description> + This specifies that any selection remain rendered even when the + edit control loses input focus. By default, the selection is hidden + when focus is lost. + </description> + </argument> + <argument name=":read-only"> + <description> + Specifies that the edit control's contents cannot be modified by the + user. + </description> + </argument> + <argument name=":vertical-scrollbar"> + <description> + Specifies that a vertical scrollbar should be displayed. This style + is only meaningful when :multi-line is also specified. + </description> + </argument> + <argument name=":want-return"> + <description> + Specifies that a carriage return be inserted when the user types + <Enter>. This style only applies when the :multi-line style + is also specified. Without this style, within a dialog the act of + typing enter has the same effect as pressing the dialog's default + button. + </description> + </argument> + </enum> + </description> + </argument> + <argument name=":text"> + <description> + Accepts a <refclhs>string</refclhs> supplying the text for the + button label. + </description> + </argument> + <argument name=":parent"> + <description> + This initarg specifies the parent of the control. + </description> + </argument> + <argument name=":dispatcher"> + <description> + See <reftopic>gfw:event-source</reftopic>. + </description> + </argument> + <argument name=":handle"> + <description> + See <reftopic>gfs:native-object</reftopic>. + </description> + </argument> + </initargs> + <seealso> + <reftopic>gfs:dispose</reftopic> + <reftopic>gfw:dialog</reftopic> + <reftopic>gfw:auto-hscroll-p</reftopic> + <reftopic>gfw:auto-vscroll-p</reftopic> + <reftopic>gfw:echo-character</reftopic> + <reftopic>gfw:enable-auto-scrolling</reftopic> + </seealso> + </class> +

1 0

[graphic-forms-cvs] r371 - in trunk/docs: manual website
by junrue＠common-lisp.net 21 Oct '06

21 Oct '06

Author: junrue Date: Fri Oct 20 20:34:05 2006 New Revision: 371 Modified: trunk/docs/manual/clhs-table.xml trunk/docs/manual/gfw-symbols.xml trunk/docs/website/index.html Log: Modified: trunk/docs/manual/clhs-table.xml ============================================================================== --- trunk/docs/manual/clhs-table.xml (original) +++ trunk/docs/manual/clhs-table.xml Fri Oct 20 20:34:05 2006 @@ -6,15 +6,16 @@ --> <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="character" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_ch.htm"/> - <entry name="error" url="http://www.lispworks.com/documentation/HyperSpec/Body/e_error.htm"/> - <entry name="float" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_float.htm"/> - <entry name="format" url="http://www.lispworks.com/documentation/HyperSpec/Body/f_format.htm"/> - <entry name="integer" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_intege.htm"/> - <entry name="list" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_list.htm"/> - <entry name="pathname" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_pn.htm"/> - <entry name="string" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_string.htm"/> - <entry name="warning" url="http://www.lispworks.com/documentation/HyperSpec/Body/e_warnin.htm"/> + <entry name="alist" url="http://www.lispworks.com/documentation/HyperSpec/Body/26_glo_a.htm#alist"/> + <entry name="boolean" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_ban.htm"/> + <entry name="character" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_ch.htm"/> + <entry name="error" url="http://www.lispworks.com/documentation/HyperSpec/Body/e_error.htm"/> + <entry name="float" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_float.htm"/> + <entry name="format" url="http://www.lispworks.com/documentation/HyperSpec/Body/f_format.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="namestring" url="http://www.lispworks.com/documentation/HyperSpec/Body/26_glo_n.htm#namestri…"/> + <entry name="pathname" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_pn.htm"/> + <entry name="string" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_string.htm"/> + <entry name="warning" url="http://www.lispworks.com/documentation/HyperSpec/Body/e_warnin.htm"/> </clhs-table> Modified: trunk/docs/manual/gfw-symbols.xml ============================================================================== --- trunk/docs/manual/gfw-symbols.xml (original) +++ trunk/docs/manual/gfw-symbols.xml Fri Oct 20 20:34:05 2006 @@ -647,6 +647,336 @@ </seealso> </class> + <class name="color-dialog"> + <description> + <hierarchy> + <inherits> + <reftopic>gfw:widget</reftopic> + </inherits> + </hierarchy> + <para role="normal"> + This class provides a standard dialog for choosing (or defining new) colors. + The <reftopic>gfw:with-color-dialog</reftopic> macro wraps the creation of + this dialog type and subsequent retrieval of the user's <reftopic>gfg:color</reftopic> + choice. However, applications may choose to implement these steps manually, + in which case the <reftopic>gfw:obtain-chosen-color</reftopic> function can be + used. + </para> + <para role="normal"> + Like other system dialogs in Graphic-Forms, file-dialog is derived from + <reftopic>gfw:widget</reftopic> rather than <reftopic>gfw:dialog</reftopic> + since the majority of its functionality is implemented by the system. A + future release will provide a customization mechanism. + </para> + </description> + <initargs> + <argument name=":initial-color"> + <description> + This initarg causes the dialog to show the specified + <reftopic>gfg:color</reftopic> as initially selected. + </description> + </argument> + <argument name=":initial-custom-colors"> + <description> + This initarg accepts a <refclhs>list</refclhs> of <reftopic>gfg:color</reftopic> + objects which are used to populate the custom color editing portion of the dialog. + A maximum of 16 colors are used, with any extras supplied in the + <refclhs>list</refclhs> being + ignored. Fewer than 16 may be supplied, in which case black is displayed as + a default color for the remaining entries. + </description> + </argument> + <argument name=":style"> + <description> + A <refclhs>list</refclhs> of keyword symbols specifying how the color dialog + is to look and behave. One or more of the following: + <enum> + <argument name=":allow-custom-colors"> + <description> + This configures the dialog to enable the + <emphasis>Define Custom Color</emphasis> button, which when + clicked reveals additional controls for creating custom colors. + </description> + </argument> + <argument name=":display-solid-only"> + <description> + This configures the dialog to only display solid colors in + the set of basic colors. + </description> + </argument> + </enum> + </description> + </argument> + <argument name=":owner"> + <description> + A value is required for this initarg, which may be either a + <reftopic>gfw:window</reftopic> or a <reftopic>gfw:dialog</reftopic>. + </description> + </argument> + <argument name=":handle"> + <description> + See <reftopic>gfs:native-object</reftopic>. + </description> + </argument> + </initargs> + <seealso> + <reftopic>gfs:dispose</reftopic> + </seealso> + </class> + + <class name="file-dialog"> + <description> + <hierarchy> + <inherits> + <reftopic>gfw:widget</reftopic> + </inherits> + </hierarchy> + <para role="normal"> + This class provides a standard dialog for navigating the file system + to select or enter file names. A variety of configurations are possible. + Please note that in :save mode, the user will be prompted to + confirm overwrite when an existing file is selected. + </para> + <para role="normal"> + The <reftopic>gfw:with-file-dialog</reftopic> macro wraps the creation + of a file-dialog and subsequent retrieval of the file paths selected by + the user. However, applications may choose to implement these steps + manually, in which case the <reftopic>gfw:file-dialog-paths</reftopic> + function can be used to obtain the user's selection(s). Unless the + :multiple-select style keyword is specified, there will at most be one + selected file returned. In either case, zero is returned if the user + cancelled the dialog. Manual construction of an instance must be followed + by an explicit call to <reftopic>gfs:dispose</reftopic>. + </para> + <para role="normal"> + Like other system dialogs in Graphic-Forms, file-dialog is derived from + <reftopic>gfw:widget</reftopic> rather than <reftopic>gfw:dialog</reftopic> + since the majority of its functionality is implemented by the system. A + future release will provide a customization mechanism. + </para> + </description> + <initargs> + <argument name=":default-extension"> + <description> + Specifies a default extension to be appended to a file name + if the user fails to provide one. Any embedded periods `.' + will be removed. Also, only the first three characters are used. + </description> + </argument> + <argument name=":filters"> + <description> + This initarg accepts a list of conses, CAR holding a string that + describes a filter, e.g., `Text Files', and CDR specifying the actual + filter pattern, e.g., `*.TXT'. Note that multiple filter patterns can + be grouped with a single description by separating them with semicolons, + e.g., `*.TXT;*.BAK'. + </description> + </argument> + <argument name=":initial-directory"> + <description> + This initarg accepts a directory <refclhs>namestring</refclhs> identifying + the location in the file system whose contents are to be browsed by the + file dialog. Note: setting this value will result in the side-effect of + changing the current working directory of the lisp process. Also, the + supplied value is used only if the <refclhs>namestring</refclhs> supplied + for :initial-filename does not contain a path. + </description> + </argument> + <argument name=":initial-filename"> + <description> + This initarg accepts a file <refclhs>namestring</refclhs> for the following + purposes: + <itemizedlist mark="bullet" spacing="compact"> + <listitem> + populate the edit field in the file dialog with the file name and extension + </listitem> + <listitem> + set the initial directory of the file dialog (and hence the current + working directory of the lisp process) if it contains a directory path + </listitem> + <listitem> + if a file actually exists in the directory, set the other components of + the dialog to reflect the attributes of the file. + </listitem> + </itemizedlist> + </description> + </argument> + <argument name=":style"> + <description> + A <refclhs>list</refclhs> of keyword symbols specifying how the font dialog + is to look and behave. One or more of the following: + <enum> + <argument name=":add-to-recent"> + <description> + This enables the system to add a link to the selected file in the + directory that contains the user's most recently used documents. + </description> + </argument> + <argument name=":multiple-select"> + <description> + This configures the dialog to accept multiple selections. + </description> + </argument> + <argument name=":path-must-exist"> + <description> + This keyword enables a validation check that constrains the user's + selection to file paths that actually exist. A warning dialog will + be displayed if the user supplies a non-existent path. + </description> + </argument> + <argument name=":show-hidden"> + <description> + This keyword enables the dialog to display files marked hidden by + the system. Note: files marked both hidden and system will not be + displayed in any case. Also, be aware that using this keyword + effectively overrides the user's preference settings. + </description> + </argument> + </enum> + </description> + </argument> + <argument name=":text"> + <description> + This initarg accepts a <clhs>string</clhs> that will become the title of + the file dialog. By default, a file dialog with the :open style flag will + display `Open' whereas the :save style flag will result in a title of + `Save As'. + </description> + </argument> + <argument name=":owner"> + <description> + A value is required for this initarg, which may be either a + <reftopic>gfw:window</reftopic> or a <reftopic>gfw:dialog</reftopic>. + </description> + </argument> + <argument name=":handle"> + <description> + See <reftopic>gfs:native-object</reftopic>. + </description> + </argument> + </initargs> + <seealso> + <reftopic>gfs:dispose</reftopic> + </seealso> + </class> + + <class name="font-dialog"> + <description> + <hierarchy> + <inherits> + <reftopic>gfw:widget</reftopic> + </inherits> + </hierarchy> + <para role="normal"> + This class provides a standard dialog for choosing attributes of a + font, either from scratch or relative to an existing font. A variety + of style options may be selected, including strikeout and font color. + </para> + <para role="normal"> + The <reftopic>gfw:with-font-dialog</reftopic> macro wraps the creation + of a font-dialog and provides a new <reftopic>gfg:font</reftopic> object + based on the user's selections. However, applications may choose to implement + these steps manually, in which case the <reftopic>gfw:font-dialog-results</reftopic> + function can be called to obtain the results of the user's selections. Manual + construction of an instance must be followed by an explicit call to + <reftopic>gfs:dispose</reftopic>. + </para> + <para role="normal"> + Like other system dialogs in Graphic-Forms, font-dialog is derived from + <reftopic>gfw:widget</reftopic> rather than <reftopic>gfw:dialog</reftopic> + since the majority of its functionality is implemented by the system. A + future release will provide a customization mechanism. + </para> + </description> + <initargs> + <argument name=":gc"> + <description> + This required initarg accepts a <reftopic>gfg:graphics-context</reftopic> + object providing context for the font selection, such as when the set of + fonts to be offered depends on a printer device. + </description> + </argument> + <argument name=":initial-color"> + <description> + This initarg accepts a <reftopic>gfg:color</reftopic> object which the + font dialog will use for its initial color selection (as long as the + :no-effects style is not set). + </description> + </argument> + <argument name=":initial-font"> + <description> + This initarg accepts a <reftopic>gfg:font</reftopic> object which the + font dialog will use for its initial font attribute selections. If not + specified, the dialog will be set to the system font's attributes. + </description> + </argument> + <argument name=":style"> + <description> + A <refclhs>list</refclhs> of keyword symbols specifying how the font dialog + is to look and behave. One or more of the following: + <enum> + <argument name=":all-fonts"> + <description> + This is a convenience style, used by default if no other font criteria + are specified, that enables the dialog to offer all possible fonts. + </description> + </argument> + <argument name=":fixed-pitch-fonts"> + <description> + Enables the dialog to offer fixed pitch fonts. + </description> + </argument> + <argument name=":no-effects"> + <description> + Causes the font dialog to hide the controls that allow the user to + specify strikeout, underline, and text color attributes. + </description> + </argument> + <argument name=":printer-fonts"> + <description> + Enables the dialog to offer fonts supported by the printer associated + with the <reftopic>gfg:graphics-context</reftopic> supplied via the + :gc initarg. + </description> + </argument> + <argument name=":screen-fonts"> + <description> + Enables the dialog to offer screen fonts supported by the system. + </description> + </argument> + <argument name=":truetype-fonts"> + <description> + Enables the dialog to offer TrueType fonts. + </description> + </argument> + <argument name=":wysiwyg-fonts"> + <description> + Enables the dialog to offer the intersection of the sets of fonts + available on the screen and the printer associated with the + <reftopic>gfg:graphics-context</reftopic> specified by the :gc + initarg. + </description> + </argument> + </enum> + </description> + </argument> + <argument name=":owner"> + <description> + A value is required for this initarg, which may be either a + <reftopic>gfw:window</reftopic> or a <reftopic>gfw:dialog</reftopic>. + </description> + </argument> + <argument name=":handle"> + <description> + See <reftopic>gfs:native-object</reftopic>. + </description> + </argument> + </initargs> + <seealso> + <reftopic>gfs:dispose</reftopic> + </seealso> + </class> + <class name="window"> <description> <hierarchy> Modified: trunk/docs/website/index.html ============================================================================== --- trunk/docs/website/index.html (original) +++ trunk/docs/website/index.html Fri Oct 20 20:34:05 2006 @@ -36,7 +36,7 @@ interface. The library can be extended via <a href="http://www.lisp.org">Common Lisp</a> bindings for system APIs.</p> <p>Long-term goals for this project may include implementing an application - framework on top of the toolkit, or a rapid UI development language, or a + framework on top of the toolkit, a rapid UI development language, a UI design tool, or some combination thereof.</p> <h3>Status</h3> @@ -51,9 +51,9 @@ <p>The supported Lisp implementations are: <ul> - <li><a href="http://clisp.cons.org/">CLISP 2.38 or later</a></li> + <li><a href="http://clisp.cons.org/">CLISP 2.38</a> or later</li> <li><a href="http://www.lispworks.com/">LispWorks 4.4.6</a></li> - <li><a href="http://www.sbcl.org/">SBCL 0.9.15</a></li> + <li><a href="http://www.sbcl.org/">SBCL 0.9.15</a> or later</li> </ul> <p>The supported Windows versions are:

1 0

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

20 Oct '06

Author: junrue Date: Fri Oct 20 19:09:32 2006 New Revision: 370 Modified: trunk/docs/manual/gf-data.xsl trunk/docs/manual/gfw-symbols.xml Log: Modified: trunk/docs/manual/gf-data.xsl ============================================================================== --- trunk/docs/manual/gf-data.xsl (original) +++ trunk/docs/manual/gf-data.xsl Fri Oct 20 19:09:32 2006 @@ -36,7 +36,7 @@ </xsl:element> </xsl:template> - <xsl:template match="para | emphasis | itemizedlist | listitem"> + <xsl:template match="para | emphasis | itemizedlist | listitem | ulink"> <xsl:copy> <xsl:copy-of select="@*"/> <xsl:apply-templates/> Modified: trunk/docs/manual/gfw-symbols.xml ============================================================================== --- trunk/docs/manual/gfw-symbols.xml (original) +++ trunk/docs/manual/gfw-symbols.xml Fri Oct 20 19:09:32 2006 @@ -63,6 +63,41 @@ </enum> </description> </argument> + <argument name=":bottom-margin"> + <description> + See <reftopic>gfw:layout-manager</reftopic>. + </description> + </argument> + <argument name=":left-margin"> + <description> + See <reftopic>gfw:layout-manager</reftopic>. + </description> + </argument> + <argument name=":right-margin"> + <description> + See <reftopic>gfw:layout-manager</reftopic>. + </description> + </argument> + <argument name=":top-margin"> + <description> + See <reftopic>gfw:layout-manager</reftopic>. + </description> + </argument> + <argument name=":horizontal-margins"> + <description> + See <reftopic>gfw:layout-manager</reftopic>. + </description> + </argument> + <argument name=":vertical-margins"> + <description> + See <reftopic>gfw:layout-manager</reftopic>. + </description> + </argument> + <argument name=":margins"> + <description> + See <reftopic>gfw:layout-manager</reftopic>. + </description> + </argument> </initargs> <seealso> <reftopic>gfw:preferred-size</reftopic> @@ -91,6 +126,109 @@ The child widget that should be initially visible. </description> </argument> + <argument name=":bottom-margin"> + <description> + See <reftopic>gfw:layout-manager</reftopic>. + </description> + </argument> + <argument name=":left-margin"> + <description> + See <reftopic>gfw:layout-manager</reftopic>. + </description> + </argument> + <argument name=":right-margin"> + <description> + See <reftopic>gfw:layout-manager</reftopic>. + </description> + </argument> + <argument name=":top-margin"> + <description> + See <reftopic>gfw:layout-manager</reftopic>. + </description> + </argument> + <argument name=":horizontal-margins"> + <description> + See <reftopic>gfw:layout-manager</reftopic>. + </description> + </argument> + <argument name=":vertical-margins"> + <description> + See <reftopic>gfw:layout-manager</reftopic>. + </description> + </argument> + <argument name=":margins"> + <description> + See <reftopic>gfw:layout-manager</reftopic>. + </description> + </argument> + </initargs> + <seealso> + <reftopic>gfw:preferred-size</reftopic> + </seealso> + </class> + + <class name="layout-manager"> + <description> + <hierarchy> + <inheritedby> + <reftopic>gfw:flow-layout</reftopic> + <reftopic>gfw:heap-layout</reftopic> + </inheritedby> + </hierarchy> + <para role="normal"> + This is the base class for objects that manage the sizes and positions + of child widgets inside container windows. Subclasses implement specialized + layout strategies. + </para> + <para role="normal"> + This class is not meant to be instantiated directly. + </para> + </description> + <initargs> + <argument name=":bottom-margin"> + <description> + An <refclhs>integer</refclhs> value specifying margin thickness in pixels. + </description> + </argument> + <argument name=":left-margin"> + <description> + An <refclhs>integer</refclhs> value specifying margin thickness in pixels. + </description> + </argument> + <argument name=":right-margin"> + <description> + An <refclhs>integer</refclhs> value specifying margin thickness in pixels. + </description> + </argument> + <argument name=":top-margin"> + <description> + An <refclhs>integer</refclhs> value specifying margin thickness in pixels. + </description> + </argument> + <argument name=":horizontal-margins"> + <description> + An <refclhs>integer</refclhs> value specifying margin thickness in pixels, + for both the left and right sides of the container. + </description> + </argument> + <argument name=":vertical-margins"> + <description> + An <refclhs>integer</refclhs> value specifying margin thickness in pixels, + for both the top and bottom sides of the container. + </description> + </argument> + <argument name=":margins"> + <description> + An <refclhs>integer</refclhs> value specifying margin thickness in pixels, + for all sides of the container. + </description> + </argument> + <argument name=":style"> + <description> + A <refclhs>list</refclhs> of keyword symbols used to configure the layout's + behavior. Each layout manager can define its own specific style keywords. + </description> + </argument> </initargs> <seealso> <reftopic>gfw:preferred-size</reftopic> @@ -130,6 +268,32 @@ </seealso> </class> + <class name="menu-item"> + <description> + <hierarchy> + <inherits> + <reftopic>gfw:item</reftopic> + </inherits> + </hierarchy> + This class represents an element of a <reftopic>gfw:menu</reftopic>. + </description> + <initargs> + <argument name=":callback"> + <description> + See <reftopic>gfw:item</reftopic>. + </description> + </argument> + <argument name=":data"> + <description> + See <reftopic>gfw:item</reftopic>. + </description> + </argument> + </initargs> + <seealso> + <reftopic>gfs:dispose</reftopic> + </seealso> + </class> + <class name="display"> <description> <hierarchy> @@ -155,7 +319,7 @@ <seealso> <reftopic>gfs:dispose</reftopic> <reftopic>gfw:obtain-displays</reftopic> - <reftopic>gfs:obtain-primary-display</reftopic> + <reftopic>gfw:obtain-primary-display</reftopic> </seealso> </class> @@ -302,6 +466,21 @@ An application-supplied object to be represented by an item instance. </description> </argument> + <argument name=":callbacks"> + <description> + See <reftopic>gfw:event-source</reftopic>. + </description> + </argument> + <argument name=":dispatcher"> + <description> + See <reftopic>gfw:event-source</reftopic>. + </description> + </argument> + <argument name=":handle"> + <description> + See <reftopic>gfs:native-object</reftopic>. + </description> + </argument> </initargs> <seealso> <reftopic>gfs:dispose</reftopic> @@ -309,6 +488,52 @@ </seealso> </class> + <class name="standard-scrollbar"> + <description> + <hierarchy> + <inherits> + <reftopic>gfw:event-source</reftopic> + </inherits> + </hierarchy> + <para role="normal"> + This class encapsulates a window standard scrollbar, which is + Microsoft's term for a scrollbar widget attached to the right + side or bottom of a window. + </para> + <para role="normal"> + This class is not meant to be instantiated by application code. + </para> + </description> + <initargs> + <argument name=":callbacks"> + <description> + See <reftopic>gfw:event-source</reftopic>. + </description> + </argument> + <argument name=":dispatcher"> + <description> + See <reftopic>gfw:event-source</reftopic>. + </description> + </argument> + <argument name=":handle"> + <description> + See <reftopic>gfs:native-object</reftopic>. + </description> + </argument> + <argument name=":orientation"> + <description> + A system value specifying whether the scrollbar is horizontal + or vertical. + </description> + </argument> + </initargs> + <seealso> + <reftopic>gfs:dispose</reftopic> + <reftopic>gfw:obtain-horizontal-scrollbar</reftopic> + <reftopic>gfw:obtain-vertical-scrollbar</reftopic> + </seealso> + </class> + <class name="item-manager"> <description> <hierarchy> @@ -406,14 +631,376 @@ See <reftopic>gfw:event-source</reftopic>. </description> </argument> + <argument name=":dispatcher"> + <description> + See <reftopic>gfw:event-source</reftopic>. + </description> + </argument> + <argument name=":handle"> + <description> + See <reftopic>gfs:native-object</reftopic>. + </description> + </argument> + </initargs> + <seealso> + <reftopic>gfs:dispose</reftopic> + </seealso> + </class> + + <class name="window"> + <description> + <hierarchy> + <inherits> + <reftopic>gfw:widget</reftopic> + <reftopic>gfw:layout-managed</reftopic> + </inherits> + <inheritedby> + <reftopic>gfw:dialog</reftopic> + <reftopic>gfw:panel</reftopic> + <reftopic>gfw:root-window</reftopic> + <reftopic>gfw:top-level</reftopic> + </inheritedby> + </hierarchy> + This is the base class for user-defined widgets that serve as containers. + </description> + <initargs> + <argument name=":style"> + <description> + See <reftopic>gfw:widget</reftopic>. + </description> + </argument> + <argument name=":callbacks"> + <description> + See <reftopic>gfw:event-source</reftopic>. + </description> + </argument> + <argument name=":dispatcher"> + <description> + See <reftopic>gfw:event-source</reftopic>. + </description> + </argument> <argument name=":handle"> <description> See <reftopic>gfs:native-object</reftopic>. </description> </argument> + <argument name=":layout"> + <description> + See <reftopic>gfw:layout-managed</reftopic> + </description> + </argument> </initargs> <seealso> <reftopic>gfs:dispose</reftopic> + <reftopic>gfw:owner</reftopic> + <reftopic>gfw:parent</reftopic> + <reftopic>gfw:text</reftopic> + </seealso> + </class> + + <class name="root-window"> + <description> + <hierarchy> + <inherits> + <reftopic>gfw:window</reftopic> + </inherits> + </hierarchy> + <para role="normal"> + This class represents the desktop window, which is the root of the + window hierarchy. Operations on a root-window are constrained + compared to other window subclasses -- not all functions normally + implemented are available for root-window. + </para> + <para role="normal"> + If an application attempts to use a root-window instance as the owner + of a <reftopic>gfw:dialog</reftopic>, the library will substitute NIL. + <ulink url="http://blogs.msdn.com/oldnewthing/archive/2004/02/24/79212.aspx"> + This blog entry</ulink> explains why the desktop window must be + handled specially. + </para> + </description> + <initargs> + <argument name=":handle"> + <description> + See <reftopic>gfs:native-object</reftopic>. + </description> + </argument> + </initargs> + <seealso> + <reftopic>gfs:dispose</reftopic> + <reftopic>gfw:owner</reftopic> + <reftopic>gfw:parent</reftopic> + </seealso> + </class> + + <class name="dialog"> + <description> + <hierarchy> + <inherits> + <reftopic>gfw:window</reftopic> + </inherits> + </hierarchy> + <para role="normal"> + This is the base class for application-defined dialogs. A dialog is a + windowed UI component, usually containing at least one + <reftopic>gfw:panel</reftopic> or <reftopic>gfw:control</reftopic>, that + remains on top of application window(s). A dialog's typical role is to + collect additional information from the user; a secondary role is to + interrupt the user with important notification messages. Note that some + applications are entirely dialog-based. + </para> + <para role="normal"> + A <emphasis>modal</emphasis> dialog forces the user to respond to it + before returning to other application functionality, whereas a + <emphasis>modeless</emphasis> dialog does not. + </para> + </description> + <initargs> + <argument name=":callbacks"> + <description> + See <reftopic>gfw:event-source</reftopic>. + </description> + </argument> + <argument name=":dispatcher"> + <description> + See <reftopic>gfw:event-source</reftopic>. + </description> + </argument> + <argument name=":handle"> + <description> + See <reftopic>gfs:native-object</reftopic>. + </description> + </argument> + <argument name=":style"> + <description> + This is a <refclhs>list</refclhs> of keyword symbols that define + the look-and-feel of the dialog. Currently, only one of the following + symbols may be specified: + <enum> + <argument name=":application-modal"> + <description> + Specifies that the dialog is modal with respect to all top-level + windows and dialogs created by the application (specifically those + created by the calling thread which are still realized on-screen). + </description> + </argument> + <argument name=":modeless"> + <description> + Specifies that the dialog is modeless, meaning that while the dialog + floats on top of all application-created windows, the user may still + interact with other windows and dialogs. + </description> + </argument> + <argument name=":owner-modal"> + <description> + Specifies that the dialog is modal only in relation to its owner + (which could be a window or another dialog). This style is the default + if no style keywords are specified. + </description> + </argument> + </enum> + </description> + </argument> + <argument name=":text"> + <description> + A <refclhs>string</refclhs> supplying the dialog's title. + </description> + </argument> + <argument name=":owner"> + <description> + Specifies the owner of the dialog. Although no error will be thrown, + the library does not allow <reftopic>gfw:root-window</reftopic> to be + the owner of any dialog -- dialog initialization code instead + substitutes NIL for the owner. + </description> + </argument> + <argument name=":layout"> + <description> + See <reftopic>gfw:layout-managed</reftopic> + </description> + </argument> + </initargs> + <seealso> + <reftopic>gfs:dispose</reftopic> + <reftopic>gfw:owner</reftopic> + <reftopic>gfw:parent</reftopic> + <reftopic>gfw:text</reftopic> + </seealso> + </class> + + <class name="top-level"> + <description> + <hierarchy> + <inherits> + <reftopic>gfw:window</reftopic> + </inherits> + </hierarchy> + This class represents windows that are self-contained and parented to + <reftopic>gfw:root-window</reftopic>. Except when created with the + :borderless or :palette styles, they are resizable and have title bars + (also called `captions'). They may have scrollbars if either of th + :horizontal-scrollbar or :vertical-scrollbar styles are specified, with + further control over scrollbar visibility being possible. + </description> + <initargs> + <argument name=":callbacks"> + <description> + See <reftopic>gfw:event-source</reftopic>. + </description> + </argument> + <argument name=":dispatcher"> + <description> + See <reftopic>gfw:event-source</reftopic>. + </description> + </argument> + <argument name=":handle"> + <description> + See <reftopic>gfs:native-object</reftopic>. + </description> + </argument> + <argument name=":style"> + <description> + This is a <refclhs>list</refclhs> of keyword symbols that define + the look-and-feel of the window. One of the following primary styles + may be specified: + <enum> + <argument name=":borderless"> + <description> + Specifies a window with a one-pixel border (so not really + borderless in the strictest sense); no frame icon, system menu, + minimize/maximize buttons, or close buttons; the system does not + paint the background. + </description> + </argument> + <argument name=":frame"> + <description> + Specifies the standard top-level frame style with system menu, + close box, and minimize/maximize buttons; this window type is + resizable; it differs from the :workspace style in that the + application is completely responsible for painting the contents. + </description> + </argument> + <argument name=":miniframe"> + <description> + Specifies a resizable window with a shorter than normal caption; + has a close box but no system menu or minimize/maximize buttons; + the system does not paint the background. + </description> + </argument> + <argument name=":palette"> + <description> + Similar to the :miniframe style, except that this style also restricts + the window from having a resize frame. + </description> + </argument> + <argument name=":workspace"> + <description> + Specifies the standard top-level frame style with system menu, close box, + and minimize/maximize buttons; this window type is resizable; it differs + from the :frame style in that the system paints the background using the + color_appworkspace Win32 color scheme. + </description> + </argument> + </enum> + One or more of the following optional styles: + <enum> + <argument name=":horizontal-scrollbar"/> + <argument name=":vertical-scrollbar"/> + </enum> + </description> + </argument> + <argument name=":maximum-size"> + <description> + A <reftopic>gfs:size</reftopic> specifying the maximum dimensions to which + the user is allowed to resize the window by dragging the border. + </description> + </argument> + <argument name=":minimum-size"> + <description> + A <reftopic>gfs:size</reftopic> specifying the minimum dimensions to which + the user is allowed to resize the window by dragging the border. + </description> + </argument> + <argument name=":text"> + <description> + A <refclhs>string</refclhs> supplying the window's title. + </description> + </argument> + <argument name=":layout"> + <description> + See <reftopic>gfw:layout-managed</reftopic> + </description> + </argument> + </initargs> + <seealso> + <reftopic>gfs:dispose</reftopic> + <reftopic>gfw:owner</reftopic> + <reftopic>gfw:text</reftopic> + </seealso> + </class> + + <class name="panel"> + <description> + <hierarchy> + <inherits> + <reftopic>gfw:window</reftopic> + </inherits> + </hierarchy> + This is the base class for windows that are children of top-level windows, + dialogs, or other panels. + </description> + <initargs> + <argument name=":callbacks"> + <description> + See <reftopic>gfw:event-source</reftopic>. + </description> + </argument> + <argument name=":dispatcher"> + <description> + See <reftopic>gfw:event-source</reftopic>. + </description> + </argument> + <argument name=":handle"> + <description> + See <reftopic>gfs:native-object</reftopic>. + </description> + </argument> + <argument name=":style"> + <description> + This is a <refclhs>list</refclhs> of keyword symbols that define + the look-and-feel of the window. One or more of the following + styles may be specified: + <enum> + <argument name=":border"> + <description> + Specifies a window with a one-pixel border (so not really + borderless in the strictest sense); no frame icon, system menu, + minimize/maximize buttons, or close buttons; the system does not + paint the background. + </description> + </argument> + <argument name=":horizontal-scrollbar"/> + <argument name=":vertical-scrollbar"/> + </enum> + </description> + </argument> + <argument name=":parent"> + <description> + A <reftopic>gfw:window</reftopic> that will be the parent of the + panel. + </description> + </argument> + <argument name=":layout"> + <description> + See <reftopic>gfw:layout-managed</reftopic> + </description> + </argument> + </initargs> + <seealso> + <reftopic>gfs:dispose</reftopic> + <reftopic>gfw:parent</reftopic> + <reftopic>gfw:top-level</reftopic> + <reftopic>gfw:dialog</reftopic> </seealso> </class>

1 0

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

20 Oct '06

Author: junrue Date: Fri Oct 20 17:07:44 2006 New Revision: 369 Modified: trunk/docs/manual/clhs-table.xml trunk/docs/manual/gf-data.xsl trunk/docs/manual/gfw-symbols.xml Log: Modified: trunk/docs/manual/clhs-table.xml ============================================================================== --- trunk/docs/manual/clhs-table.xml (original) +++ trunk/docs/manual/clhs-table.xml Fri Oct 20 17:07:44 2006 @@ -11,6 +11,7 @@ <entry name="character" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_ch.htm"/> <entry name="error" url="http://www.lispworks.com/documentation/HyperSpec/Body/e_error.htm"/> <entry name="float" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_float.htm"/> + <entry name="format" url="http://www.lispworks.com/documentation/HyperSpec/Body/f_format.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"/> Modified: trunk/docs/manual/gf-data.xsl ============================================================================== --- trunk/docs/manual/gf-data.xsl (original) +++ trunk/docs/manual/gf-data.xsl Fri Oct 20 17:07:44 2006 @@ -323,11 +323,13 @@ </xsl:element> <xsl:element name="entry"> <xsl:attribute name="valign">top</xsl:attribute> - <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 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 17:07:44 2006 @@ -17,6 +17,119 @@  + <class name="flow-layout"> + <description> + <hierarchy> + <inherits> + <reftopic>gfw:layout-manager</reftopic> + </inherits> + </hierarchy> + This layout manager arranges child widgets in a row or column. + </description> + <initargs> + <argument name=":spacing"> + <description> + An <refclhs>integer</refclhs> value specifying the number of pixels + between succeeding child widgets. + </description> + </argument> + <argument name=":style"> + <description> + A <refclhs>list</refclhs> containing keyword symbols, as follows. + One of the following primary styles: + <enum> + <argument name=":horizontal"> + <description>Horizontal orientation is the default.</description> + </argument> + <argument name=":vertical"> + <description>Vertical orientation.</description> + </argument> + </enum> + Zero or more of the following optional styles: + <enum> + <argument name=":normalize"> + <description> + Children will be sized equally in the dimension opposite to + the layout orientation, using the maximum of the preferred sizes. + </description> + </argument> + <argument name=":wrap"> + <description> + Enables wrapping of the layout flow if the available horizontal + (or vertical) space within the container is less than the layout + requests for a full row (or column). The default layout mode is unwrapped. + </description> + </argument> + </enum> + </description> + </argument> + </initargs> + <seealso> + <reftopic>gfw:preferred-size</reftopic> + </seealso> + </class> + + <class name="heap-layout"> + <description> + <hierarchy> + <inherits> + <reftopic>gfw:layout-manager</reftopic> + </inherits> + </hierarchy> + This layout manager creates a virtual heap of child widgets, where only + one child is visible at a time (known as the <emphasis>top child</emphasis>). + Application code can select a different child to be the + <emphasis>top child</emphasis> as needed, with a subsequent call to + <reftopic>gfw:layout</reftopic> updating the layout visually. If no + maximum or minimum size is set for + any children, all children are resized according to the maximum of their + preferred sizes. + </description> + <initargs> + <argument name=":top-child"> + <description> + The child widget that should be initially visible. + </description> + </argument> + </initargs> + <seealso> + <reftopic>gfw:preferred-size</reftopic> + </seealso> + </class> + + <class name="menu"> + <description> + <hierarchy> + <inherits> + <reftopic>gfw:widget</reftopic> + <reftopic>gfw:item-manager</reftopic> + </inherits> + </hierarchy> + This class represents a container for menu items and submenus. + </description> + <initargs> + <argument name=":callbacks"> + <description> + See <reftopic>gfw:event-source</reftopic>. + </description> + </argument> + <argument name=":dispatcher"> + <description> + See <reftopic>gfw:event-source</reftopic>. + </description> + </argument> + <argument name=":handle"> + <description> + See <reftopic>gfs:native-object</reftopic>. + </description> + </argument> + </initargs> + <seealso> + <reftopic>gfs:dispose</reftopic> + <reftopic>gfw:menu-item</reftopic> + </seealso> + </class> + <class name="display"> <description> <hierarchy> @@ -161,6 +274,199 @@ </seealso> </class> + <class name="item"> + <description> + <hierarchy> + <inherits> + <reftopic>gfw:event-source</reftopic> + </inherits> + <inheritedby> + <reftopic>gfw:list-item</reftopic> + <reftopic>gfw:menu-item</reftopic> + </inheritedby> + </hierarchy> + This is the base class for non-windowed user interface objects serving + as elements of a <reftopic>gfw:item-manager</reftopic>. For example, + each entry in a <reftopic>gfw:list-box</reftopic> control is represented + by an item. + </description> + <initargs> + <argument name=":callback"> + <description> + A callback function whose arguments are congruent with + <reftopic>gfw:event-select</reftopic>. + </description> + </argument> + <argument name=":data"> + <description> + An application-supplied object to be represented by an item instance. + </description> + </argument> + </initargs> + <seealso> + <reftopic>gfs:dispose</reftopic> + <reftopic>gfw:owner</reftopic> + </seealso> + </class> + + <class name="item-manager"> + <description> + <hierarchy> + <inheritedby> + <reftopic>gfw:menu</reftopic> + <reftopic>gfw:list-box</reftopic> + </inheritedby> + </hierarchy> + This is a mix-in for widgets that contain and display sub-elements. + </description> + <initargs> + <argument name=":image-provider"> + <description> + A function accepting one argument and returning an instance of + <reftopic>gfg:image</reftopic>. The function's argument will be + the application-supplied object for the <reftopic>gfw:item</reftopic> + being rendered. The default implementation returns NIL. + </description> + </argument> + <argument name=":sort-predicate"> + <description> + A function accepting two arguments and returning a <refclhs>boolean</refclhs>. + This serves as a predicate for the purpose of ordering the members of the + item-manager. The arguments are two of the application-supplied objects. + Not all subclasses of item-manager make use of this feature. + </description> + </argument> + <argument name=":text-provider"> + <description> + A function accepting one argument and returning a <refclhs>string</refclhs>. + The function's argument will be the application-supplied object for the + <reftopic>gfw:item</reftopic> being rendered. The default implementation + checks whether the argument is a <refclhs>string</refclhs>, and if so, + just returns it; otherwise, <refclhs>format</refclhs> is called. + </description> + </argument> + </initargs> + <seealso> + <reftopic>gfs:dispose</reftopic> + </seealso> + </class> + + <class name="list-item"> + <description> + <hierarchy> + <inherits> + <reftopic>gfw:item</reftopic> + </inherits> + </hierarchy> + This class represents an element of a <reftopic>gfw:list-box</reftopic>. + </description> + <initargs> + <argument name=":callback"> + <description> + See <reftopic>gfw:item</reftopic>. + </description> + </argument> + <argument name=":data"> + <description> + See <reftopic>gfw:item</reftopic>. + </description> + </argument> + </initargs> + <seealso> + <reftopic>gfs:dispose</reftopic> + </seealso> + </class> + + <class name="widget"> + <description> + <hierarchy> + <inherits> + <reftopic>gfw:event-source</reftopic> + </inherits> + <inheritedby> + <reftopic>gfw:control</reftopic> + <reftopic>gfw:color-dialog</reftopic> + <reftopic>gfw:file-dialog</reftopic> + <reftopic>gfw:menu</reftopic> + <reftopic>gfw:window</reftopic> + </inheritedby> + </hierarchy> + The widget class is the base class for all windowed user interface objects. + </description> + <initargs> + <argument name=":style"> + <description> + A <refclhs>list</refclhs> of keyword symbols supplying additional + information about the desired look-and-feel or behavior of the widget; + style keywords are widget-specific. + </description> + </argument> + <argument name=":callbacks"> + <description> + See <reftopic>gfw:event-source</reftopic>. + </description> + </argument> + <argument name=":handle"> + <description> + See <reftopic>gfs:native-object</reftopic>. + </description> + </argument> + </initargs> + <seealso> + <reftopic>gfs:dispose</reftopic> + </seealso> + </class> + + <class name="timer"> + <description> + <hierarchy> + <inherits> + <reftopic>gfw:event-source</reftopic> + </inherits> + </hierarchy> + A timer is a non-windowed object that generates events at a regular + (adjustable) frequency. Applications handle timer events by implementing + methods for the <reftopic>gfw:event-timer</reftopic> generic function. + </description> + <initargs> + <argument name=":initial-delay"> + <description> + A non-negative <refclhs>integer</refclhs> value specifying the number + of milliseconds until the first timer event is delivered. + </description> + </argument> + <argument name=":delay"> + <description> + A non-negative <refclhs>integer</refclhs> value specifying the number + of milliseconds between successive timer events. If + <emphasis>:initial-delay</emphasis> is + not specified, then this value will be used as the initial delay as well. + Setting <emphasis>:delay</emphasis> to 0 and + <emphasis>:initial-delay</emphasis> to a positive value has the effect + of creating a <emphasis>one-shot</emphasis> timer. + </description> + </argument> + <argument name=":callbacks"> + <description> + See <reftopic>gfw:event-source</reftopic>. + </description> + </argument> + <argument name=":dispatcher"> + <description> + See <reftopic>gfw:event-source</reftopic>. + </description> + </argument> + <argument name=":handle"> + <description> + See <reftopic>gfs:native-object</reftopic>. + </description> + </argument> + </initargs> + <seealso> + <reftopic>gfs:dispose</reftopic> + </seealso> + </class> +

1 0

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

20 Oct '06

Author: junrue Date: Fri Oct 20 15:48:08 2006 New Revision: 368 Modified: trunk/docs/manual/gfw-symbols.xml Log: Modified: trunk/docs/manual/gfw-symbols.xml ============================================================================== --- trunk/docs/manual/gfw-symbols.xml (original) +++ trunk/docs/manual/gfw-symbols.xml Fri Oct 20 15:48:08 2006 @@ -231,6 +231,17 @@ </seealso> </function> + <function name="obtain-event-time"> + <syntax> + <return> + <emphasis>milliseconds</emphasis> + </return> + </syntax> + <description> + Returns the millisecond timestamp of the event currently being processed. + </description> + </function> +  <generic-function name="event-activate"> @@ -334,6 +345,61 @@ </seealso> </generic-function> + <generic-function name="event-timer"> + <syntax> + <arguments> + <argument name="event-dispatcher"> + <description> + The <reftopic>gfw:event-dispatcher</reftopic> that will process + this event. + </description> + </argument> + <argument name="timer"> + <description> + The <reftopic>gfw:timer</reftopic> that generated this event. + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Implement a method for this generic function to handle timer notifications. + </description> + <seealso> + <reftopic>gfw:event-source</reftopic> + </seealso> + </generic-function> + + <generic-function name="event-modify"> + <syntax> + <arguments> + <argument name="event-dispatcher"> + <description> + The <reftopic>gfw:event-dispatcher</reftopic> that will process + this event. + </description> + </argument> + <argument name="widget"> + <description> + The <reftopic>gfw:widget</reftopic> modified by the user. + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Implement this method to respond to changes due to user input within <arg1/>, + for example when the user types text inside an edit control. + </description> + <seealso> + <reftopic>gfw:event-source</reftopic> + </seealso> + </generic-function> + <generic-function name="event-close"> <syntax> <arguments> @@ -434,6 +500,36 @@ </seealso> </generic-function> + <generic-function name="event-select"> + <syntax> + <arguments> + <argument name="event-dispatcher"> + <description> + The <reftopic>gfw:event-dispatcher</reftopic> that will process + this event. + </description> + </argument> + <argument name="widget"> + <description> + The <reftopic>gfw:widget</reftopic> that was selected, or whose + sub-element was selected. + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Implement a method for this generic function to handle notification that + <arg1/> or some sub-element of <arg1/> has been selected. Selection may + occur via the mouse or keyboard. + </description> + <seealso> + <reftopic>gfw:event-source</reftopic> + </seealso> + </generic-function> + <generic-function name="event-focus-gain"> <syntax> <arguments> @@ -993,6 +1089,197 @@ </seealso> </generic-function> + <generic-function name="event-scroll"> + <syntax> + <arguments> + <argument name="event-dispatcher"> + <description> + The <reftopic>gfw:event-dispatcher</reftopic> that will process + this event. + </description> + </argument> + <argument name="widget"> + <description> + The <reftopic>gfw:widget</reftopic> that was scrolled. + </description> + </argument> + <argument name="axis"> + <description> + One of the following keyword symbols describing orientation: + <enum> + <argument name=":horizontal"/> + <argument name=":vertical"/> + </enum> + </description> + </argument> + <argument name="detail"> + <description> + One of the following keyword symbols describing the requested scrolling + action: + <enum> + <argument name=":end"> + <description> + Move the viewport such that the bottom or right-most content is + revealed. + </description> + </argument> + <argument name=":page-back"> + <description> + Move the viewport backwards by an amount equal to the viewport's + height or width, or the amount remaining between the current + viewport origin and the model origin, whichever is smaller. + </description> + </argument> + <argument name=":page-forward"> + <description> + Move the viewport forward by an amount equal to the viewport's + height or width, or the amount remaining between the current + viewport origin and the model extent, whichever is smaller. + </description> + </argument> + <argument name=":start"> + <description> + Move the viewport such that the top or left-most model content is + revealed. + </description> + </argument> + <argument name=":step-back"> + <description> + Move the viewport backwards by an application-defined amount, or + the amount remaining between the current viewport origin and the + model origin, whichever is smaller. + </description> + </argument> + <argument name=":step-forward"> + <description> + Move the viewport forward by an application-defined amount, or the + amount remaining between the current viewport origin and the model + extent, whichever is smaller. + </description> + </argument> + <argument name=":thumb-position"> + <description> + Move the viewport to an absolute position. + </description> + </argument> + <argument name=":thumb-track"> + <description> + The user is adjusting the viewport origin continuously, as when + dragging the scrollbar thumb. + </description> + </argument> + </enum> + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + Implement a method for this generic function to handle scrolling notifications + for <arg1/>. + </description> + <seealso> + <reftopic>gfw:event-source</reftopic> + </seealso> + </generic-function> + + <generic-function name="event-session"> + <syntax> + <arguments> + <argument name="event-dispatcher"> + <description> + The <reftopic>gfw:event-dispatcher</reftopic> that will process + this event. + </description> + </argument> + <argument name="widget"> + <description> + The <reftopic>gfw:widget</reftopic> receiving this event. + </description> + </argument> + <argument name="phase"> + <description> + <enum> + <argument name=":query"> + <description> + This symbol means that the system is querying the application + for permission to proceed. Return nil if there is a reason to + veto the process, or non-nil otherwise. + </description> + </argument> + <argument name=":end"> + <description> + This symbol is specified in the subsequent call to event-session. + It means that the system is going ahead with ending the session, + therefore this is an opportunity for graceful cleanup. + </description> + </argument> + </enum> + </description> + </argument> + <argument name="reason"> + <description> + <enum> + <argument name=":logoff"> + <description> + The user is logging off. + </description> + </argument> + <argument name=":replacing-file"> + <description> + The application must exit because a file it is using is being + replaced. + </description> + </argument> + <argument name=":shutdown"> + <description> + The system is shutting down or restarting. + </description> + </argument> + </enum> + </description> + </argument> + </arguments> + <return> + <emphasis>undefined</emphasis> + </return> + </syntax> + <description> + <para role="normal"> + Implement this method to participate in the system's session shutdown + protocol. When the user chooses to end the session (by logging out or + by shutting down), or if an application calls one of the Win32 shutdown + functions, every application is given a veto option. This event function + will be called at least once for each top-level window in the application. + </para> + <para role="normal"> + The MSDN documentation makes the following recommendations for handling + this event: + </para> + <itemizedlist mark="bullet" spacing="compact"> + <listitem> + Whenever possible, applications should respect the user's intentions by + allowing the session to end. + </listitem> + <listitem> + In the case of a critical operation, provide a dialog or other feedback + with information for the user as to consequences if the application is + interrupted at this time. + </listitem> + <listitem> + Respond to the :query phase as quickly as possible, leaving time-consuming + cleanup to be done in the session :end phase. + </listitem> + </itemizedlist> + </description> + <seealso> + <reftopic>gfw:event-source</reftopic> + <reftopic>gfw:top-level</reftopic> + </seealso> + </generic-function> +  </package>

1 0