graphic-forms-cvs
Threads by month
- ----- 2025 -----
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2024 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2023 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2022 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2021 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2020 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2019 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2018 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2017 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2016 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2015 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2014 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2013 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2012 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2011 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2010 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2009 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2008 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2007 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2006 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
October 2006
- 1 participants
- 102 discussions
Author: junrue
Date: Sun Oct 22 14:54:27 2006
New Revision: 387
Added:
tags/release-0.6.0/
- copied from r386, trunk/
Log:
tagging the 0.6.0 release
1
0
[graphic-forms-cvs] r386 - in trunk: . docs/manual docs/website
by junrue＠common-lisp.net 22 Oct '06
by junrue＠common-lisp.net 22 Oct '06
22 Oct '06
Author: junrue
Date: Sun Oct 22 14:48:51 2006
New Revision: 386
Modified:
trunk/NEWS.txt
trunk/README.txt
trunk/docs/manual/introduction.xml
trunk/docs/website/index.html
Log:
more release prep
Modified: trunk/NEWS.txt
==============================================================================
--- trunk/NEWS.txt (original)
+++ trunk/NEWS.txt Sun Oct 22 14:48:51 2006
@@ -5,7 +5,6 @@
Here is what's new in this release:
-
. CFFI snapshot 060925 or later is now required if you are running
CLISP 2.40 or later (due to a change in the argument list of
CLISP's FFI:FOREIGN-LIBRARY-FUNCTION).
@@ -75,6 +74,19 @@
for windows whereby the size value was not being set in the appropriate
slot if there were no layout set for the window.
+The README.txt file in the release zip file also has additional important
+information about this release.
+
+Download the release zip file here:
+http://prdownloads.sourceforge.net/graphic-forms/graphic-forms-0.6.0.zip?download
+
+The project website is:
+http://common-lisp.net/project/graphic-forms/
+
+Jack Unrue
+jdunrue (at) gmail (dot) com
+22 October 2006
+
==============================================================================
Release 0.5.0 of Graphic-Forms, a Common Lisp library for Windows GUI
Modified: trunk/README.txt
==============================================================================
--- trunk/README.txt (original)
+++ trunk/README.txt Sun Oct 22 14:48:51 2006
@@ -43,7 +43,7 @@
Supported Common Lisp Implementations
-------------------------------------
-Graphic-Forms currently supports CLISP 2.38 or higher, LispWorks 4.4.6,
+Graphic-Forms currently supports CLISP 2.40 or higher, LispWorks 4.4.6,
and SBCL 0.9.15 (the latter with a small patch).
Modified: trunk/docs/manual/introduction.xml
==============================================================================
--- trunk/docs/manual/introduction.xml (original)
+++ trunk/docs/manual/introduction.xml Sun Oct 22 14:48:51 2006
@@ -46,7 +46,7 @@
<title>Prerequisites</title>
<bridgehead renderas="sect2">Supported Common Lisp Implementations</bridgehead>
<itemizedlist mark="bullet" spacing="compact">
- <listitem>CLISP 2.38 or later</listitem>
+ <listitem>CLISP 2.40 or later</listitem>
<listitem>LispWorks 4.4.6</listitem>
<listitem>
SBCL 0.9.15 or later
Modified: trunk/docs/website/index.html
==============================================================================
--- trunk/docs/website/index.html (original)
+++ trunk/docs/website/index.html Sun Oct 22 14:48:51 2006
@@ -51,7 +51,7 @@
<p>The supported Lisp implementations are:
<ul>
- <li><a href="http://clisp.cons.org/">CLISP 2.38</a> or later</li>
+ <li><a href="http://clisp.cons.org/">CLISP 2.40</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> or later</li>
</ul>
1
0
[graphic-forms-cvs] r385 - in trunk: . docs/manual docs/website src/tests/uitoolkit
by junrue＠common-lisp.net 22 Oct '06
by junrue＠common-lisp.net 22 Oct '06
22 Oct '06
Author: junrue
Date: Sun Oct 22 14:36:56 2006
New Revision: 385
Added:
trunk/src/tests/uitoolkit/README.txt
Modified:
trunk/NEWS.txt
trunk/README.txt
trunk/docs/manual/Makefile
trunk/docs/manual/README.txt
trunk/docs/manual/gf-data.xsl
trunk/docs/manual/gfw-symbols.xml
trunk/docs/manual/graphic-forms.xml
trunk/docs/manual/graphic-forms.xsl
trunk/docs/website/docs.html
trunk/docs/website/index.html
Log:
release 0.6 prep
Modified: trunk/NEWS.txt
==============================================================================
--- trunk/NEWS.txt (original)
+++ trunk/NEWS.txt Sun Oct 22 14:36:56 2006
@@ -1,9 +1,18 @@
+Release 0.6.0 of Graphic-Forms, a Common Lisp library for Windows GUI
+programming, is now available. This is an alpha release, meaning that
+the feature set and API have not yet stabilized.
+
+Here is what's new in this release:
+
. CFFI snapshot 060925 or later is now required if you are running
CLISP 2.40 or later (due to a change in the argument list of
CLISP's FFI:FOREIGN-LIBRARY-FUNCTION).
+. Completely revamped the Programming Reference. DocBook/XSL is now used
+ for help authoring, and the manual is delivered in HTML Help format.
+
. Implemented scrolling protocol and related helper objects and functions
to facilitate scrolling functionality in applications:
Modified: trunk/README.txt
==============================================================================
--- trunk/README.txt (original)
+++ trunk/README.txt Sun Oct 22 14:36:56 2006
@@ -1,5 +1,5 @@
-Graphic-Forms README for version 0.6.0 (xx xxxxxxx 2006)
+Graphic-Forms README for version 0.6.0 (22 October 2006)
Copyright (c) 2006, Jack D. Unrue
Graphic-Forms is a user interface library implemented in Common Lisp focusing
@@ -17,7 +17,7 @@
http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/cclan/asdf/
*note: ASDF is bundled with SBCL*
- - CFFI (cffi-060606 or later)
+ - CFFI (cffi-060925 or later)
http://common-lisp.net/project/cffi/
- Closer to MOP
@@ -138,12 +138,8 @@
(asdf:operate 'asdf:load-op :graphic-forms-uitoolkit)
-6. You may optionally compile the reference manual. GNU Make and
- makeinfo (version 4.8) are prerequisites. Assuming you already
- have those components installed, the reference manual can be
- built by opening a command prompt and cd'ing to the `docs\manual'
- subdirectory, then typing `make'. The output will be
- deposited in a subdirectory called `reference'.
+6. You may optionally compile the reference manual. See the README.txt
+ file in the docs/manual subdirectory for more details.
7. Proceed to the next section to run the tests, or start coding!
@@ -164,26 +160,20 @@
;;
;; execute demos and test programs
+ ;;
+ (gft:hello-world)
(gft:unblocked)
(gft:textedit)
- (gft:drawing-tester)
-
- (gft:event-tester)
-
- (gft:image-tester) ; if ImageMagick loaded, shows PNG and GIF images
-
- (gft:layout-tester)
-
- (gft:widget-tester)
-
- (gft:windlg)
+ ;;
+ ;; see src/tests/uitoolkit/README.txt
+ ;; for details on other test programs
;;
;; execute the unit-tests
-
+ ;;
(in-package :gft)
(run-tests)
Modified: trunk/docs/manual/Makefile
==============================================================================
--- trunk/docs/manual/Makefile (original)
+++ trunk/docs/manual/Makefile Sun Oct 22 14:36:56 2006
@@ -5,18 +5,22 @@
# Copyright (c) 2006, Jack D. Unrue
#
-CHM-DEPS = gfs-tmp-pkg.xml gfg-tmp-pkg.xml gfw-tmp-pkg.xml constants.xml api.xml \
+VERSION = 0.6
+
+CHM-DEPS = gfs-tmp-pkg.xml gfg-tmp-pkg.xml gfw-tmp-pkg.xml \
+ constants.xml api.xml \
catalog.xml glossary.xml graphic-forms.xml image-data-plugins.xml \
introduction.xml legal.xml miscellaneous-topics.xml
COMMON-DEPS = gf-data.xsl gf-package.xsl clhs-table.xml win32-api-table.xml
TMP-XML = gfs-tmp-pkg.xml gfs-tmp-syms.xml gfg-tmp-pkg.xml gfg-tmp-syms.xml \
- gfw-tmp-pkg.xml gfw-tmp-syms.xml
+ gfw-tmp-pkg.xml gfw-tmp-syms.xml tmp.xml
XSLT-PROC = xsltproc --nonet
-graphic-forms.chm: $(CHM-DEPS)
- $(XSLT-PROC) graphic-forms.xsl graphic-forms.xml
+graphic-forms-$(VERSION).chm: $(CHM-DEPS)
+ cat graphic-forms.xml | sed -e 's/VERSION/$(VERSION)/g' > tmp.xml
+ $(XSLT-PROC) --stringparam version $(VERSION) graphic-forms.xsl tmp.xml
-hhc htmlhelp.hhp; exit 0 # muffle Error Ignored msg due to hhc exit value 1
find . \( -name "*~" -o -name "*.html" -o -name "*.hhk" -o -name "*.hhc" -o -name "*.hhp" \) -exec rm {} \;
Modified: trunk/docs/manual/README.txt
==============================================================================
--- trunk/docs/manual/README.txt (original)
+++ trunk/docs/manual/README.txt Sun Oct 22 14:36:56 2006
@@ -37,10 +37,10 @@
subdirectory underneath where you installed the Graphic-Forms source.
Modify the URI values in catalog.xml to suit your particular
-environment, then run make on Makefile.
-
-Then double-click on graphic-forms.chm and you should see the
-Programming Reference appear.
+environment, then run make on Makefile. A file named
+graphic-forms-<version>.chm is created in the current directory.
+<version> is the version of Graphic-Forms. Double-click on the
+CHM file and start enjoying the Programming Reference :-)
More information about configuring DocBook and xsltproc, as well
Modified: trunk/docs/manual/gf-data.xsl
==============================================================================
--- trunk/docs/manual/gf-data.xsl (original)
+++ trunk/docs/manual/gf-data.xsl Sun Oct 22 14:36:56 2006
@@ -115,7 +115,7 @@
</xsl:when>
<xsl:otherwise>
<xsl:message terminate="yes">
- <xsl:text>Could not find argument </xsl:text><xsl:value-of select="$index - 1"/>
+ <xsl:text>gf-data.xsl: could not find argument </xsl:text><xsl:value-of select="$index - 1"/>
</xsl:message>
</xsl:otherwise>
</xsl:choose>
Modified: trunk/docs/manual/gfw-symbols.xml
==============================================================================
--- trunk/docs/manual/gfw-symbols.xml (original)
+++ trunk/docs/manual/gfw-symbols.xml Sun Oct 22 14:36:56 2006
@@ -2414,6 +2414,141 @@
<!-- GENERIC FUNCTIONS -->
+ <generic-function name="compute-layout">
+ <syntax>
+ <arguments>
+ <argument name="layout-manager">
+ <description>
+ The <reftopic>gfw:layout-manager</reftopic> dictating how children
+ of <arg1/> are to be arranged.
+ </description>
+ </argument>
+ <argument name="layout-managed">
+ <description>
+ The <reftopic>gfw:layout-managed</reftopic> container whose children
+ are to be sized and positioned.
+ </description>
+ </argument>
+ <argument name="width-hint">
+ <description>
+ A positive <refclhs>integer</refclhs> specifying a hypothetical width
+ value, or negative if <arg1/>'s width is not constrained.
+ </description>
+ </argument>
+ <argument name="height-hint">
+ <description>
+ A positive <refclhs>integer</refclhs> specifying a hypothetical height
+ value, or negative if <arg1/>'s height is not constrained.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ This function is responsible for the actual layout of children. Returns
+ a <refclhs>list</refclhs> of (child . rectangle) pairs describing the
+ new bounds of each child within <arg1/>. A <reftopic>gfw:layout-manager</reftopic>
+ subclass implements a method for this generic function based on its particular
+ layout strategy, possibly using attributes set by the user via
+ <reftopic>gfw:layout-attribute</reftopic>.
+ </description>
+ <seealso>
+ <reftopic>gfw:compute-size</reftopic>
+ <reftopic>gfw:perform</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="compute-size">
+ <syntax>
+ <arguments>
+ <argument name="layout-manager">
+ <description>
+ The <reftopic>gfw:layout-manager</reftopic> dictating how children
+ of <arg1/> are to be arranged.
+ </description>
+ </argument>
+ <argument name="layout-managed">
+ <description>
+ The <reftopic>gfw:layout-managed</reftopic> container whose children
+ are to be sized and positioned.
+ </description>
+ </argument>
+ <argument name="width-hint">
+ <description>
+ A positive <refclhs>integer</refclhs> specifying a hypothetical width
+ value, or negative if <arg1/>'s width is not constrained.
+ </description>
+ </argument>
+ <argument name="height-hint">
+ <description>
+ A positive <refclhs>integer</refclhs> specifying a hypothetical height
+ value, or negative if <arg1/>'s height is not constrained.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Computes and returns the new <reftopic>gfs:size</reftopic> of <arg1/>'s
+ client area. A <reftopic>gfw:layout-manager</reftopic> subclass implements
+ a method for this generic function based on its particular layout strategy,
+ possibly using attributes set by the user via
+ <reftopic>gfw:layout-attribute</reftopic>.
+ </description>
+ <seealso>
+ <reftopic>gfw:compute-layout</reftopic>
+ <reftopic>gfw:perform</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="perform">
+ <syntax>
+ <arguments>
+ <argument name="layout-manager">
+ <description>
+ The <reftopic>gfw:layout-manager</reftopic> dictating how children
+ of <arg1/> are to be arranged.
+ </description>
+ </argument>
+ <argument name="layout-managed">
+ <description>
+ The <reftopic>gfw:layout-managed</reftopic> container whose children
+ are to be sized and positioned.
+ </description>
+ </argument>
+ <argument name="width-hint">
+ <description>
+ A positive <refclhs>integer</refclhs> specifying a hypothetical width
+ value, or negative if <arg1/>'s width is not constrained.
+ </description>
+ </argument>
+ <argument name="height-hint">
+ <description>
+ A positive <refclhs>integer</refclhs> specifying a hypothetical height
+ value, or negative if <arg1/>'s height is not constrained.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Calls <reftopic>gfw:compute-layout</reftopic> for <arg1/> and then moves
+ and resizes <arg1/>'s children. Subclasses may implement their own methods
+ on this generic function, but note that most derivations should call
+ CALL-NEXT-METHOD to allow the base implementation to execute.
+ </description>
+ <seealso>
+ <reftopic>gfw:compute-layout</reftopic>
+ <reftopic>gfw:compute-size</reftopic>
+ </seealso>
+ </generic-function>
+
<generic-function name="update-native-style">
<syntax>
<arguments>
@@ -2499,7 +2634,7 @@
<seealso>
<reftopic>gfw:redraw</reftopic>
<reftopic>gfw:with-drawing-disabled</reftopic>
- <reftopic>gfw:enable-drawing</reftopic>
+ <reftopic>gfw:enable-redraw</reftopic>
</seealso>
</generic-function>
Modified: trunk/docs/manual/graphic-forms.xml
==============================================================================
--- trunk/docs/manual/graphic-forms.xml (original)
+++ trunk/docs/manual/graphic-forms.xml Sun Oct 22 14:36:56 2006
@@ -25,7 +25,7 @@
</subtitle>
<bridgehead renderas="sect2">
- Programming Reference (version 0.6)
+ Reference (version VERSION)
</bridgehead>
Modified: trunk/docs/manual/graphic-forms.xsl
==============================================================================
--- trunk/docs/manual/graphic-forms.xsl (original)
+++ trunk/docs/manual/graphic-forms.xsl Sun Oct 22 14:36:56 2006
@@ -7,6 +7,7 @@
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
<xsl:import href="htmlhelp.xsl"/>
+ <xsl:param name="version" />
<xsl:param name="chapter.autolabel" select="0"/>
<xsl:param name="chunk.first.sections" select="1"/>
<xsl:param name="chunk.section.depth" select="2"/>
@@ -18,7 +19,7 @@
<xsl:param name="htmlhelp.button.forward" select="1"/>
<xsl:param name="htmlhelp.button.next" select="0"/>
<xsl:param name="htmlhelp.button.prev" select="0"/>
- <xsl:param name="htmlhelp.chm" select="'graphic-forms.chm'"/>
+ <xsl:param name="htmlhelp.chm" select="concat('graphic-forms-',$version,'.chm')"/>
<xsl:param name="htmlhelp.hhc.folders.instead.books" select="0"/>
<xsl:param name="htmlhelp.show.advanced.search" select="1"/>
<xsl:param name="suppress.navigation" select="1"/>
Modified: trunk/docs/website/docs.html
==============================================================================
--- trunk/docs/website/docs.html (original)
+++ trunk/docs/website/docs.html Sun Oct 22 14:36:56 2006
@@ -13,7 +13,9 @@
<h3>Graphic-Forms documentation</h3>
</div>
- <h3><a href="reference/index.html">Programming Reference</a></h3>
+ <h3><a href="http://sourceforge.net/project/showfiles.php?group_id=163034">Programming Reference</a></h3>
+ <p>Note: the link above leads to the SourceForge download site, from
+ where you can download the Reference in HTML Help (CHM) format.</p>
<h3><a href="faq.html">FAQ</a></h3>
Modified: trunk/docs/website/index.html
==============================================================================
--- trunk/docs/website/index.html (original)
+++ trunk/docs/website/index.html Sun Oct 22 14:36:56 2006
@@ -43,7 +43,7 @@
<p>The current version is
<a href="http://sourceforge.net/project/showfiles.php?group_id=163034">
- 0.6.0</a>, released on 22 August 2006.</p>
+ 0.6.0</a>, released on 22 October 2006.</p>
<p>Graphic-Forms is in the alpha stage of development,
meaning new features are still being added and existing features require
considerable testing. Brave souls who experiment with the code should expect
Added: trunk/src/tests/uitoolkit/README.txt
==============================================================================
--- (empty file)
+++ trunk/src/tests/uitoolkit/README.txt Sun Oct 22 14:36:56 2006
@@ -0,0 +1,55 @@
+
+Here is some information on the test programs available in this directory.
+You must first load the Graphic-Forms systems as described in the top-level
+README file.
+
+
+How To Run Purpose
+------------------------------------------------------------------------------
+
+(gft:drawing-tester) Provides a test case for each major drawing operation,
+ with variations for pen style, pen width, foreground,
+ and background color settings. Text mode also shows
+ features like tab expansion, mnemonics, and transparent
+ text.
+
+(gft:event-tester) Verifies that events are being delivered and processed.
+ Mouse events are visible if you press any button while
+ moving the mouse (of course, mouse move events do not
+ require a button press). Keyboard events are shown if
+ you type keys. Mousing over the menus and menu items
+ shows menu arming events. Also, this is one of the
+ test cases for setting menu options via DEFMENU.
+
+(gft:hello-world) A very basic sanity check that we are able to create
+ a window and repaint it when needed.
+
+(gft:image-tester) Tests the display of bitmaps in various sizes and
+ color depths, also showing transparency masks and the
+ resulting transparent backgrounds. Also, if you've
+ loaded the ImageMagick plugin as described in the
+ top-level README, you'll see a PNG image as well.
+
+(gft:layout-tester) Tests the flow layout manager. Explore the menu tree
+ to see what operations are possible. Try changing
+ layout settings and then resize the window.
+
+(gft:scroll-tester) Provides test cases for scrolling. Simple grid mode
+ displays a numbered, scrollable grid, where the
+ step size is 1 pixel. Text mode tests integral
+ scrolling and resizing support. When switching from
+ the simple grid to text mode, clicking on the window
+ border gets the window to reset to the proper boundary.
+
+(gft:widget-tester) This is a start at a generic widget-testing program.
+ Currently displays buttons, a check box, list boxes,
+ sliders, and scrollbars. This is also a test case for
+ heap layout.
+
+(gft:windlg) Provides a way to exercise custom dialogs, system
+ dialogs, and several window styles. Note that the
+ Borderless window is dismissed when you click within
+ it using the mouse.
+
+
+[the end]
1
0
Author: junrue
Date: Sun Oct 22 02:52:06 2006
New Revision: 384
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 Sun Oct 22 02:52:06 2006
@@ -361,6 +361,7 @@
</argument>
</initargs>
<seealso>
+ <reftopic>gfw:thumb-position</reftopic>
<reftopic>gfw:event-source</reftopic>
<reftopic>gfw:page-increment</reftopic>
<reftopic>gfw:step-increment</reftopic>
@@ -583,6 +584,12 @@
</initargs>
<seealso>
<reftopic>gfs:dispose</reftopic>
+ <reftopic>gfw:update-from-items</reftopic>
+ <reftopic>gfw:item-count</reftopic>
+ <reftopic>gfw:append-item</reftopic>
+ <reftopic>gfw:delete-item</reftopic>
+ <reftopic>gfw:item-index</reftopic>
+ <reftopic>gfw:selected-items</reftopic>
</seealso>
</class>
@@ -1443,6 +1450,9 @@
</initargs>
<seealso>
<reftopic>gfs:dispose</reftopic>
+ <reftopic>gfw:update-native-style</reftopic>
+ <reftopic>gfw:parent</reftopic>
+ <reftopic>gfw:style-of</reftopic>
</seealso>
</class>
@@ -2395,11 +2405,289 @@
<seealso>
<reftopic>gfw:standard-scrollbar</reftopic>
<reftopic>gfw:scrollbar</reftopic>
+ <reftopic>gfw:thumb-position</reftopic>
+ <reftopic>gfw:page-increment</reftopic>
+ <reftopic>gfw:step-increment</reftopic>
+ <reftopic>gfw:event-scroll</reftopic>
</seealso>
</function>
<!-- GENERIC FUNCTIONS -->
+ <generic-function name="update-native-style">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a <reftopic>gfw:control</reftopic> subclass.
+ </description>
+ </argument>
+ <argument name="integer">
+ <description>
+ An <refclhs>integer</refclhs> specifying replacement style flags.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ This function replaces the native style flags of <arg0/> with
+ <arg1/> and calls any additional API needed to ensure that
+ <arg0/>'s visual representation is refreshed. <arg1/>
+ is returned.
+ </para>
+ <para role="normal">
+ This function is not intended to be called from application code.
+ </para>
+ </description>
+ <seealso>
+ <reftopic>gfw:style-of</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="update-from-items">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a <reftopic>gfw:item-manager</reftopic> subclass.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ Synchronizes <arg0/>'s internal model (i.e., a native control's
+ data structures) with data derived from the <emphasis>items</emphasis>
+ slot. If <arg0/> has been assigned a sorting predicate, the array of
+ items will be sorted prior to the internal model update.
+ </para>
+ <para role="normal">
+ This function is not intended to be called from application code.
+ However, applications defining new control types may need to implement
+ this.
+ </para>
+ </description>
+ <seealso>
+ <reftopic>gfw:items-of</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="update">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a subclass of <reftopic>gfw:widget</reftopic>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Forces all outstanding paint requests for <arg0/> to be processed
+ before this function returns.
+ </description>
+ <seealso>
+ <reftopic>gfw:redraw</reftopic>
+ <reftopic>gfw:with-drawing-disabled</reftopic>
+ <reftopic>gfw:enable-drawing</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="thumb-position">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of <reftopic>gfw:scrollbar</reftopic>, <reftopic>gfw:slider</reftopic>,
+ or <reftopic>gfw:standard-scrollbar</reftopic>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) an <refclhs>integer</refclhs> value representing the
+ position of the scroll thumb for <arg0/>. A
+ <reftopic>gfw:scrolling-helper</reftopic> instance will manage the
+ thumb position for the <reftopic>gfw:window</reftopic> to which it is
+ assigned.
+ </description>
+ </generic-function>
+
+ <generic-function name="text-modified-p">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ An object with a text component that can be modified by
+ the user.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns T if the text component of <arg0/> has been modified by the user;
+ NIL otherwise. The corresponding SETF function updates the dirty state flag.
+ This function is not implemented for all <reftopic>gfw:widget</reftopic>s,
+ since in some cases there are multiple text components and in other cases
+ there is no text component at all.
+ </description>
+ <seealso>
+ <reftopic>gfw:text</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="text-for-pasting-p">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ The object to be queried for readiness to accept text from
+ the system clipboard.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ This function is a shortcut means of checking the clipboard for
+ existence of data of a specific type (text). This status information
+ is typically used to enable or disable a "Paste" menu item.
+ </para>
+ <para role="normal">
+ Note: an upcoming release will include more general infrastructure
+ for clipboard operations.
+ </para>
+ </description>
+ <seealso>
+ <reftopic>gfw:copy-text</reftopic>
+ <reftopic>gfw:cut-text</reftopic>
+ <reftopic>gfw:paste-text</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="text-baseline">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a <reftopic>gfw:widget</reftopic> subclass
+ having text content.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ Returns the Y coordinate value (in <arg0/>'s coordinate system)
+ that correlates to the baseline of the text of the control, if any.
+ For controls in which a text baseline is not meaningful, such as a
+ <reftopic>gfw:label</reftopic> with a <reftopic>gfg:image</reftopic>,
+ this function returns the control's height.
+ </para>
+ <para role="normal">
+ By default, Graphic-Forms does not implement this function for
+ <reftopic>gfw:window</reftopic> subclasses. However, custom controls
+ should implement this if the custom control will be used as a child
+ within a container using a <reftopic>gfw:layout-manager</reftopic>.
+ </para>
+ </description>
+ <seealso>
+ <reftopic>gfw:preferred-size</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="text">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ An object having a text attribute, such as a window title.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>string</refclhs>
+ </return>
+ </syntax>
+ <description>
+ For a <reftopic>gfw:window</reftopic> or <reftopic>gfw:dialog</reftopic>,
+ this function returns (sets) <arg0/>'s titlebar text (which may be blank). For
+ other widgets that have a text component, this function returns (sets) that
+ text component. For anything else, this function returns nil.
+ </description>
+ </generic-function>
+
+ <generic-function name="show">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object whose visibility is to be configured.
+ </description>
+ </argument>
+ <argument name="boolean">
+ <description>
+ A <refclhs>boolean</refclhs> flag.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Causes <arg0/> to be visible if <arg1/> is non-NIL (but not necessarily
+ top-most in the display Z-order), or hidden if <arg1/> is NIL.
+ </description>
+ <seealso>
+ <reftopic>gfw:visible-p</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="visible-p">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object whose visibility is to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns T if <arg0/> is visible (not necessarily top-most);
+ NIL otherwise.
+ </description>
+ <seealso>
+ <reftopic>gfw:show</reftopic>
+ </seealso>
+ </generic-function>
+
<generic-function name="selected-span">
<syntax with-setf="t">
<arguments>
@@ -2655,6 +2943,7 @@
will be generated so that <arg0/> can update itself visually.
</description>
<seealso>
+ <reftopic>gfw:update</reftopic>
<reftopic>gfw:enable-redraw</reftopic>
<reftopic>gfw:with-drawing-disabled</reftopic>
</seealso>
@@ -2763,6 +3052,7 @@
this value on behalf of windows with standard scrollbars.
</description>
<seealso>
+ <reftopic>gfw:thumb-position</reftopic>
<reftopic>gfw:event-scroll</reftopic>
<reftopic>gfw:scroll</reftopic>
<reftopic>gfw:step-increment</reftopic>
@@ -2790,6 +3080,7 @@
manages this value on behalf of windows with standard scrollbars.
</description>
<seealso>
+ <reftopic>gfw:thumb-position</reftopic>
<reftopic>gfw:event-scroll</reftopic>
<reftopic>gfw:scroll</reftopic>
<reftopic>gfw:page-increment</reftopic>
@@ -3177,7 +3468,7 @@
</generic-function>
<generic-function name="items-of">
- <syntax>
+ <syntax with-setf="t">
<arguments>
<argument name="self">
<description>
@@ -3408,6 +3699,8 @@
its client area; NIL disables redrawing.
</description>
<seealso>
+ <reftopic>gfw:update</reftopic>
+ <reftopic>gfw:redraw</reftopic>
<reftopic>gfw:with-drawing-disabled</reftopic>
</seealso>
</generic-function>
@@ -5378,6 +5671,9 @@
queued so that when the lock is lifted, <arg0/> will be repainted.
</description>
<seealso>
+ <reftopic>gfw:redraw</reftopic>
+ <reftopic>gfw:update</reftopic>
+ <reftopic>gfw:enable-redraw</reftopic>
</seealso>
</macro>
1
0
Author: junrue
Date: Sun Oct 22 02:00:35 2006
New Revision: 383
Modified:
trunk/docs/manual/gfg-symbols.xml
trunk/docs/manual/gfw-symbols.xml
Log:
Modified: trunk/docs/manual/gfg-symbols.xml
==============================================================================
--- trunk/docs/manual/gfg-symbols.xml (original)
+++ trunk/docs/manual/gfg-symbols.xml Sun Oct 22 02:00:35 2006
@@ -1393,7 +1393,7 @@
</argument>
<argument name="list">
<description>
- A <refclhs>list</refclhs> of <reftopic>gfg:point</reftopic>s
+ A <refclhs>list</refclhs> of <reftopic>gfs:point</reftopic>s
defining the polygon's line segments.
</description>
</argument>
@@ -1426,7 +1426,7 @@
</argument>
<argument name="list">
<description>
- A <refclhs>list</refclhs> of <reftopic>gfg:point</reftopic>s
+ A <refclhs>list</refclhs> of <reftopic>gfs:point</reftopic>s
defining the polygon's line segments.
</description>
</argument>
@@ -1460,7 +1460,7 @@
</argument>
<argument name="list">
<description>
- A <refclhs>list</refclhs> of <reftopic>gfg:point</reftopic>s
+ A <refclhs>list</refclhs> of <reftopic>gfs:point</reftopic>s
defining line segments.
</description>
</argument>
@@ -1500,7 +1500,7 @@
</argument>
<argument name="point">
<description>
- A <reftopic>gfg:point</reftopic> specifying the upper-left
+ A <reftopic>gfs:point</reftopic> specifying the upper-left
corner of the rectangle bounding <arg1/>.
</description>
</argument>
Modified: trunk/docs/manual/gfw-symbols.xml
==============================================================================
--- trunk/docs/manual/gfw-symbols.xml (original)
+++ trunk/docs/manual/gfw-symbols.xml Sun Oct 22 02:00:35 2006
@@ -622,11 +622,13 @@
<reftopic>gfw:control</reftopic>
<reftopic>gfw:color-dialog</reftopic>
<reftopic>gfw:file-dialog</reftopic>
+ <reftopic>gfw:font-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.
+ This is the base class for all windowed user interface objects whose
+ behavior can be extended by applications.
</description>
<initargs>
<argument name=":style">
@@ -751,7 +753,7 @@
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>
+ manually, in which case the <reftopic>gfw:obtain-chosen-files</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
@@ -886,7 +888,7 @@
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>
+ these steps manually, in which case the <reftopic>gfw:obtain-chosen-font</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>.
@@ -1404,7 +1406,7 @@
<reftopic>gfw:button</reftopic>
<reftopic>gfw:edit</reftopic>
<reftopic>gfw:label</reftopic>
- <reftopic>gfw:listbox</reftopic>
+ <reftopic>gfw:list-box</reftopic>
<reftopic>gfw:scrollbar</reftopic>
<reftopic>gfw:slider</reftopic>
</inheritedby>
@@ -1683,10 +1685,9 @@
<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>
+ <reftopic>gfw:text</reftopic>
</seealso>
</class>
@@ -2399,6 +2400,347 @@
<!-- GENERIC FUNCTIONS -->
+ <generic-function name="selected-span">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ An object having selectable content.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>object</emphasis>
+ <reftopic>gfs:span</reftopic>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ Returns a <reftopic>gfs:span</reftopic> describing a range of data
+ within <arg0/> that is in the selected state, as well as an object
+ to return the selected data. If there is no selection, this function
+ returns NIL for both values. This function is defined only for widgets
+ whose notion of selection is a contiguous range of simple data
+ (e.g., <refclhs>character</refclhs>s in a <refclhs>string</refclhs>).
+ </para>
+ <para role="normal">
+ The corresponding SETF function sets the content of <arg0/> whose
+ indices lie within <emphasis>span</emphasis> to the selected state.
+ An existing selection's extent is modified to match the new span.
+ Passing NIL for <emphasis>span</emphasis> will unselect all content.
+ </para>
+ </description>
+ <seealso>
+ <reftopic>gfw:selected-count</reftopic>
+ <reftopic>gfw:select-all</reftopic>
+ <reftopic>gfw:edit</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="selected-p">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object having selectable state as an attribute.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns T if <arg0/> is in the selected state; nil otherwise.
+ </description>
+ <seealso>
+ <reftopic>gfw:select</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="selected-count">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a subclass of <reftopic>gfw:item-manager</reftopic>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns the number of items contained by <arg0/> that are in the
+ selected state.
+ </description>
+ <seealso>
+ <reftopic>gfw:select-all</reftopic>
+ <reftopic>gfw:selected-items</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="selected-items">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a subclass of <reftopic>gfw:item-manager</reftopic>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>list</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) the <reftopic>gfw:item</reftopic> subclass instances
+ that are in the selected state. Passing NIL will unselect all items,
+ equivalent to calling <reftopic>gfw:select-all</reftopic>.
+ </description>
+ <seealso>
+ <reftopic>gfw:selected-count</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="select">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object having selectable state as an attribute.
+ </description>
+ </argument>
+ <argument name="boolean">
+ <description>
+ A <refclhs>boolean</refclhs> specifying whether <arg0/>'s
+ selection state is to be set or unset.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Sets <arg0/> to the selected state if <arg1/> is not NIL or to the
+ unselected state if NIL.
+ </description>
+ <seealso>
+ <reftopic>gfw:selected-p</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="select-all">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object having content that may be selected.
+ </description>
+ </argument>
+ <argument name="boolean">
+ <description>
+ A <refclhs>boolean</refclhs> specifying whether <arg0/>'s
+ content is to be selected or unselected.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Sets the content of <arg0/> to the selected state if <arg1/> is
+ not NIL or to the unselected state if NIL. For <reftopic>gfw:item-manager</reftopic>
+ subclasses, this means all items within <arg0/> are affected. For
+ controls with editable content, like <reftopic>gfw:edit</reftopic>, this
+ function affects all of the content.
+ </description>
+ <seealso>
+ <reftopic>gfw:selected-span</reftopic>
+ <reftopic>gfw:selected-items</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="scroll">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a subclass of <reftopic>gfw:window</reftopic>.
+ </description>
+ </argument>
+ <argument name="delta-x">
+ <description>
+ An <refclhs>integer</refclhs> specifying how many pixels to
+ scroll on the horizontal axis.
+ </description>
+ </argument>
+ <argument name="delta-y">
+ <description>
+ An <refclhs>integer</refclhs> specifying how many pixels to
+ scroll on the vertical axis.
+ </description>
+ </argument>
+ <argument name="children-p">
+ <description>
+ Not yet implemented, must be NIL.
+ </description>
+ </argument>
+ <argument name="milliseconds">
+ <description>
+ Not yet implemented, must be 0.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Scrolls <arg0/> by a number of pixels right or down equal to the
+ <refclhs>integer</refclhs> values <arg1/> and <arg2/>; either delta
+ value may be negative in order to scroll left or up. Paint events
+ are delivered for the areas exposed due to scrolling.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-paint</reftopic>
+ <reftopic>gfw:scrolling-helper</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="resizable-p">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a subclass of <reftopic>gfw:widget</reftopic>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns T if <arg0/> can be resized by the user; NIL otherwise.
+ The corresponding SETF function is implemented for <reftopic>gfw:top-level</reftopic>
+ (but only has meaning when the :frame or :workspace styles are set),
+ allowing the application to modify the resizability of <arg0/>, whereupon the
+ frame decorations are modified appropriately.
+ </description>
+ <seealso>
+ <reftopic>gfw:style-of</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="redraw">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a subclass of <reftopic>gfw:widget</reftopic>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Causes the entire bounds of <arg0/> to be marked as needing to be redrawn.
+ For <reftopic>gfw:window</reftopic> subclasses, an <reftopic>gfw:event-paint</reftopic>
+ will be generated so that <arg0/> can update itself visually.
+ </description>
+ <seealso>
+ <reftopic>gfw:enable-redraw</reftopic>
+ <reftopic>gfw:with-drawing-disabled</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="redo-available-p">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object that supports undo/redo.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns T if <arg0/> has undo/redo capability and has an operation that
+ can be redone; NIL otherwise.
+ </description>
+ <seealso>
+ <reftopic>gfw:undo-available-p</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="undo-available-p">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object that supports undo/redo.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns T if <arg0/> has undo/redo capability and has an operation that
+ can be undone; NIL otherwise.
+ </description>
+ <seealso>
+ <reftopic>gfw:redo-available-p</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="preferred-size">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a subclass of <reftopic>gfw:widget</reftopic>.
+ </description>
+ </argument>
+ <argument name="width-hint">
+ <description>
+ An <refclhs>integer</refclhs>.
+ </description>
+ </argument>
+ <argument name="height-hint">
+ <description>
+ An <refclhs>integer</refclhs>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic>gfs:size</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Implement this function to return <arg0/>'s preferred dimensions -- that is,
+ the dimensions that <arg0/> computes as being the best fit for itself and/or
+ its children. If one or both of <arg1/> and <arg2/> are positive, then each
+ such argument is used as a constraint on the size calculation.
+ </description>
+ <seealso>
+ <reftopic>gfw:layout</reftopic>
+ <reftopic>gfw:minimum-size</reftopic>
+ <reftopic>gfw:maximum-size</reftopic>
+ <reftopic>gfw:size</reftopic>
+ </seealso>
+ </generic-function>
+
<generic-function name="page-increment">
<syntax with-setf="t">
<arguments>
@@ -2852,7 +3194,8 @@
subclass instances. The SETF function provides a <refclhs>list</refclhs>
of data objects to be wrapped by instances of the appropriate
<reftopic>gfw:item</reftopic> subclass, which replaces the existing items
- within <arg0/> and then causes <arg0/> to be repainted.
+ within <arg0/>. Call <reftopic>gfw:update-from-items</reftopic> to repaint
+ <arg0/>.
</description>
<seealso>
<reftopic>gfw:append-item</reftopic>
@@ -3199,27 +3542,6 @@
</seealso>
</generic-function>
- <generic-function name="enabled-p">
- <syntax>
- <arguments>
- <argument name="self">
- <description>
- The object to query for its state.
- </description>
- </argument>
- </arguments>
- <return>
- <refclhs>boolean</refclhs>
- </return>
- </syntax>
- <description>
- Returns T if <arg0/> is enabled; NIL otherwise.
- </description>
- <seealso>
- <reftopic>gfw:enable</reftopic>
- </seealso>
- </generic-function>
-
<generic-function name="echo-character">
<syntax with-setf="t">
<arguments>
@@ -4922,6 +5244,52 @@
<!-- ACCESSORS -->
+ <slot-accessor name="style-of">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a subclass of <reftopic>gfw:widget</reftopic>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>list</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns a <refclhs>list</refclhs> of widget-specific keyword symbols
+ that configure the look-and-feel of <arg0/>.
+ </description>
+ <seealso>
+ <reftopic>gfw:update-native-style</reftopic>
+ </seealso>
+ </slot-accessor>
+
+ <slot-accessor name="layout-p">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a subclass of <reftopic>gfw:layout-managed</reftopic>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) a <refclhs>boolean</refclhs> controlling whether layout
+ management is enabled within <arg0/>.
+ </description>
+ <seealso>
+ <reftopic>gfw:layout</reftopic>
+ <reftopic>gfw:preferred-size</reftopic>
+ <reftopic>gfw:enable-layout</reftopic>
+ </seealso>
+ </slot-accessor>
+
<!-- MACROS -->
<macro name="with-color-dialog">
1
0
Author: junrue
Date: Sun Oct 22 00:44:07 2006
New Revision: 382
Modified:
trunk/docs/manual/api.xml
trunk/docs/manual/constants.xml
trunk/docs/manual/gfw-symbols.xml
trunk/docs/manual/introduction.xml
trunk/docs/manual/legal.xml
trunk/docs/manual/miscellaneous-topics.xml
Log:
Modified: trunk/docs/manual/api.xml
==============================================================================
--- trunk/docs/manual/api.xml (original)
+++ trunk/docs/manual/api.xml Sun Oct 22 00:44:07 2006
@@ -3,7 +3,7 @@
Copyright (c) 2006, Jack D. Unrue
-->
-<chapter>
+<chapter id="api">
<title>API Reference</title>
<para role="normal">
Modified: trunk/docs/manual/constants.xml
==============================================================================
--- trunk/docs/manual/constants.xml (original)
+++ trunk/docs/manual/constants.xml Sun Oct 22 00:44:07 2006
@@ -3,7 +3,7 @@
Copyright (c) 2006, Jack D. Unrue
-->
-<chapter>
+<chapter id="constants">
<title>Constants and Variables</title>
<indexterm><primary>constants</primary></indexterm>
Modified: trunk/docs/manual/gfw-symbols.xml
==============================================================================
--- trunk/docs/manual/gfw-symbols.xml (original)
+++ trunk/docs/manual/gfw-symbols.xml Sun Oct 22 00:44:07 2006
@@ -362,6 +362,9 @@
</initargs>
<seealso>
<reftopic>gfw:event-source</reftopic>
+ <reftopic>gfw:page-increment</reftopic>
+ <reftopic>gfw:step-increment</reftopic>
+ <reftopic>gfw:scroll</reftopic>
</seealso>
</class>
@@ -2396,6 +2399,203 @@
<!-- GENERIC FUNCTIONS -->
+ <generic-function name="page-increment">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ A <reftopic>gfw:scrollbar</reftopic>, <reftopic>gfw:slider</reftopic>,
+ or <reftopic>gfw:standard-scrollbar</reftopic>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ This function returns the amount by which the viewport origin is incremented
+ forward (or backward) when a user gesture causes a scroll event of type
+ :page-forward (or :page-back). The returned value determines the size of the
+ proportional thumb. The <reftopic>gfw:scrolling-helper</reftopic> manages
+ this value on behalf of windows with standard scrollbars.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-scroll</reftopic>
+ <reftopic>gfw:scroll</reftopic>
+ <reftopic>gfw:step-increment</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="step-increment">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ A <reftopic>gfw:scrollbar</reftopic>, <reftopic>gfw:slider</reftopic>,
+ or <reftopic>gfw:standard-scrollbar</reftopic>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ This function returns the amount by which the viewport origin is incremented
+ forward (or backward) when a user gesture causes a scroll event of type
+ :step-forward (or :step-back). The <reftopic>gfw:scrolling-helper</reftopic>
+ manages this value on behalf of windows with standard scrollbars.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-scroll</reftopic>
+ <reftopic>gfw:scroll</reftopic>
+ <reftopic>gfw:page-increment</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="pack">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a subclass of <reftopic>gfw:layout-managed</reftopic>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Causes <arg0/> to be resized to the smallest possible dimensions given
+ the locations and sizes of its children, as determined by <arg0/>'s
+ <reftopic>gfw:layout-manager</reftopic>.
+ </description>
+ <seealso>
+ <reftopic>gfw:layout</reftopic>
+ <reftopic>gfw:layout-p</reftopic>
+ <reftopic>gfw:enable-layout</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="owner">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An "owned" object such as a <reftopic>gfw:top-level</reftopic>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic>gfw:window</reftopic>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ Returns the owner of <arg0/>, which may be different from <arg0/>'s
+ parent because the window ownership hierarchy includes the relationships
+ between physically separate top-level windows and dialogs. It is possible
+ for a window to be unowned but still have a parent. Consequently, calling
+ <reftopic>gfw:parent</reftopic> on a <reftopic>gfw:top-level</reftopic>
+ will return an instance of <reftopic>gfw:root-window</reftopic>, but
+ calling this function may return NIL.
+ </para>
+ <para role="normal">
+ <ulink url="http://blogs.msdn.com/oldnewthing/archive/2004/02/24/79212.aspx">
+ This blog entry</ulink> provides more information.
+ </para>
+ </description>
+ <seealso>
+ <reftopic>gfw:parent</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="parent">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object capable of being the child of another container.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic>gfw:window</reftopic>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ Returns the parent of <arg0/>. In the case of <reftopic>gfw:panel</reftopic>
+ and <reftopic>gfw:control</reftopic>, this will be the ancestor
+ <reftopic>gfw:dialog</reftopic>, <reftopic>gfw:panel</reftopic>, or
+ <reftopic>gfw:top-level</reftopic>. In the case of a <reftopic>gfw:dialog</reftopic>
+ or <reftopic>gfw:top-level</reftopic>, then a <reftopic>gfw:root-window</reftopic>
+ is returned. In the case of a submenu, this will be the
+ <reftopic>gfw:menu</reftopic>'s ancestor in the hierarchy; but for a menubar or
+ context menu, this function returns NIL.
+ </para>
+ <para role="normal">
+ <ulink url="http://blogs.msdn.com/oldnewthing/archive/2004/02/24/79212.aspx">
+ This blog entry</ulink> provides more information.
+ </para>
+ </description>
+ <seealso>
+ <reftopic>gfw:owner</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="obtain-horizontal-scrollbar">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object configured with a horizontal scrollbar.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic>gfw:standard-scrollbar</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns the horizontal <reftopic>gfw:standard-scrollbar</reftopic>
+ attached to the bottom of <arg0/>, if <arg0/> is configured to
+ have one and whether or not said scrollbar is currently visible;
+ returns NIL otherwise.
+ </description>
+ <seealso>
+ <reftopic>gfw:obtain-vertical-scrollbar</reftopic>
+ <reftopic>gfw:horizontal-scrollbar-p</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="obtain-vertical-scrollbar">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object configured with a vertical scrollbar.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic>gfw:standard-scrollbar</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns the vertical <reftopic>gfw:standard-scrollbar</reftopic>
+ attached to the bottom of <arg0/>, if <arg0/> is configured to
+ have one and whether or not said scrollbar is currently visible;
+ returns NIL otherwise.
+ </description>
+ <seealso>
+ <reftopic>gfw:obtain-horizontal-scrollbar</reftopic>
+ <reftopic>gfw:vertical-scrollbar-p</reftopic>
+ </seealso>
+ </generic-function>
+
<generic-function name="menu-bar">
<syntax with-setf="t">
<arguments>
Modified: trunk/docs/manual/introduction.xml
==============================================================================
--- trunk/docs/manual/introduction.xml (original)
+++ trunk/docs/manual/introduction.xml Sun Oct 22 00:44:07 2006
@@ -3,7 +3,7 @@
Copyright (c) 2006, Jack D. Unrue
-->
-<chapter>
+<chapter id="introduction">
<title>Introduction</title>
<indexterm><primary>Introduction</primary></indexterm>
Modified: trunk/docs/manual/legal.xml
==============================================================================
--- trunk/docs/manual/legal.xml (original)
+++ trunk/docs/manual/legal.xml Sun Oct 22 00:44:07 2006
@@ -3,7 +3,7 @@
Copyright (c) 2006, Jack D. Unrue
-->
-<chapter>
+<chapter id="legal">
<title>Legal Notices</title>
<para>
Copyright © 2006, Jack D. Unrue <jdunrue at gmail dot com>
Modified: trunk/docs/manual/miscellaneous-topics.xml
==============================================================================
--- trunk/docs/manual/miscellaneous-topics.xml (original)
+++ trunk/docs/manual/miscellaneous-topics.xml Sun Oct 22 00:44:07 2006
@@ -3,7 +3,7 @@
Copyright (c) 2006, Jack D. Unrue
-->
-<chapter>
+<chapter id="misc-topics">
<title>Miscellaneous Topics</title>
<para role="normal">
1
0
Author: junrue
Date: Sat Oct 21 23:38:55 2006
New Revision: 381
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 23:38:55 2006
@@ -2396,6 +2396,190 @@
<!-- GENERIC FUNCTIONS -->
+ <generic-function name="menu-bar">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a subclass of <reftopic>gfw:window</reftopic>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic>gfw:menu</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) the <reftopic>gfw:menu</reftopic> serving as the
+ menu bar for <arg0/>. The SETF function automatically refreshes
+ the menu bar.
+ </description>
+ <seealso>
+ <reftopic>gfw:defmenu</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="maximum-size">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ An object that has a size attribute which may be altered by
+ the user.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic>gfs:size</reftopic>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ Returns (sets) the largest dimensions to which the user may resize
+ <arg0/>. By default, <reftopic>gfw:window</reftopic>s and
+ <reftopic>gfw:control</reftopic>s return NIL indicating that there
+ is effectively no constraint.
+ </para>
+ <para role="normal">
+ If the new maximum size provided via the SETF function is smaller
+ than the current size, the widget is resized to the new maximum.
+ </para>
+ </description>
+ <seealso>
+ <reftopic>gfw:size</reftopic>
+ <reftopic>gfw:preferred-size</reftopic>
+ <reftopic>gfw:minimum-size</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="minimum-size">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ An object that has a size attribute which may be altered by
+ the user.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic>gfs:size</reftopic>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ Returns (sets) the smallest dimensions to which the user may resize
+ <arg0/>. By default, <reftopic>gfw:window</reftopic>s return NIL
+ indicating that the minimum constraint is determined by the windowing
+ system's configuration; whereas, <reftopic>gfw:control</reftopic>s
+ return the same value by default as would <reftopic>gfw:preferred-size</reftopic>.
+ </para>
+ <para role="normal">
+ If the new minimum size provided via the SET function is larger than the
+ current size, the widget is resized to the new minimum.
+ </para>
+ </description>
+ <seealso>
+ <reftopic>gfw:size</reftopic>
+ <reftopic>gfw:preferred-size</reftopic>
+ <reftopic>gfw:maximum-size</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="mapchildren">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ A container for children.
+ </description>
+ </argument>
+ <argument name="func">
+ <description>
+ A function of two arguments.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>list</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Calls <arg1/> for each child of <arg0/> and places <arg1/>'s
+ return value in the result <refclhs>list</refclhs>. <arg1/>'s
+ two arguments are <arg0/> and the current child. Note that
+ mapchildren accesses <arg0/>'s actual children as determined
+ by the underlying windowing system, regardless of any
+ <reftopic>gfw:layout-manager</reftopic> assigned to <arg0/>.
+ </description>
+ </generic-function>
+
+ <generic-function name="location">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ An object that can be positioned.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic>gfs:point</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) the location of the top-left corner of <arg0/> within
+ its parent's coordinate system.
+ </description>
+ <seealso>
+ <reftopic>gfw:size</reftopic>
+ <reftopic>gfw:parent</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="line-count">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object whose content is logically organized into lines.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns the total number of lines (e.g., of text) contained by <arg0/>.
+ </description>
+ <seealso>
+ <reftopic>gfw:edit</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="layout">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a subclass of <reftopic>gfw:layout-managed</reftopic>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Causes <arg0/>'s layout manager to update the sizes and locations of
+ <arg0/>'s children.
+ </description>
+ <seealso>
+ <reftopic>gfw:layout-manager</reftopic>
+ </seealso>
+ </generic-function>
+
<generic-function name="item-count">
<syntax>
<arguments>
@@ -3069,6 +3253,9 @@
<seealso>
<reftopic>gfw:client-size</reftopic>
<reftopic>gfw:size</reftopic>
+ <reftopic>gfw:preferred-size</reftopic>
+ <reftopic>gfw:maximum-size</reftopic>
+ <reftopic>gfw:minimum-size</reftopic>
</seealso>
</generic-function>
@@ -3128,6 +3315,9 @@
</description>
<seealso>
<reftopic>gfw:size</reftopic>
+ <reftopic>gfw:preferred-size</reftopic>
+ <reftopic>gfw:maximum-size</reftopic>
+ <reftopic>gfw:minimum-size</reftopic>
</seealso>
</generic-function>
@@ -3147,6 +3337,10 @@
<seealso>
<reftopic>gfw:client-size</reftopic>
<reftopic>gfw:parent</reftopic>
+ <reftopic>gfw:location</reftopic>
+ <reftopic>gfw:preferred-size</reftopic>
+ <reftopic>gfw:maximum-size</reftopic>
+ <reftopic>gfw:minimum-size</reftopic>
</seealso>
</generic-function>
1
0
Author: junrue
Date: Sat Oct 21 23:12:38 2006
New Revision: 380
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 23:12:38 2006
@@ -2396,6 +2396,204 @@
<!-- GENERIC FUNCTIONS -->
+ <generic-function name="item-count">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a subclass of <reftopic>gfw:item-manager</reftopic>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns the number of items maintained by <arg0/>.
+ </description>
+ <seealso>
+ <reftopic>gfw:append-item</reftopic>
+ <reftopic>gfw:delete-item</reftopic>
+ <reftopic>gfw:item-index</reftopic>
+ <reftopic>gfw:items-of</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="item-index">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a subclass of <reftopic>gfw:item-manager</reftopic>.
+ </description>
+ </argument>
+ <argument name="item">
+ <description>
+ The <reftopic>gfw:item</reftopic> subclass instance to be
+ located within <arg0/>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns the zero-based index of <arg1/> within <arg0/>.
+ </description>
+ <seealso>
+ <reftopic>gfw:append-item</reftopic>
+ <reftopic>gfw:delete-item</reftopic>
+ <reftopic>gfw:item-count</reftopic>
+ <reftopic>gfw:items-of</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="items-of">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a subclass of <reftopic>gfw:item-manager</reftopic>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>list</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns a <refclhs>list</refclhs> of <reftopic>gfw:item</reftopic>
+ subclass instances. The SETF function provides a <refclhs>list</refclhs>
+ of data objects to be wrapped by instances of the appropriate
+ <reftopic>gfw:item</reftopic> subclass, which replaces the existing items
+ within <arg0/> and then causes <arg0/> to be repainted.
+ </description>
+ <seealso>
+ <reftopic>gfw:append-item</reftopic>
+ <reftopic>gfw:delete-item</reftopic>
+ <reftopic>gfw:item-count</reftopic>
+ <reftopic>gfw:item-index</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="inner-limits">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ The object whose inner range of values is to be returned or set.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic>gfs:span</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Certain controls having the concept of a range of values within which a
+ selector may be positioned also allow the indicator to be further
+ constrained to a narrower range, e.g., <reftopic>gfw:slider</reftopic>.
+ If the SETF function is used to set a sub-range, <arg0/>'s visual style
+ will be updated and the indicator restricted appropriately.
+ </description>
+ <seealso>
+ <reftopic>gfw:outer-limit</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="outer-limit">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ The object whose maximum value is to be returned or set.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) an <refclhs>integer</refclhs> representing the maximum
+ value or position to which the indicator in <arg0/> may be set by the
+ user. Application code is responsible for synchronizing this maximum
+ with its content model.
+ </description>
+ <seealso>
+ <reftopic>gfw:inner-limits</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="image">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ An object that owns (or will own) a <reftopic>gfg:image</reftopic>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic>gfg:image</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns the <reftopic>gfg:image</reftopic> currently associated with
+ <arg0/>. If <arg0/> is a <reftopic>gfw:window</reftopic>, then this
+ function returns a <reftopic>gfg:icon-bundle</reftopic>; in that case,
+ the SETF function accepts either type.
+ </description>
+ </generic-function>
+
+ <generic-function name="horizontal-scrollbar-p">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ The object whose scrollbar configuration is to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns T if <arg0/> has been configured with a horizontal scrollbar,
+ even if said scrollbar is not currently visible; NIL otherwise.
+ </description>
+ <seealso>
+ <reftopic>gfw:enable-scrollbars</reftopic>
+ <reftopic>gfw:vertical-scrollbar-p</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="vertical-scrollbar-p">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ The object whose scrollbar configuration is to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns T if <arg0/> has been configured with a vertical scrollbar,
+ even if said scrollbar is not currently visible; NIL otherwise.
+ </description>
+ <seealso>
+ <reftopic>gfw:enable-scrollbars</reftopic>
+ <reftopic>gfw:horizontal-scrollbar-p</reftopic>
+ </seealso>
+ </generic-function>
+
<generic-function name="enabled-p">
<syntax>
<arguments>
@@ -2417,6 +2615,48 @@
</seealso>
</generic-function>
+ <generic-function name="focus-p">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ The object whose focus ownership is to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns T if <arg0/> has the keyboard focus; NIL otherwise.
+ </description>
+ <seealso>
+ <reftopic>gfw:give-focus</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="give-focus">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ The destination for keyboard focus.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Places keyboard focus on <arg0/>.
+ </description>
+ <seealso>
+ <reftopic>gfw:focus-p</reftopic>
+ </seealso>
+ </generic-function>
+
<generic-function name="enable-redraw">
<syntax>
<arguments>
@@ -2654,6 +2894,9 @@
</description>
<seealso>
<reftopic>gfw:append-item</reftopic>
+ <reftopic>gfw:item-count</reftopic>
+ <reftopic>gfw:items-of</reftopic>
+ <reftopic>gfw:item-index</reftopic>
</seealso>
</generic-function>
@@ -3148,6 +3391,8 @@
<reftopic>gfw:append-submenu</reftopic>
<reftopic>gfw:defmenu</reftopic>
<reftopic>gfw:delete-item</reftopic>
+ <reftopic>gfw:item-count</reftopic>
+ <reftopic>gfw:items-of</reftopic>
</seealso>
</generic-function>
1
0
Author: junrue
Date: Sat Oct 21 22:05:49 2006
New Revision: 379
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 22:05:49 2006
@@ -535,6 +535,9 @@
<reftopic>gfs:dispose</reftopic>
<reftopic>gfw:obtain-horizontal-scrollbar</reftopic>
<reftopic>gfw:obtain-vertical-scrollbar</reftopic>
+ <reftopic>gfw:enable-scrollbars</reftopic>
+ <reftopic>gfw:horizontal-scrollbar-p</reftopic>
+ <reftopic>gfw:vertical-scrollbar-p</reftopic>
</seealso>
</class>
@@ -2393,6 +2396,307 @@
<!-- GENERIC FUNCTIONS -->
+ <generic-function name="enabled-p">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ The object whose enabled state is to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns T if <arg0/> is enabled; NIL otherwise.
+ </description>
+ <seealso>
+ <reftopic>gfw:enable</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="enable-redraw">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ A <reftopic>gfw:widget</reftopic>.
+ </description>
+ </argument>
+ <argument name="flag">
+ <description>
+ A <refclhs>boolean</refclhs> flag specifying whether redrawing
+ within <arg0/> is enabled.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Any non-NIL value for <arg1/> enables <arg0/> to be updated and invalidates
+ its client area; NIL disables redrawing.
+ </description>
+ <seealso>
+ <reftopic>gfw:with-drawing-disabled</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="enable-layout">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ A <reftopic>gfw:window</reftopic>.
+ </description>
+ </argument>
+ <argument name="flag">
+ <description>
+ A <refclhs>boolean</refclhs> flag specifying whether layout within
+ <arg0/> is enabled.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Any non-NIL value for <arg1/> enables layout within <arg0/>; NIL
+ disables layout.
+ </description>
+ <seealso>
+ <reftopic>gfw:layout</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="enable-auto-scrolling">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object that supports scrolling functionality.
+ </description>
+ </argument>
+ <argument name="horizontal">
+ <description>
+ A <refclhs>boolean</refclhs> flag controlling the horizontal axis.
+ </description>
+ </argument>
+ <argument name="vertical">
+ <description>
+ A <refclhs>boolean</refclhs> flag controlling the vertical axis.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Configures the object to allow (or disallow) automatic scrolling in
+ the horizontal or vertical directions.
+ </description>
+ <seealso>
+ <reftopic>gfw:auto-hscroll-p</reftopic>
+ <reftopic>gfw:auto-vscroll-p</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="enable-scrollbars">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object that supports scrolling functionality.
+ </description>
+ </argument>
+ <argument name="horizontal">
+ <description>
+ A <refclhs>boolean</refclhs> flag controlling the scrollbar
+ on the horizontal axis.
+ </description>
+ </argument>
+ <argument name="vertical">
+ <description>
+ A <refclhs>boolean</refclhs> flag controlling the scrollbar
+ on the vertical axis.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Specifying T for <arg1/> (<arg2/>) configures <arg0/> to have a
+ <reftopic>gfw:standard-scrollbar</reftopic> to attached to the
+ right-hand (bottom) edge. The visibility of each scrollbar then
+ depends on the scrollbar visibility policy configured for <arg0/>
+ and the state of the scrolling viewport. Specifying NIL disables
+ the scrollbar.
+ </description>
+ <seealso>
+ <reftopic>gfw:horizontal-scrollbar-p</reftopic>
+ <reftopic>gfw:vertical-scrollbar-p</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="enable">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ The object to be enabled or disabled.
+ </description>
+ </argument>
+ <argument name="flag">
+ <description>
+ A <refclhs>boolean</refclhs> indicating whether to enable
+ or disable <arg0/>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ For widgets, this function causes <arg0/> to stop (or re-enable)
+ input event processing and changes its look from the default to
+ grayed or vice versa. For a <reftopic>gfw:timer</reftopic>, this
+ function starts or stops event generation.
+ </description>
+ <seealso>
+ <reftopic>gfw:enabled-p</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="enabled-p">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ The object to query for its state.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns T if <arg0/> is enabled; NIL otherwise.
+ </description>
+ <seealso>
+ <reftopic>gfw:enable</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="echo-character">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ An object that allows the user to edit text content.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>character</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) the character used to mask text content, such as
+ inside a <reftopic>gfw:edit</reftopic> created with the :password
+ style symbol.
+ </description>
+ </generic-function>
+
+ <generic-function name="delete-all">
+ <syntax>
+ <arguments>
+ <argument name="self"/>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Removes all content from <arg0/>.
+ </description>
+ </generic-function>
+
+ <generic-function name="delete-item">
+ <syntax>
+ <arguments>
+ <argument name="item-manager">
+ <description>
+ A <reftopic>gfw:item-manager</reftopic>.
+ </description>
+ </argument>
+ <argument name="index">
+ <description>
+ A zero-based <refclhs>integer</refclhs> index into the items
+ contained within <arg0/>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Removes the item at <arg1/> from <arg0/>.
+ </description>
+ <seealso>
+ <reftopic>gfw:append-item</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="delete-selection">
+ <syntax>
+ <arguments>
+ <argument name="self"/>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Removes the subset of items from <arg0/> that are in the selected
+ state. For a control with a text field component, such as an edit control,
+ this function deletes selected text.
+ </description>
+ </generic-function>
+
+ <generic-function name="delete-span">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object with a contiguous range of content to be removed.
+ </description>
+ </argument>
+ <argument name="span">
+ <description>
+ A <reftopic>gfs:span</reftopic> identifying a range of content.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Removes the content from <arg0/> whose zero-based indices lie within
+ <arg1/>.
+ </description>
+ </generic-function>
+
<generic-function name="copy-text">
<syntax>
<arguments>
@@ -2843,6 +3147,7 @@
<reftopic>gfw:append-separator</reftopic>
<reftopic>gfw:append-submenu</reftopic>
<reftopic>gfw:defmenu</reftopic>
+ <reftopic>gfw:delete-item</reftopic>
</seealso>
</generic-function>
1
0
Author: junrue
Date: Sat Oct 21 19:55:04 2006
New Revision: 378
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 19:55:04 2006
@@ -2393,6 +2393,360 @@
<!-- GENERIC FUNCTIONS -->
+ <generic-function name="copy-text">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object that can interact with the system clipboard.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ This function is a shortcut for a common clipboard transfer operation,
+ namely the transfer of text from <arg0/> to the system clipboard. The
+ existing content of <arg0/> remains undisturbed. Some controls like
+ the edit control have built-in clipboard functionality, and in such
+ cases, the implementation of this function delegates to such functionality
+ directly.
+ </para>
+ <para role="normal">
+ Note: an upcoming release will include more general infrastructure for
+ clipboard operations.
+ </para>
+ </description>
+ <seealso>
+ <reftopic>gfw:cut-text</reftopic>
+ <reftopic>gfw:paste-text</reftopic>
+ <reftopic>gfw:text-for-pasting-p</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="cut-text">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object that can interact with the system clipboard.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ This function is a shortcut for a common clipboard transfer operation,
+ namely the transfer of text from <arg0/> to the system clipboard and
+ removal of that content of <arg0/>. Some controls like
+ the edit control have built-in clipboard functionality, and in such
+ cases, the implementation of this function delegates to such functionality
+ directly. For other widgets, this operation is a wrapper around a
+ copy/delete sequence.
+ </para>
+ <para role="normal">
+ Note: an upcoming release will include more general infrastructure for
+ clipboard operations.
+ </para>
+ </description>
+ <seealso>
+ <reftopic>gfw:copy-text</reftopic>
+ <reftopic>gfw:paste-text</reftopic>
+ <reftopic>gfw:text-for-pasting-p</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="paste-text">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object that can interact with the system clipboard.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ This function is a shortcut for a common clipboard transfer operation,
+ namely the transfer of text from the system clipboard to <arg0/>.
+ Some controls like the edit control have built-in clipboard functionality,
+ and in such cases, the implementation of this function delegates to such
+ functionality directly.
+ </para>
+ <para role="normal">
+ Note: an upcoming release will include more general infrastructure for
+ clipboard operations.
+ </para>
+ </description>
+ <seealso>
+ <reftopic>gfw:copy-text</reftopic>
+ <reftopic>gfw:cut-text</reftopic>
+ <reftopic>gfw:text-for-pasting-p</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="compute-outer-size">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object with border decorations.
+ </description>
+ </argument>
+ <argument name="size">
+ <description>
+ A <reftopic>gfs:size</reftopic> describing the desired
+ client size.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic>gfs:size</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns the dimensions of the area required to enclose <arg0/>
+ assuming <arg1/> is the desired client area, taking into account
+ the trim and other decorations which <arg0/> is configured to have.
+ </description>
+ <seealso>
+ <reftopic>gfw:client-size</reftopic>
+ <reftopic>gfw:size</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="compute-style-flags">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object having style flags that must be translated prior to
+ <arg0/>'s native handle being created.
+ </description>
+ </argument>
+ <notarg name="&rest"/>
+ <argument name="extra-data">
+ <description>
+ Additional translation data.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ Converts <arg0/>'s style keyword symbols to a pair of native bitmasks;
+ the first conveys normal/standard flags, whereas the second any extended
+ flags that the system supports.
+ </para>
+ <para role="normal">
+ This function is not usually called by application code. A method is
+ defined on it for each control, standard dialog, or similar widgets
+ having a native system resource. Library extensions that add new widget
+ types, on the other hand, are required to provide appropriate
+ implementations.
+ </para>
+ </description>
+ <seealso>
+ <reftopic>gfw:style-of</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="client-size">
+ <syntax>
+ <arguments>
+ <argument name="self"/>
+ </arguments>
+ <return>
+ <reftopic>gfs:size</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns the dimensions of the client area within <arg0/>, which
+ is the area typically drawn within or serving as a container for
+ children.
+ </description>
+ <seealso>
+ <reftopic>gfw:size</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="size">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self"/>
+ </arguments>
+ <return>
+ <reftopic>gfs:size</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) the dimensions of <arg0/> within the parent coordinate
+ system, including any border trim or other decoration.
+ </description>
+ <seealso>
+ <reftopic>gfw:client-size</reftopic>
+ <reftopic>gfw:parent</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="check">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object supporting check/uncheck behavior.
+ </description>
+ </argument>
+ <argument name="flag">
+ <description>
+ A <refclhs>boolean</refclhs>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Sets <arg0/> into the checked state.
+ </description>
+ <seealso>
+ <reftopic>gfw:checked-p</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="checked-p">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object supporting check/uncheck behavior.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns T if <arg0/> is in the checked state; NIL otherwise.
+ </description>
+ <seealso>
+ <reftopic>gfw:check</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="center-on-owner">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a <reftopic>gfw:widget</reftopic> subclass.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Positions <arg0/> such that it is centrally-located relative to
+ the bounds of <arg0/>'s owner, based on <arg0/>'s current outermost
+ size.
+ </description>
+ <seealso>
+ <reftopic>gfw:center-on-parent</reftopic>
+ <reftopic>gfw:owner</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="center-on-parent">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a <reftopic>gfw:widget</reftopic> subclass.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Positions <arg0/> such that it is centrally-located relative to
+ the bounds of <arg0/>'s parent, based on <arg0/>'s current outermost
+ size.
+ </description>
+ <seealso>
+ <reftopic>gfw:center-on-owner</reftopic>
+ <reftopic>gfw:parent</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="cancel-widget">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a <reftopic>gfw:window</reftopic> subclass.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic>gfw:widget</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) the <reftopic>gfw:widget</reftopic> that is invoked by
+ the <Esc> key or otherwise acts to dismiss <arg0/>. In a
+ <reftopic>gfw:dialog</reftopic>, the widget must be a
+ <reftopic>gfw:button</reftopic> and is typically labelled "Cancel".
+ </description>
+ <seealso>
+ <reftopic>gfw:default-widget</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="default-widget">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a <reftopic>gfw:window</reftopic> subclass.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic>gfw:widget</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) the <reftopic>gfw:widget</reftopic> that represents
+ the default action for <arg0/>. Passing NIL to the SETF function
+ clears the default widget binding. The default action is invoked when
+ the user presses <Enter> within <arg0/>.
+ </description>
+ <seealso>
+ <reftopic>gfw:cancel-widget</reftopic>
+ <reftopic>gfw:event-default-action</reftopic>
+ </seealso>
+ </generic-function>
+
<generic-function name="auto-hscroll-p">
<syntax>
<arguments>
1
0
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 FUNCTIONS -->
+ <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
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 FUNCTIONS -->
<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 @@
<!-- ACCESSORS -->
+ <!-- MACROS -->
+
+ <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
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 FUNCTIONS -->
<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
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 @@
<!-- FUNCTIONS -->
+ <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 FUNCTIONS -->
<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
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>
+
<!-- STRUCTURES -->
<!-- FUNCTIONS -->
1
0
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>
+
<!-- STRUCTURES -->
<!-- FUNCTIONS -->
1
0
20 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
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
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 @@
<!-- CLASSES -->
+ <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>
+
<!-- STRUCTURES -->
<!-- FUNCTIONS -->
1
0
Author: junrue
Date: Fri Oct 20 15:48:08 2006
New Revision: 368
Modified:
trunk/docs/manual/gfw-symbols.xml
Log:
Modified: trunk/docs/manual/gfw-symbols.xml
==============================================================================
--- trunk/docs/manual/gfw-symbols.xml (original)
+++ trunk/docs/manual/gfw-symbols.xml Fri Oct 20 15:48:08 2006
@@ -231,6 +231,17 @@
</seealso>
</function>
+ <function name="obtain-event-time">
+ <syntax>
+ <return>
+ <emphasis>milliseconds</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Returns the millisecond timestamp of the event currently being processed.
+ </description>
+ </function>
+
<!-- GENERIC FUNCTIONS -->
<generic-function name="event-activate">
@@ -334,6 +345,61 @@
</seealso>
</generic-function>
+ <generic-function name="event-timer">
+ <syntax>
+ <arguments>
+ <argument name="event-dispatcher">
+ <description>
+ The <reftopic>gfw:event-dispatcher</reftopic> that will process
+ this event.
+ </description>
+ </argument>
+ <argument name="timer">
+ <description>
+ The <reftopic>gfw:timer</reftopic> that generated this event.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Implement a method for this generic function to handle timer notifications.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="event-modify">
+ <syntax>
+ <arguments>
+ <argument name="event-dispatcher">
+ <description>
+ The <reftopic>gfw:event-dispatcher</reftopic> that will process
+ this event.
+ </description>
+ </argument>
+ <argument name="widget">
+ <description>
+ The <reftopic>gfw:widget</reftopic> modified by the user.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Implement this method to respond to changes due to user input within <arg1/>,
+ for example when the user types text inside an edit control.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
+ </seealso>
+ </generic-function>
+
<generic-function name="event-close">
<syntax>
<arguments>
@@ -434,6 +500,36 @@
</seealso>
</generic-function>
+ <generic-function name="event-select">
+ <syntax>
+ <arguments>
+ <argument name="event-dispatcher">
+ <description>
+ The <reftopic>gfw:event-dispatcher</reftopic> that will process
+ this event.
+ </description>
+ </argument>
+ <argument name="widget">
+ <description>
+ The <reftopic>gfw:widget</reftopic> that was selected, or whose
+ sub-element was selected.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Implement a method for this generic function to handle notification that
+ <arg1/> or some sub-element of <arg1/> has been selected. Selection may
+ occur via the mouse or keyboard.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
+ </seealso>
+ </generic-function>
+
<generic-function name="event-focus-gain">
<syntax>
<arguments>
@@ -993,6 +1089,197 @@
</seealso>
</generic-function>
+ <generic-function name="event-scroll">
+ <syntax>
+ <arguments>
+ <argument name="event-dispatcher">
+ <description>
+ The <reftopic>gfw:event-dispatcher</reftopic> that will process
+ this event.
+ </description>
+ </argument>
+ <argument name="widget">
+ <description>
+ The <reftopic>gfw:widget</reftopic> that was scrolled.
+ </description>
+ </argument>
+ <argument name="axis">
+ <description>
+ One of the following keyword symbols describing orientation:
+ <enum>
+ <argument name=":horizontal"/>
+ <argument name=":vertical"/>
+ </enum>
+ </description>
+ </argument>
+ <argument name="detail">
+ <description>
+ One of the following keyword symbols describing the requested scrolling
+ action:
+ <enum>
+ <argument name=":end">
+ <description>
+ Move the viewport such that the bottom or right-most content is
+ revealed.
+ </description>
+ </argument>
+ <argument name=":page-back">
+ <description>
+ Move the viewport backwards by an amount equal to the viewport's
+ height or width, or the amount remaining between the current
+ viewport origin and the model origin, whichever is smaller.
+ </description>
+ </argument>
+ <argument name=":page-forward">
+ <description>
+ Move the viewport forward by an amount equal to the viewport's
+ height or width, or the amount remaining between the current
+ viewport origin and the model extent, whichever is smaller.
+ </description>
+ </argument>
+ <argument name=":start">
+ <description>
+ Move the viewport such that the top or left-most model content is
+ revealed.
+ </description>
+ </argument>
+ <argument name=":step-back">
+ <description>
+ Move the viewport backwards by an application-defined amount, or
+ the amount remaining between the current viewport origin and the
+ model origin, whichever is smaller.
+ </description>
+ </argument>
+ <argument name=":step-forward">
+ <description>
+ Move the viewport forward by an application-defined amount, or the
+ amount remaining between the current viewport origin and the model
+ extent, whichever is smaller.
+ </description>
+ </argument>
+ <argument name=":thumb-position">
+ <description>
+ Move the viewport to an absolute position.
+ </description>
+ </argument>
+ <argument name=":thumb-track">
+ <description>
+ The user is adjusting the viewport origin continuously, as when
+ dragging the scrollbar thumb.
+ </description>
+ </argument>
+ </enum>
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Implement a method for this generic function to handle scrolling notifications
+ for <arg1/>.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="event-session">
+ <syntax>
+ <arguments>
+ <argument name="event-dispatcher">
+ <description>
+ The <reftopic>gfw:event-dispatcher</reftopic> that will process
+ this event.
+ </description>
+ </argument>
+ <argument name="widget">
+ <description>
+ The <reftopic>gfw:widget</reftopic> receiving this event.
+ </description>
+ </argument>
+ <argument name="phase">
+ <description>
+ <enum>
+ <argument name=":query">
+ <description>
+ This symbol means that the system is querying the application
+ for permission to proceed. Return nil if there is a reason to
+ veto the process, or non-nil otherwise.
+ </description>
+ </argument>
+ <argument name=":end">
+ <description>
+ This symbol is specified in the subsequent call to event-session.
+ It means that the system is going ahead with ending the session,
+ therefore this is an opportunity for graceful cleanup.
+ </description>
+ </argument>
+ </enum>
+ </description>
+ </argument>
+ <argument name="reason">
+ <description>
+ <enum>
+ <argument name=":logoff">
+ <description>
+ The user is logging off.
+ </description>
+ </argument>
+ <argument name=":replacing-file">
+ <description>
+ The application must exit because a file it is using is being
+ replaced.
+ </description>
+ </argument>
+ <argument name=":shutdown">
+ <description>
+ The system is shutting down or restarting.
+ </description>
+ </argument>
+ </enum>
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ Implement this method to participate in the system's session shutdown
+ protocol. When the user chooses to end the session (by logging out or
+ by shutting down), or if an application calls one of the Win32 shutdown
+ functions, every application is given a veto option. This event function
+ will be called at least once for each top-level window in the application.
+ </para>
+ <para role="normal">
+ The MSDN documentation makes the following recommendations for handling
+ this event:
+ </para>
+ <itemizedlist mark="bullet" spacing="compact">
+ <listitem>
+ Whenever possible, applications should respect the user's intentions by
+ allowing the session to end.
+ </listitem>
+ <listitem>
+ In the case of a critical operation, provide a dialog or other feedback
+ with information for the user as to consequences if the application is
+ interrupted at this time.
+ </listitem>
+ <listitem>
+ Respond to the :query phase as quickly as possible, leaving time-consuming
+ cleanup to be done in the session :end phase.
+ </listitem>
+ </itemizedlist>
+ </description>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
+ <reftopic>gfw:top-level</reftopic>
+ </seealso>
+ </generic-function>
+
<!-- ACCESSORS -->
</package>
1
0
Author: junrue
Date: Fri Oct 20 15:06:37 2006
New Revision: 367
Modified:
trunk/docs/manual/clhs-table.xml
trunk/docs/manual/gfw-symbols.xml
Log:
Modified: trunk/docs/manual/clhs-table.xml
==============================================================================
--- trunk/docs/manual/clhs-table.xml (original)
+++ trunk/docs/manual/clhs-table.xml Fri Oct 20 15:06:37 2006
@@ -6,13 +6,14 @@
-->
<clhs-table>
- <entry name="alist" url="http://www.lispworks.com/documentation/HyperSpec/Body/26_glo_a.htm#alist"/>
- <entry name="boolean" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_ban.htm"/>
- <entry name="error" url="http://www.lispworks.com/documentation/HyperSpec/Body/e_error.htm"/>
- <entry name="float" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_float.htm"/>
- <entry name="integer" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_intege.htm"/>
- <entry name="list" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_list.htm"/>
- <entry name="pathname" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_pn.htm"/>
- <entry name="string" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_string.htm"/>
- <entry name="warning" url="http://www.lispworks.com/documentation/HyperSpec/Body/e_warnin.htm"/>
+ <entry name="alist" url="http://www.lispworks.com/documentation/HyperSpec/Body/26_glo_a.htm#alist"/>
+ <entry name="boolean" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_ban.htm"/>
+ <entry name="character" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_ch.htm"/>
+ <entry name="error" url="http://www.lispworks.com/documentation/HyperSpec/Body/e_error.htm"/>
+ <entry name="float" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_float.htm"/>
+ <entry name="integer" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_intege.htm"/>
+ <entry name="list" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_list.htm"/>
+ <entry name="pathname" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_pn.htm"/>
+ <entry name="string" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_string.htm"/>
+ <entry name="warning" url="http://www.lispworks.com/documentation/HyperSpec/Body/e_warnin.htm"/>
</clhs-table>
Modified: trunk/docs/manual/gfw-symbols.xml
==============================================================================
--- trunk/docs/manual/gfw-symbols.xml (original)
+++ trunk/docs/manual/gfw-symbols.xml Fri Oct 20 15:06:37 2006
@@ -266,6 +266,7 @@
<reftopic>gfw:top-level</reftopic>
<reftopic>gfw:dialog</reftopic>
<reftopic>gfw:menu</reftopic>
+ <reftopic>gfw:event-deactivate</reftopic>
</seealso>
</generic-function>
@@ -297,6 +298,7 @@
<reftopic>gfw:event-source</reftopic>
<reftopic>gfw:top-level</reftopic>
<reftopic>gfw:dialog</reftopic>
+ <reftopic>gfw:event-activate</reftopic>
</seealso>
</generic-function>
@@ -457,6 +459,7 @@
</description>
<seealso>
<reftopic>gfw:event-source</reftopic>
+ <reftopic>gfw:event-focus-loss</reftopic>
</seealso>
</generic-function>
@@ -485,6 +488,508 @@
</description>
<seealso>
<reftopic>gfw:event-source</reftopic>
+ <reftopic>gfw:event-focus-gain</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="event-key-down">
+ <syntax>
+ <arguments>
+ <argument name="event-dispatcher">
+ <description>
+ The <reftopic>gfw:event-dispatcher</reftopic> that will process
+ this event.
+ </description>
+ </argument>
+ <argument name="widget">
+ <description>
+ The <reftopic>gfw:widget</reftopic> in which a key was pressed.
+ </description>
+ </argument>
+ <argument name="keycode">
+ <description>
+ The virtual key code of the key that was pressed. Constants for
+ certain special keys are described
+ <reftopic label="here">virtual key codes</reftopic>.
+ </description>
+ </argument>
+ <argument name="char">
+ <description>
+ The <refclhs>character</refclhs> value resulting from translation
+ of the virtual key code, or NIL if the key code cannot be translated.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Implement a method for this generic function to respond to a key being
+ pressed within <arg1/>.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
+ <reftopic>gfw:event-key-up</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="event-key-up">
+ <syntax>
+ <arguments>
+ <argument name="event-dispatcher">
+ <description>
+ The <reftopic>gfw:event-dispatcher</reftopic> that will process
+ this event.
+ </description>
+ </argument>
+ <argument name="widget">
+ <description>
+ The <reftopic>gfw:widget</reftopic> in which a key was released.
+ </description>
+ </argument>
+ <argument name="keycode">
+ <description>
+ The virtual key code of the key that was released. Constants for
+ certain special keys are described
+ <reftopic label="here">virtual key codes</reftopic>.
+ </description>
+ </argument>
+ <argument name="char">
+ <description>
+ The <refclhs>character</refclhs> value resulting from translation
+ of the virtual key code, or NIL if the key code cannot be translated.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Implement a method for this generic function to respond to a key being
+ released within <arg1/>.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
+ <reftopic>gfw:event-key-down</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="event-mouse-double">
+ <syntax>
+ <arguments>
+ <argument name="event-dispatcher">
+ <description>
+ The <reftopic>gfw:event-dispatcher</reftopic> that will process
+ this event.
+ </description>
+ </argument>
+ <argument name="widget">
+ <description>
+ The <reftopic>gfw:widget</reftopic> in which the mouse was double-clicked.
+ </description>
+ </argument>
+ <argument name="point">
+ <description>
+ A <reftopic>gfs:point</reftopic> indicating the location of the mouse
+ cursor.
+ </description>
+ </argument>
+ <argument name="button">
+ <description>
+ A keyword symbol identifying which mouse button was used:
+ <enum>
+ <argument name=":left-button"/>
+ <argument name=":middle-button"/>
+ <argument name=":right-button"/>
+ </enum>
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Implement a method for this generic function to respond to a mouse
+ double-click within <arg1/>.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
+ <reftopic>gfw:event-mouse-up</reftopic>
+ <reftopic>gfw:event-mouse-down</reftopic>
+ <reftopic>gfw:event-mouse-move</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="event-mouse-down">
+ <syntax>
+ <arguments>
+ <argument name="event-dispatcher">
+ <description>
+ The <reftopic>gfw:event-dispatcher</reftopic> that will process
+ this event.
+ </description>
+ </argument>
+ <argument name="widget">
+ <description>
+ The <reftopic>gfw:widget</reftopic> in which the mouse was clicked.
+ </description>
+ </argument>
+ <argument name="point">
+ <description>
+ A <reftopic>gfs:point</reftopic> indicating the location of the mouse
+ cursor.
+ </description>
+ </argument>
+ <argument name="button">
+ <description>
+ A keyword symbol identifying which mouse button was used:
+ <enum>
+ <argument name=":left-button"/>
+ <argument name=":middle-button"/>
+ <argument name=":right-button"/>
+ </enum>
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Implement a method for this generic function to respond to a mouse
+ button click within <arg1/>.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
+ <reftopic>gfw:event-mouse-double</reftopic>
+ <reftopic>gfw:event-mouse-up</reftopic>
+ <reftopic>gfw:event-mouse-move</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="event-mouse-move">
+ <syntax>
+ <arguments>
+ <argument name="event-dispatcher">
+ <description>
+ The <reftopic>gfw:event-dispatcher</reftopic> that will process
+ this event.
+ </description>
+ </argument>
+ <argument name="widget">
+ <description>
+ The <reftopic>gfw:widget</reftopic> in which the mouse was moved.
+ </description>
+ </argument>
+ <argument name="point">
+ <description>
+ A <reftopic>gfs:point</reftopic> indicating the location of the mouse
+ cursor.
+ </description>
+ </argument>
+ <argument name="button">
+ <description>
+ A keyword symbol identifying which mouse button was pressed, if any:
+ <enum>
+ <argument name=":left-button"/>
+ <argument name=":middle-button"/>
+ <argument name=":right-button"/>
+ </enum>
+ Otherwise, this argument is NIL.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Implement a method for this generic function to respond to the mouse moving
+ within <arg1/>.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
+ <reftopic>gfw:event-mouse-double</reftopic>
+ <reftopic>gfw:event-mouse-down</reftopic>
+ <reftopic>gfw:event-mouse-up</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="event-mouse-up">
+ <syntax>
+ <arguments>
+ <argument name="event-dispatcher">
+ <description>
+ The <reftopic>gfw:event-dispatcher</reftopic> that will process
+ this event.
+ </description>
+ </argument>
+ <argument name="widget">
+ <description>
+ The <reftopic>gfw:widget</reftopic> in which the mouse was released.
+ </description>
+ </argument>
+ <argument name="point">
+ <description>
+ A <reftopic>gfs:point</reftopic> indicating the location of the mouse
+ cursor.
+ </description>
+ </argument>
+ <argument name="button">
+ <description>
+ A keyword symbol identifying which mouse button was released:
+ <enum>
+ <argument name=":left-button"/>
+ <argument name=":middle-button"/>
+ <argument name=":right-button"/>
+ </enum>
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Implement a method for this generic function to respond to the mouse being
+ released within <arg1/>.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
+ <reftopic>gfw:event-mouse-double</reftopic>
+ <reftopic>gfw:event-mouse-down</reftopic>
+ <reftopic>gfw:event-mouse-move</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="event-move">
+ <syntax>
+ <arguments>
+ <argument name="event-dispatcher">
+ <description>
+ The <reftopic>gfw:event-dispatcher</reftopic> that will process
+ this event.
+ </description>
+ </argument>
+ <argument name="widget">
+ <description>
+ The <reftopic>gfw:widget</reftopic> being moved.
+ </description>
+ </argument>
+ <argument name="point">
+ <description>
+ A <reftopic>gfs:point</reftopic> indicating <arg1/>'s new location.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Implement a method for this generic function to respond to <arg1/> being
+ moved.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
+ <reftopic>gfw:event-pre-move</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="event-pre-move">
+ <syntax>
+ <arguments>
+ <argument name="event-dispatcher">
+ <description>
+ The <reftopic>gfw:event-dispatcher</reftopic> that will process
+ this event.
+ </description>
+ </argument>
+ <argument name="widget">
+ <description>
+ The <reftopic>gfw:widget</reftopic> being moved.
+ </description>
+ </argument>
+ <argument name="rectangle">
+ <description>
+ A <reftopic>gfs:rectangle</reftopic> describing the move drag rectangle,
+ which may be modified by the application.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Implement a method for this generic function to respond to <arg1/> being
+ moved. This event function gives the application an opportunity to modify
+ the move drag outline prior to the move event being delivered, thus
+ controlling the ultimate location of <arg1/>.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
+ <reftopic>gfw:event-move</reftopic>
+ <reftopic>gfw:top-level</reftopic>
+ <reftopic>gfw:dialog</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="event-resize">
+ <syntax>
+ <arguments>
+ <argument name="event-dispatcher">
+ <description>
+ The <reftopic>gfw:event-dispatcher</reftopic> that will process
+ this event.
+ </description>
+ </argument>
+ <argument name="widget">
+ <description>
+ The <reftopic>gfw:widget</reftopic> being resized.
+ </description>
+ </argument>
+ <argument name="point">
+ <description>
+ A <reftopic>gfs:size</reftopic> indicating <arg1/>'s new dimensions.
+ </description>
+ </argument>
+ <argument name="type">
+ <description>
+ One of the following keyword symbols describing the resize action
+ in more detail:
+ <enum>
+ <argument name=":maximized">
+ <description>
+ Indicates that <arg1/> was expanded to its maximum size, such
+ as when the user clicks on the maximize button in a window frame.
+ </description>
+ </argument>
+ <argument name=":minimized">
+ <description>
+ Indicates that <arg1/> was minimized to the taskbar.
+ </description>
+ </argument>
+ <argument name=":restored">
+ <description>
+ Indicates that <arg1/> was either restored from a minimized state,
+ or that resizing occurred while widget was already in a visible,
+ non-maximized state.
+ </description>
+ </argument>
+ </enum>
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Implement a method for this generic function to respond to <arg1/> being
+ resized.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
+ <reftopic>gfw:event-pre-move</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="event-pre-resize">
+ <syntax>
+ <arguments>
+ <argument name="event-dispatcher">
+ <description>
+ The <reftopic>gfw:event-dispatcher</reftopic> that will process
+ this event.
+ </description>
+ </argument>
+ <argument name="widget">
+ <description>
+ The <reftopic>gfw:widget</reftopic> being resized.
+ </description>
+ </argument>
+ <argument name="rectangle">
+ <description>
+ A <reftopic>gfs:rectangle</reftopic> describing the resize drag rectangle,
+ which may be modified by the application.
+ </description>
+ </argument>
+ <argument name="type">
+ <description>
+ One of the following keyword symbols describing which of eight possible
+ areas of <arg1/>'s frame is being dragged:
+ <enum>
+ <argument name=":bottom"/>
+ <argument name=":bottom-left"/>
+ <argument name=":bottom-right"/>
+ <argument name=":left"/>
+ <argument name=":right"/>
+ <argument name=":top"/>
+ <argument name=":top-left"/>
+ <argument name=":top-right"/>
+ </enum>
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Implement a method for this generic function to respond to <arg1/> being
+ resized. This event function gives the application an opportunity to modify
+ the resize drag outline prior to the resize event being delivered, thus
+ controlling the resulting dimensions of <arg1/>.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
+ <reftopic>gfw:event-resize</reftopic>
+ <reftopic>gfw:top-level</reftopic>
+ <reftopic>gfw:dialog</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="event-paint">
+ <syntax>
+ <arguments>
+ <argument name="event-dispatcher">
+ <description>
+ The <reftopic>gfw:event-dispatcher</reftopic> that will process
+ this event.
+ </description>
+ </argument>
+ <argument name="widget">
+ <description>
+ The <reftopic>gfw:widget</reftopic> whose contents need repainting.
+ </description>
+ </argument>
+ <argument name="graphics-context">
+ <description>
+ A <reftopic>gfg:graphics-context</reftopic> initialized for use during
+ this event.
+ </description>
+ </argument>
+ <argument name="rectangle">
+ <description>
+ A <reftopic>gfs:rectangle</reftopic> specifying the region within
+ <arg1/> that needs repainting.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Implement a method for this generic function to respond to system requests
+ to repaint <arg1/>.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
</seealso>
</generic-function>
1
0
Author: junrue
Date: Fri Oct 20 02:51:53 2006
New Revision: 366
Modified:
trunk/NEWS.txt
trunk/docs/manual/gfs-symbols.xml
trunk/docs/manual/gfw-symbols.xml
Log:
Modified: trunk/NEWS.txt
==============================================================================
--- trunk/NEWS.txt (original)
+++ trunk/NEWS.txt Fri Oct 20 02:51:53 2006
@@ -13,7 +13,7 @@
* GFW:EVENT-SCROLL function for handling low-level scrolling events
- * GFW:SCROLLING-EVENT-DISPATCHER for automatic management of a scrollable
+ * GFW:SCROLLING-HELPER for automatic management of a scrollable
child panel and window scrollbars (works in combination with
GFW:HEAP-LAYOUT)
Modified: trunk/docs/manual/gfs-symbols.xml
==============================================================================
--- trunk/docs/manual/gfs-symbols.xml (original)
+++ trunk/docs/manual/gfs-symbols.xml Fri Oct 20 02:51:53 2006
@@ -632,6 +632,7 @@
</description>
<seealso>
<reftopic>gfs:disposed-error</reftopic>
+ <reftopic>gfw:event-dispose</reftopic>
</seealso>
</generic-function>
@@ -667,7 +668,7 @@
</description>
<seealso>
<reftopic>gfs:disposed-p</reftopic>
- <reftopic>gfw:event-disposed</reftopic>
+ <reftopic>gfw:event-dispose</reftopic>
</seealso>
</generic-function>
Modified: trunk/docs/manual/gfw-symbols.xml
==============================================================================
--- trunk/docs/manual/gfw-symbols.xml (original)
+++ trunk/docs/manual/gfw-symbols.xml Fri Oct 20 02:51:53 2006
@@ -269,6 +269,37 @@
</seealso>
</generic-function>
+ <generic-function name="event-deactivate">
+ <syntax>
+ <arguments>
+ <argument name="event-dispatcher">
+ <description>
+ The <reftopic>gfw:event-dispatcher</reftopic> that will process
+ this event.
+ </description>
+ </argument>
+ <argument name="widget">
+ <description>
+ The <reftopic>gfw:widget</reftopic> being deactivated.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Implement a method for this generic function to respond to the deactivation
+ of <arg1/>. This event is only received by top-level windows or dialogs,
+ and means that some other window or dialog has been activated.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
+ <reftopic>gfw:top-level</reftopic>
+ <reftopic>gfw:dialog</reftopic>
+ </seealso>
+ </generic-function>
+
<generic-function name="event-arm">
<syntax>
<arguments>
@@ -332,6 +363,131 @@
</seealso>
</generic-function>
+ <generic-function name="event-default-action">
+ <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> for which the default action
+ was invoked.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Implement a method for this generic function to respond to a default action.
+ For example, a default action is invoked when the user double-clicks on a
+ <reftopic>gfw:list-box</reftopic>, or presses <ENTER> while the
+ keyboard focus is owned by a <reftopic>gfw:edit</reftopic> control.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="event-dispose">
+ <syntax>
+ <arguments>
+ <argument name="event-dispatcher">
+ <description>
+ The <reftopic>gfw:event-dispatcher</reftopic> that will process
+ this event.
+ </description>
+ </argument>
+ <argument name="widget">
+ <description>
+ The <reftopic>gfw:widget</reftopic> being disposed.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ Implement a method for this generic function to respond to <arg1/>
+ being discarded via <reftopic>gfs:dispose</reftopic>. This event
+ function is called while the data model for widget is still valid.
+ </para>
+ <para role="normal">
+ Note: this function is not an interface to the Common Lisp
+ garbage collector.
+ </para>
+ </description>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
+ <reftopic>gfs:disposed-error</reftopic>
+ <reftopic>gfs:disposed-p</reftopic>
+ <reftopic>gfs:native-object</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="event-focus-gain">
+ <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> gaining keyboard focus.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Implement a method for this generic function to respond to <arg1/>
+ gaining the keyboard focus.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="event-focus-loss">
+ <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> losing keyboard focus.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Implement a method for this generic function to respond to <arg1/>
+ losing the keyboard focus.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
+ </seealso>
+ </generic-function>
+
<!-- ACCESSORS -->
</package>
1
0
Author: junrue
Date: Fri Oct 20 02:04:27 2006
New Revision: 365
Modified:
trunk/docs/manual/README.txt
trunk/docs/manual/clhs-table.xml
trunk/docs/manual/gf-data.xsl
trunk/docs/manual/gfw-symbols.xml
trunk/docs/manual/win32-api-table.xml
Log:
Modified: trunk/docs/manual/README.txt
==============================================================================
--- trunk/docs/manual/README.txt (original)
+++ trunk/docs/manual/README.txt Fri Oct 20 02:04:27 2006
@@ -1,10 +1,15 @@
-The Programming Reference source consists of XML-based DocBook files,
-custom XSLT and CSS files, and a catalog file for resolving URIs. Two
-sets of utilities are used to translate the sources into HTML Help
-(CHM) format.
+The Programming Reference source consists of XML-based source files,
+some of which are DocBook files and others which are transformed
+into DocBook, along with custom XSLT and CSS files, and a catalog
+file for resolving URIs. Several utilities comprise the translation
+process from sources into HTML Help (CHM) format.
+
+Before anything else, you should install a version of GNU Make
+for Windows, since the docs build process is managed with a
+makefile. Just install MSYS or Cygwin, if you haven't already.
-First, you will need a version of xsltproc and its dependencies. The
+Next, you will need a version of xsltproc and its dependencies. The
version of xsltproc that I have had success using is available from:
http://www.zlatkovic.com/libxml.en.html
@@ -19,7 +24,7 @@
Note: I did not have success with libxslt from GnuWin32 so I would not
recommend using that version.
-Second, you will need the hhc.exe command-line compiler from the
+Third, you will need the hhc.exe command-line compiler from the
HTML Help Workshop, available here:
http://go.microsoft.com/fwlink/?LinkId=14188
@@ -29,22 +34,14 @@
In order to translate from DocBook into HTML Help source and then into
a CHM file, open a command prompt and cd into the docs/manual
-subdirectory where you installed the Graphic-Forms source.
+subdirectory underneath where you installed the Graphic-Forms source.
Modify the URI values in catalog.xml to suit your particular
-environment, then run the following commands (note that I am using
-MSYS, so these are run from my bash prompt, translate appropriately
-if you are in a Windows CMD prompt):
-
-% export XML_CATALOG_FILES=catalog.xml
-% xsltproc --nonet graphic-forms.xsl graphic-forms.xml
-% hhc htmlhelp.hhp
+environment, then run make on Makefile.
Then double-click on graphic-forms.chm and you should see the
Programming Reference appear.
-The provided Makefile automates the above commands.
-
More information about configuring DocBook and xsltproc, as well
as a quick tutorial on the whole process, see these links:
Modified: trunk/docs/manual/clhs-table.xml
==============================================================================
--- trunk/docs/manual/clhs-table.xml (original)
+++ trunk/docs/manual/clhs-table.xml Fri Oct 20 02:04:27 2006
@@ -6,6 +6,7 @@
-->
<clhs-table>
+ <entry name="alist" url="http://www.lispworks.com/documentation/HyperSpec/Body/26_glo_a.htm#alist"/>
<entry name="boolean" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_ban.htm"/>
<entry name="error" url="http://www.lispworks.com/documentation/HyperSpec/Body/e_error.htm"/>
<entry name="float" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_float.htm"/>
Modified: trunk/docs/manual/gf-data.xsl
==============================================================================
--- trunk/docs/manual/gf-data.xsl (original)
+++ trunk/docs/manual/gf-data.xsl Fri Oct 20 02:04:27 2006
@@ -343,11 +343,13 @@
</xsl:element>
<xsl:element name="entry">
<xsl:attribute name="valign">top</xsl:attribute>
+ <para role="normal">
<xsl:for-each select="*">
<xsl:sort select="substring-after(.,':')" order="ascending" case-order="upper-first"/>
<xsl:apply-templates select="."/>
<xsl:if test="not(position()=last())">, </xsl:if>
</xsl:for-each>
+ </para>
</xsl:element>
</xsl:element>
</xsl:template>
Modified: trunk/docs/manual/gfw-symbols.xml
==============================================================================
--- trunk/docs/manual/gfw-symbols.xml (original)
+++ trunk/docs/manual/gfw-symbols.xml Fri Oct 20 02:04:27 2006
@@ -17,12 +17,321 @@
<!-- CLASSES -->
+ <class name="display">
+ <description>
+ <hierarchy>
+ <inherits>
+ <reftopic>gfs:native-object</reftopic>
+ </inherits>
+ </hierarchy>
+ <para role="normal">
+ Instances of this class describe characteristics of monitors attached
+ to the system.
+ </para>
+ <para role="normal">
+ This class is not meant to be instantiated by application code.
+ </para>
+ </description>
+ <initargs>
+ <argument name=":handle">
+ <description>
+ See <reftopic>gfs:native-object</reftopic>
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfs:dispose</reftopic>
+ <reftopic>gfw:obtain-displays</reftopic>
+ <reftopic>gfs:obtain-primary-display</reftopic>
+ </seealso>
+ </class>
+
+ <class name="event-dispatcher">
+ <description>
+ <hierarchy>
+ <inheritedby>
+ <reftopic>gfw:scrolling-helper</reftopic>
+ </inheritedby>
+ </hierarchy>
+ Applications define subclasses of this class and implement one
+ or more of the event generic functions.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
+ </seealso>
+ </class>
+
+ <class name="scrolling-helper">
+ <description>
+ <hierarchy>
+ <inherits>
+ <reftopic>gfw:event-dispatcher</reftopic>
+ </inherits>
+ </hierarchy>
+ This is an event dispatcher specialized for processing scroll events
+ on behalf of windows.
+ </description>
+ <initargs>
+ <argument name=":step-increments">
+ <description>
+ A <reftopic>gfs:size</reftopic> object describing how large a
+ single step represents in pixels. The default is 1 pixel.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
+ </seealso>
+ </class>
+
+ <class name="layout-managed">
+ <description>
+ <hierarchy>
+ <inheritedby>
+ <reftopic>gfw:window</reftopic>
+ </inheritedby>
+ </hierarchy>
+ This is a mix-in for widgets that employ a <reftopic>gfw:layout-manager</reftopic>
+ to position children.
+ </description>
+ <initargs>
+ <argument name=":layout">
+ <description>
+ An instance of a <reftopic>gfw:layout-manager</reftopic> subclass.
+ </description>
+ </argument>
+ </initargs>
+ <seealso/>
+ </class>
+
+ <class name="event-source">
+ <description>
+ <hierarchy>
+ <inherits>
+ <reftopic>gfs:native-object</reftopic>
+ </inherits>
+ <inheritedby>
+ <reftopic>gfw:item</reftopic>
+ <reftopic>gfw:standard-scrollbar</reftopic>
+ <reftopic>gfw:timer</reftopic>
+ <reftopic>gfw:widget</reftopic>
+ </inheritedby>
+ </hierarchy>
+ <para role="normal">
+ This is the base class for user interface objects having a native
+ system resource that generates events.
+ </para>
+ <para role="normal">
+ This class defines a class-allocated slot holding a symbol
+ identifying an event function (e.g., <reftopic>gfw:event-select</reftopic>),
+ to be supplied along with a function pointer in calls to the internal
+ define-dispatcher function. The purpose of this is to facilitate
+ implementation of shortcuts for defining dispatchers where definition of
+ a primary event function is sufficient, as is the case when a control
+ class wants to support a :callback initarg. The choice of event function
+ is determined by each subclass, hence this slot is shadowed by each such
+ subclass. Application code typically is not concerned with this slot,
+ except when an application defines new kinds of event sources.
+ </para>
+ </description>
+ <initargs>
+ <argument name=":handle">
+ <description>
+ See <reftopic>gfs:native-object</reftopic>
+ </description>
+ </argument>
+ <argument name=":callbacks">
+ <description>
+ An <refclhs>alist</refclhs> where the CAR of each entry is a
+ symbol identifying one of the event generic functions and the
+ CDR is a function with congruent arguments. This constitutes
+ a specification for a new <reftopic>gfw:event-dispatcher</reftopic>
+ subclass and event methods.
+ </description>
+ </argument>
+ <argument name=":dispatcher">
+ <description>
+ The <reftopic>gfw:event-dispatcher</reftopic> instance wrapping
+ responsibility for processing events on behalf of this object.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfs:dispose</reftopic>
+ </seealso>
+ </class>
+
<!-- STRUCTURES -->
<!-- FUNCTIONS -->
+ <function name="default-message-filter">
+ <syntax>
+ <arguments>
+ <argument name="gm-code">
+ <description>
+ The value returned by the Win32 API function
+ <refwin32api>GetMessage</refwin32api>.
+ </description>
+ </argument>
+ <argument name="msg-ptr">
+ <description>
+ A foreign pointer to a Win32 <refwin32api>MSG</refwin32api>
+ structure, filled in by <refwin32api>GetMessage</refwin32api>,
+ containing raw event data to be translated and dispatched.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ Processes messages for all windows, non-modal dialogs, and controls.
+ Accelerator keys are translated by this function. Returns NIL
+ so that <reftopic>gfw:message-loop</reftopic> will continue, unless
+ <arg0/> is less than or equal to 0, in which case T is returned
+ so that <reftopic>gfw:message-loop</reftopic> will exit. More
+ specifically, when <arg0/> is 0, <arg1/> identifies a WM_QUIT
+ message indicating normal shutdown; if <arg0/> is -1, then the system
+ has reported an error during message retrieval; in this situation,
+ the application should attempt a graceful shutdown.
+ </para>
+ <para role="normal">
+ This function is not intended to be called by application code; rather,
+ it is passed to <reftopic>gfw:message-loop</reftopic>.
+ </para>
+ </description>
+ </function>
+
+ <function name="message-loop">
+ <syntax>
+ <arguments>
+ <argument name="msg-filter">
+ <description>
+ A function to process each message.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ This function retrieves messages from the queue associated with the
+ current thread, passing each one to the function specified by <arg0/>
+ so that it may be translated and dispatched. The return value of the
+ <arg0/> function determines whether message-loop continues or returns
+ -- it must return NIL if message-loop should continue, or non-NIL if
+ message-loop should exit.
+ </description>
+ <seealso>
+ <reftopic>gfw:default-message-filter</reftopic>
+ </seealso>
+ </function>
+
<!-- GENERIC FUNCTIONS -->
+ <generic-function name="event-activate">
+ <syntax>
+ <arguments>
+ <argument name="event-dispatcher">
+ <description>
+ The <reftopic>gfw:event-dispatcher</reftopic> that will process
+ this event.
+ </description>
+ </argument>
+ <argument name="widget">
+ <description>
+ The <reftopic>gfw:widget</reftopic> being activated.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Implement a method for this generic function to respond to the activation
+ of <arg1/>. For top-level windows or dialogs, this means that <arg1/> was
+ brought to the foreground and its trim (title bar and border) have become
+ highlighted. For a menu, it means the user has clicked on the menu item
+ serving as the anchor for the menu which is therefore about to be shown.
+ In the menu case, event-activate is an opportunity to adjust the menu's
+ contents.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
+ <reftopic>gfw:top-level</reftopic>
+ <reftopic>gfw:dialog</reftopic>
+ <reftopic>gfw:menu</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="event-arm">
+ <syntax>
+ <arguments>
+ <argument name="event-dispatcher">
+ <description>
+ The <reftopic>gfw:event-dispatcher</reftopic> that will process
+ this event.
+ </description>
+ </argument>
+ <argument name="widget">
+ <description>
+ The <reftopic>gfw:widget</reftopic> about to be selected.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Implement a method for this generic function to respond to notification
+ that <arg1/> is about to be selected. Arming events are not always
+ followed by selection events, such as when the user is moving the mouse
+ across multiple items on a menu.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
+ <reftopic>gfw:event-select</reftopic>
+ <reftopic>gfw:menu</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="event-close">
+ <syntax>
+ <arguments>
+ <argument name="event-dispatcher">
+ <description>
+ The <reftopic>gfw:event-dispatcher</reftopic> that will process
+ this event.
+ </description>
+ </argument>
+ <argument name="widget">
+ <description>
+ The <reftopic>gfw:widget</reftopic> being closed.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Implement a method for this generic function to respond to <arg1/>
+ being closed by the user. Only top-level windows and dialogs receive
+ close events.
+ </description>
+ <seealso>
+ <reftopic>gfw:event-source</reftopic>
+ <reftopic>gfw:top-level</reftopic>
+ <reftopic>gfw:dialog</reftopic>
+ </seealso>
+ </generic-function>
+
<!-- ACCESSORS -->
</package>
Modified: trunk/docs/manual/win32-api-table.xml
==============================================================================
--- trunk/docs/manual/win32-api-table.xml (original)
+++ trunk/docs/manual/win32-api-table.xml Fri Oct 20 02:04:27 2006
@@ -9,5 +9,7 @@
<entry name="COLORREF" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/gdi/colors…"/>
<entry name="CommDlgExtendedError" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/winui/winu…"/>
<entry name="GetLastError" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/debug/base…"/>
+ <entry name="GetMessage" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/winui/winu…"/>
<entry name="Icons in Win32" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnwui/html…"/>
+ <entry name="MSG" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/winui/winu…"/>
</win32-api-table>
1
0
[graphic-forms-cvs] r364 - in trunk: . src src/tests/uitoolkit src/uitoolkit/widgets
by junrue＠common-lisp.net 19 Oct '06
by junrue＠common-lisp.net 19 Oct '06
19 Oct '06
Author: junrue
Date: Fri Oct 20 00:28:30 2006
New Revision: 364
Added:
trunk/src/uitoolkit/widgets/scrolling-helper.lisp
- copied, changed from r346, trunk/src/uitoolkit/widgets/scrolling-event-dispatcher.lisp
Removed:
trunk/src/uitoolkit/widgets/scrolling-event-dispatcher.lisp
Modified:
trunk/graphic-forms-uitoolkit.asd
trunk/src/packages.lisp
trunk/src/tests/uitoolkit/scroll-tester.lisp
trunk/src/uitoolkit/widgets/event.lisp
trunk/src/uitoolkit/widgets/scrollbar.lisp
trunk/src/uitoolkit/widgets/widget-classes.lisp
Log:
renamed scrolling-event-dispatcher to scrolling-helper
Modified: trunk/graphic-forms-uitoolkit.asd
==============================================================================
--- trunk/graphic-forms-uitoolkit.asd (original)
+++ trunk/graphic-forms-uitoolkit.asd Fri Oct 20 00:28:30 2006
@@ -138,7 +138,7 @@
(:file "menu-item")
(:file "menu-language")
(:file "event")
- (:file "scrolling-event-dispatcher")
+ (:file "scrolling-helper")
(:file "scrollbar")
(:file "slider")
(:file "window")
Modified: trunk/src/packages.lisp
==============================================================================
--- trunk/src/packages.lisp (original)
+++ trunk/src/packages.lisp Fri Oct 20 00:28:30 2006
@@ -265,7 +265,7 @@
#:panel
#:root-window
#:scrollbar
- #:scrolling-event-dispatcher
+ #:scrolling-helper
#:slider
#:timer
#:top-level
Modified: trunk/src/tests/uitoolkit/scroll-tester.lisp
==============================================================================
--- trunk/src/tests/uitoolkit/scroll-tester.lisp (original)
+++ trunk/src/tests/uitoolkit/scroll-tester.lisp Fri Oct 20 00:28:30 2006
@@ -41,7 +41,7 @@
(setf *scroll-tester-win* nil)
(gfw:shutdown 0))
-(defclass scroll-tester-events (gfw:scrolling-event-dispatcher) ())
+(defclass scroll-tester-events (gfw:scrolling-helper) ())
(defmethod gfw:event-close ((disp scroll-tester-events) window)
(declare (ignore window))
Modified: trunk/src/uitoolkit/widgets/event.lisp
==============================================================================
--- trunk/src/uitoolkit/widgets/event.lisp (original)
+++ trunk/src/uitoolkit/widgets/event.lisp Fri Oct 20 00:28:30 2006
@@ -391,7 +391,7 @@
(disp (dispatcher widget)))
(unwind-protect
(let ((parent (gfw:parent widget)))
- (when (and parent (typep (dispatcher parent) 'scrolling-event-dispatcher))
+ (when (and parent (typep (dispatcher parent) 'scrolling-helper))
(let ((origin (slot-value (dispatcher parent) 'viewport-origin)))
(set-window-origin gc origin)
(incf (gfs:point-x pnt) (gfs:point-x origin))
Modified: trunk/src/uitoolkit/widgets/scrollbar.lisp
==============================================================================
--- trunk/src/uitoolkit/widgets/scrollbar.lisp (original)
+++ trunk/src/uitoolkit/widgets/scrollbar.lisp Fri Oct 20 00:28:30 2006
@@ -181,7 +181,7 @@
(error 'gfs:disposed-error))
(let ((disp (dispatcher (parent self))))
(cond
- ((typep disp 'scrolling-event-dispatcher)
+ ((typep disp 'scrolling-helper)
(if (eql (orientation-of self) :horizontal)
(gfs:size-width (step-increments self))
(gfs:size-height (step-increments self))))
@@ -196,7 +196,7 @@
(warn 'gfs:toolkit-warning :detail "negative step increment"))
(let ((disp (dispatcher (parent self))))
(cond
- ((typep disp 'scrolling-event-dispatcher)
+ ((typep disp 'scrolling-helper)
(if (eql (orientation-of self) :horizontal)
(setf (gfs:size-width (step-increments self)) amount)
(setf (gfs:size-height (step-increments self)) amount)))
Copied: trunk/src/uitoolkit/widgets/scrolling-helper.lisp (from r346, trunk/src/uitoolkit/widgets/scrolling-event-dispatcher.lisp)
==============================================================================
--- trunk/src/uitoolkit/widgets/scrolling-event-dispatcher.lisp (original)
+++ trunk/src/uitoolkit/widgets/scrolling-helper.lisp Fri Oct 20 00:28:30 2006
@@ -1,5 +1,5 @@
;;;;
-;;;; scrolling-event-dispatcher.lisp
+;;;; scrolling-helper.lisp
;;;;
;;;; Copyright (C) 2006, Jack D. Unrue
;;;; All rights reserved.
@@ -130,7 +130,7 @@
;;; methods
;;;
-(defmethod event-pre-resize ((disp scrolling-event-dispatcher) (window window) rect type)
+(defmethod event-pre-resize ((disp scrolling-helper) (window window) rect type)
(let ((h-step (gfs:size-width (step-increments disp)))
(v-step (gfs:size-height (step-increments disp)))
(outer-size (gfw:size window))
@@ -153,27 +153,27 @@
(setf (gfs:size-height size) amount)))
(setf (gfs:size rect) size)))
-(defmethod event-resize ((disp scrolling-event-dispatcher) (window window) size type)
+(defmethod event-resize ((disp scrolling-helper) (window window) size type)
(declare (ignore size type))
(call-next-method)
(when (typep (layout-of window) 'heap-layout)
(update-scrollbar-page-sizes window)
(update-viewport-origin-for-resize window)))
-(defmethod event-scroll ((disp scrolling-event-dispatcher) (window window) axis detail)
+(defmethod event-scroll ((disp scrolling-helper) (window window) axis detail)
(declare (ignore disp))
(when (typep (layout-of window) 'heap-layout)
(update-scrolling-state window axis detail)))
-(defmethod initialize-instance :after ((self scrolling-event-dispatcher) &key)
+(defmethod initialize-instance :after ((self scrolling-helper) &key)
(validate-step-values (step-increments self)))
-(defmethod print-object ((self scrolling-event-dispatcher) stream)
+(defmethod print-object ((self scrolling-helper) stream)
(print-unreadable-object (self stream :type t)
(format stream "horizontal policy: ~a " (horizontal-policy-of self))
(format stream "vertical policy: ~a " (vertical-policy-of self))
(format stream "step increments: ~a" (step-increments self))))
-(defmethod (setf step-increment) :after (amounts (self scrolling-event-dispatcher))
+(defmethod (setf step-increment) :after (amounts (self scrolling-helper))
(validate-step-values amounts)
(setf (slot-value self 'step-increment) (gfs:copy-size amounts)))
Modified: trunk/src/uitoolkit/widgets/widget-classes.lisp
==============================================================================
--- trunk/src/uitoolkit/widgets/widget-classes.lisp (original)
+++ trunk/src/uitoolkit/widgets/widget-classes.lisp Fri Oct 20 00:28:30 2006
@@ -39,7 +39,7 @@
(defclass event-dispatcher () ()
(:documentation "Instances of this class receive events on behalf of user interface objects."))
-(defclass scrolling-event-dispatcher (event-dispatcher)
+(defclass scrolling-helper (event-dispatcher)
((horizontal-policy
:accessor horizontal-policy-of
:initarg :horizontal-policy
1
0
Author: junrue
Date: Thu Oct 19 23:56:22 2006
New Revision: 363
Modified:
trunk/docs/manual/gfg-symbols.xml
Log:
Modified: trunk/docs/manual/gfg-symbols.xml
==============================================================================
--- trunk/docs/manual/gfg-symbols.xml (original)
+++ trunk/docs/manual/gfg-symbols.xml Thu Oct 19 23:56:22 2006
@@ -1484,6 +1484,76 @@
</seealso>
</generic-function>
+ <generic-function name="draw-text">
+ <syntax>
+ <arguments>
+ <argument name="graphics-context">
+ <description>
+ A <reftopic>gfg:graphics-context</reftopic> on which to draw.
+ </description>
+ </argument>
+ <argument name="string">
+ <description>
+ A <refclhs>string</refclhs> to be rendered, which may contain
+ characters that will be interpreted specially; see <arg3/>.
+ </description>
+ </argument>
+ <argument name="point">
+ <description>
+ A <reftopic>gfg:point</reftopic> specifying the upper-left
+ corner of the rectangle bounding <arg1/>.
+ </description>
+ </argument>
+ <notarg name="&optional"/>
+ <argument name="style">
+ <description>
+ A <refclhs>list</refclhs> containing one or more of the following
+ keyword symbols:
+ <enum>
+ <argument name=":mnemonic">
+ <description>
+ Underline the mnemonic character, specified in <arg1/> with
+ an ampersand.
+ </description>
+ </argument>
+ <argument name=":tab">
+ <description>
+ Expand tabs embedded in <arg1/>; see <arg4/>.
+ </description>
+ </argument>
+ <argument name=":transparent">
+ <description>
+ The background of the drawing area where <arg1/> will be
+ rendered is preserved.
+ </description>
+ </argument>
+ </enum>
+ </description>
+ </argument>
+ <argument name="tab-width">
+ <description>
+ A positive <refclhs>integer</refclhs> specifying the number of
+ pixels into which tabs should be expanded; the default is 8.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Draws <arg1/>, optionally expanding tabs and underlining the mnemonic
+ character.
+ </description>
+ <seealso>
+ <reftopic>gfg:foreground-color</reftopic>
+ <reftopic>gfg:background-color</reftopic>
+ <reftopic>gfg:font</reftopic>
+ <reftopic>gfg:text-extent</reftopic>
+ <reftopic>gfg:metrics</reftopic>
+ </seealso>
+ </generic-function>
+
<generic-function name="load">
<syntax>
<arguments>
1
0