From: <mie...@us...> - 2013-12-18 02:37:08
|
Revision: 9727 http://sourceforge.net/p/oorexx/code-0/9727 Author: miesfeld Date: 2013-12-18 02:37:05 +0000 (Wed, 18 Dec 2013) Log Message: ----------- ooDialog - start work on the 4.2.4 docs Modified Paths: -------------- docs/trunk/oodialog/en-US/baseClasses.xml docs/trunk/oodialog/en-US/dialogObject.xml docs/trunk/oodialog/en-US/eventNotification.xml docs/trunk/oodialog/en-US/oodialog.xml docs/trunk/oodialog/en-US/userdialog.xml Added Paths: ----------- docs/trunk/oodialog/en-US/statusBar.xml docs/trunk/oodialog/en-US/toolBar.xml Modified: docs/trunk/oodialog/en-US/baseClasses.xml =================================================================== --- docs/trunk/oodialog/en-US/baseClasses.xml 2013-12-18 02:35:19 UTC (rev 9726) +++ docs/trunk/oodialog/en-US/baseClasses.xml 2013-12-18 02:37:05 UTC (rev 9727) @@ -1465,6 +1465,10 @@ <entry>Creates a tab control in the dialog template.</entry> </row> <row> +<entry><xref linkend="mthCreateToolBar"/></entry> +<entry>Creates a toolbar control in the dialog template.</entry> +</row> +<row> <entry><xref linkend="mthCreateTrackBar"/></entry> <entry>Creates a trackbar control in the dialog template.</entry> </row> @@ -2031,6 +2035,17 @@ </programlisting> </section> +<section id="ddCreateToolBar"><title>createToolBar</title> +<programlisting> +DynamicDialog::<xref linkend="mthCreateToolBar"/> + +<![CDATA[ +>>--createToolBar(-id-,--x-,--y-,--cx-,--cy-+---------+--+-----------------+--)->< + +-,-style-+ +-,-attributeName-+ +]]> +</programlisting> +</section> + <section id="ddCreateTrackBar"><title>createTrackBar</title> <programlisting> DynamicDialog::<xref linkend="mthCreateTrackBar"/> @@ -2578,6 +2593,14 @@ <entry>Returns an object of the <computeroutput>Tab</computeroutput> class for the tab control with the specified resource ID.</entry> </row> <row> +<entry><xref linkend="pbdNewToolBar"/></entry> +<entry>Returns an object of the <computeroutput>ToolBar</computeroutput> class for the toolbar control with the specified resource ID.</entry> +</row> +<row> +<entry><xref linkend="pbdNewToolTip"/></entry> +<entry>Returns an object of the <computeroutput>ToolTip</computeroutput> class for the tooltip control with the specified resource ID.</entry> +</row> +<row> <entry><xref linkend="pbdNewTreeView"/></entry> <entry>Returns an object of the <computeroutput>TreeView</computeroutput> class for the tree-view control with the specified resource ID.</entry> </row> @@ -3758,6 +3781,16 @@ </programlisting> </section> +<section id="pbdNewStatic" xreflabel="newStatic"><title>newStatic</title> +<programlisting> +PlainBaseDialog::<xref linkend="mthNewStatic"/> + +<![CDATA[ +>>--newStatic(--id--)---------------------------->< +]]> +</programlisting> +</section> + <section id="pbdNewTab" xreflabel="newTab"><title>newTab</title> <programlisting> PlainBaseDialog::<xref linkend="mthNewTab"/> @@ -3768,16 +3801,26 @@ </programlisting> </section> -<section id="pbdNewStatic" xreflabel="newStatic"><title>newStatic</title> +<section id="pbdNewToolBar" xreflabel="newToolBar"><title>newToolBar</title> <programlisting> -PlainBaseDialog::<xref linkend="mthNewStatic"/> +PlainBaseDialog::<xref linkend="mthNewToolBar"/> <![CDATA[ ->>--newStatic(--id--)---------------------------->< +>>--newToolBar(--id--)------------------------------->< ]]> </programlisting> </section> +<section id="pbdNewToolTip" xreflabel="newToolTip"><title>newToolTip</title> +<programlisting> +PlainBaseDialog::<xref linkend="mthNewToolTip"/> + +<![CDATA[ +>>--newToolTip(--id--)------------------------------->< +]]> +</programlisting> +</section> + <section id="pbdNewTrackBar" xreflabel="newTrackBar"><title>newTrackBar</title> <programlisting> PlainBaseDialog::<xref linkend="mthNewTrackBar"/> Modified: docs/trunk/oodialog/en-US/dialogObject.xml =================================================================== --- docs/trunk/oodialog/en-US/dialogObject.xml 2013-12-18 02:35:19 UTC (rev 9726) +++ docs/trunk/oodialog/en-US/dialogObject.xml 2013-12-18 02:37:05 UTC (rev 9727) @@ -403,6 +403,10 @@ <entry>Connects an event notification from a tab control to a method in the Rexx dialog.</entry> </row> <row> +<entry><xref linkend="enConnectToolBarEvent"/></entry> +<entry>Connects an event notification from a toolbar control to a method in the Rexx dialog.</entry> +</row> +<row> <entry><xref linkend="enConnectToolTipEvent"/></entry> <entry>Connects an event notification from a tool tip control to a method in the Rexx dialog.</entry> </row> @@ -1011,10 +1015,18 @@ <entry>Returns an object of the <computeroutput>Static</computeroutput> class for the static control with the specified resource ID.</entry> </row> <row> +<entry><xref linkend="mthNewStatusBar"/></entry> +<entry>Returns an object of the <computeroutput>StatusBar</computeroutput> class for the status bar control with the specified resource ID.</entry> +</row> +<row> <entry><xref linkend="mthNewTab"/></entry> <entry>Returns an object of the <computeroutput>Tab</computeroutput> class for the tab control with the specified resource ID.</entry> </row> <row> +<entry><xref linkend="mthNewToolBar"/></entry> +<entry>Returns an object of the <computeroutput>ToolBar</computeroutput> class for the toolbar control with the specified resource ID.</entry> +</row> +<row> <entry><xref linkend="mthNewToolTip"/></entry> <entry>Returns an object of the <computeroutput>ToolTip</computeroutput> class for the tool tip control with the specified resource ID.</entry> </row> @@ -4239,6 +4251,65 @@ </variablelist> </section> +<section id="mthNewStatusBar" xreflabel="newStatusBar"><title>newStatusBar</title> +<indexterm><primary>newStatusBar</primary></indexterm> +<indexterm><primary>dialog object</primary><secondary>newStatusBar</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--newStatusBar(--id--)------------------------->< +]]> +</programlisting> + +<para> + The <emphasis role="italic">newStatusBar</emphasis> method returns an object of the <xref linkend="clsStatusBar"/> control + class. This object represents the status bar control in the underlying dialog with the specified resource ID. +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The single argument is: + <variablelist> + <varlistentry><term>id [required]</term> + <listitem> + <para> + The resource ID of the status bar dialog control. May be numeric or <xref linkend="defSymbolicId"/>. + </para> + </listitem></varlistentry> + </variablelist> + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + An object of the status bar control class or <emphasis role="italic">.nil</emphasis> on any error. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Example:</emphasis></term> + <listitem> + <para> + The following example gets a new status bar control object that represents the status bar control in the underlying + dialog with the symbolic ID of IDC_STATUSBAR. Provided the underlying dialog control exists, it is divided into parts and + the text for each part is assigned and the text for each part is set: + + <programlisting> + <![CDATA[ + status = self~newStatusBar(IDC_STATUSBAR) + + parts = .array~of(50, 100, 200, -1) + status~setParts(parts) + status~setText("Line 1", 1) + status~setText("Column 1", 2) + status~setText("No Selection", 3) + status~setText("RW", 4) + + ]]> + </programlisting> + </para> + </listitem></varlistentry> +</variablelist> +</section> + <section id="mthNewTab" xreflabel="newTab"><title>newTab</title> <indexterm><primary>newTab</primary></indexterm> <indexterm><primary>dialog object</primary><secondary>newTab</secondary></indexterm> @@ -4295,6 +4366,68 @@ </variablelist> </section> +<section id="mthNewToolBar" xreflabel="newToolBar"><title>newToolBar</title> +<indexterm><primary>newToolBar</primary></indexterm> +<indexterm><primary>dialog object</primary><secondary>newToolBar</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--newToolBar(--id--)--------------------------->< + +]]> +</programlisting> + +<para> + The <emphasis role="italic">newToolBar</emphasis> method returns an object of the + <xref linkend="clsToolBar"/> control class. This object represents the toolbar control in the underlying dialog + with the specified resource ID. +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The single argument is: + </para> + <variablelist> + <varlistentry><term>id [required]</term> + <listitem> + <para> + The resource ID of the toolbar dialog control. May be numeric or <xref linkend="defSymbolicId"/>. + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + An object of the toolbar control class or <emphasis role="italic">.nil</emphasis> on any error. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is detected. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Example:</emphasis></term> + <listitem> + <para> + The following example initializes the tab control with symbolic ID IDC_TAB to have 5 tabs: + +<programlisting> +<![CDATA[ +::class 'MyDlgClass' subclass ResDialog + +::method initDialog + self~newTab(IDC_TAB)~addSequence("Design", "Implementation", - + "Test", "Review", "Release") + +]]> +</programlisting> + </para> + </listitem></varlistentry> +</variablelist> +</section> + <section id="mthNewToolTip" xreflabel="newToolTip"><title>newToolTip</title> <indexterm><primary>newToolTip</primary></indexterm> <indexterm><primary>dialog object</primary><secondary>newToolTip</secondary></indexterm> @@ -4338,9 +4471,10 @@ </para> <para> There is only one Rexx object created for each single Windows dialog control. Once the <emphasis - role="italic">createToolTip</emphasis> method has created the underlying ToolTip, each invocation of the <emphasis - role="italic">newToolTip</emphasis> method, using the same resource ID, will return the same Rexx object. - </para> </listitem></varlistentry> + role="italic">newToolBar</emphasis> method has been invoked once, each successive invocation of the <emphasis + role="italic">newToolBar</emphasis> method, using the same resource ID, will return the same Rexx object. + </para> + </listitem></varlistentry> <varlistentry><term><emphasis role="bold">Details</emphasis></term> <listitem> <para> @@ -4350,36 +4484,23 @@ <varlistentry><term><emphasis role="bold">Example:</emphasis></term> <listitem> <para> - This example creates a balloon ToolTip that displays an important message. The message is different during different - states of the application. When the message text needs to be changed, the updateMsg() method uses the <emphasis - role="italic">newToolTip</emphasis> method to get the Rexx object representing the underlying ToolTip and changes the - text for the message: + This example instantiates a new toolbar object and then begins to initialize the underlying Windows toolbar: <programlisting> <![CDATA[ ::method initDialog - expose icon - - toolTip = self~createToolTip(IDC_TT_BALLOON, 'BALLOON') - toolTip~setTitle("Important Message", icon) ... + tb = self~newToolBar(IDC_TOOLBAR) -::method updateMsg private - use strict arg newMsg - - toolInfo = .ToolInfo~forID(self~newEdit(IDC_EDIT)) - toolInfo~text = newMsg - - tt = self~newToolTip(IDC_TT_BALLOON) - tt~updateTipText(toolInfo) - - + ret = tb~setExtendedStyle('DOUBLEBUFFER MIXEDBUTTONS') + ret = tb~setBitmapSize(.Size~new(24, 24)) + ... ]]> </programlisting> </para> </listitem></varlistentry> </variablelist> -</section> <!-- End dialog object::newToolTip() --> +</section> <!-- End dialog object::newToolBar() --> <section id="mthNewTrackBar" xreflabel="newTrackBar"><title>newTrackBar</title> <indexterm><primary>newTrackBar</primary></indexterm> @@ -4876,6 +4997,17 @@ </programlisting> </section> +<section id="enConnectToolBarEvent" xreflabel="connectToolBarEvent"><title>connectToolBarEvent</title> +<programlisting> +EventNotification::<xref linkend="mthConnectToolBarEvent"/> + +<![CDATA[ +>>--connectToolBarEvent(--id--,--event--+-----------+--+--------------+--)----->< + +-,-mthName-+ +-,-willReply--+ +]]> +</programlisting> +</section> + <section id="enConnectToolTipEvent" xreflabel="connectToolTipEvent"><title>connectToolTipEvent</title> <programlisting> EventNotification::<xref linkend="mthConnectToolTipEvent"/> Modified: docs/trunk/oodialog/en-US/eventNotification.xml =================================================================== --- docs/trunk/oodialog/en-US/eventNotification.xml 2013-12-18 02:35:19 UTC (rev 9726) +++ docs/trunk/oodialog/en-US/eventNotification.xml 2013-12-18 02:37:05 UTC (rev 9727) @@ -653,6 +653,10 @@ <entry>Connects an event notification from a tab control to a method in the Rexx dialog.</entry> </row> <row> +<entry><xref linkend="mthConnectToolBarEvent"/></entry> +<entry>Connects an event notification from a toolbar control to a method in the Rexx dialog.</entry> +</row> +<row> <entry><xref linkend="mthConnectToolTipEvent"/></entry> <entry>Connects an event notification from a ToolTip control to a method in the Rexx dialog.</entry> </row> @@ -7151,7 +7155,7 @@ <programlisting> <![CDATA[ -::class 'SimpleDialog subclass UserDialog +::class 'SimpleDialog' subclass UserDialog ::method initDialog @@ -7167,7 +7171,7 @@ self~newScrollBar(IDC_SB_FILE)~setPos(pos, .true) say "Pos:" pos - say "Verify event code: + say "Verify event code:" say " THUMBPOSITION:" .ScrollBar~THUMBPOSITION say " This event: " eventCode @@ -7704,7 +7708,122 @@ </section> +<section id="mthConnectToolBarEvent" xreflabel="connectToolBarEvent"><title>connectToolBarEvent</title> +<indexterm><primary>connectToolBarEvent</primary></indexterm> +<indexterm><primary>dialog object</primary><secondary>connectToolBarEvent</secondary></indexterm> +<indexterm><primary>EventNotification class</primary><secondary>connectToolBarEvent</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--connectToolBarEvent(--id--,--event--+-----------+--+-------------+--)------>< + +-,-mthName-+ +-,-willReply-+ +]]> +</programlisting> +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>id [required]</term> + <listitem> + <para> + The resource ID of the toolbar control whose notification message is to be connected to a method in the Rexx dialog. + May be numeric or <xref linkend="defSymbolicId"/>. + </para> + </listitem></varlistentry> + <varlistentry><term>event [required]</term> + <listitem> + <para> + Exactly one of the following keywords. The keyword specifies the event to be connected. Case is not significant. + </para> + <para> + <simplelist type='vert' columns='3'> + <member>?</member> + <member>?</member> + <member>?</member> + <member>?</member> + </simplelist> + </para> + <variablelist> + <varlistentry id="kywToolBarBEGINADJUST" xreflabel="BEGINADJUST"><term>BEGINADJUST</term> + <listitem> + <para> + xxx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term>methodName [optional]</term> + <listitem> + <para> + The name of the method that is to be invoked whenever the specified event happens. The programmer defines this method. + If this argument is omitted, a method name is automatically generated that consists of the event keyword preceded by + <computeroutput>on</computeroutput>. For instance, <computeroutput>onBeginAdjust</computeroutput>. The method name can + not be the empty string. The empty string is treated as an omitted argument. + </para> + </listitem></varlistentry> + <varlistentry><term>willReply [optional]</term> + <listitem> + <para> + The <emphasis role="italic">willReply</emphasis> argument controls whether the interpreter <link + linkend="sctCodingEventHandlers">waits</link> for the reply from the event handler, for some of the toolbar events. + The default is ... + </para> + <para> + xxx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + Returns <computeroutput>.true</computeroutput> if the event was connected correctly, otherwise + <computeroutput>.false</computeroutput>. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + See the sections on <link linkend="sctConnectingEventHandlers">connecting</link> and <link + linkend="sctCodingEventHandlers">coding</link> event handlers for additional information on event handlers. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details:</emphasis></term> + <listitem> + <para> + Syntax errors are raised when incorrect usage is detected, including the use of an invalid symbolic ID or an + unrecognized event keyword. + </para> + <para> + If the programmer does not provide a matching method in the Rexx dialog, a syntax condition will be raised if the + connected event happens. + </para> + <para> + The underlying dialog receives the TBN_* messages as the notifications for the tool tip events. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Example:</emphasis></term> + <listitem> + <para> + This example ... +<programlisting> +<![CDATA[ + +]]> +</programlisting> + </para> + </listitem></varlistentry> +</variablelist> + +</section> <!-- End EventNotification::connectToolBarEvent() --> + + <section id="mthConnectToolTipEvent" xreflabel="connectToolTipEvent"><title>connectToolTipEvent</title> <indexterm><primary>connectToolTipEvent</primary></indexterm> <indexterm><primary>dialog object</primary><secondary>connectToolTipEvent</secondary></indexterm> Modified: docs/trunk/oodialog/en-US/oodialog.xml =================================================================== --- docs/trunk/oodialog/en-US/oodialog.xml 2013-12-18 02:35:19 UTC (rev 9726) +++ docs/trunk/oodialog/en-US/oodialog.xml 2013-12-18 02:37:05 UTC (rev 9727) @@ -65,7 +65,9 @@ <xi:include href="progressbar.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="scrollbar.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="static.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="statusBar.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="tab.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="toolBar.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="tooltip.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="trackbar.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="treeview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> Added: docs/trunk/oodialog/en-US/statusBar.xml =================================================================== --- docs/trunk/oodialog/en-US/statusBar.xml (rev 0) +++ docs/trunk/oodialog/en-US/statusBar.xml 2013-12-18 02:37:05 UTC (rev 9727) @@ -0,0 +1,908 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "oodialog.ent"> +%BOOK_ENTITIES; +]> +<!--######################################################################### + # + # Description: Open Object Rexx: ooDialog Reference XML file. + # + # Copyright (c) 2013-2013 Rexx Language Association. 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 materials provided with the distribution. + # + # Neither the name of Rexx Language Association nor the names + # of its contributors may be used to endorse or promote products + # derived from this software without specific prior written permission. + # + # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + # FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED + # TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, + # OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY + # OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING + # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + # + ######################################################################### +--> +<chapter id="clsStatusBar" xreflabel="StatusBar"><title>StatusBar Controls</title> +<indexterm><primary>StatusBar class</primary></indexterm> +<para> + xxx +</para> +<para> + yyy +</para> +<para> + The <computeroutput>StatusBar</computeroutput> class provides methods to work with and manipulate the underlying Windows + status bar dialog control which it represents. It is a concrete subclass of the dialog <xref + linkend="chpDialogControlObject"/> object and therefore has all methods of the dialog control object. +</para> +<para> + In addition to the methods of the class itself, the following methods from other classes in the ooDialog framework are + needed, or are useful, when working with status bar controls: +<variablelist> + <varlistentry><term><emphasis role="bold">Instantiation:</emphasis></term> + <listitem> + <para> + Use the <xref linkend="tmthNewStatusBar"/> method of the <xref linkend="chpDialogObject"/> object to retrieve a new + StatusBar object. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Dynamic Definition:</emphasis></term> + <listitem> + <para> + To dynamically define a tab in a <xref linkend="clsUserDialog"/> class, use the <xref linkend="tmthCreateStatusBar"/> + method. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Event Notification</emphasis></term> + <listitem> + <para> + To connect the <xref linkend="ovvEvents"/> notifications sent by the underlying status bar control to + a method in the Rexx dialog object use the <xref linkend="tmthConnectStatusBarEvent"/> method. + </para> + </listitem></varlistentry> +</variablelist> +</para> + +<section id="sctMethodsStautBar"><title>Method Table</title> +<para> + The following table provides links to the documentation for the primary classes, methods, and attributes used in working + with StatusBar objects, including the pertinent classes, and methods from other classes: +</para> +<table id="tblStatusBarMethods" frame="all"> +<title>Important StatusBar Methods</title> +<tgroup cols="2"> +<colspec colwidth="1*" /> +<colspec colwidth="4*" /> +<thead> +<row> +<entry>Method</entry> +<entry>Description</entry> +</row> +</thead> +<tbody> +<row> +<entry align="center"><emphasis role="bold">Useful</emphasis></entry> +<entry align="center"><emphasis role="bold"> External Methods</emphasis></entry> +</row> +<row> +<entry><xref linkend="tmthNewStatusBar"/></entry> +<entry>Returns a <computeroutput>StatusBar</computeroutput> object for the control with the specified ID.</entry> +</row> +<row> +<entry><xref linkend="tmthCreateStatusBar"/></entry> +<entry>Creates a status bar control in the dialog template of a <xref linkend="clsUserDialog"/></entry> +</row> +<row> +<entry><xref linkend="tmthConnectStatusBarEvent"/></entry> +<entry>Connects status bar event notifications to a method in the Rexx dialog object</entry> +</row> +<row> +<entry align="center"><emphasis role="bold">Instance Methods</emphasis></entry> +<entry align="center"><emphasis role="bold"></emphasis></entry> +</row> +<row> +<entry><xref linkend="mthGetBorders"/></entry> +<entry>x.</entry> +</row> +<row> +<entry><xref linkend="mthGetIcon"/></entry> +<entry>x.</entry> +</row> +<row> +<entry><xref linkend="mthGetParts"/></entry> +<entry>x.</entry> +</row> +<row> +<entry><xref linkend="mthGetRect"/></entry> +<entry>x.</entry> +</row> +<row> +<entry><xref linkend="mthIsSimple"/></entry> +<entry>x.</entry> +</row> +<row> +<entry><xref linkend="mthSetBkColor"/></entry> +<entry>x.</entry> +</row> +<row> +<entry><xref linkend="mthSetIcon"/></entry> +<entry>x.</entry> +</row> +<row> +<entry><xref linkend="mthSetMinHeight"/></entry> +<entry>x.</entry> +</row> +<row> +<entry><xref linkend="mthSetParts"/></entry> +<entry>x.</entry> +</row> +<row> +<entry><xref linkend="mthSetTextClsStatusBar"/></entry> +<entry>x.</entry> +</row> +<row> +<entry><xref linkend="mthSimple"/></entry> +<entry>x.</entry> +</row> +</tbody></tgroup> +</table> +</section> + + +<section id="tmthNewStatusBar" xreflabel="newStatusBar"><title>newStatusBar (dialog object method)</title> +<para> + StatusBar objects can not be instantiated by the programmer from Rexx code. Rather a StatusBar object is obtained by using + the <xref linkend="mthNewToolBar"/>() method of the <xref linkend="chpDialogObject"/> object. The + syntax is: +<programlisting> +<![CDATA[ +>>-newStatusBar(--id--)-------------------------->< +]]> +</programlisting> +</para> +</section> <!-- End newStatusBar() [PlainBaseDialog method] --> + + +<section id="tmthCreateStatusBar" xreflabel="createStatusBar"><title>createStatusBar (UserDialog method)</title> +<para> + A status bar control can be added to the dialog template for a <xref linkend="clsUserDialog"/> dialog through the <xref + linkend="mthCreateToolBar"/>() method. The basic syntax is: +<programlisting> <![CDATA[ +>>--createStatusBar(-id-,--x-,--y-,--cx-,--cy-+---------+--+-----------------+--)-->< + +-,-style-+ +-,-attributeName-+ + +]]> +</programlisting> +</para> +</section> <!-- End UserDialog::createStatusBar() [UserDialog method] --> + + +<section id="tmthConnectStatusBarEvent" xreflabel="connectStatusBarEvent"><title>connectStatusBarEvent (dialog object method)</title> +<para> + To connect event notifications from a status bar control use the + <xref linkend="mthConnectToolBarEvent"/>() method of the + <xref linkend="chpDialogObject"/> object. The basic syntax is: + +<programlisting> <![CDATA[ +>>-connectStatusBarEvent(--id--,--event--+----------------+--+--------------+--)--->< + +--,-methodName--+ +-,-willReply--+ + +]]> +</programlisting> +</para> +</section> <!-- End connectStatusBarEvent() [EventNotification method] --> + +<section id="mthGetBorders" xreflabel="getBorders"><title>getBorders</title> +<indexterm><primary>getBorders</primary></indexterm> +<indexterm><primary>StatusBar class</primary><secondary>getBorders</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getBorders(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is detected. + </para> + <para> + Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Example:</emphasis></term> + <listitem> + <para> + This example ... +<programlisting> +<![CDATA[ + +]]> +</programlisting> + </para> + </listitem></varlistentry> +</variablelist> +</section> <!-- End StatusBar::getBorders() --> + +<section id="mthGetIcon" xreflabel="getIcon"><title>getIcon</title> +<indexterm><primary>getIcon</primary></indexterm> +<indexterm><primary>StatusBar class</primary><secondary>getIcon</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getIcon(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is detected. + </para> + <para> + Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Example:</emphasis></term> + <listitem> + <para> + This example ... +<programlisting> +<![CDATA[ + +]]> +</programlisting> + </para> + </listitem></varlistentry> +</variablelist> +</section> <!-- End StatusBar::getIcon() --> + +<section id="mthGetParts" xreflabel="getParts"><title>getParts</title> +<indexterm><primary>getParts</primary></indexterm> +<indexterm><primary>StatusBar class</primary><secondary>getParts</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getParts(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is detected. + </para> + <para> + Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Example:</emphasis></term> + <listitem> + <para> + This example ... +<programlisting> +<![CDATA[ + +]]> +</programlisting> + </para> + </listitem></varlistentry> +</variablelist> +</section> <!-- End StatusBar::getParts() --> + +<section id="mthGetRect" xreflabel="getRect"><title>getRect</title> +<indexterm><primary>getRect</primary></indexterm> +<indexterm><primary>StatusBar class</primary><secondary>getRect</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--getRect(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is detected. + </para> + <para> + Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Example:</emphasis></term> + <listitem> + <para> + This example ... +<programlisting> +<![CDATA[ + +]]> +</programlisting> + </para> + </listitem></varlistentry> +</variablelist> +</section> <!-- End StatusBar::getRect() --> + +<section id="mthIsSimple" xreflabel="isSimple"><title>isSimple</title> +<indexterm><primary>isSimple</primary></indexterm> +<indexterm><primary>StatusBar class</primary><secondary>isSimple</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--isSimple(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is detected. + </para> + <para> + Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Example:</emphasis></term> + <listitem> + <para> + This example ... +<programlisting> +<![CDATA[ + +]]> +</programlisting> + </para> + </listitem></varlistentry> +</variablelist> +</section> <!-- End StatusBar::isSimple() --> + +<section id="mthSetBkColor" xreflabel="setBkColor"><title>setBkColor</title> +<indexterm><primary>setBkColor</primary></indexterm> +<indexterm><primary>StatusBar class</primary><secondary>setBkColor</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--setBkColor(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is detected. + </para> + <para> + Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Example:</emphasis></term> + <listitem> + <para> + This example ... +<programlisting> +<![CDATA[ + +]]> +</programlisting> + </para> + </listitem></varlistentry> +</variablelist> +</section> <!-- End StatusBar::setBkColor() --> + +<section id="mthSetIcon" xreflabel="setIcon"><title>setIcon</title> +<indexterm><primary>setIcon</primary></indexterm> +<indexterm><primary>StatusBar class</primary><secondary>setIcon</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--setIcon(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is detected. + </para> + <para> + Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Example:</emphasis></term> + <listitem> + <para> + This example ... +<programlisting> +<![CDATA[ + +]]> +</programlisting> + </para> + </listitem></varlistentry> +</variablelist> +</section> <!-- End StatusBar::setIcon() --> + +<section id="mthSetMinHeight" xreflabel="setMinHeight"><title>setMinHeight</title> +<indexterm><primary>setMinHeight</primary></indexterm> +<indexterm><primary>StatusBar class</primary><secondary>setMinHeight</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--setMinHeight(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is detected. + </para> + <para> + Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Example:</emphasis></term> + <listitem> + <para> + This example ... +<programlisting> +<![CDATA[ + +]]> +</programlisting> + </para> + </listitem></varlistentry> +</variablelist> +</section> <!-- End StatusBar::setMinHeight() --> + +<section id="mthSetParts" xreflabel="setParts"><title>setParts</title> +<indexterm><primary>setParts</primary></indexterm> +<indexterm><primary>StatusBar class</primary><secondary>setParts</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--setParts(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is detected. + </para> + <para> + Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Example:</emphasis></term> + <listitem> + <para> + This example ... +<programlisting> +<![CDATA[ + +]]> +</programlisting> + </para> + </listitem></varlistentry> +</variablelist> +</section> <!-- End StatusBar::setParts() --> + +<section id="mthSetTextClsStatusBar" xreflabel="setText"><title>setText</title> +<indexterm><primary>setText</primary></indexterm> +<indexterm><primary>StatusBar class</primary><secondary>setText</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--setText(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is detected. + </para> + <para> + Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Example:</emphasis></term> + <listitem> + <para> + This example ... +<programlisting> +<![CDATA[ + +]]> +</programlisting> + </para> + </listitem></varlistentry> +</variablelist> +</section> <!-- End StatusBar::setText() --> + +<section id="mthSimple" xreflabel="simple"><title>simple</title> +<indexterm><primary>simple</primary></indexterm> +<indexterm><primary>StatusBar class</primary><secondary>simple</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--simple(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is detected. + </para> + <para> + Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Example:</emphasis></term> + <listitem> + <para> + This example ... +<programlisting> +<![CDATA[ + +]]> +</programlisting> + </para> + </listitem></varlistentry> +</variablelist> +</section> <!-- End StatusBar::simple() --> + +</chapter> <!-- End StatusBar class --> Property changes on: docs/trunk/oodialog/en-US/statusBar.xml ___________________________________________________________________ Added: svn:eol-style ## -0,0 +1 ## +native \ No newline at end of property Added: docs/trunk/oodialog/en-US/toolBar.xml =================================================================== --- docs/trunk/oodialog/en-US/toolBar.xml (rev 0) +++ docs/trunk/oodialog/en-US/toolBar.xml 2013-12-18 02:37:05 UTC (rev 9727) @@ -0,0 +1,2798 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "oodialog.ent"> +%BOOK_ENTITIES; +]> +<!--######################################################################### + # + # Description: Open Object Rexx: ooDialog Reference XML file. + # + # Copyright (c) 2013-2013 Rexx Language Association. 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 materials provided with the distribution. + # + # Neither the name of Rexx Language Association nor the names + # of its contributors may be used to endorse or promote products + # derived from this software without specific prior written permission. + # + # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + # FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED + # TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, + # OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY + # OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING + # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + # + ######################################################################### +--> +<chapter id="clsToolBar" xreflabel="ToolBar"><title>ToolBar Controls</title> +<indexterm><primary>ToolBar class</primary></indexterm> +<para> + xxx +</para> +<para> + yyy +</para> +<para> + The <computeroutput>ToolBar</computeroutput> class provides methods to work with and manipulate the underlying Windows + toolbar dialog control which it represents. It is a concrete subclass of the dialog <xref + linkend="chpDialogControlObject"/> object and therefore has all methods of the dialog control object. +</para> +<para> + In addition to the methods of the class itself, the following methods from other classes in the ooDialog framework are + needed, or are useful, when working with toolbar controls: +<variablelist> + <varlistentry><term><emphasis role="bold">Instantiation:</emphasis></term> + <listitem> + <para> + Use the <xref linkend="tmthNewToolBar"/> method of the <xref linkend="chpDialogObject"/> object to retrieve a new ToolBar + object. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Dynamic Definition:</emphasis></term> + <listitem> + <para> + To dynamically define a toolbar in a <xref linkend="clsUserDialog"/> class, use the + <xref linkend="tmthCreateToolBar"/> method. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Event Notification</emphasis></term> + <listitem> + <para> + To connect the <xref linkend="ovvEvents"/> notifications sent by the underlying toolbar control to + a method in the Rexx dialog object use the <xref linkend="tmthConnectToolBarEvent"/> method. + </para> </listitem></varlistentry> +</variablelist> </para> + +<section id="sctMethodsToolBar"><title>Method Table</title> +<para> + The following table provides links to the documentation for the primary classes, methods, and attributes used in working + with ToolBar objects, including the pertinent classes, and methods from other classes: +</para> +<table id="tblToolBarMethods" frame="all"> +<title>Important Tab Methods</title> +<tgroup cols="2"> +<colspec colwidth="1*" /> +<colspec colwidth="4*" /> +<thead> +<row> +<entry>Method</entry> +<entry>Description</entry> +</row> +</thead> +<tbody> +<row> +<entry align="center"><emphasis role="bold">Useful</emphasis></entry> +<entry align="center"><emphasis role="bold">Classes</emphasis></entry> +</row> +<row> +<entry><xref linkend="clsTbButton"/></entry> +<entry><computeroutput>TbButton</computeroutput>objects define the buttons in a toobar and are used to recieve information concerning buttons in the toolbar.</entry> +</row> +<row> +<entry align="center"><emphasis role="bold">Useful</emphasis></entry> +<entry align="center"><emphasis role="bold"> External Methods</emphasis></entry> +</row> +<row> +<entry><xref linkend="tmthNewToolBar"/></entry> +<entry>Returns a <computeroutput>ToolBar</computeroutput> object for the control with the specified ID.</entry> +</row> +<row> +<entry><xref linkend="tmthCreateToolBar"/></entry> +<entry>Creates a toolbar control in the dialog template of a <xref linkend="clsUserDialog"/></entry> +</row> +<row> +<entry><xref linkend="tmthConnectToolBarEvent"/></entry> +<entry>Connects toolbar event notifications to a method in the Rexx dialog object</entry> +</row> +<row> +<entry align="center"><emphasis role="bold">Instance Methods</emphasis></entry> +<entry align="center"><emphasis role="bold"></emphasis></entry> +</row> +<row> +<entry><xref linkend="mthAddBitmap"/></entry> +<entry>x.</entry> +</row> +</tbody></tgroup> +</table> +</section> + + +<section id="tmthNewToolBar" xreflabel="newToolbar"><title>newToolbar (dialog object method)</title> +<para> + Toolbar objects can not be instantiated by the programmer from Rexx code. Rather a Toolbar object is obtained by using the + <xref linkend="mthNewToolBar"/>() method of the <xref linkend="chpDialogObject"/> object. The + syntax is: +<programlisting> +<![CDATA[ +>>-newToolbar(--id--)--------------------->< + +]]> +</programlisting> +</para> +</section> <!-- End newToolBar() [PlainBaseDialog method] --> + + +<section id="tmthCreateToolBar" xreflabel="createToolBar"><title>createToolBar (UserDialog method)</title> +<para> + A toolbar control can be added to the dialog template for a <xref linkend="clsUserDialog"/> dialog through the <xref + linkend="mthCreateToolBar"/>() method. The basic syntax is: +<programlisting> <![CDATA[ +>>--createToolBar(-id-,--x-,--y-,--cx-,--cy-+---------+--+-----------------+--)--->< + +-,-style-+ +-,-attributeName-+ + +]]> +</programlisting> +</para> +</section> <!-- End UserDialog::createToolBar() [UserDialog method] --> + + +<section id="tmthConnectToolBarEvent" xreflabel="connectToolBarEvent"><title>connectToolBarEvent (dialog object method)</title> +<para> + To connect event notifications from an toolbar control use the + <xref linkend="mthConnectToolBarEvent"/>() method of the + <xref linkend="chpDialogObject"/> object. The basic syntax is: + +<programlisting> <![CDATA[ +>>-connectToolBarEvent(--id--,--event--+----------------+--+--------------+--)---->< + +--,-methodName--+ +-,-willReply--+ + +]]> +</programlisting> +</para> +</section> <!-- End connectToolBarEvent() [EventNotification method] --> + +<section id="mthAddBitmap" xreflabel="addBitmap"><title>addBitmap</title> +<indexterm><primary>addBitmap</primary></indexterm> +<indexterm><primary>ToolBar class</primary><secondary>addBitmap</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--addBitmap(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is detected. + </para> + <para> + Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Example:</emphasis></term> + <listitem> + <para> + This example ... +<programlisting> +<![CDATA[ + +]]> +</programlisting> + </para> + </listitem></varlistentry> +</variablelist> +</section> <!-- End ToolBar::addBitmap() --> + +<section id="mthAddButtons" xreflabel="addButtons"><title>addButtons</title> +<indexterm><primary>addButtons</primary></indexterm> +<indexterm><primary>ToolBar class</primary><secondary>addButtons</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--addButtons(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is detected. + </para> + <para> + Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Example:</emphasis></term> + <listitem> + <para> + This example ... +<programlisting> +<![CDATA[ + +]]> +</programlisting> + </para> + </listitem></varlistentry> +</variablelist> +</section> <!-- End ToolBar::addButtons() --> + +<section id="mthAddString" xreflabel="addString"><title>addString</title> +<indexterm><primary>addString</primary></indexterm> +<indexterm><primary>ToolBar class</primary><secondary>addString</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--addString(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Details</emphasis></term> + <listitem> + <para> + Raises syntax errors when incorrect usage is detected. + </para> + <para> + Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable. + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Example:</emphasis></term> + <listitem> + <para> + This example ... +<programlisting> +<![CDATA[ + +]]> +</programlisting> + </para> + </listitem></varlistentry> +</variablelist> +</section> <!-- End ToolBar::addString() --> + +<section id="mthAutoSize" xreflabel="autoSize"><title>autoSize</title> +<indexterm><primary>autoSize</primary></indexterm> +<indexterm><primary>ToolBar class</primary><secondary>autoSize</secondary></indexterm> +<programlisting> +<![CDATA[ +>>--autoSize(--+--------+--)--------------------------------------------->< + +--type--+ +]]> +</programlisting> + +<para> + xx +</para> +<variablelist> + <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term> + <listitem> + <para> + The arguments are: + </para> + <variablelist> + <varlistentry><term>TERM</term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + </variablelist> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Return value:</emphasis></term> + <listitem> + <para> + xx + </para> + </listitem></varlistentry> + <varlistentry><term><emphasis role="bold">Remarks:</emphasis></term> + <listitem> + <para> + Additional comments. + </para> + </listitem></varlistentry>... [truncated message content] |