Author: junrue Date: Sat Dec 23 01:31:46 2006 New Revision: 422
Added: trunk/docs/manual/protocols.xml Modified: trunk/docs/manual/Makefile trunk/docs/manual/gf-data.xsl trunk/docs/manual/gfw-symbols.xml trunk/docs/manual/glossary.xml trunk/docs/manual/graphic-forms.xml trunk/docs/manual/miscellaneous-topics.xml trunk/src/uitoolkit/system/system-constants.lisp Log: more documentation, some of which related to status-bar and friends, and some just general doc update
Modified: trunk/docs/manual/Makefile ============================================================================== --- trunk/docs/manual/Makefile (original) +++ trunk/docs/manual/Makefile Sat Dec 23 01:31:46 2006 @@ -10,7 +10,7 @@ CHM-DEPS = gfs-tmp-pkg.xml gfg-tmp-pkg.xml gfw-tmp-pkg.xml gfc-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 + introduction.xml legal.xml protocols.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 \
Modified: trunk/docs/manual/gf-data.xsl ============================================================================== --- trunk/docs/manual/gf-data.xsl (original) +++ trunk/docs/manual/gf-data.xsl Sat Dec 23 01:31:46 2006 @@ -2,7 +2,7 @@ <!-- gf-data.xsl
- Copyright (c) 2006, Jack D. Unrue + Copyright (c) 2006-2007, Jack D. Unrue --> <xsl:stylesheet xmlns:exsl="http://exslt.org/common"
Modified: trunk/docs/manual/gfw-symbols.xml ============================================================================== --- trunk/docs/manual/gfw-symbols.xml (original) +++ trunk/docs/manual/gfw-symbols.xml Sat Dec 23 01:31:46 2006 @@ -532,6 +532,7 @@ <hierarchy> <inheritedby> <reftopic>gfw:window</reftopic> + <reftopic>gfw:status-bar</reftopic> </inheritedby> </hierarchy> This is a mix-in for widgets that employ a <reftopic>gfw:layout-manager</reftopic> @@ -709,6 +710,7 @@ <inheritedby> <reftopic>gfw:menu</reftopic> <reftopic>gfw:list-box</reftopic> + <reftopic>gfw:status-bar</reftopic> </inheritedby> </hierarchy> This is a mix-in for widgets that contain and display sub-elements. @@ -790,6 +792,7 @@ <reftopic>gfw:font-dialog</reftopic> <reftopic>gfw:menu</reftopic> <reftopic>gfw:window</reftopic> + <reftopic>gfw:status-bar</reftopic> </inheritedby> </hierarchy> This is the base class for all windowed user interface objects whose @@ -1444,6 +1447,9 @@ <reftopic>gfs:dispose</reftopic> <reftopic>gfw:owner</reftopic> <reftopic>gfw:text</reftopic> + <reftopic>gfw:obtain-horizontal-scrollbar</reftopic> + <reftopic>gfw:obtain-vertical-scrollbar</reftopic> + <reftopic>gfw:obtain-status-bar</reftopic> </seealso> </class>
@@ -2049,9 +2055,82 @@ </initargs> <seealso> <reftopic>gfs:dispose</reftopic> - <reftopic>gfw:dialog</reftopic> + <reftopic>gfw:update-native-style</reftopic> + <reftopic>gfw:parent</reftopic> + <reftopic>gfw:style-of</reftopic> + <reftopic>gfw:list-item</reftopic> <reftopic>gfw:auto-vscroll-p</reftopic> <reftopic>gfw:append-item</reftopic> + <reftopic>gfw:delete-item</reftopic> + <reftopic>gfw:item-count</reftopic> + <reftopic>gfw:items-of</reftopic> + <reftopic>gfw:update-from-items</reftopic> + <reftopic>gfw:item-index</reftopic> + </seealso> + </class> + + <class name="status-bar"> + <description> + <hierarchy> + <inherits> + <reftopic>gfw:widget</reftopic> + <reftopic>gfw:layout-managed</reftopic> + <reftopic>gfw:item-manager</reftopic> + </inherits> + </hierarchy> + This class represents the status bar widget with which <reftopic>gfw:top-level</reftopic> + instances may be configured. Application code does not instantiate this class directly. + </description> + <initargs> + <argument name=":parent"> + <description> + This initarg specifies the parent of the control. + </description> + </argument> + <argument name=":handle"> + <description> + See <reftopic>gfs:native-object</reftopic>. + </description> + </argument> + </initargs> + <seealso> + <reftopic>gfs:dispose</reftopic> + <reftopic>gfw:update-native-style</reftopic> + <reftopic>gfw:parent</reftopic> + <reftopic>gfw:style-of</reftopic> + <reftopic>gfw:status-item</reftopic> + <reftopic>gfw:append-item</reftopic> + <reftopic>gfw:delete-item</reftopic> + <reftopic>gfw:item-count</reftopic> + <reftopic>gfw:items-of</reftopic> + <reftopic>gfw:update-from-items</reftopic> + <reftopic>gfw:item-index</reftopic> + </seealso> + </class> + + <class name="status-item"> + <description> + <hierarchy> + <inherits> + <reftopic>gfw:item</reftopic> + </inherits> + </hierarchy> + This class represents an element of a <reftopic>gfw:status-bar</reftopic>. + </description> + <initargs> + <argument name=":parent"> + <description> + This initarg specifies the parent of the control. + </description> + </argument> + <argument name=":data"> + <description> + See <reftopic>gfw:item</reftopic>. + </description> + </argument> + </initargs> + <seealso> + <reftopic>gfs:dispose</reftopic> </seealso> </class>
@@ -2946,7 +3025,11 @@ </para> </description> <seealso> + <reftopic>gfw:append-item</reftopic> + <reftopic>gfw:delete-item</reftopic> + <reftopic>gfw:item-count</reftopic> <reftopic>gfw:items-of</reftopic> + <reftopic>gfw:item-index</reftopic> </seealso> </generic-function>
@@ -3700,6 +3783,29 @@ </seealso> </generic-function>
+ <generic-function name="obtain-status-bar"> + <syntax> + <arguments> + <argument name="self"> + <description> + An object configured with a statusbar. + </description> + </argument> + </arguments> + <return> + <reftopic>gfw:status-bar</reftopic> + </return> + </syntax> + <description> + Returns the <reftopic>gfw:status-bar</reftopic> + attached to the bottom of <arg0/>, if <arg0/> is configured to + have one. + </description> + <seealso> + <reftopic>gfw:status-item</reftopic> + </seealso> + </generic-function> + <generic-function name="menu-bar"> <syntax with-setf="t"> <arguments>
Modified: trunk/docs/manual/glossary.xml ============================================================================== --- trunk/docs/manual/glossary.xml (original) +++ trunk/docs/manual/glossary.xml Sat Dec 23 01:31:46 2006 @@ -1,7 +1,7 @@ <!-- glossary.xml
- Copyright (c) 2006, Jack D. Unrue + Copyright (c) 2006-2007, Jack D. Unrue --> <glossary id="glossary"><title>Glossary</title> <indexterm><primary>Glossary</primary></indexterm> @@ -11,7 +11,7 @@ <glossentry id="accelerator"><glossterm>accelerator</glossterm> <glossdef> <para> - An accelerator is a key sequence assigned to an application + An <emphasis>accelerator</emphasis> is a key sequence assigned to an application function allowing a user to bypass navigation of the menu or control hierarchy normally required to invoke the function. Some accelerators are established by Windows style guidelines, such as control-c for @@ -27,7 +27,7 @@ <glossentry id="auto-scrolling"><glossterm>auto-scrolling</glossterm> <glossdef> <para> - Auto-scrolling is a feature whereby scrolling occurs as a side + <emphasis>Auto-scrolling</emphasis> is a feature whereby scrolling occurs as a side effect of user input so content can remain visible, thus avoiding the need to explicitly manipulate scrollbars to achieve the same result. </para> @@ -44,9 +44,9 @@ <glossentry id="control"><glossterm>control</glossterm> <glossdef> <para> - A control is a system-defined window class whose role is to accept - user input and possibly generate notification events based on such - input. + A <emphasis>control</emphasis> is a system-defined window class whose + role is to accept user input and possibly generate notification events + based on such input. </para> </glossdef> </glossentry> @@ -58,9 +58,9 @@ <glossentry id="default action"><glossterm>default action</glossterm> <glossdef> <para> - Conceptually, a default action is a secondary event initiated by - user input that is a logical follow-up to a previous event. Examples - of such user gestures include double-clicking an item in a list box + Conceptually, a <emphasis>default action</emphasis> is a secondary event + initiated by user input that is a logical follow-up to a previous event. + Examples of such user gestures include double-clicking an item in a list box control, or pressing enter when an edit control has the keyboard focus. The response to a default action makes use of context established by the preceding event (e.g., the selection set by an initial click @@ -72,8 +72,8 @@ <glossentry id="dialog"><glossterm>dialog</glossterm> <glossdef> <para> - A dialog is a mechanism for collecting user input or showing - information. The system defines common dialogs for tasks like + A <emphasis>dialog</emphasis> is a mechanism for collecting user input + or showing information. The system defines common dialogs for tasks like choosing files, fonts, or colors. Custom dialogs can be defined by application code. </para> @@ -87,8 +87,8 @@ <glossentry id="extension"><glossterm>extension</glossterm> <glossdef> <para> - An extension is code providing additional functionality beyond the - original scope of a system. An extension framework encourages + An <emphasis>extension</emphasis> is code providing additional functionality + beyond the original scope of a system. An extension framework encourages modularity. More importantly, it is a conscious design choice to allow a system to be stretched beyond what the original designers may have anticipated. @@ -126,9 +126,9 @@ <glossdef> <para> A collection of menu items presented within a single rectangular - region. Menus are often anchored to a menu bar, but may also be - invoked in a context-sensitive manner via the mouse or an - <glossseealso otherterm="accelerator"/>. + region. <emphasis>Menus</emphasis> are often anchored to a menu bar, + but may also be invoked in a context-sensitive manner via the mouse + or an <glossseealso otherterm="accelerator"/>. </para> </glossdef> </glossentry> @@ -136,8 +136,8 @@ <glossentry id="mix-in"><glossterm>mix-in class</glossterm> <glossdef> <para> - A mix-in class represents a specific abstraction that complements - the role(s) of other class(es) in a class hierarchy. + A <emphasis>mix-in</emphasis> class represents a specific abstraction + that complements the role(s) of other class(es) in a class hierarchy. </para> </glossdef> </glossentry> @@ -145,10 +145,10 @@ <glossentry id="mnemonic"><glossterm>mnemonic</glossterm> <glossdef> <para> - A mnemonic is a key sequence (usually a single character modified - by the <Alt> key) enabling mouse-free navigation of a menu or - control hierarchy to invoke an application function. Depending on - the user's system settings, mnemonic characters may be hidden until + A <emphasis>mnemonic</emphasis> is a key sequence (usually a single + character modified by the <Alt> key) enabling mouse-free navigation + of a menu or control hierarchy to invoke an application function. Depending + on the user's system settings, mnemonic characters may be hidden until the user presses the <Alt> key. </para> <glossseealso otherterm="accelerator"/> @@ -167,15 +167,26 @@ <glossentry id="plugin"><glossterm>plugin</glossterm> <glossdef> <para> - A plugin is a unit of code integrated into a larger system in order - to implement a specific instance of an established category of - services. A plugin framework encourages modularity within a - defined scope of functionality. + A <emphasis>plugin</emphasis> is a unit of code integrated into + a larger system in order to implement a specific instance of an + established category of services. A plugin framework encourages + modularity within a defined scope of functionality. </para> <glossseealso otherterm="extension"/> </glossdef> </glossentry>
+ <glossentry id="protocol"><glossterm>protocol</glossterm> + <glossdef> + <para> + In Common Lisp, a <emphasis>protocol</emphasis> refers to a group + of logically-related functions (usually generic functions, since + protocols are often designed to be extensible). The Metaobject + Protocol (MOP) is a popular and sophisticated example. + </para> + </glossdef> + </glossentry> + </glossdiv>
<glossdiv id="glossary-Q"><title>Q</title>
Modified: trunk/docs/manual/graphic-forms.xml ============================================================================== --- trunk/docs/manual/graphic-forms.xml (original) +++ trunk/docs/manual/graphic-forms.xml Sat Dec 23 01:31:46 2006 @@ -14,6 +14,7 @@ <!ENTITY gfgpkg SYSTEM "gfg-tmp-pkg.xml"> <!-- generated file --> <!ENTITY gfspkg SYSTEM "gfs-tmp-pkg.xml"> <!-- generated file --> <!ENTITY gfwpkg SYSTEM "gfw-tmp-pkg.xml"> <!-- generated file --> + <!ENTITY protocols SYSTEM "protocols.xml"> <!ENTITY misctopics SYSTEM "miscellaneous-topics.xml"> <!ENTITY imdataplugins SYSTEM "image-data-plugins.xml"> <!ENTITY glossary SYSTEM "glossary.xml"> @@ -33,6 +34,7 @@ &legal; &introduction; &api; + &protocols; &misctopics; &glossary;
Modified: trunk/docs/manual/miscellaneous-topics.xml ============================================================================== --- trunk/docs/manual/miscellaneous-topics.xml (original) +++ trunk/docs/manual/miscellaneous-topics.xml Sat Dec 23 01:31:46 2006 @@ -1,7 +1,7 @@ <!-- miscellaneous-topics.xml
- Copyright (c) 2006, Jack D. Unrue + Copyright (c) 2006-2007, Jack D. Unrue --> <chapter id="misc-topics"> <title>Miscellaneous Topics</title>
Added: trunk/docs/manual/protocols.xml ============================================================================== --- (empty file) +++ trunk/docs/manual/protocols.xml Sat Dec 23 01:31:46 2006 @@ -0,0 +1,16 @@ +<!-- + protocols.xml + + Copyright (c) 2006-2007, Jack D. Unrue +--> +<chapter id="protocols"> + <title>Protocols</title> + + <para role="normal"> + This chapter's sections discuss the <glossterm linkend="protocol">protocols</glossterm> + representing major functional areas of Graphic-Forms. + </para> + + + +</chapter>
Modified: trunk/src/uitoolkit/system/system-constants.lisp ============================================================================== --- trunk/src/uitoolkit/system/system-constants.lisp (original) +++ trunk/src/uitoolkit/system/system-constants.lisp Sat Dec 23 01:31:46 2006 @@ -951,24 +951,24 @@ ;;; statusbar constants ;;;
-(defconstant +sb-SETPARTS+ #x0404) ; (WM_USER+4) -(defconstant +sb-GETPARTS+ #x0406) ; (WM_USER+6) -(defconstant +sb-GETBORDERS+ #x0407) ; (WM_USER+7) -(defconstant +sb-SETMINHEIGHT+ #x0408) ; (WM_USER+8) -(defconstant +sb-SIMPLE+ #x0409) ; (WM_USER+9) -(defconstant +sb-GETRECT+ #x040A) ; (WM_USER+10) -(defconstant +sb-ISSIMPLE+ #x040E) ; (WM_USER+14) -(defconstant +sb-SETICON+ #x040F) ; (WM_USER+15) -(defconstant +sb-SETTIPTEXTA+ #x0410) ; (WM_USER+16) -(defconstant +sb-SETTIPTEXTW+ #x0411) ; (WM_USER+17) -(defconstant +sb-GETTIPTEXTA+ #x0412) ; (WM_USER+18) -(defconstant +sb-GETTIPTEXTW+ #x0413) ; (WM_USER+19) -(defconstant +sb-GETICON+ #x0414) ; (WM_USER+20) -(defconstant +sb-SETUNICODEFORMAT+ #x2005) ; CCM_SETUNICODEFORMAT -(defconstant +sb-GETUNICODEFORMAT+ #x2006) ; CCM_GETUNICODEFORMAT +(defconstant +sb-setparts+ #x0404) ; (WM_USER+4) +(defconstant +sb-getparts+ #x0406) ; (WM_USER+6) +(defconstant +sb-getborders+ #x0407) ; (WM_USER+7) +(defconstant +sb-setminheight+ #x0408) ; (WM_USER+8) +(defconstant +sb-simple+ #x0409) ; (WM_USER+9) +(defconstant +sb-getrect+ #x040A) ; (WM_USER+10) +(defconstant +sb-issimple+ #x040E) ; (WM_USER+14) +(defconstant +sb-seticon+ #x040F) ; (WM_USER+15) +(defconstant +sb-settiptexta+ #x0410) ; (WM_USER+16) +(defconstant +sb-settiptextw+ #x0411) ; (WM_USER+17) +(defconstant +sb-gettiptexta+ #x0412) ; (WM_USER+18) +(defconstant +sb-gettiptextw+ #x0413) ; (WM_USER+19) +(defconstant +sb-geticon+ #x0414) ; (WM_USER+20) +(defconstant +sb-setunicodeformat+ #x2005) ; CCM_SETUNICODEFORMAT +(defconstant +sb-getunicodeformat+ #x2006) ; CCM_GETUNICODEFORMAT
-(defconstant +sbars-SIZEGRIP+ #x0100) -(defconstant +sbars-TOOLTIPS+ #x0800) +(defconstant +sbars-sizegrip+ #x0100) +(defconstant +sbars-tooltips+ #x0800)
(defconstant +sbs-horz+ #x0000) (defconstant +sbs-vert+ #x0001)