graphic-forms-cvs
Threads by month
- ----- 2025 -----
- 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