From: <mie...@us...> - 2008-12-26 19:20:51
|
Revision: 3810 http://oorexx.svn.sourceforge.net/oorexx/?rev=3810&view=rev Author: miesfeld Date: 2008-12-26 19:20:48 +0000 (Fri, 26 Dec 2008) Log Message: ----------- Continue work on ooDialog doc update Modified Paths: -------------- docs/trunk/oodialog/Makefile docs/trunk/oodialog/oodialog.sgml docs/trunk/oodialog/resources.sgml docs/trunk/oodialog/userdialog.sgml Modified: docs/trunk/oodialog/Makefile =================================================================== --- docs/trunk/oodialog/Makefile 2008-12-26 19:19:54 UTC (rev 3809) +++ docs/trunk/oodialog/Makefile 2008-12-26 19:20:48 UTC (rev 3810) @@ -68,6 +68,7 @@ scrollbarc.sgml \ slidercontrolc.sgml \ staticcontrolc.sgml \ + resources.sgml \ tabcontrolc.sgml \ termdef.sgml \ treecontrolc.sgml \ Modified: docs/trunk/oodialog/oodialog.sgml =================================================================== --- docs/trunk/oodialog/oodialog.sgml 2008-12-26 19:19:54 UTC (rev 3809) +++ docs/trunk/oodialog/oodialog.sgml 2008-12-26 19:20:48 UTC (rev 3810) @@ -15,18 +15,19 @@ <!ENTITY utilityclasses SYSTEM "utilityclasses.sgml"> <!ENTITY mesextcl SYSTEM "mesextcl.sgml"> <!ENTITY advcntlc SYSTEM "advcntlc.sgml"> +<!ENTITY resources SYSTEM "resources.sgml"> <!ENTITY staticcontrolc SYSTEM "staticcontrolc.sgml"> +<!ENTITY buttoncontrols SYSTEM "buttoncontrols.sgml"> <!ENTITY editcontrolc SYSTEM "editcontrolc.sgml"> -<!ENTITY listcontrolc SYSTEM "listcontrolc.sgml"> -<!ENTITY buttoncontrols SYSTEM "buttoncontrols.sgml"> +<!ENTITY comboboxc SYSTEM "comboboxc.sgml"> <!ENTITY listboxc SYSTEM "listboxc.sgml"> -<!ENTITY comboboxc SYSTEM "comboboxc.sgml"> <!ENTITY scrollbarc SYSTEM "scrollbarc.sgml"> -<!ENTITY propertysheetc SYSTEM "propertysheetc.sgml"> +<!ENTITY listcontrolc SYSTEM "listcontrolc.sgml"> +<!ENTITY treecontrolc SYSTEM "treecontrolc.sgml"> +<!ENTITY slidercontrolc SYSTEM "slidercontrolc.sgml"> <!ENTITY progressbarc SYSTEM "progressbarc.sgml"> -<!ENTITY slidercontrolc SYSTEM "slidercontrolc.sgml"> <!ENTITY tabcontrolc SYSTEM "tabcontrolc.sgml"> -<!ENTITY treecontrolc SYSTEM "treecontrolc.sgml"> +<!ENTITY propertysheetc SYSTEM "propertysheetc.sgml"> <!ENTITY notices SYSTEM "../shared/notices.sgml"> <!ENTITY cpl SYSTEM "../shared/CPLv1.0.sgml"> <!ENTITY gethelp SYSTEM "../shared/gethelp.sgml"> @@ -87,36 +88,37 @@ </bookinfo> -&preface; <!-- About This Book --> +&preface; <!-- About This Book --> <!-- start of body --> -&reference; <!-- Reference --> -&termdef; <!-- Definition of Terms --> +&reference; <!-- Reference --> +&termdef; <!-- Definition of Terms --> &basedialog; <!-- BaseDialog Class --> -&dialogcontrolc; <!-- DialogControl Class --> +&dialogcontrolc; <!-- DialogControl Class --> &userdialog; <!-- UserDialog Class --> -&plainuserdialogc; <!-- PlainUserDialog Class --> -&resdialog; <!-- ResDialog Class --> -&categorydialog; <!-- CategoryDialog Class --> -&standarddialog; <!-- Standard Dialogs, External Functions, and Public Routines --> -&utilityclasses; <!-- Utility Classess, DlgUtil, Point, DlgArea, etc.. --> -&mesextcl; <!-- MessageExtensions Class --> -&advcntlc; <!-- AdvancedControl Class --> -&staticcontrolc; <!-- StaticControl Class --> -&editcontrolc; <!-- EditControl Class --> -&listcontrolc; <!-- ListControl Class --> -&buttoncontrols; <!-- Button Controls --> -&listboxc; <!-- ListBox Class --> -&comboboxc; <!-- ComboBox Class --> +&plainuserdialogc; <!-- PlainUserDialog Class --> +&resdialog; <!-- ResDialog Class --> +&categorydialog; <!-- CategoryDialog Class --> +&standarddialog; <!-- Standard Dialogs, External Functions, and Public Routines --> +&utilityclasses; <!-- Utility Classess, DlgUtil, Point, DlgArea, etc.. --> +&mesextcl; <!-- MessageExtensions Class --> +&advcntlc; <!-- AdvancedControl Class --> +&resources; <!-- Resources --> +&staticcontrolc; <!-- StaticControl Class --> +&buttoncontrols; <!-- Button Controls --> +&editcontrolc; <!-- EditControl Class --> +&comboboxc; <!-- ComboBox Class --> +&listboxc; <!-- ListBox Class --> &scrollbarc; <!-- ScrollBar Class --> -&propertysheetc; <!-- PropertySheet Class --> -&progressbarc; <!-- ProgressBar Class --> -&slidercontrolc; <!-- SliderControl Class --> +&listcontrolc; <!-- ListControl Class --> +&treecontrolc; <!-- TreeControl Class --> +&slidercontrolc; <!-- SliderControl Class --> +&progressbarc; <!-- ProgressBar Class --> &tabcontrolc; <!-- TabControl Class --> -&treecontrolc; <!-- TreeControl Class --> +&propertysheetc; <!-- PropertySheet Class --> <!-- start of appendix --> -¬ices; <!-- Notices --> -&cpl; <!-- CPL --> +¬ices; <!-- Notices --> +&cpl; <!-- CPL --> -&genindex; <!-- Index --> +&genindex; <!-- Index --> </book> Modified: docs/trunk/oodialog/resources.sgml =================================================================== --- docs/trunk/oodialog/resources.sgml 2008-12-26 19:19:54 UTC (rev 3809) +++ docs/trunk/oodialog/resources.sgml 2008-12-26 19:20:48 UTC (rev 3810) @@ -44,17 +44,23 @@ <chapter id="resources"><title>Resources</title> <indexterm><primary>Resources</primary></indexterm> <para> - In Windows resources are binary data used in Windows based applications. The data in standard - resources describes things like: dialog boxes, icons, menus, cursors, bitmaps, fonts, etc., familar to - ooDialog programmers. Standard resources also include things accelerator tables, string-table entries, - message-table entries, and other resourcess that ooDialog does not currently have support for, but may - support in the future. + In the Windows OS, a <emphasis role="italic">resource</emphasis>, is binary data used by a + Windows-based application. Usually, the binary data is attached to one of the applicatios's + executable files (*.exe or *.dll.) However, the binary data can also be generated dynamically in + memory. (Which is common in ooDialog, for example a UserDialog.) </para> <para> + The data in standard resources describes things like: dialog boxes, icons, menus, cursors, + bitmaps, fonts, etc., familar to ooDialog programmers. Standard resources also include things + accelerator tables, string-table entries, message-table entries, and other resourcess that + ooDialog does not currently have support for, but may support in the future. +</para> +<para> This chapter describes ooDialog classes that provide access to Windows resources. The classes allow - the oodialog programmer to use and manipulate resources in their ooDialog programs. The classes listed - in the following table are documented in this chapter: -<table id="tUtilityClasses" frame="all"> + the oodialog programmer to use and manipulate resources in their ooDialog programs. This is an + area of ooDialog is slated for future improvements. The classes listed in the following table are + documented in this chapter: +<table id="tblResourcesClasses" frame="all"> <title>ooDialog Utilitiy Classes</title> <tgroup cols="2"> <thead> @@ -80,5 +86,430 @@ </table> </para> +<section id="clsImage"><title>Image Class</title> +<indexterm><primary>Image class</primary></indexterm> +<para> + A ... is .. +</para> +<para> +</para> +<variablelist> +<varlistentry><term>Requires:</term> +<listitem><para>The Image class requires the class +definition file <computeroutput>ooDialog.cls</computeroutput>: +<programlisting> +<![CDATA[ +::requires "ooDialog" +]]> +</programlisting> +</para></listitem></varlistentry> +<varlistentry><term>Methods:</term> +<listitem> +<para> + Instances of the Image class implement the methods listed in the following + table: +</para> +<table id="tblImageMethods" frame="all"> +<title>Image Instance Methods</title> +<tgroup cols="2"> +<thead> +<row> +<entry>Method...</entry> +<entry>...on page</entry> +</row> +</thead> +<tbody> +<row> +<entry>new (Class method)</entry> +<entry><link linkend="mthNewClsImage">new</link></entry> +</row> +<row> +<entry>id (Class method)</entry> +<entry><link linkend="mthIdClsImage">id</link></entry> +</row> +</tbody></tgroup> +</table> +</listitem></varlistentry> +</variablelist> + + +<section id="mthNewClsImage"><title>new (Class method)</title> +<indexterm><primary>methodName</primary> +<secondary>ButtonControl class</secondary></indexterm> +<programlisting> +<![CDATA[ +>>-aButtonControl~methodName(--x--,--y--)------------------>< + +]]> +</programlisting> + +<para></para> +<variablelist> +<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> +<listitem><para>The arguments are: +<variablelist> +<varlistentry><term>x</term> +<listitem><para>xx. +</para></listitem></varlistentry> +<varlistentry><term>y</term> +<listitem><para>yyy, +</para></listitem></varlistentry> +</variablelist> +</para></listitem></varlistentry> +<varlistentry><term><emphasis role="bold">Return value:</emphasis></term> +<listitem><para>The possible return values are: +<variablelist> +<varlistentry><term>0</term> +<listitem><para>Success +</para></listitem></varlistentry> +<varlistentry><term>-1</term> +<listitem><para>Some error. +</para></listitem></varlistentry> +</variablelist> +</para></listitem></varlistentry> +<varlistentry><term><emphasis role="bold">Example:</emphasis></term> +<listitem><para>This example ... +<programlisting> +<![CDATA[ +x = y +return 0 +]]> +</programlisting> +</para></listitem></varlistentry> +</variablelist> +</section> + + +<section id="mthIdClsImage"><title>id</title> +<indexterm><primary>methodName</primary> +<secondary>ButtonControl class</secondary></indexterm> +<programlisting> +<![CDATA[ +>>-aButtonControl~methodName(--x--,--y--)------------------>< + +]]> +</programlisting> + +<para></para> +<variablelist> +<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> +<listitem><para>The arguments are: +<variablelist> +<varlistentry><term>x</term> +<listitem><para>xx. +</para></listitem></varlistentry> +<varlistentry><term>y</term> +<listitem><para>yyy, +</para></listitem></varlistentry> +</variablelist> +</para></listitem></varlistentry> +<varlistentry><term><emphasis role="bold">Return value:</emphasis></term> +<listitem><para>The possible return values are: +<variablelist> +<varlistentry><term>0</term> +<listitem><para>Success +</para></listitem></varlistentry> +<varlistentry><term>-1</term> +<listitem><para>Some error. +</para></listitem></varlistentry> +</variablelist> +</para></listitem></varlistentry> +<varlistentry><term><emphasis role="bold">Example:</emphasis></term> +<listitem><para>This example ... +<programlisting> +<![CDATA[ +x = y +return 0 +]]> +</programlisting> +</para></listitem></varlistentry> +</variablelist> +</section> + +</section> <!-- End Image class --> + +<section id="clsImageList"><title>ImageList Class</title> +<indexterm><primary>ImageList class</primary></indexterm> +<para> + A ... is .. +</para> +<para> +</para> +<variablelist> +<varlistentry><term>Requires:</term> +<listitem><para>The ImageList class requires the class +definition file <computeroutput>ooDialog.cls</computeroutput>: +<programlisting> +<![CDATA[ +::requires "ooDialog.cls" +]]> +</programlisting> +</para></listitem></varlistentry> +<varlistentry><term>Methods:</term> +<listitem> +<para> + Instances of the ImageList class implement the methods listed in the following table: +</para> + +<table id="tblImageListMethods" frame="all"> +<title>Image Instance Methods</title> +<tgroup cols="2"> +<thead> +<row> +<entry>Method...</entry> +<entry>...on page</entry> +</row> +</thead> +<tbody> +<row> +<entry>new (Class method)</entry> +<entry><link linkend="mthNewClsImageList">new</link></entry> +</row> +<row> +<entry>create (Class method)</entry> +<entry><link linkend="mthCreateClsImageList">id</link></entry> +</row> +</tbody></tgroup> +</table> +</listitem></varlistentry> +</variablelist> + + +<section id="mthNewClsImageList"><title>new (Class method)</title> +<indexterm><primary>methodName</primary> +<secondary>ButtonControl class</secondary></indexterm> +<programlisting> +<![CDATA[ +>>-aButtonControl~methodName(--x--,--y--)------------------>< + +]]> +</programlisting> + +<para></para> +<variablelist> +<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> +<listitem><para>The arguments are: +<variablelist> +<varlistentry><term>x</term> +<listitem><para>xx. +</para></listitem></varlistentry> +<varlistentry><term>y</term> +<listitem><para>yyy, +</para></listitem></varlistentry> +</variablelist> +</para></listitem></varlistentry> +<varlistentry><term><emphasis role="bold">Return value:</emphasis></term> +<listitem><para>The possible return values are: +<variablelist> +<varlistentry><term>0</term> +<listitem><para>Success +</para></listitem></varlistentry> +<varlistentry><term>-1</term> +<listitem><para>Some error. +</para></listitem></varlistentry> +</variablelist> +</para></listitem></varlistentry> +<varlistentry><term><emphasis role="bold">Example:</emphasis></term> +<listitem><para>This example ... +<programlisting> +<![CDATA[ +x = y +return 0 +]]> +</programlisting> +</para></listitem></varlistentry> +</variablelist> +</section> + +<section id="mthCreateClsImageList"><title>id</title> +<indexterm><primary>methodName</primary> +<secondary>ButtonControl class</secondary></indexterm> +<programlisting> +<![CDATA[ +>>-aButtonControl~methodName(--x--,--y--)------------------>< + +]]> +</programlisting> + +<para></para> +<variablelist> +<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> +<listitem><para>The arguments are: +<variablelist> +<varlistentry><term>x</term> +<listitem><para>xx. +</para></listitem></varlistentry> +<varlistentry><term>y</term> +<listitem><para>yyy, +</para></listitem></varlistentry> +</variablelist> +</para></listitem></varlistentry> +<varlistentry><term><emphasis role="bold">Return value:</emphasis></term> +<listitem><para>The possible return values are: +<variablelist> +<varlistentry><term>0</term> +<listitem><para>Success +</para></listitem></varlistentry> +<varlistentry><term>-1</term> +<listitem><para>Some error. +</para></listitem></varlistentry> +</variablelist> +</para></listitem></varlistentry> +<varlistentry><term><emphasis role="bold">Example:</emphasis></term> +<listitem><para>This example ... +<programlisting> +<![CDATA[ +x = y +return 0 +]]> +</programlisting> +</para></listitem></varlistentry> +</variablelist> +</section> + +</section> <!-- End ImageList class --> + +<section id="clsResourceImage"><title>ResourceImage Class</title> +<indexterm><primary>ResourceImage class</primary></indexterm> +<para> + A ... is .. +</para> +<para> +</para> +<variablelist> +<varlistentry><term>Requires:</term> +<listitem><para>The ResourceImage class requires the class definition file +<computeroutput>ooDialog.cls</computeroutput>: +<programlisting> +<![CDATA[ +::requires "ooDialog.cls" +]]> +</programlisting> +</para></listitem></varlistentry> +<varlistentry><term>Methods:</term> +<listitem> +<para> + Instances of the ResourceImage class implement the methods listed in the following table: +</para> + +<table id="tblResourceImageMethods" frame="all"> +<title>Name Instance Methods</title> +<tgroup cols="2"> +<thead> +<row> +<entry>Method...</entry> +<entry>...on page</entry> +</row> +</thead> +<tbody> +<row> +<entry>new (Class method)</entry> +<entry><link linkend="mthNewClsResourceImage">new</link></entry> +</row> +<row> +<entry>getImage</entry> +<entry><link linkend="mthGetImageClsResourceImage">getImage</link></entry> +</row> +</tbody></tgroup> +</table> +</listitem></varlistentry> +</variablelist> + + +<section id="mthNewClsResourceImage"><title>new</title> +<indexterm><primary>new</primary> +<secondary>ResouceImage class</secondary></indexterm> +<programlisting> +<![CDATA[ +>>-aButtonControl~methodName(--x--,--y--)------------------>< + +]]> +</programlisting> + +<para></para> +<variablelist> +<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> +<listitem><para>The arguments are: +<variablelist> +<varlistentry><term>x</term> +<listitem><para>xx. +</para></listitem></varlistentry> +<varlistentry><term>y</term> +<listitem><para>yyy, +</para></listitem></varlistentry> +</variablelist> +</para></listitem></varlistentry> +<varlistentry><term><emphasis role="bold">Return value:</emphasis></term> +<listitem><para>The possible return values are: +<variablelist> +<varlistentry><term>0</term> +<listitem><para>Success +</para></listitem></varlistentry> +<varlistentry><term>-1</term> +<listitem><para>Some error. +</para></listitem></varlistentry> +</variablelist> +</para></listitem></varlistentry> +<varlistentry><term><emphasis role="bold">Example:</emphasis></term> +<listitem><para>This example ... +<programlisting> +<![CDATA[ +x = y +return 0 +]]> +</programlisting> +</para></listitem></varlistentry> +</variablelist> +</section> + +<section id="mthGetImageClsResourceImage"><title>getImage</title> +<indexterm><primary>getImage</primary> +<secondary>ResouceImage class</secondary></indexterm> +<programlisting> +<![CDATA[ +>>-aButtonControl~methodName(--x--,--y--)------------------>< + +]]> +</programlisting> + +<para></para> +<variablelist> +<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> +<listitem><para>The arguments are: +<variablelist> +<varlistentry><term>x</term> +<listitem><para>xx. +</para></listitem></varlistentry> +<varlistentry><term>y</term> +<listitem><para>yyy, +</para></listitem></varlistentry> +</variablelist> +</para></listitem></varlistentry> +<varlistentry><term><emphasis role="bold">Return value:</emphasis></term> +<listitem><para>The possible return values are: +<variablelist> +<varlistentry><term>0</term> +<listitem><para>Success +</para></listitem></varlistentry> +<varlistentry><term>-1</term> +<listitem><para>Some error. +</para></listitem></varlistentry> +</variablelist> +</para></listitem></varlistentry> +<varlistentry><term><emphasis role="bold">Example:</emphasis></term> +<listitem><para>This example ... +<programlisting> +<![CDATA[ +x = y +return 0 +]]> +</programlisting> +</para></listitem></varlistentry> +</variablelist> +</section> + +</section> <!-- End ResourceImage class --> + + </chapter> Modified: docs/trunk/oodialog/userdialog.sgml =================================================================== --- docs/trunk/oodialog/userdialog.sgml 2008-12-26 19:19:54 UTC (rev 3809) +++ docs/trunk/oodialog/userdialog.sgml 2008-12-26 19:20:48 UTC (rev 3810) @@ -1406,7 +1406,6 @@ <indexterm><primary>addGroupBox</primary></indexterm> <programlisting> <![CDATA[ - +-,-""----+-,--""-----+-,__-1__+ >>-dlg~addGroupBox(--x-,-y-,-cx-,-cy--+---------+-----------+--------+--)----->< +-,-text--+-,--style--+-,--id--+ @@ -1414,54 +1413,80 @@ </programlisting> <para> - The addGroupBox method adds a group box to the dialog. A group box is actually a button control. A - group box can have a frame and a title. + The addGroupBox method adds a group box to the dialog. A group box is a button control, not a + static control. A group box can have a frame and a label </para> <variablelist> -<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> -<listitem><variablelist> -<varlistentry><term>x, y, cx, cy</term> -<listitem><para>The <link linkend="listCommonArguments">control coordinates</link> -</para></listitem></varlistentry> -<varlistentry><term>text</term> -<listitem><para>The text for the group box title. -</para></listitem></varlistentry> -<varlistentry><term>style</term> -<listitem> - <para> - A list of 0 or more <link linkend="paraStyleExplanation">style</link> keywords separated by - spaces: + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> <variablelist> - <varlistentry><term>RIGHT</term> - <listitem><para>Normally the text is aligned to the upper left of the group box frame. This - style aligns the text to the upper right of the frame - </para></listitem></varlistentry> - <varlistentry><term>HIDDEN</term> - <listitem><para>The <link linkend="wsvisible">not visible</link> window style. - </para></listitem></varlistentry> - <varlistentry><term>DISABLED</term> - <listitem><para>The <link linkend="wsborder">not enabled</link> window style. - </para></listitem></varlistentry> - <varlistentry><term>BORDER</term> - <listitem><para>The <link linkend="wsborder">border</link> window style. - </para></listitem></varlistentry> - <varlistentry><term>GROUP</term> - <listitem><para>The <link linkend="wsborder">group</link> control style. - </para></listitem></varlistentry> - <varlistentry><term>TAB</term> - <listitem><para>The <link linkend="wsborder">tab</link> control style. - </para></listitem></varlistentry> + <varlistentry><term>x, y, cx, cy</term> + <listitem> + <para> + The <link linkend="listCommonArguments">control coordinates</link> + </para> + </listitem></varlistentry> + <varlistentry><term>text</term> + <listitem> + <para> + The text for the group box label + </para> + </listitem></varlistentry> + <varlistentry><term>style</term> + <listitem> + <para> + A list of 0 or more <link linkend="paraStyleExplanation">style</link> keywords separated by + spaces: + <variablelist> + <varlistentry><term>RIGHT</term> + <listitem> + <para> + Normally the text is aligned to the upper left of the group box frame. This style + aligns the text to the upper right of the frame + </para> + </listitem></varlistentry> + <varlistentry><term>HIDDEN</term> + <listitem> + <para> + The <link linkend="wsvisible">not visible</link> window style. + </para> + </listitem></varlistentry> + <varlistentry><term>DISABLED</term> + <listitem> + <para> + The <link linkend="wsborder">not enabled</link> window style. + </para> + </listitem></varlistentry> + <varlistentry><term>BORDER</term> + <listitem> + <para> + The <link linkend="wsborder">border</link> window style. + </para> + </listitem></varlistentry> + <varlistentry><term>GROUP</term> + <listitem> + <para> + The <link linkend="wsborder">group</link> control style. + </para> + </listitem></varlistentry> + <varlistentry><term>TAB</term> + <listitem> + <para> + The <link linkend="wsborder">tabstop</link> control style. + </para> + </listitem></varlistentry> + </variablelist> + </para> + </listitem></varlistentry> + <varlistentry><term>id</term> + <listitem> + <para> + The resource <link linkend="idArgument">ID</link> for the group box. + </para> + </listitem></varlistentry> </variablelist> - </para></listitem></varlistentry> -<varlistentry><term>id</term> -<listitem><para> - The resource id of the group box. By the default a group box is assigned a resource id of -1. - Assigning a positive id allows the programmer to modify the group box after it is created, perhaps - to change the text of its title, change its postition. -</para></listitem></varlistentry> + </listitem></varlistentry> </variablelist> -</listitem></varlistentry> -</variablelist> </section> <section id="sectAddStaticControls"><title>Add Static Controls</title> @@ -1485,10 +1510,10 @@ <para> A word about frames and rectangles. In previous versions of the ooDialog reference frames and rectangles were documented as though they were a type of separate controls. They are not, they - are just a static control with a particular style. The <link linkend="fig56">Frames and + are just a static control with a particular style. The <link linkend="figFramesRects">Frames and Rectangles</link> picture gives some idea of how the different types of static controls can appear. - <figure id="fig56"><title>Frames and Rectangles</title> + <figure id="figFramesRects"><title>Frames and Rectangles</title> <mediaobject> <imageobject> <!-- Note! - if we include a /imagedata tag we get an error for DSSSL! --> @@ -1502,144 +1527,272 @@ <indexterm><primary>addStatic</primary></indexterm> <programlisting> <![CDATA[ - +_-1_+ +-,-"TEXT"-+ +-,-""----+ + +-,-"TEXT"-+ >>-dlg~addStatic(--+----+--,-x-,-y-,-cx-,-cy--+----------+--+---------+--)---->< +-id-+ +-,-style--+--+-,-text--+ ]]> </programlisting> <para> - The addStatic method adds any type of static control. + The addStatic method adds any type of static control. The 3 basic types of static controls are + static text, static image, and static frames / rectangles. </para> <variablelist> -<varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> -<listitem><para> -<variablelist> -<varlistentry><term>id</term> -<listitem><para> - The resource id for the control By default a static control is assigned a resource id of -1. - Assigning a positive id allows the programmer to modify the static control after it is created, - perhaps to change its text or to change its postition. -</para></listitem></varlistentry> -<varlistentry><term>x, y, cx, cy</term> -<listitem><para>The <link linkend="listCommonArguments">control coordinates</link> -</para></listitem></varlistentry> -<varlistentry><term>style</term> -<listitem> - <para> - A list of the <link linkend="paraStyleExplanation">style</link> keywords separated by spaces. - The keywords: TEXT, BITMAP, METAFILE, ICON, WHITERECT, GRAYRECT, BLACKRECT, WHITEFRAME, - GRAYFRAME, BLACKFRAME, ETCHED, HORZ, and VERT determine the type of static control to be - created. If more than one of these type keywords is specified, which static control is created - is undefined. The other style keywords modify the appearance or behavior of the static control. + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> <variablelist> - <varlistentry><term>TEXT</term> - <listitem><para>A static text control is created, this is the default. - </para></listitem></varlistentry> - <varlistentry><term>BITMAP</term> - <listitem><para>A static image control is created that will use a bitmap. - </para></listitem></varlistentry> - <varlistentry><term>METAFILE</term> - <listitem><para>A static image control that uses a metafile will be created. - </para></listitem></varlistentry> - <varlistentry><term>ICON</term> - <listitem><para>A static image control that uses an icon will be created. - </para></listitem></varlistentry> - <varlistentry><term>WHITERECT</term> - <listitem><para>keyword explanation - </para></listitem></varlistentry> - <varlistentry><term>WHITEFRAME</term> - <listitem><para>keyword explanation - </para></listitem></varlistentry> - <varlistentry><term>GRAYRECT</term> - <listitem><para>keyword explanation - </para></listitem></varlistentry> - <varlistentry><term>GRAYFRAME</term> - <listitem><para>keyword explanation - </para></listitem></varlistentry> - <varlistentry><term>BLACKRECT</term> - <listitem><para>keyword explanation - </para></listitem></varlistentry> - <varlistentry><term>BLACKFRAME</term> - <listitem><para>keyword explanation - </para></listitem></varlistentry> - <varlistentry><term>ETCHED</term> - <listitem><para>keyword explanation - </para></listitem></varlistentry> - <varlistentry><term>HORZ</term> - <listitem><para>keyword explanation - </para></listitem></varlistentry> - <varlistentry><term>VERT</term> - <listitem><para>keyword explanation - </para></listitem></varlistentry> - <varlistentry><term>CENTER</term> - <listitem><para>keyword explanation - </para></listitem></varlistentry> - <varlistentry><term>RIGHT</term> - <listitem><para>keyword explanation - </para></listitem></varlistentry> - <varlistentry><term>SIMPLE</term> - <listitem><para>keyword explanation - </para></listitem></varlistentry> - <varlistentry><term>LEFTNOWRAP</term> - <listitem><para>keyword explanation - </para></listitem></varlistentry> - <varlistentry><term>LEFT</term> - <listitem><para>keyword explanation - </para></listitem></varlistentry> - <varlistentry><term>NOTIFY</term> - <listitem><para>keyword explanation - </para></listitem></varlistentry> - <varlistentry><term>SUNKEN</term> - <listitem><para>keyword explanation - </para></listitem></varlistentry> - <varlistentry><term>EDITCONTROL</term> - <listitem><para>keyword explanation - </para></listitem></varlistentry> - <varlistentry><term>ENDELLIPSIS</term> - <listitem><para>keyword explanation - </para></listitem></varlistentry> - <varlistentry><term>NOPREFIX</term> - <listitem><para>keyword explanation - </para></listitem></varlistentry> - <varlistentry><term>PATHELLIPSIS</term> - <listitem><para>keyword explanation - </para></listitem></varlistentry> - <varlistentry><term>WORDELLIPSIS</term> - <listitem><para>keyword explanation - </para></listitem></varlistentry> - <varlistentry><term>CENTERIMAGE</term> - <listitem><para>keyword explanation - </para></listitem></varlistentry> - <varlistentry><term>RIGHTJUST</term> - <listitem><para>keyword explanation - </para></listitem></varlistentry> - <varlistentry><term>SIZECONTROL</term> - <listitem><para>keyword explanation - </para></listitem></varlistentry> - <varlistentry><term>SIZEIMAGE</term> - <listitem><para>keyword explanation - </para></listitem></varlistentry> - <varlistentry><term>HIDDEN</term> - <listitem><para>The <link linkend="wsvisible">not visible</link> window style. - </para></listitem></varlistentry> - <varlistentry><term>DISABLED</term> - <listitem><para>The <link linkend="wsborder">not enabled</link> window style. - </para></listitem></varlistentry> - <varlistentry><term>BORDER</term> - <listitem><para>The <link linkend="wsborder">border</link> window style. - </para></listitem></varlistentry> - <varlistentry><term>GROUP</term> - <listitem><para>The <link linkend="wsborder">group</link> control style. - </para></listitem></varlistentry> - <varlistentry><term>TAB</term> - <listitem><para>The <link linkend="wsborder">tab</link> control style. - </para></listitem></varlistentry> + <varlistentry><term>id</term> + <listitem> + <para> + The resource <link linkend="idArgument">ID</link> for the static control. + </para> + </listitem></varlistentry> + <varlistentry><term>x, y, cx, cy</term> + <listitem> + <para> + The <link linkend="listCommonArguments">control coordinates</link> + </para> + </listitem></varlistentry> + <varlistentry><term>style</term> + <listitem> + <para> + A list of 0 or more <link linkend="paraStyleExplanation">style</link> keywords separated by + spaces. The keywords: TEXT, BITMAP, METAFILE, ICON, WHITERECT, GRAYRECT, BLACKRECT, + WHITEFRAME, GRAYFRAME, BLACKFRAME, ETCHED, HORZ, and VERT determine the type of static + control to be created. If more than one of these type keywords is specified, which static + control is created is undefined. The other style keywords modify the appearance or behavior + of the static control. + <variablelist> + <varlistentry><term>TEXT</term> + <listitem> + <para> + A static text control is created, this is the default. + </para> + </listitem></varlistentry> + <varlistentry><term>BITMAP</term> + <listitem> + <para> + A static image control is created that will use a bitmap. + </para> + </listitem></varlistentry> + <varlistentry><term>METAFILE</term> + <listitem> + <para> + A static image control that uses a metafile will be created. + </para> + </listitem></varlistentry> + <varlistentry><term>ICON</term> + <listitem> + <para> + A static image control that uses an icon will be created. + </para> + </listitem></varlistentry> + <varlistentry><term>WHITERECT</term> + <listitem> + <para> + A <link linkend="figFramesRects">rectangle</link>rectangle filled with the current window + background color, which is white in the default color scheme. + </para> + </listitem></varlistentry> + <varlistentry><term>WHITEFRAME</term> + <listitem> + <para> + A <link linkend="figFramesRects">frame</link> drawn with the same color as the window + background, which is white in the default color scheme. + </para> + </listitem></varlistentry> + <varlistentry><term>GRAYRECT</term> + <listitem> + <para> + A <link linkend="figFramesRects">rectangle</link>rectangle filled with the current screen + background color, which is gray in the default color scheme. + </para> + </listitem></varlistentry> + <varlistentry><term>GRAYFRAME</term> + <listitem> + <para> + A <link linkend="figFramesRects">frame</link> drawn with the same color as the current + screen background, which is gray in the default color scheme. + </para> + </listitem></varlistentry> + <varlistentry><term>BLACKRECT</term> + <listitem> + <para> + A <link linkend="figFramesRects">rectangle</link>rectangle filled with the current window + frame color, which is black in the default color scheme. + </para> + </listitem></varlistentry> + <varlistentry><term>BLACKFRAME</term> + <listitem> + <para> + A <link linkend="figFramesRects">frame</link> drawn with the same color as the current + window frames, which is black in the default color scheme. + </para> + </listitem></varlistentry> + <varlistentry><term>ETCHED</term> + <listitem> + <para> + A <link linkend="figFramesRects">frame</link> drawn with an etched appearance. + </para> + </listitem></varlistentry> + <varlistentry><term>HORZ</term> + <listitem> + <para> + A <link linkend="figFramesRects">frame</link> drawn with an etched appearance, but only + the top horizontal line of the frame is drawn. In other words, this is a single + horizontal line, whose position and length are determined by the position and width of + the imaginary frame specified by the control coordinates. + </para> + </listitem></varlistentry> + <varlistentry><term>VERT</term> + <listitem> + <para> + A <link linkend="figFramesRects">frame</link> drawn with an etched appearance, but only + the left vertical line of the frame is drawn. In other words, this is a single vertical + line, whose position and length are determined by the position and height of the + imaginary frame specified by the control coordinates. + </para> + </listitem></varlistentry> + <varlistentry><term>LEFT</term> + <listitem> + <para> + Left aligns text for static text controls. Lines are automatically word wrapped. Words + longer than the width of the control are truncated. This is the default for static text + controls and does not need to be specified. + </para> + </listitem></varlistentry> + <varlistentry><term>CENTER</term> + <listitem> + <para> + Uses centered text alignment for static text controls. Lines are automatically word + wrapped. Words longer than the width of the control are truncated. If no text alignment + style is specified, the text is left aligned. + </para> + </listitem></varlistentry> + <varlistentry><term>RIGHT</term> + <listitem> + <para> + Right aligns text for static text controls. Lines are automatically word wrapped. Words + longer than the width of the control are truncated. If no text alignment style is + specified, the text is left aligned. + </para> + </listitem></varlistentry> + <varlistentry><term>SIMPLE</term> + <listitem> + <para> + A single line of left-aligned text in the rectangle. The text line cannot be shortened + or altered in any way. If the control is disabled, the text is not grayed. + </para> + </listitem></varlistentry> + <varlistentry><term>LEFTNOWRAP</term> + <listitem> + <para> + A single line of text, left-aligned. Tabs are expanded, but words are not wrapped. Text + that extends past the end of a line is clipped. + </para> + </listitem></varlistentry> + <varlistentry><term>NOTIFY</term> + <listitem> + <para> + keyword explanation + </para> + </listitem></varlistentry> + <varlistentry><term>SUNKEN</term> + <listitem> + <para> + keyword explanation + </para> + </listitem></varlistentry> + <varlistentry><term>EDITCONTROL</term> + <listitem> + <para> + keyword explanation + </para> + </listitem></varlistentry> + <varlistentry><term>ENDELLIPSIS</term> + <listitem> + <para> + keyword explanation + </para> + </listitem></varlistentry> + <varlistentry><term>NOPREFIX</term> + <listitem> + <para> + keyword explanation + </para> + </listitem></varlistentry> + <varlistentry><term>PATHELLIPSIS</term> + <listitem> + <para> + keyword explanation + </para> + </listitem></varlistentry> + <varlistentry><term>WORDELLIPSIS</term> + <listitem> + <para> + keyword explanation + </para> + </listitem></varlistentry> + <varlistentry><term>CENTERIMAGE</term> + <listitem> + <para> + keyword explanation + </para> + </listitem></varlistentry> + <varlistentry><term>RIGHTJUST</term> + <listitem> + <para> + keyword explanation + </para> + </listitem></varlistentry> + <varlistentry><term>SIZECONTROL</term> + <listitem> + <para> + keyword explanation + </para> + </listitem></varlistentry> + <varlistentry><term>SIZEIMAGE</term> + <listitem> + <para> + keyword explanation + </para> + </listitem></varlistentry> + <varlistentry><term>HIDDEN</term> + <listitem> + <para> + The <link linkend="wsvisible">not visible</link> window style. + </para> + </listitem></varlistentry> + <varlistentry><term>DISABLED</term> + <listitem> + <para> + The <link linkend="wsborder">not enabled</link> window style. + </para> + </listitem></varlistentry> + <varlistentry><term>BORDER</term> + <listitem> + <para> + The <link linkend="wsborder">border</link> window style. + </para> + </listitem></varlistentry> + <varlistentry><term>GROUP</term> + <listitem> + <para> + The <link linkend="wsborder">group</link> control style. + </para> + </listitem></varlistentry> + <varlistentry><term>TAB</term> + <listitem> + <para> + The <link linkend="wsborder">tabstop</link> control style. + </para> + </listitem></varlistentry> + </variablelist> + </para> + </listitem></varlistentry> </variablelist> - </para></listitem></varlistentry> + </listitem></varlistentry> </variablelist> -</para></listitem></varlistentry> -</variablelist> </section> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |