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