Menu
▾
▴
[Oorexx-svn] SF.net SVN: oorexx:[7322] docs/trunk/oodialog
|
From: <mie...@us...> - 2011-12-02 03:39:07
|
Revision: 7322
http://oorexx.svn.sourceforge.net/oorexx/?rev=7322&view=rev
Author: miesfeld
Date: 2011-12-02 03:38:59 +0000 (Fri, 02 Dec 2011)
Log Message:
-----------
Continue ooDialog doc update
Modified Paths:
--------------
docs/trunk/oodialog/Makefile
docs/trunk/oodialog/baseClasses.xml
docs/trunk/oodialog/button.xml
docs/trunk/oodialog/deprecated.xml
docs/trunk/oodialog/dialogControlObject.xml
docs/trunk/oodialog/dialogObject.xml
docs/trunk/oodialog/oodialog.xml
docs/trunk/oodialog/standarddialog.xml
docs/trunk/oodialog/windowExtensions.xml
docs/trunk/oodialog/windowExtensionsDO.xml
Added Paths:
-----------
docs/trunk/oodialog/dialogExtensions.xml
Modified: docs/trunk/oodialog/Makefile
===================================================================
--- docs/trunk/oodialog/Makefile 2011-12-01 21:52:57 UTC (rev 7321)
+++ docs/trunk/oodialog/Makefile 2011-12-02 03:38:59 UTC (rev 7322)
@@ -55,6 +55,7 @@
deprecated.xml \
dialogControlObject.xml \
dialogObject.xml \
+ dialogExtensions.xml \
edit.xml \
eventNotification.xml \
listbox.xml \
Modified: docs/trunk/oodialog/baseClasses.xml
===================================================================
--- docs/trunk/oodialog/baseClasses.xml 2011-12-01 21:52:57 UTC (rev 7321)
+++ docs/trunk/oodialog/baseClasses.xml 2011-12-02 03:38:59 UTC (rev 7322)
@@ -136,20 +136,17 @@
</para>
</section>
-<!-- <section id="clsWindowBase"><title>WindowBase Mixin Class</title> START -->
+<!-- <section id="clsWindowBase"><title>WindowBase Mixin Class</title> START -->
&windowBase;
-<!-- <section id="clsWindowBase"><title>WindowBase Mixin Class</title> END -->
+<!-- <section id="clsWindowBase"><title>WindowBase Mixin Class</title> END -->
-<!-- <section id="clsWindowExtensions"><title>WindowExtensions Mixin Class</title> START -->
+<!-- <section id="clsWindowExtensions"><title>WindowExtensions Mixin Class</title> START -->
&windowExtensions;
-<!-- <section id="clsWindowExtensions"><title>WindowExtensions Mixin Class</title> END -->
+<!-- <section id="clsWindowExtensions"><title>WindowExtensions Mixin Class</title> END -->
-<section id="clsDialogExtensions"><title>DialogExtensions Mixin Class</title>
-<indexterm><primary>DialogExtensions Class</primary></indexterm>
-<para>
- x
-</para>
-</section>
+<!-- <section id="clsDialogExtensions"><title>DialogExtensions Mixin Class</title> START -->
+&dialogExtensions;
+<!-- <section id="clsDialogExtensions"><title>DialogExtensions Mixin Class</title> END -->
<!-- <section id="clsEventNotification"><title>EventNotification Mixin Class</title> START -->
&connectingEvents;
Modified: docs/trunk/oodialog/button.xml
===================================================================
--- docs/trunk/oodialog/button.xml 2011-12-01 21:52:57 UTC (rev 7321)
+++ docs/trunk/oodialog/button.xml 2011-12-02 03:38:59 UTC (rev 7322)
@@ -193,42 +193,10 @@
<entry align="center"><emphasis role="bold">Instance Methods</emphasis></entry>
</row>
<row>
-<entry><link linkend="mthChangeBitmap">changeBitmap</link></entry>
-<entry>Changes the bitmap of a bitmap button.</entry>
-</row>
-<row>
<entry><link linkend="mthClick">click</link></entry>
<entry>Simulates a user clicking on the associated button control.</entry>
</row>
<row>
-<entry><link linkend="mthDimBitmap">dimBitmap</link></entry>
-<entry>Draws a bitmap step by step.</entry>
-</row>
-<row>
-<entry><link linkend="mthDisplaceBitmapClsButton">displaceBitmap</link></entry>
-<entry>Sets the position of the bitmap within a bitmap button.</entry>
-</row>
-<row>
-<entry><link linkend="mthDrawBitmapClsButton">drawBitmap</link></entry>
-<entry>Draws the bitmap for a bitmap button at the specified position.</entry>
-</row>
-<row>
-<entry><link linkend="mthGetBitmapPositionClsButton">getBitmapPosition</link></entry>
-<entry>Retrieves the postion, as a point, of the upper left corner of a bitmap within a bitmap button.</entry>
-</row>
-<row>
-<entry><link linkend="mthGetBitMapSizeXClsButton">getBitmapSizeX</link></entry>
-<entry>Retrieves the width of the bitmap that is set for a bitmap button.</entry>
-</row>
-<row>
-<entry><link linkend="mthGetBitMapSizeYClsButton">getBitmapSizeY</link></entry>
-<entry>Retrieves the height of the bitmap that is set for a bitmap button.</entry>
-</row>
-<row>
-<entry><link linkend="mthGetBmpDisplacementClsButton">getBmpDisplacement</link></entry>
-<entry>Retrieves the position of the bitmap within a bitmap button.</entry>
-</row>
-<row>
<entry><link linkend="mthGetIdealSize">getIdealSize</link></entry>
<entry>Queries the button control for the size that best fits its text or image.</entry>
</row>
@@ -249,22 +217,6 @@
<entry>Simulates the user pushing the associated button control.</entry>
</row>
<row>
-<entry><link linkend="mthScrollClsButton">scroll</link></entry>
-<entry>Moves a rectangle within the button and redraws the uncovered area with the button background color.</entry>
-</row>
-<row>
-<entry><link linkend="mthScrollBitmapFromToClsButton">scrollBitmapFromTo</link></entry>
-<entry>Scrolls the bitmap within the bitmap button from one position to another.</entry>
-</row>
-<row>
-<entry><link linkend="mthScrollTextClsButton">scrollText</link></entry>
-<entry>Scrolls text in the button with the given font, size, and color.</entry>
-</row>
-<row>
-<entry><link linkend="mthSetBitmapPositionClsButton">setBitmapPosition</link></entry>
-<entry>Sets the postion of the upper left corner of a bitmap within the bitmap button.</entry>
-</row>
-<row>
<entry><link linkend="mthSetImage">setImage</link></entry>
<entry>Sets, or removes, the image associated with a button.</entry>
</row>
@@ -637,11 +589,11 @@
</orderedlist>
</para>
</listitem></varlistentry>
-</variablelist> </section>
+</variablelist>
+</section>
<section id="mthStyleEquals"><title>style=</title>
<indexterm><primary>style=</primary></indexterm>
-<indexterm><primary>style=</primary><secondary>Button class</secondary></indexterm>
<indexterm><primary>Button class</primary><secondary>style=</secondary></indexterm>
<programlisting>
<![CDATA[
@@ -1295,68 +1247,6 @@
</section>
-<section id="mthScrollClsButton"><title>scroll</title>
-<indexterm><primary>scroll</primary><secondary>Button class</secondary></indexterm>
-<indexterm><primary>Button class</primary><secondary>scroll</secondary></indexterm>
-<programlisting>
-<![CDATA[
->>--scroll(--xPos--,--yPos--,--left--,--top--,--right--,--bottom--)------------><
-
-]]>
-</programlisting>
-
-<para>
- Moves the specified rectangle within the button and redraws the uncovered area with the button background color. This
- method is used to move bitmaps within bitmap buttons.
-</para>
-<variablelist>
- <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
- <listitem>
- <para>
- The arguments are:
- <variablelist>
- <varlistentry><term>xPos, yPos [required]</term>
- <listitem>
- <para>
- The client area <link linkend="defScreenCoordinates">coordinates</link> of the new position for the upper left
- corner of the specified rectangle. The coordinates are specified in pixels.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>left, top, right, bottom [required]</term>
- <listitem>
- <para>
- The client area <link linkend="defScreenCoordinates">coordinates</link> of the upper left and bottom right
- corners of the rectangular area to be moved. The coordinates are specified in pixels.
- </para>
- </listitem></varlistentry>
- </variablelist>
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
- <listitem>
- <para>
- Returns 0 on success and 1 on error.
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
- <listitem>
- <para>
- Probably the only practical use of this method is to move the bitmap in a bitmap button. However, the method itself
- does not require that the button be a bitmap button.
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Details</emphasis></term>
- <listitem>
- <para>
- Raises syntax errors when incorrect arguments are detected.
- </para>
- <para>
- Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
- </para>
- </listitem></varlistentry>
-</variablelist>
-</section> <!-- End Button::scroll() -->
-
<section id="mthSetImageList"><title>setImageList</title>
<indexterm><primary>setImageList</primary></indexterm>
<indexterm><primary>Button class</primary><secondary>setImageList</secondary></indexterm>
@@ -1672,1074 +1562,6 @@
</section> <!-- End ButtonControl::setImage() -->
-<section id="mthDimBitmap"><title>dimBitmap</title>
-<indexterm><primary>dimBitmap</primary></indexterm>
-<indexterm><primary>Button class</primary><secondary>dimBitmap</secondary></indexterm>
-<programlisting>
-<![CDATA[
->>--dimBitmap(--bmp--,--cx--,--cy--+---------+--+---------+--+---------+--)----><
- +-,-stepX-+ +-,-stepY-+ +-,-steps-+
-
-]]>
-</programlisting>
-
-<para>
- Draws a bitmap on the client area of the button control step by step.
-</para>
-<variablelist>
- <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
- <listitem>
- <para>
- The arguments are:
- <variablelist>
- <varlistentry><term>bmp [required]</term>
- <listitem>
- <para>
- A handle to the bitmap loaded with <link linkend="mthLoadBitmap">loadBitmap</link>.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>cx, cy [required]</term>
- <listitem>
- <para>
- The width and height of the bitmap.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>stepx, stepy [optional]</term>
- <listitem>
- <para>
- The number of pixels to increment the x and y position of the bitmap at each step. The default is 2 pixels for
- both <emphasis role="italic">cx</emphasis> and <emphasis role="italic">cy</emphasis>.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>steps [optional]</term>
- <listitem>
- <para>
- The number of iterations used to draw the bitmap. The bitmap is redrawn at each step. The default is 10.
- </para>
- </listitem></varlistentry>
- </variablelist>
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
- <listitem>
- <para>
- This method does not return a value.
- </para>
- </listitem></varlistentry>
-</variablelist>
-</section>
-
-<section id="mthChangeBitmap"><title>changeBitmap</title>
-<indexterm><primary>changeBitmap</primary></indexterm>
-<indexterm><primary>Button class</primary><secondary>changeBitmap</secondary></indexterm>
-<programlisting>
-<![CDATA[
-
->>--changeBitmap(-normal-+-----------+-+------------+-+------------+-+---------+-)--><
- +-,-focused-+ +-,-selected-+ +-,-disabled-+ +-,-style-+
-
-]]>
-</programlisting>
-
-<para>
- Changes the bitmaps for an already <link linkend="mthInstallBitmapButton">installed</link> bitmap button and
- optionally immediately redraws the button.
-</para>
-<variablelist>
- <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
- <listitem>
- <para>
- The arguments are:
- <variablelist>
- <varlistentry><term>normal [required]</term>
- <listitem>
- <para>
- The bitmap to use for the normal state ofthe button. See the remarks for information on how the bitmap may be
- specified.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>focused [optional]</term>
- <listitem>
- <para>
- The bitmap to use for the focused state ofthe button. See the remarks for information on how the bitmap may be
- specified. If this argument is omitted, the normal bitmap is used for the focused state.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>selected [optional]</term>
- <listitem>
- <para>
- The bitmap to use for the selected state ofthe button. See the remarks for information on how the bitmap may be
- specified. If this argument is omitted, the normal bitmap is used for the selected state.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>disabled [optional]</term>
- <listitem>
- <para>
- The bitmap to use for the disabled state of the button. See the remarks for information on how the bitmap may be
- specified. If this argument is omitted, the normal bitmap is used for the disabled state.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>style [optional]</term>
- <listitem>
- <para>
- A list of 0 or more of the following keywords separated by spaces, case is not significant:
- </para>
- <para>
- <simplelist type='vert' columns='3'>
- <member>FRAME </member>
- <member>USEPAL </member>
- <member>INMEMORY</member>
- <member>STRETCH </member>
- <member>NODRAW </member>
- </simplelist>
- <variablelist>
- <varlistentry><term>FRAME</term>
- <listitem>
- <para>
- With this option, when the ooDialog framework draws the bitmap button, it attempts to draw it with the 3D
- effect. Note that the drawing method is outdated and will give a somewhat different appearance to the button
- than that of buttons in modern Windows versions.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>USEPAL</term>
- <listitem>
- <para>
- Uses the colors of the bitmap for the normal state to create a system color palette. Use this option when
- the bitmap was created with a palette other than the default Windows color palette. This palette is used
- when drawing all of the bitmap states so when different bitmaps are used for the different states, they
- should all use the same colors.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>INMEMORY</term>
- <listitem>
- <para>
- The bitmaps can be loaded into memory through the <link linkend="mthLoadBitmap">loadBitmap</link> method. In
- this case, the programmer uses the bitmap handle to specify the bitmaps and <emphasis
- role="bold">must</emphasis> use the INMEMORY keyword.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>STRETCH</term>
- <listitem>
- <para>
- If the size of the bitmap is smaller than the size of the button rectangle, the bitmap is stretched to match
- the size of the button. This option has no effect on bitmaps loaded from a dynamic-link library.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>NODRAW</term>
- <listitem>
- <para>
- By default, when the button bitmaps are changed, the button is immediately redrawn. If this keyword is used,
- the button is not redrawn immediately. The next time the button needs to be redrawn, it will be redrawn
- using the new bitmaps.
- </para>
- </listitem></varlistentry>
- </variablelist>
- </para>
- </listitem></varlistentry>
- </variablelist>
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
- <listitem>
- <para>
- The return values are:
- <variablelist>
- <varlistentry><term>0</term>
- <listitem>
- <para>
- Success.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>-1</term>
- <listitem>
- <para>
- The resource ID could not be resolved.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>-1</term>
- <listitem>
- <para>
- Error.
- </para>
- </listitem></varlistentry>
- </variablelist>
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
- <listitem>
- <para>
- The arguments specifying the bitmaps can be a bitmap file name, a bitmap <link linkend="defHandle">handle</link>, or
- the resource number of a bitmap compiled into the resource DLL of a <link linkend="clsResDialog">ResDialog</link>.
- The bitmap arguments must all be the same type. I.e. all file names, all resource IDs, or all handles. If the bitmap
- arguments are handles the style argument must contain the INMEMORY keyword.
- </para>
- <para>
- The bitmap button must have already been assigned bitmaps, if there are no assigned bitmaps this method fails. All
- of the existing assigned bitmaps are removed, the programmer must reasign all 4 bitmaps, even if the bitmap for some
- state is the same as the previous bitmap.
- </para>
- <para>
- In ooDialog a bitmap button is an owner-drawn button that uses the supplied bitmap(s) for the button. ooDialog
- internally handles the drawing of the button.
- </para>
- <para>
- Up to 4 bitmaps can be assigned to the button. These bitmaps are drawn for the different button states: normal,
- focused, selected and disabled. The normal bitmap must be supplied and that bitmap is used for any of the other
- states if no bitmap for the state is supplied.
- </para>
- <para>
- It is the <link linkend="chpDialogObject">dialog</link> object that stores the bitmap information. The button object
- forwards the method invocation to its parent dialog using its own resource ID. This method and the <link
- linkend="mthChangeBitmapButton">changeBitmapButton</link> method of the dialog object are
- equivalent.
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Details</emphasis></term>
- <listitem>
- <para>
- Raises syntax errors when incorrect arguments are detected.
- </para>
- <para>
- Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
- <listitem>
- <para>
-<programlisting>
-<![CDATA[
-
- button = self~newPushButton("IDOK")
- button~changeBitmap("AddBut_n.bmp", "AddBut_f.bmp", "AddBut_s.bmp", -
- "AddBut_d.bmp", "FRAME")
-
-]]>
-</programlisting>
- </para>
- </listitem></varlistentry>
-</variablelist>
-</section> <!-- End Button::changeBitmap() -->
-
-
-<section id="mthGetBitmapPositionClsButton"><title>getBitmapPosition</title>
-<indexterm><primary>getBitmapPosition</primary><secondary>Button class</secondary></indexterm>
-<indexterm><primary>Button class</primary><secondary>getBitmapPosition</secondary></indexterm>
-<programlisting>
-<![CDATA[
->>--getBitmapPosition(--pos--)-------------------><
-
-]]>
-</programlisting>
-
-<para>
- Retrieves the postion in client <link linkend="defScreenCoordinates">coordinates</link> of the upper left corner of a
- bitmap within a bitmap button.
-</para>
-<variablelist>
- <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
- <listitem>
- <para>
- The only argument is:
- <variablelist>
- <varlistentry><term>pos</term>
- <listitem>
- <para>
- A <link linkend="clsPoint">point</link> object. On a successful return the point object is updated with the
- position of the bitmap. On an error return, the point object is left unchanged.
- </para>
- </listitem></varlistentry>
- </variablelist>
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
- <listitem>
- <para>
- Returns <computeroutput>.true</computeroutput> on success and <computeroutput>.false</computeroutput> on error.
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
- <listitem>
- <para>
- Recall that client area coordinates are relative to the (0, 0) point of the client area of a window. Both or either
- of the coordinates can be negative. A negative x will place the bitmap to the left of the edge of the button. A
- negative y will place the bitmap above the top of the bitmap.
- </para>
- <para>
- This method is only for bitmaps that have been assigned to a bitmap button through the <link
- linkend="mthInstallBitmapButton">installBitmapButton</link> method. If there is no bitmap assigned to the button
- then <computeroutput>.false</computeroutput> is returned.
- </para>
- <para>
- It is the <link linkend="chpDialogObject">dialog</link> object that knows the position of the bitmap. The button
- object forwards the method invocation to its parent dialog using its own resource ID. This method and the <link
- linkend="mthGetBitmapPositionClsDialogExtensions">getBitmapPosition</link> method of the dialog object are
- equivalent.
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Details:</emphasis></term>
- <listitem>
- <para>
- Raises syntax errors when incorrect arguments are detected.
- </para>
- <para>
- Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
- </para>
- </listitem></varlistentry>
-</variablelist>
-</section> <!-- End PushButton::getBitmapPosition() -->
-
-<section id="mthGetBitMapSizeXClsButton"><title>getBitMapSizeX</title>
-<indexterm><primary>getBitMapSizeX</primary><secondary>Button class</secondary></indexterm>
-<indexterm><primary>Button class</primary><secondary>getBitMapSizeX</secondary></indexterm>
-<programlisting>
-<![CDATA[
->>--getBitMapSizeX-------------------------------><
-
-]]>
-</programlisting>
-
-<para>
- Gets the width of the bitmap assigned to a bitmap button in pixels.
-</para>
-<variablelist>
- <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
- <listitem>
- <para>
- This method does not take any argument.
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
- <listitem>
- <para>
- On success, the width of the assigned bitmap in pixels, on error -1.
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
- <listitem>
- <para>
- This method is only for bitmaps that have been assigned to a bitmap button through the <link
- linkend="mthInstallBitmapButton">installBitmapButton</link> method. If there is no bitmap assigned to the button
- then -1 is returned.
- </para>
- <para>
- It is the <link linkend="chpDialogObject">dialog</link> object that knows the width of the bitmap. The button object
- forwards the method invocation to its parent dialog using its own resource ID. This method and the <link
- linkend="mthGetBitmapSizeXClsDialogExtensions">getBitmapSizeX</link> method of the dialog object are equivalent.
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Details</emphasis></term>
- <listitem>
- <para>
- Raises syntax errors when incorrect arguments are detected.
- </para>
- <para>
- Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
- </para>
- </listitem></varlistentry>
-</variablelist>
-</section> <!-- End Button::getBitMapSizeX() -->
-
-
-<section id="mthGetBitMapSizeYClsButton"><title>getBitmapSizeY</title>
-<indexterm><primary>getBitmapSizeY</primary><secondary>Button class</secondary></indexterm>
-<indexterm><primary>Button class</primary><secondary>getBitmapSizeY</secondary></indexterm>
-<programlisting>
-<![CDATA[
->>--getBitmapSizeY-------------------------------><
-
-]]>
-</programlisting>
-
-<para>
- Gets the height of the bitmap assigned to this bitmap button in pixels.
-</para>
-<variablelist>
- <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
- <listitem>
- <para>
- This method does not take any argument.
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
- <listitem>
- <para>
- On success, the height of the assigned bitmap in pixels, on error -1.
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
- <listitem>
- <para>
- This method is only for bitmaps that have been assigned to a bitmap button through the <link
- linkend="mthInstallBitmapButton">installBitmapButton</link> method. If there is no bitmap assigned to this button
- then -1 is returned.
- </para>
- <para>
- It is the <link linkend="chpDialogObject">dialog</link> object that knows the height of the bitmap. The button
- object forwards the method invocation to its parent dialog using its own resource ID. This method and the <link
- linkend="mthGetBitmapSizeYClsDialogExtensions">getBitmapSizeX</link> method of the dialog object are equivalent.
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Details</emphasis></term>
- <listitem>
- <para>
- Raises syntax errors when incorrect arguments are detected.
- </para>
- <para>
- Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
- </para>
- </listitem></varlistentry>
-</variablelist>
-</section> <!-- End Button::getBitMapSizeX() -->
-
-<section id="mthSetBitmapPositionClsButton"><title>setBitmapPosition</title>
-<indexterm><primary>setBitmapPosition</primary><secondary>Button class</secondary></indexterm>
-<indexterm><primary>Button class</primary><secondary>setBitmapPosition</secondary></indexterm>
-<programlisting>
-<![CDATA[
-
-Form 1:
-
->>--setBitmapPosition(--point--)-----------------><
-
-Form 2:
-
->>--setBitmapPosition(--x--,--y--)---------------><
-
-Generic form:
-
->>--setBitmapPosition(--newPosition--)-----------><
-
-]]>
-</programlisting>
-
-<para>
- Sets the position of the upper left corner of the bitmap within the <link linkend="defClientArea">client</link> area
- of a bitmap button.
-</para>
-<variablelist>
- <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
- <listitem>
- <para>
- The argument(s) specify the (x, y) coordinates of the bitmap. These coordinates can be specifed either as a <link
- linkend="clsPoint">object</link> or as 2 separate whole number arguments, as in Form 2.
- <variablelist>
- <varlistentry><term>newPosition [required]</term>
- <listitem>
- <para>
- Whether specified as a <computeroutput>point</computeroutput> object, or using the <emphasis
- role="italic">x, y</emphasis> format, both the x and y coordinates are required. If only one argument is used, it
- must be a <computeroutput>point</computeroutput> object. The coordinates are specified as client area
- coordinates, in pixels.
- </para>
- </listitem></varlistentry>
- </variablelist>
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
- <listitem>
- <para>
- This method returns 0 for success and 1 on error.
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
- <listitem>
- <para>
- Recall that client area coordinates are relative to the (0, 0) point of the client area of a window. Both or either
- of the coordinates can be negative. A negative x will place the bitmap to the left of the edge of the button. A
- negative y will place the bitmap above the top of the bitmap.
- </para>
- <para>
- This method is only for bitmaps that have been assigned to a bitmap button through the <link
- linkend="mthInstallBitmapButton">installBitmapButton</link> method. If there is no bitmap assigned to the button
- then 1 is returned.
- </para>
- <para>
- It is the <link linkend="chpDialogObject">dialog</link> object that sets the position of the bitmap. The button
- object forwards the method invocation to its parent dialog using its own resource ID. This method and the <link
- linkend="mthSetBitmapPositionClsDialogExtensions">setBitmapPosition</link> method of the dialog object are
- equivalent.
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Details:</emphasis></term>
- <listitem>
- <para>
- Raises syntax errors when incorrect arguments are detected.
- </para>
- <para>
- Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
- </para>
- </listitem></varlistentry>
- <varlistentry id="exampleSetBitmapPosition"><term><emphasis role="bold">Example:</emphasis></term>
- <listitem>
- <para>
-
-<programlisting>
-<![CDATA[
- p = .Point~new
- button = self~newPushButton(IDC_PB_HORSEBITMAP)
- if button~getBitmapPosition(p) then
- p~x += 4
- p~y += 3
- button~setBitmapPosition(p)
- end
-]]>
-</programlisting>
- </para>
- </listitem></varlistentry>
-</variablelist>
-</section> <!-- End PushButton::setBitmapPosition() -->
-
-<section id="mthGetBmpDisplacementClsButton"><title>getBmpDisplacement</title>
-<indexterm><primary>getBmpDisplacement</primary><secondary>Button class</secondary></indexterm>
-<indexterm><primary>Button class</primary><secondary>getBmpDisplacement</secondary></indexterm>
-<programlisting>
-<![CDATA[
->>--getBmpDisplacement---------------------------><
-
-]]>
-</programlisting>
-
-<para>
- Returns a string containing the client <link linkend="defScreenCoordinates">coordinates</link> of the bitmap in this
- bitmap button.
-</para>
-<variablelist>
- <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
- <listitem>
- <para>
- There are no arguments for this method.
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
- <listitem>
- <para>
- A string with the X position and then the Y position of the bitmap, in pixles. The X and Y coordinates are separated
- by a blank. On error, -1 is returned.
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
- <listitem>
- <para>
- Recall that client area coordinates are relative to the (0, 0) point of the client area of a window. Both or either
- of the coordinates can be negative.
- </para>
- <para>
- This method is only for bitmaps that have been assigned to a bitmap button through the <link
- linkend="mthInstallBitmapButton">installBitmapButton</link> method. If there is no bitmap assigned to the button
- then -1 is returned.
- </para>
- <para>
- It is the <link linkend="chpDialogObject">dialog</link> object knows the position of the bitmap. The button object
- forwards the method invocation to its parent dialog using its own resource ID. This method and the <link
- linkend="mthGetBmpDisplacementClsDialogExtensions">getBmpDisplacement</link> method of the dialog object are
- equivalent.
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Details</emphasis></term>
- <listitem>
- <para>
- Raises syntax errors when incorrect arguments are detected.
- </para>
- <para>
- Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
- <listitem>
- <para>
- The <link linkend="mthDisplaceBitmapClsButton">displaceBitmap</link> example uses <emphasis
- role="italic">getBmpDisplacement</emphasis>.
-<programlisting>
-<![CDATA[
-
-]]>
-</programlisting>
- </para>
- </listitem></varlistentry>
-</variablelist>
-</section> <!-- End Button::getBmpDisplacement() -->
-
-
-<section id="mthDisplaceBitmapClsButton"><title>displaceBitmap</title>
-<indexterm><primary>displaceBitmap</primary><secondary>Button class</secondary></indexterm>
-<indexterm><primary>Button class</primary><secondary>displaceBitmap</secondary></indexterm>
-<programlisting>
-<![CDATA[
->>--displaceBitmap(--x--,--y--)------------------><
-
-]]>
-</programlisting>
-
-<para>
- The <emphasis role="italic">displaceBitmap</emphasis> method sets the position of a bitmap within the <link
- linkend="defClientArea">client</link> area of a bitmap button.
-</para>
-<variablelist>
- <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
- <listitem>
- <para>
- The arguments are:
- <variablelist>
- <varlistentry><term>x [required]</term>
- <listitem>
- <para>
- The x co-ordinate of the top left corner of the bitmap within the client area of the bitmap button.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>y [required]</term>
- <listitem>
- <para>
- The y co-ordinate of the upper left corner of the bitmap within the client area of the bitmap button.
- </para>
- </listitem></varlistentry>
- </variablelist>
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
- <listitem>
- <para>
- Both the x and y coordinates are in pixels and can have negative values.
- </para>
- <para>
- Recall that client area coordinates are specified in relation to the (0, 0) point of the client area of a window.
- Negative values then place the bitmap outside of the client area of the bitmap
- </para>
- <para>
- The <link linkend="mthSetBitmapPositionClsButton">setBitmapPosition</link> method is most likely a better method to use than
- the <emphasis role="italic">displaceBitmap</emphasis>. It accepts eithe a <computeroutput>Point</computeroutput>
- object or the individual x and y coordinates to specify the position of the bitmap. <emphasis role="italic">Set
- position</emphasis> more accurately describes what the method does than <emphasis role="italic">displace</emphasis>.
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
- <listitem>
- <para>
- The following example moves the bitmap within the associated bitmap button 4 screen pixels to the right and 3
- pixels upward. Contrast this with the <link linkend="exampleSetBitmapPosition">setBitmapPosition</link> example:
-<programlisting>
-<![CDATA[
-
- button = self~newPushButton("IDC_PB_BITMAP1")
- parse value button~getBmpDisplacement with dx dy
- if dx <> -1 then do
- dx += 4
- dy -=3
- button~displaceBitmap(dx, dy)
- end
-
-]]>
-</programlisting>
- </para>
- </listitem></varlistentry>
-</variablelist>
-</section> <!-- End Button::displaceBitmap() -->
-
-
-<section id="mthScrollTextClsButton"><title>scrollText</title>
-<indexterm><primary>scrollText</primary><secondary>Button class</secondary></indexterm>
-<indexterm><primary>Button class</primary><secondary>scrollText</secondary></indexterm>
-<programlisting>
-<![CDATA[
->>--scrollText(--text--+--------+--+--------+--+--------+--+-----+--+--------+->
- +-,-font-+ +-,-size-+ +-,-opts-+ +-,-y-+ +-,-step-+
-
->--+---------+--+---------+----------------------------------------------------><
- +-,-sleep-+ +-,-color-+
-
-]]>
-</programlisting>
-
-<para>
- Scrolls text in the button using the specified font.
-</para>
-<variablelist>
- <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
- <listitem>
- <para>
- The arguments are:
- <variablelist>
- <varlistentry><term>text [required]</term>
- <listitem>
- <para>
- A text string that is displayed and scrolled.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>font [optional]</term>
- <listitem>
- <para>
- The name of the font used to write the text. If omitted, the System font is used.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>size [optional]</term>
- <listitem>
- <para>
- The size of the font used to write the text. If omitted, the default is 10.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>opts [optional]</term>
- <listitem>
- <para>
- A list of 0 or more of the following keywords separated by spaces, case is not significant. These options control
- aspects of the font and how the font is written. If this argument is omitted a normal font is used, i.e., not
- bolded, underlined, italicized, or striked out.
- </para>
- <para>
- <simplelist type='vert' columns='3'>
- <member>THIN </member>
- <member>EXTRALIGHT </member>
- <member>LIGHT </member>
- <member>MEDIUM </member>
- <member>SEMIBOLD </member>
- <member>EXTRABOLD </member>
- <member>HEAVY </member>
- <member>BOLD </member>
- <member>UNDERLINE </member>
- <member>ITALIC </member>
- <member>STRIKEOUT </member>
- </simplelist>
- <variablelist>
- <varlistentry><term>THIN</term>
- <listitem>
- <para>
- The weight of the font in a range of 0 through 1000 will be 100.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>EXTRALIGHT</term>
- <listitem>
- <para>
- The weight of the font in a range of 0 through 1000 will be 200.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>LIGHT</term>
- <listitem>
- <para>
- The weight of the font in a range of 0 through 1000 will be 300.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>MEDIUM</term>
- <listitem>
- <para>
- The weight of the font in a range of 0 through 1000 will be 500.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>SEMIBOLD</term>
- <listitem>
- <para>
- The weight of the font in a range of 0 through 1000 will be 600.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>BOLD</term>
- <listitem>
- <para>
- The weight of the font in a range of 0 through 1000 will be 700.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>EXTRABOLD</term>
- <listitem>
- <para>
- The weight of the font in a range of 0 through 1000 will be 800.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>HEAVY</term>
- <listitem>
- <para>
- The weight of the font in a range of 0 through 1000 will be 900.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>UNDERLINE</term>
- <listitem>
- <para>
- An underline font is used.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>ITALIC</term>
- <listitem>
- <para>
- An italic font is used.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>STRIKEOUT</term>
- <listitem>
- <para>
- A strike out font is used.
- </para>
- </listitem></varlistentry>
- </variablelist>
- </para>
- </listitem></varlistentry>
- <varlistentry><term>y</term>
- <listitem>
- <para>
- The Y client area <link linkend="defScreenCoordinates">coordinate</link> of the text. The default is 0. This
- argument is used to shift the text down from the top edge of the button, if needed.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>step</term>
- <listitem>
- <para>
- The number of screen pixels that the text is moved to the left in each iteration. The default is 4.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>sleep</term>
- <listitem>
- <para>
- The time, in milliseconds, that the program waits after each iteration. This determines the scrolling speed. The
- default is 10 milliseconds.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>color</term>
- <listitem>
- <para>
- The color index used for the text. The default is 0, which is black.
- </para>
- </listitem></varlistentry>
- </variablelist>
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
- <listitem>
- <para>
- Returns 0 on success and 1 on error.
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
- <listitem>
- <para>
- The text is scrolled from right to left. Scrolling is done by repeatedly rewriting the text at <emphasis
- role="italic">step</emphasis> pixels to the left in the client area of the button, starting at the right edge of
- the button.. When the writing postion reaches the left edge of the button, the rewriting ends. The button must have
- the OWNERDRAWN style.
- </para>
- <para>
- The <emphasis role="italic">font</emphasis>, <emphasis role="italic">size</emphasis>, <emphasis
- role="italic">style</emphasis>, and <emphasis role="italic">color</emphasis> arguments specify a font for the text
- being scrolled. The ooDialog framework requests a font to match this description from the font manager.
- </para>
- <para>
- If the method is started concurrently, call it a second time with no arguments to stop the scrolling.
- </para>
- <para>
- It is the <link linkend="chpDialogObject">dialog</link> object that scrolls the text. The button object forwards the
- method invocation to its parent dialog using its own window handle. This method and the <link
- linkend="mthScrollTextClsDialogExtensions">scrollText</link> method of the dialog object are
- equivalent.
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
- <listitem>
- <para>
- The following example scrolls the string "Hello world!" from left to right within the associated button. The text is
- located 2 pixels below the top of the client area, one move is 3 screen pixels, and the delay time after each
- movement is 15 ms.
-
-<programlisting>
-<![CDATA[
-
-button = self~newPushButton("IDC_PB_SCROLLER")
-button~start(scrollText, "Hello world!", "Arial", 36, "BOLD ITALIC", 2, 3, 15, 4)
-
-]]>
-</programlisting>
-
- </para>
- </listitem></varlistentry>
-</variablelist>
-</section> <!-- End Button::scrollText() -->
-
-<section id="mthDrawBitmapClsButton"><title>drawBitmap</title>
-<indexterm><primary>drawBitmap</primary><secondary>Button class</secondary></indexterm>
-<indexterm><primary>Button class</primary><secondary>drawBitmap</secondary></indexterm>
-<programlisting>
-<![CDATA[
-
->>--drawBitmap(-+---+-+-----+-+--------+-+--------+-+---------+-+----------+-)-><
- +-x-+ +-,-y-+ +-,-bmpX-+ +-,-bmpY-+ +-,-width-+ +-,-height-+
-
-]]>
-</programlisting>
-
-<para>
- Draws all, or part of, the bitmap for the bitmap button at the specified position.
-</para>
-<variablelist>
- <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
- <listitem>
- <para>
- The arguments are:
- <variablelist>
- <varlistentry><term>x, y [optional]</term>
- <listitem>
- <para>
- The client area <link linkend="defScreenCoordinates">coordinates</link> where the upper left corner of the
- bitmap is to be drawn, in pixels. The default is (0, 0).
- </para>
- </listitem></varlistentry>
- <varlistentry><term>bmpX, bmpY [optional]</term>
- <listitem>
- <para>
- The coordinates in the bitmap for the upper left corner of the portion that is to be drawn. The default is (0,
- 0). This, along with the <emphasis role="italic">width</emphasis> and <emphasis role="italic">height</emphasis>
- arguments, can be used to draw only a portion of the bitmap. For instance, to draw only the lower right quadrant
- of the bitmap, this argument could be set to the mid point of the bitmap.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>width [optional]</term>
- <listitem>
- <para>
- The width, starting from ()<emphasis role="italic">bmpX</emphasis>, <emphasis role="italic">bmpY</emphasis>) of
- the bitmap of the portion for the bitmap being drawn. If omitted or 0, the remaining width of the bitmap is
- drawn.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>height [optional]</term>
- <listitem>
- <para>
- The height, starting from ()<emphasis role="italic">bmpX</emphasis>, <emphasis role="italic">bmpY</emphasis>) of
- the bitmap for the portion of the bitmap being drawn. If omitted or 0, the remaining height of the bitmap is
- drawn.
- </para>
- </listitem></varlistentry>
- </variablelist>
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
- <listitem>
- <para>
- Returns 0 on success or 1 for error.
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
- <listitem>
- <para>
- This method is only for bitmaps that have been assigned to a bitmap button through the <link
- linkend="mthInstallBitmapButton">installBitmapButton</link> method. If there is no bitmap assigned to the button
- then -1 is returned.
- </para>
- <para>
- Unlike the <link linkend="mthSetBitmapPositionClsButton">setBitmapPosition</link> method, which permanently sets
- the position for the bitmap, the <emphasis role="italic">drawBitmap</emphasis> immediately draws the bitmap, or part
- of it, at the specified position. If the button needs to be redrawn, maybe because the window was covered and then
- uncovered, the bitmap is drawn at the position set with <emphasis role="italic">setBitmapPosition</emphasis>.
- <emphasis role="italic">drawBitmap</emphasis> is used by <link
- linkend="mthScrollBitmapFromToClsButton">scrollBitmapFromTo</link>, for example.
- </para>
- <para>
- You can use the <emphasis role="italic">drawBitmap</emphasis> method to animate a bitmap by providing a bitmap that
- contains several images and use the offset and extension arguments to display a single image of the bitmap.
- </para>
- <para>
- It is the <link linkend="chpDialogObject">dialog</link> object that draws the bitmap. The button object forwards the
- method invocation to its parent dialog using its own window handle and resource ID. This method and the <link
- linkend="mthDrawBitmapClsDialogExtensions">drawBitmap</link> method of the dialog object are equivalent.
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Details</emphasis></term>
- <listitem>
- <para>
- Raises syntax errors when incorrect arguments are detected.
- </para>
- <para>
- Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
- </para>
- </listitem></varlistentry>
-</variablelist>
-</section> <!-- End Button::drawBitmap() -->
-
-
-<section id="mthScrollBitmapFromToClsButton"><title>scrollBitmapFromTo</title>
-<indexterm><primary>scrollBitmapFromTo</primary><secondary>Button class</secondary></indexterm>
-<indexterm><primary>Button class</primary><secondary>scrollBitmapFromTo</secondary></indexterm>
-<programlisting>
-<![CDATA[
-
->>--scrollBitmapFromTo(--fromX--,--fromY--,--toX--,--toY----------------------->
-
-
->--+---------+--+---------+--+---------+--+------------+--)--------------------><
- +-,-stepX-+ +-,-stepY-+ +-,-delay-+ +-,-displace-+
-]]>
-</programlisting>
-
-<para>
- Scrolls, (moves,) a bitmap from one position to another within a bitmap button.
-</para>
-<variablelist>
- <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
- <listitem>
- <para>
- The arguments are:
- <variablelist>
- <varlistentry><term>fromX, fromY [required]</term>
- <listitem>
- <para>
- The starting position, in client <link linkend="defScreenCoordinates">coordinates</link>, where the upper
- left corner of the bitmap is first drawn. This is specified in pixels.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>toX, toY [required]</term>
- <listitem>
- <para>
- The ending position, in client <link linkend="defScreenCoordinates">coordinates</link>, where the upper
- left corner of the bitmap is drawn last. This is specified in pixels.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>stepX, stepY [optional]</term>
- <listitem>
- <para>
- The amount, in pixels, that the bitmap is moved for each step. For each move, <emphasis
- role="italic">stepX</emphasis> is the amount the bitmap is moved horizontally and <emphasis
- role="italic">stepY</emphasis> is the amount the bitmap is vertically. Either or both can be negative. The
- default for both is 0. However, they can not both be 0, or both omitted.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>delay [optional]</term>
- <listitem>
- <para>
- The time in milliseconds this method waits after each move before doing the next move. This determines the speed
- at which the bitmap moves. The default is 0, which means there is no delay between each move of the bitmap.
- </para>
- </listitem></varlistentry>
- <varlistentry><term>displace [optional]</term>
- <listitem>
- <para>
- If <computeroutput>.true</computeroutput> the internal position of the bitmap is updated after each incremental
- move. <link linkend="mthSetBitmapPositionClsButton">setBitmapPosition</link> is called after each step to adjust
- the bitmap position. If an external event causes the dialog to be redrawn, the bitmap is shown at the correct
- position. The default is <computeroutput>.true</computeroutput>.
- </para>
- </listitem></varlistentry>
- </variablelist>
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
- <listitem>
- <para>
- Returns 0 on success and 1 on error.
- </para>
- </listitem></varlistentry>
- <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
- <listitem>
- <para>
- This method is only for bitmaps that have been assigned to a bitmap button through the <link
- linkend="mthInstallBitmapButton">installBitmapButton</link> method. If there is no bitmap assigned to the button
- then 1 is returned.
- </para>
- <para>
- Scrolling is done by positioning the bitmap and then drawing it. After the bitmap is drawn, it is repositioned
- using the <emphasis role="italic">stepX</emphasis> and <emphasis role="italic">stepY</emphasis> arguments, and drawn
- again. This is repeated until the bitmap reaches the (<emphasis role="italic">toX</emphasis>, <emphasis
- role="italic">toY</emphasis>) ending position.
- </para>
- <para>
- It is the <link linkend="chpDialogObject">dialog</link> object that scrolls the bitmap. The button object forwards
- the method invocation to its parent dialog using its own resource ID. This method and the <link
- linkend="mthScrollBitmapFromToClsDialogExtensions">scrollBitmapFromTo</link> method of the dialog object are
- equivalent.
- </para>
- </listitem></varlistentry>
-</variablelist>
-</section> <!-- End DialogExtensions::scrollBitmapFromTo() -->
-
</section> <!-- End Section Push Buttons -->
Modified: docs/trunk/oodialog/deprecated.xml
===================================================================
--- docs/trunk/oodialog/deprecated.xml 2011-12-01 21:52:57 UTC (rev 7321)
+++ docs/trunk/oodialog/deprecated.xml 2011-12-02 03:38:59 UTC (rev 7322)
@@ -1104,6 +1104,22 @@
<section id="deprecatedDialogControls"><title>Deprecated Methods of Dialog Controls</title>
<indexterm><primary>Deprecated</primary><secondary>dialog control methods</secondary></indexterm>
+<section id="deprecatedButton"><title>Deprecated Button Methods</title>
+<indexterm><primary>Deprecated</primary><secondary>button methods</secondary></indexterm>
+<para>
+ The following lists the <link linkend="ovvDeprecated">deprecated</link> methods of the <emphasis
+ role="italic">Button</emphasis> class and how to replace those methods in ooDialog programs.
+</para>
+
+<section><title>editSelection</title>
+<para>
+ This method is <link linkend="ovvDeprecated">deprecated</link> Use <link
+ linkend="mthSetEditSelection">setEditSelection</link>().
+</para>
+</section>
+
+</section> <!-- End Deprecated Buttons Methods Section -->
+
<section id="deprecatedComboBox"><title>Deprecated ComboBox Methods</title>
<indexterm><primary>Deprecated</primary><secondary>combo box methods</secondary></indexterm>
<para>
Modified: docs/trunk/oodialog/dialogControlObject.xml
===================================================================
--- docs/trunk/oodialog/dialogControlObject.xml 2011-12-01 21:52:57 UTC (rev 7321)
+++ docs/trunk/oodialog/dialogControlObject.xml 2011-12-02 03:38:59 UTC (rev 7322)
@@ -43,7 +43,7 @@
-->
<chapter id="chpDialogControlObject"><title>The Dialog Control Object</title>
<indexterm><primary>dialog control object</primary></indexterm>
-<indexterm><primary>DialogControl class</primary></indexterm>
+<indexterm><primary>dialog control object</primary></indexterm>
<para>
This chapter discussses the <emphasis role="italic">dialog control object</emphasis> in a fashion similar to the <link
linkend="chpDialogObject">dialog object</link>. It lists the methods that are common to all dialog controls. In the
@@ -494,8 +494,8 @@
<entry><link linkend="assignfocus">AssignFocus</link></entry>
</row>
<row>
-<entry>CaptureMouse</entry>
-<entry><link linkend="capturemouse">CaptureMouse</link></entry>
+<entry>captureMouse</entry>
+<entry><link linkend="mthCaptureMouse">captureMouse</link></entry>
</row>
<row>
<entry>clear</entry>
@@ -843,13 +843,13 @@
<section id="appmodmeth"><title>Appearance and Behavior Methods</title>
<indexterm><primary>enable methods</primary>
-<secondary>DialogControl class</secondary></indexterm>
+<secondary>dialog control object</secondary></indexterm>
<indexterm><primary>disable methods</primary>
-<secondary>DialogControl class</secondary></indexterm>
+<secondary>dialog control object</secondary></indexterm>
<indexterm><primary>hide methods</primary>
-<secondary>DialogControl class</secondary></indexterm>
+<secondary>dialog control object</secondary></indexterm>
<indexterm><primary>show methods</primary>
-<secondary>DialogControl class</secondary></indexterm>
+<secondary>dialog control pbkect</secondary></indexterm>
<para>The following methods deal with the appearance or the behavior of the
dialog control. The list contains methods to get or change the size, position,
visibility, behavior, etc., of dialog controls.
@@ -1313,7 +1313,7 @@
<secondary>dialog control object</secondary></indexterm>
<indexterm><primary>dialog control object</primary>
<secondary>getTextSizeDlg</secondary></indexterm>
-<indexterm><primary>DialogControl class</primary>
+<indexterm><primary>dialog control object</primary>
<secondary>getTextSizeDlg</secondary></indexterm>
<programlisting>
<![CDATA[
@@ -2163,13 +2163,13 @@
<section id="drawmeth"><title>Draw Methods</title>
<indexterm><primary>draw methods</primary>
-<secondary>DialogControl class</secondary></indexterm>
+<secondary>dialog control object</secondary></indexterm>
<para>The following methods are used to draw, redraw, and clear a dialog or dialog
control.</para>
<section id="mthClearRectClsDialogControl"><title>clearRect</title>
<indexterm><primary>clearRect</primary>
-<secondary>DialogControl class</secondary></indexterm>
+<secondary>dialog control object</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aDialogControl~clearRect(--left--,--top--,--right--,--bottom--)-><
@@ -2208,7 +2208,7 @@
<section id="redrawrect"><title>RedrawRect</title>
<indexterm><primary>RedrawRect</primary>
-<secondary>DialogControl class</secondary></indexterm>
+<secondary>dialog control object</secondary></indexterm>
<programlisting>
<![CDATA[
>>-aDialogControl~RedrawRect(--left--,--top--,--right--,--bottom-->
@@ -2285,23 +2285,23 @@
</variablelist>
</section>
-<section id="capturemouse"><title>CaptureMouse</title>
-<indexterm><primary>CaptureMouse</primary></indexterm>
+<section id="mthCaptureMouse"><title>captureMouse</title>
+<indexterm><primary>captureMouse</primary><secondary>dialog control object</secondary></indexterm>
<programlisting>
<![CDATA[
->>-aDialogControl~CaptureMouse---------------------------------><
+>>--captureMouse---------------------------------><
]]>
</programlisting>
-<para>The CaptureMouse method captures the mouse. This
-means that the associated dialog or dialog control receives the entire mouse
-input regardless of whether the mouse cursor is within the borders of the
-dialog or dialog control.</para>
+<para>The captureMouse method captures the mouse. This
+means that the associated dialog control receives the entire mouse input regardless of whether the mouse cursor is
+within the borders of the dialog control.
+</para>
<variablelist>
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
-<listitem><para>The handle to the dialog or dialog control that previously captured
+<listitem><para>The handle to the window that previously captured
the mouse, or 0 if the mouse was not captured before.
</para></listitem></varlistentry>
</variablelist>
@@ -2381,7 +2381,7 @@
<section id="dcmeth"><title>Device Context Methods</title>
<indexterm><primary>device context methods</primary>
-<secondary>DialogControl class</secondary></indexterm>
+<secondary>dialog control object</secondary></indexterm>
<para>The following methods are used to retrieve and release a device context
(DC).</para>
<para>A device context (DC) is associated with a dialog or dialog control, and
@@ -2394,7 +2394,7 @@
<section id="textmeth"><title>Text Methods</title>
<indexterm><primary>text methods</primary>
-<secondary>DialogControl class</secondary></indexterm>
+<secondary>dialog control object</secondary></indexterm>
<para>The following methods are used to display text dynamically in a window
area and to modify the state of a device context. See <link linkend="h001062">GetWindowDC</link>, <link linkend="mthGetDC">getDC</link>, and <link linkend="h001077">GetButtonDC</link> for information on how to retrieve
a device context.</para>
Added: docs/trunk/oodialog/dialogExtensions.xml
===================================================================
--- docs/trunk/oodialog/dialogExtensions.xml (rev 0)
+++ docs/trunk/oodialog/dialogExtensions.xml 2011-12-02 03:38:59 UTC (rev 7322)
@@ -0,0 +1,1830 @@
+<!--#########################################################################
+ #
+ # Description: Open Object Rexx: ooDialog Reference SGML file.
+ #
+ # Copyright (c) 2008-2011, Rexx Language Association. All rights reserved.
+ # Portions Copyright (c) 2004, IBM Corporation. All rights reserved.
+ #
+ # This program and the accompanying materials are made available under
+ # the terms of the Common Public License v1.0 which accompanies this
+ # distribution. A copy is also available at the following address:
+ # http://www.oorexx.org/license.html
+ #
+ # Redistribution and use in source and binary forms, with or
+ # without modification, are permitted provided that the following
+ # conditions are met:
+ #
+ # Redistributions of source code must retain the above copyright
+ # notice, this list of conditions and the following disclaimer.
+ # Redistributions in binary form must reproduce the above copyright
+ # notice, this list of conditions and the following disclaimer in
+ # the documentation and/or other mate...
[truncated message content] |