Menu
▾
▴
[Oorexx-svn] SF.net SVN: oorexx:[5975] docs/trunk/oodialog
|
From: <mie...@us...> - 2010-05-25 01:07:37
|
Revision: 5975
http://oorexx.svn.sourceforge.net/oorexx/?rev=5975&view=rev
Author: miesfeld
Date: 2010-05-25 01:07:30 +0000 (Tue, 25 May 2010)
Log Message:
-----------
ooDialog doc updates (sorry, not 100% sure it will compile without some tag errors.)
Modified Paths:
--------------
docs/trunk/oodialog/dialogObject.xml
docs/trunk/oodialog/menus.xml
docs/trunk/oodialog/overview.xml
docs/trunk/oodialog/windowBase.xml
Modified: docs/trunk/oodialog/dialogObject.xml
===================================================================
--- docs/trunk/oodialog/dialogObject.xml 2010-05-25 00:59:49 UTC (rev 5974)
+++ docs/trunk/oodialog/dialogObject.xml 2010-05-25 01:07:30 UTC (rev 5975)
@@ -11067,9 +11067,9 @@
</section>
</section>
-<section id="man0018"><title>Bitmap Methods</title>
+<section id="sctBitmapMethods"><title>Bitmap Methods</title>
<indexterm><primary>bitmap methods</primary></indexterm>
-<para>The methods listed below deal with bitmaps.</para>
+<para>The methods listed in this section deal with using bitmaps.</para>
<section id="mthInstallBitmapButton"><title>installBitmapButton</title>
<indexterm><primary>installBitmapButton</primary></indexterm>
@@ -11164,7 +11164,7 @@
.
.
.
-::method InitDialog
+::method initDialog
self~installBitmapButton(204, "BmpButtonClicked", ,
"AddBut_n.bmp", "AddBut_f.bmp", ,
"AddBut_s.bmp", "AddBut_d.bmp", "FRAME")
@@ -12504,54 +12504,6 @@
</section> <!-- End Sending Windows Messages Section -->
-<section id="debuggingmeth"><title>Debugging Methods</title>
-<indexterm><primary>debugging methods</primary></indexterm>
-<para>
- The following method(s) can be used to help debug ooDialog programs. At this time there are very few
- methods.
-</para>
-
-<section id="dumpdialog"><title>dump</title>
-<indexterm><primary>dump</primary></indexterm>
-<para>
- The <emphasis role="italic">dump</emphasis>() method displays the internal settings of the dialog
- administration table.
-</para>
-<para>
- <emphasis role="bold">Note</emphasis> that this method is of limited use unless one understands the
- private internal implementation of ooDialog. In addition, the internal implementation of ooDialog,
- that is not documented, is subject to change. And in fact some of the implementation is changing. In
- particular the dialog administration table is going away. Once it has been removed completely, this
- method will producd no output.
-</para>
-<programlisting>
-<![CDATA[
->>--dump(--+-------------+--)---------------------------------><
- +-dialogadmin-+
-
-]]>
-</programlisting>
-
-<para></para>
-<variablelist>
-<varlistentry><term><emphasis role="bold">Argument:</emphasis></term>
-<listitem><para>The only argument is:
-<variablelist>
-<varlistentry><term>dialogadmin</term>
-<listitem><para>
- A pointer to a particular dialog administration record. If you specify this argument, you get detailed
- information on this record. If you omit this argument, all administration records (one for each dialog
- of the active process) are listed.
-</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>
-
<section id="deprecatedDialogMethods"><title>Deprecated Methods</title>
<indexterm><primary>Deprecated</primary><secondary>dialog object methods</secondary></indexterm>
<para>
@@ -12582,6 +12534,15 @@
</para>
</section>
+<section><title>connectAnimatedButton</title>
+<indexterm><primary>Deprecated</primary><secondary>connectAnimatedButton</secondary></indexterm>
+<indexterm><primary>Deprecated</primary><secondary>dialog object</secondary><tertiary>connectAnimatedButton</tertiary></indexterm>
+<para>
+ This method is <link linkend="ovvDeprecated">deprecated</link>. Replace this method with the <link
+ linkend="mthInstallAnimatedButton">installAnimatedButton</link>() method.
+</para>
+</section>
+
<section><title>connectBitmapButton</title>
<indexterm><primary>Deprecated</primary><secondary>connectBitmapButton</secondary></indexterm>
<indexterm><primary>Deprecated</primary><secondary>dialog object</secondary><tertiary>connectBitmapButton</tertiary></indexterm>
@@ -12611,6 +12572,17 @@
</para>
</section>
+<section><title>dump</title>
+<indexterm><primary>Deprecated</primary><secondary>dump</secondary></indexterm>
+<indexterm><primary>Deprecated</primary><secondary>dialog object</secondary><tertiary>dump</tertiary></indexterm>
+<para>
+ This method is <link linkend="ovvDeprecated">deprecated</link>. It will simply print: "dump() deprecated." In
+ older versions of ooDialog, the <emphasis role="italic">dump</emphasis>() method would print out information tied to
+ the undocumented internal implementation of ooDialog. Since the internal implementation has changed, this information
+ no longer exists.
+</para>
+</section>
+
<section><title>enableMenuItem</title>
<indexterm><primary>Deprecated</primary><secondary>enableMenuItem</secondary></indexterm>
<indexterm><primary>Deprecated</primary><secondary>dialog object</secondary><tertiary>enableMenuItem</tertiary></indexterm>
Modified: docs/trunk/oodialog/menus.xml
===================================================================
--- docs/trunk/oodialog/menus.xml 2010-05-25 00:59:49 UTC (rev 5974)
+++ docs/trunk/oodialog/menus.xml 2010-05-25 01:07:30 UTC (rev 5975)
@@ -95,37 +95,93 @@
</thead>
<tbody>
<row>
-<entry>BinaryMenuBar</entry>
-<entry><link linkend="clsBinaryMenuBar">BinaryMenuBar Class</link></entry>
+<entry><link linkend="clsBinaryMenuBar">BinaryMenuBar</link></entry>
+<entry>A menu bar created from a menu resource, or created as an empty menu bar.</entry>
</row>
<row>
-<entry>ScriptMenuBar</entry>
-<entry><link linkend="clsScriptMenuBar">ScriptMenuBar Class</link></entry>
+<entry><link linkend="clsMenu">Menu (Mixin Class) The Menu Object</link></entry>
+<entry>The basis for the menu object.</entry>
</row>
<row>
-<entry>UserMenuBar</entry>
-<entry><link linkend="clsUserMenuBar">UserMenuBar Class</link></entry>
+<entry><link linkend="clsMenuBar">MenuBar (Mixin Class) The Menu Bar Object</link></entry>
+<entry>The basis for the menu bar object.</entry>
</row>
<row>
-<entry>PopupMenu</entry>
-<entry><link linkend="clsPopupMenu">PopupMenu Class</link></entry>
+<entry><link linkend="clsPopupMenu">PopupMenu</link></entry>
+<entry>A menu or a shortcut menu, also known as a submenu or a context menu.</entry>
</row>
<row>
-<entry>Menu</entry>
-<entry><link linkend="clsMenu">Menu (Mixin Class)</link></entry>
+<entry><link linkend="clsScriptMenuBar">ScriptMenuBar</link></entry>
+<entry>A menu bar created from a resource script file.</entry>
</row>
<row>
-<entry>MenuBar</entry>
-<entry><link linkend="clsMenuBar">MenuBar (Mixin Class) The Menu Object</link></entry>
+<entry><link linkend="clsSystemMenu">SystemMenu</link></entry>
+<entry>A system menu, also known as the window menu or the control menu.</entry>
</row>
<row>
-<entry>MenuTemplate Class</entry>
-<entry><link linkend="clsMenuTemplate">MenuTemplate (Mixin Class) The Menu Bar Object</link></entry>
+<entry><link linkend="clsUserMenuBar">UserMenuBar</link></entry>
+<entry>
+ A menu bar created by the programmer in a fashion similar to a <link linkend="clsUserDialog">UserDialog</link>.
+</entry>
</row>
</tbody></tgroup>
</table>
</para>
+<section id="sctMenuItemIDs"><title>Menu Item IDs</title>
+<para>
+ Each menu item in a menu can be uniquely identified. This documentation generically refers to a menu item <emphasis
+ role="italic">ID</emphasis>, but there are really two ways of identifying a menu item.
+</para>
+
+<variablelist>
+ <varlistentry id="entMenuItemIdentifier"><term><emphasis role="bold">Menu-Item Identifier</emphasis></term>
+ <listitem>
+ <para>
+ Each menu item has a unique, non-negative, integer assigned to it by the programmer, called a menu-item identifier.
+ These numbers are essentially the same as any other resource <link linkend="defResourceID">ID</link> used in
+ ooDialog. The Rexx programmer can use numeric or <link linkend="defSymbolicID">symbolic</link> IDs for menu-item
+ identifier's, in the same way as for other resource IDs.
+ </para>
+ <para>
+ All menus assign menu-item identifiers to command items and submenus. ooDialog uses what the Windows operating
+ system calls <emphasis role="italic">extended</emphasis> menus. Extended menus also assign identifiers to
+ separators. Identifiers are used for menu command <link linkend="sctMenuCommandEvents">events</link>. In addition, a
+ menu item can be specified using its identifier in method invocations. For example, to <link
+ linkend="mthEnableClsMenu">enable</link> or <link linkend="mthDisableClsMenu">disable</link> a menu item.
+ </para>
+ <para>
+ Identifiers allow the programmer to specify any menu item anywhere in the menu hiearchy. The <link
+ linkend="mthGetIDClsMenu">getID</link>() method can be used to retrieve the identifier of the menu item at a
+ specified position
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Menu-Item Position</emphasis></term>
+ <listitem>
+ <para>
+ In addition to having a unique identifier, each menu item in a menu bar or menu has a unique position value.
+ Although the operating system uses zero-based position numbering, ooDialog uses one-based position numbering to
+ conform to general Rexx practice. The leftmost item in a menu bar, or the top item in a menu, has position one. The
+ position value is incremented for subsequent menu items. A position value is assigned to all items in a menu,
+ including separators.
+ </para>
+ <para>
+ Position values can be used in method invocations that require specifying a menu item. Note that since the top item
+ in a menu, or the leftmost menu item in a menu bar, always has a position of one, it is not possible to uniquely
+ specify any menu item in a menu hiearchy. Rather, you can only use a position to specify an item in a specific
+ submenu.
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+<para>
+ Except in a few methods where it simply does not make any sense, all menu methods that require specifying a menu item
+ accept either a menu item identifier or a menu item position. The menu item specifier is refered to as the menu item
+ ID. Since both identifiers and positions are numbers, the programmer needs to specify which is bing used. However, by
+ default, the ID is assumed to be an indetifier. Therefore, the programmer only need indicate when the ID is a position
+ ID.
+</para>
+</section>
+
<section id="sctMenuCommandEvents"><title>Menu Command Events</title>
<indexterm><primary>menu object</primary><secondary>command events</secondary></indexterm>
<para>
@@ -138,9 +194,10 @@
</para>
<para>
However, there are some specific details when dealing with menus that should be understood. The menu command event is
- connected using the resource ID of the menu item, just as dialog control events are connected using the resource ID of
- the dialog control. Event notifications are always connected to a specific Rexx dialog object, the dialog object that
- represents the <link linkend="ovvUnderlying">underlying</link> dialog that the notification is expected to be sent to.
+ connected using the menu item <link linkend="sctMenuItemIDs">identifier</link> of the command item, just as dialog
+ control events are connected using the resource ID of the dialog control. Event notifications are always connected to
+ a specific Rexx dialog object, the dialog object that represents the <link linkend="ovvUnderlying">underlying</link>
+ dialog that the notification is expected to be sent to.
</para>
<para>
A Rexx dialog control object has one, and only one, underlying dialog. But, a Rexx <link linkend="clsMenuBar">menu bar
@@ -171,7 +228,7 @@
</para>
<para>
E.g., take the case of an OK push button and an Exit menu item. Many times the action to take for both is exactly the
- same. Here the ooDialog programmer would use the same resource ID of both the button and the menu item. OK buttons
+ same. Here the ooDialog programmer would use the same resource ID for both the button and the menu item. OK buttons
normally use the resource ID of <computeroutput>IDOK</computeroutput>, which the ooDialog framework <link
linkend="sctStandardEventMethods">automatically</link> connects to the <link linkend="mthOk">OK</link> method. If the
programmer also uses the IDOK id for the Exit menu item, then nothing else need be done. Whether the user selects the
@@ -187,6 +244,7 @@
<section id="clsMenu"><title>The Menu Object</title>
<indexterm><primary>Menu class</primary></indexterm>
<indexterm><primary>The Menu Object</primary></indexterm>
+<indexterm><primary>menu object</primary></indexterm>
<para>
All the menu classes in ooDialog are similar. Menus have a large number of methods that are common to all types of
menus. These common methods are contained in the <computeroutput>Menu</computeroutput> class, a mixin class inherited
@@ -237,14 +295,50 @@
<entry align="center"><emphasis role="bold"></emphasis></entry>
</row>
<row>
+<entry><link linkend="mthCheckClsMenu">check</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthCheckRadioButton">checkRadioButton</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthConnectAllCommandEvents">connectAllCommandEvents</link></entry>
+<entry>.</entry>
+</row>
+<row>
<entry><link linkend="mthConnectCommandEvent">connectCommandEvent</link></entry>
<entry>Connects a menu command event notification from a menu to a method in a Rexx dialog.</entry>
</row>
<row>
+<entry><link linkend="mthConnectMenuEvent">connectMenuEvent</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthConnectSomeCommandEvents">connectSomeCommandEvents</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthDeletePopup">deletePopup</link></entry>
+<entry>.</entry>
+</row>
+<row>
<entry><link linkend="mthDestroyClsMenu">destroy</link></entry>
<entry>Releases the system resources used by the menu.</entry>
</row>
<row>
+<entry><link linkend="mthDisableClsMenu">disable</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthEnableClsMenu">enable</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthGetAutoConnectStatus">getAutoConnectStatus</link></entry>
+<entry>.</entry>
+</row>
+<row>
<entry><link linkend="mthGetCountClsMenu">getCount</link></entry>
<entry>Returns the number of items in the menu.</entry>
</row>
@@ -253,9 +347,145 @@
<entry>Returns the value of the hMenu attribute of the menu.</entry>
</row>
<row>
+<entry><link linkend="mthGetHelpID">getHelpID</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthGetIDClsMenu">getID</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthGetItemState">getItemState</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthGetMaxHeight">getMaxHeight</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthGetMenuHandle">getMenuHandle</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthGetPopup"></link>getPopup</entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthGetTextClsMenu">getText</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthGetType">getType</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthGray">gray</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthHilite">hilite</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthInsertItem">insertItem</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthInsertPopup">insertPopup</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthInsertSeparator">insertSeparator</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthIsChecked">isChecked</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthIsCommandItem">isCommandItem</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthIsDisabled">isDisabled</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthIsEnabledClsMenu">isEnabled</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthIsGrayed">isGrayed</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthIsPopup">isPopup</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthIsSeparator">isSeparator</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthIsValidItemID">isValidItemID</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthIsValidMenu">isValidMenu</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthIsValidMenuHandle">isValidMenuHandle</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthItemTextToMethodName">itemTextToMethodName</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthReleaseMenuHandle">releaseMenuHandle</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthRemoveItem">removeItem</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthRemovePopup">removePopup</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthRemoveSeparator">removeSeparator</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthSetAutoConnection">setAutoConnection</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthSetHelpID">setHelpID</link></entry>
+<entry>.</entry>
+</row>
+<row>
<entry><link linkend="mthSetID">setID</link></entry>
<entry>Sets the resource ID of the menu.</entry>
</row>
+<row>
+<entry><link linkend="mthSetMaxHeight">setMaxHeight</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthSetTextClsMenu">setText</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthUncheckClsMenu">uncheck</link></entry>
+<entry>.</entry>
+</row>
+<row>
+<entry><link linkend="mthUnhilite">unhilite</link></entry>
+<entry>.</entry>
+</row>
</tbody></tgroup>
</table>
</para>
@@ -457,7 +687,7 @@
<varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
<listitem>
<para>
- The number of menu items in the menu.
+ The number of menu items in the menu, or -1 on error.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
@@ -472,8 +702,14 @@
<para>
<programlisting>
<![CDATA[
-count = menuObj~count
-say 'The menu has' count 'items.'
+ count = menuObj~count
+ if count \== -1 then do
+ say 'The menu has' count 'items.'
+ end
+ else do
+ say 'Error getting count of menu items:'
+ say ' Error Code:' .SystemErrorCode SysGetErrortext(.SystemErrorCode)
+ end
]]>
</programlisting>
</para>
@@ -482,7 +718,7 @@
</section>
<section id="mthIsValidMenu"><title>isValidMenu</title>
-<indexterm><primary>isValidMenu</primary>
+<indexterm><primary>isValidMenu</primary></indexterm>
<indexterm><primary>menu object</primary><secondary>isValidMenu</secondary></indexterm>
<programlisting>
<![CDATA[
@@ -509,17 +745,424 @@
Returns true if the menu is valid, otherwise false.
</para>
</listitem></varlistentry>
+</variablelist>
+</section> <!-- End Menu::isValidMenu() -->
+
+<section id="mthIsValidMenuHandle"><title>isValidMenuHandle</title>
+<indexterm><primary>isValidMenuHandle</primary></indexterm>
+<indexterm><primary>menu object</primary><secondary>isValidMenuHandle</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--isValidMenuHandle(--handle--)--------------------><
+
+]]>
+</programlisting>
+
+<para>
+ Given a handle, determines if the handle is a menu handle and, if it is, if the menu is still valid.
+</para>
+<variablelist>
+ <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ The single argument is:
+ <variablelist>
+ <varlistentry><term>handle</term>
+ <listitem>
+ <para>
+ The handle to check if it is a valid menu handle.
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
+ <listitem>
+ <para>
+ True if <emphasis role="italic">handle</emphasis> is the handle of a valid menu, otherwise false.
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End menu object::isValidMenuHandle() -->
+
+<section id="mthIsValidItemID"><title>isValidItemID</title>
+<indexterm><primary>isValidItemID</primary></indexterm>
+<indexterm><primary>menu object</primary><secondary>isValidItemID</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--isValidItemID(--id--+---------------+--)---------><
+ +-,-byPosition--+
+]]>
+</programlisting>
+
+<para>
+ Determines if a specific menu item <link linkend="sctMenuItemIDs">ID</link> is valid for this menu.
+</para>
+<variablelist>
+ <varlistentry><term><emphasis role="bold">Details</emphasis></term>
+ <listitem>
+ <para>
+ Sets the <link linkend="dotSystemErrorCode">.SystemErrorCode</link> variable.
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ The arguments are:
+ <variablelist>
+ <varlistentry><term>id [required]</term>
+ <listitem>
+ <para>
+ The menu item ID to check.
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term>byPosition [optional]</term>
+ <listitem>
+ <para>
+ If the item ID is a resource ID or a positional ID. The default is false, a resource ID. Use true if the ID is a
+ positional ID.
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </para>
+ </listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Return value:</emphasis></term>
+ <listitem>
+ <para>
+ True if the id is valid for the menu, otherwise false.
+ </para>
+ </listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Remarks:</emphasis></term>
<listitem>
<para>
Additional comments.
+ </para></listitem></varlistentry>
+ <varlistentry><term><emphasis role="bold">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
</para>
</listitem></varlistentry>
</variablelist>
-</section> <!-- End Menu::isValidMenu() -->
+</section> <!-- End menu object::isValidItemID() -->
+<section id="mthIsPopup"><title>isPopup</title>
+<indexterm><primary>isPopup</primary></indexterm>
+<indexterm><primary>menu object</primary><secondary>isPopup</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--isPopup(--+--------+--)---------------------------------------------><
+ +--type--+
+]]>
+</programlisting>
+
+<para>
+ xx
+</para>
+<variablelist>
+ <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">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </para>
+ </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">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End menu object::isPopup() -->
+
+<section id="mthIsCommandItem"><title>isCommandItem</title>
+<indexterm><primary>isCommandItem</primary></indexterm>
+<indexterm><primary>menu object</primary><secondary>isCommandItem</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--isCommandItem(--+--------+--)---------------------------------------------><
+ +--type--+
+]]>
+</programlisting>
+
+<para>
+ xx
+</para>
+<variablelist>
+ <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">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </para>
+ </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">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End menu object::isCommandItem() -->
+
+<section id="mthIsSeparator"><title>isSeparator</title>
+<indexterm><primary>isSeparator</primary></indexterm>
+<indexterm><primary>menu object</primary><secondary>isSeparator</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--isSeparator(--+--------+--)---------------------------------------------><
+ +--type--+
+]]>
+</programlisting>
+
+<para>
+ xx
+</para>
+<variablelist>
+ <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">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </para>
+ </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">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End menu object::isSeparator() -->
+
+<section id="mthGetHandle"><title>getHandle</title>
+<indexterm><primary>getHandle</primary></indexterm>
+<indexterm><primary>menu object</primary><secondary>getHandle</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--getHandle----------------------------------------><
+
+]]>
+</programlisting>
+
+<para>
+ xx
+</para>
+<variablelist>
+ <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">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </para>
+ </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">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End Menu::getHandle() -->
+
+<section id="mthGetMenuHandle"><title>getMenuHandle</title>
+<indexterm><primary>getMenuHandle</primary></indexterm>
+<indexterm><primary>menu object</primary><secondary>getMenuHandle</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--getMenuHandle(--+--------+--)---------------------------------------------><
+ +--type--+
+]]>
+</programlisting>
+
+<para>
+ xx
+</para>
+<variablelist>
+ <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">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </para>
+ </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">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End menu object::getMenuHandle() -->
+
<section id="mthReleaseMenuHandle"><title>releaseMenuHandle</title>
-<indexterm><primary>releaseMenuHandle</primary>
+<indexterm><primary>releaseMenuHandle</primary></indexterm>
<indexterm><primary>menu object</primary><secondary>releaseMenuHandle</secondary></indexterm>
<programlisting>
<![CDATA[
@@ -583,7 +1226,7 @@
</section> <!-- End Menu::releaseMenuHandle() -->
<section id="mthDestroyClsMenu"><title>destroy</title>
-<indexterm><primary>destroy</primary><secondary>menu object</secondary>
+<indexterm><primary>destroy</primary><secondary>menu object</secondary></indexterm>
<indexterm><primary>menu object</primary><secondary>destroy</secondary></indexterm>
<programlisting>
<![CDATA[
@@ -644,16 +1287,78 @@
</variablelist>
</section> <!-- End Menu::destroy() -->
-<section id="mthGetHandle"><title>getHandle</title>
-<indexterm><primary>getHandle</primary>
-<indexterm><primary>menu object</primary><secondary>getHandle</secondary></indexterm>
+<section id="mthGetPopup"><title>getPopup</title>
+<indexterm><primary>getPopup</primary></indexterm>
+<indexterm><primary>menu object</primary><secondary>getPopup</secondary></indexterm>
<programlisting>
<![CDATA[
->>--getHandle----------------------------------------><
+>>--getPopup(--+--------+--)---------------------------------------------><
+ +--type--+
+]]>
+</programlisting>
+<para>
+ xx
+</para>
+<variablelist>
+ <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">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </para>
+ </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">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
]]>
</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End menu object::getPopup() -->
+<section id="mthInsertPopup"><title>insertPopup</title>
+<indexterm><primary>insertPopup</primary></indexterm>
+<indexterm><primary>menu object</primary><secondary>insertPopup</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--insertPopup(--+--------+--)---------------------------------------------><
+ +--type--+
+]]>
+</programlisting>
+
<para>
xx
</para>
@@ -704,8 +1409,1433 @@
</para>
</listitem></varlistentry>
</variablelist>
-</section> <!-- End Menu::getHandle() -->
+</section> <!-- End menu object::insertPopup() -->
+<section id="mthInsertItem"><title>insertItem</title>
+<indexterm><primary>insertItem</primary></indexterm>
+<indexterm><primary>menu object</primary><secondary>insertItem</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--insertItem(--+--------+--)---------------------------------------------><
+ +--type--+
+]]>
+</programlisting>
+
+<para>
+ xx
+</para>
+<variablelist>
+ <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">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </para>
+ </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">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End menu object::insertItem() -->
+
+<section id="mthInsertSeparator"><title>insertSeparator</title>
+<indexterm><primary>insertSeparator</primary></indexterm>
+<indexterm><primary>menu object</primary><secondary>insertSeparator</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--insertSeparator(--+--------+--)---------------------------------------------><
+ +--type--+
+]]>
+</programlisting>
+
+<para>
+ xx
+</para>
+<variablelist>
+ <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">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </para>
+ </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">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End menu object::insertSeparator() -->
+
+<section id="mthRemovePopup"><title>removePopup</title>
+<indexterm><primary>removePopup</primary></indexterm>
+<indexterm><primary>menu object</primary><secondary>removePopup</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--removePopup(--+--------+--)---------------------------------------------><
+ +--type--+
+]]>
+</programlisting>
+
+<para>
+ xx
+</para>
+<variablelist>
+ <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">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </para>
+ </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">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End menu object::removePopup() -->
+
+<section id="mthRemoveItem"><title>removeItem</title>
+<indexterm><primary>removeItem</primary></indexterm>
+<indexterm><primary>menu object</primary><secondary>removeItem</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--removeItem(--+--------+--)---------------------------------------------><
+ +--type--+
+]]>
+</programlisting>
+
+<para>
+ xx
+</para>
+<variablelist>
+ <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">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </para>
+ </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">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End menu object::removeItem() -->
+
+<section id="mthRemoveSeparator"><title>removeSeparator</title>
+<indexterm><primary>removeSeparator</primary></indexterm>
+<indexterm><primary>menu object</primary><secondary>removeSeparator</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--removeSeparator(--+--------+--)---------------------------------------------><
+ +--type--+
+]]>
+</programlisting>
+
+<para>
+ xx
+</para>
+<variablelist>
+ <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">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </para>
+ </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">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End menu object::removeSeparator() -->
+
+<section id="mthDeletePopup"><title>deletePopup</title>
+<indexterm><primary>deletePopup</primary></indexterm>
+<indexterm><primary>menu object</primary><secondary>deletePopup</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--deletePopup(--+--------+--)---------------------------------------------><
+ +--type--+
+]]>
+</programlisting>
+
+<para>
+ xx
+</para>
+<variablelist>
+ <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">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </para>
+ </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">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End menu object::deletePopup() -->
+
+<section id="mthIsEnabledClsMenu"><title>isEnabled</title>
+<indexterm><primary>isEnabled</primary><secondary>menu object</secondary></indexterm>
+<indexterm><primary>menu object</primary><secondary>isEnabled</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--isEnabled(--+--------+--)---------------------------------------------><
+ +--type--+
+]]>
+</programlisting>
+
+<para>
+ xx
+</para>
+<variablelist>
+ <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">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </para>
+ </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">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End menu object::isEnabled() -->
+
+<section id="mthIsDisabled"><title>isDisabled</title>
+<indexterm><primary>isDisabled</primary></indexterm>
+<indexterm><primary>menu object</primary><secondary>isDisabled</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--isDisabled(--+--------+--)---------------------------------------------><
+ +--type--+
+]]>
+</programlisting>
+
+<para>
+ xx
+</para>
+<variablelist>
+ <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">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </para>
+ </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">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End menu object::isDisabled() -->
+
+<section id="mthIsGrayed"><title>isGrayed</title>
+<indexterm><primary>isGrayed</primary></indexterm>
+<indexterm><primary>menu object</primary><secondary>isGrayed</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--isGrayed(--+--------+--)---------------------------------------------><
+ +--type--+
+]]>
+</programlisting>
+
+<para>
+ xx
+</para>
+<variablelist>
+ <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">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </para>
+ </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">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End menu object::isGrayed() -->
+
+<section id="mthIsChecked"><title>isChecked</title>
+<indexterm><primary>isChecked</primary></indexterm>
+<indexterm><primary>menu object</primary><secondary>isChecked</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--isChecked----------------------------------------><
+]]>
+</programlisting>
+
+<para>
+ xx
+</para>
+<variablelist>
+ <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">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </para>
+ </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">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End menu object::isChecked() -->
+
+<section id="mthEnableClsMenu"><title>enable</title>
+<indexterm><primary>enable</primary><secondary>menu object</secondary></indexterm>
+<indexterm><primary>menu object</primary><secondary>enable</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--enable(--+--------+--)---------------------------------------------><
+ +--type--+
+]]>
+</programlisting>
+
+<para>
+ xx
+</para>
+<variablelist>
+ <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">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </para>
+ </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">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End menu object::enable() -->
+
+<section id="mthDisableClsMenu"><title>disable</title>
+<indexterm><primary>disable</primary><secondary>menu object</secondary></indexterm>
+<indexterm><primary>menu object</primary><secondary>disable</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--disable(--+--------+--)---------------------------------------------><
+ +--type--+
+]]>
+</programlisting>
+
+<para>
+ xx
+</para>
+<variablelist>
+ <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">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </para>
+ </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">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End menu object::disable() -->
+
+<section id="mthGray"><title>gray</title>
+<indexterm><primary>gray</primary></indexterm>
+<indexterm><primary>menu object</primary><secondary>gray</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--gray(--+--------+--)---------------------------------------------><
+ +--type--+
+]]>
+</programlisting>
+
+<para>
+ xx
+</para>
+<variablelist>
+ <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">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </para>
+ </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">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End menu object::gray() -->
+
+<section id="mthCheckClsMenu"><title>check</title>
+<indexterm><primary>check</primary><secondary>menu object</secondary></indexterm>
+<indexterm><primary>menu object</primary><secondary>check</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--check(--+--------+--)---------------------------------------------><
+ +--type--+
+]]>
+</programlisting>
+
+<para>
+ xx
+</para>
+<variablelist>
+ <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">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </para>
+ </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">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End menu object::check() -->
+
+<section id="mthUncheckClsMenu"><title>uncheck</title>
+<indexterm><primary>uncheck</primary><secondary>menu object</secondary></indexterm>
+<indexterm><primary>menu object</primary><secondary>uncheck</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--uncheck(--+--------+--)---------------------------------------------><
+ +--type--+
+]]>
+</programlisting>
+
+<para>
+ xx
+</para>
+<variablelist>
+ <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">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </para>
+ </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">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End menu object::uncheck() -->
+
+<section id="mthCheckRadioButton"><title>checkRadioButton</title>
+<indexterm><primary>checkRadioButton</primary></indexterm>
+<indexterm><primary>menu object</primary><secondary>checkRadioButton</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--checkRadioButton(--+--------+--)---------------------------------------------><
+ +--type--+
+]]>
+</programlisting>
+
+<para>
+ xx
+</para>
+<variablelist>
+ <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">Arguments:</emphasis></term>
+ <listitem>
+ <para>
+ xx
+ <variablelist>
+ <varlistentry><term>TERM</term>
+ <listitem>
+ <para>
+ xx
+ </para>
+ </listitem></varlistentry>
+ </variablelist>
+ </para>
+ </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">Example:</emphasis></term>
+ <listitem>
+ <para>
+ This example ...
+<programlisting>
+<![CDATA[
+
+]]>
+</programlisting>
+ </para>
+ </listitem></varlistentry>
+</variablelist>
+</section> <!-- End menu object::checkRadioButton() -->
+
+<section id="mthHilite"><title>hilite</title>
+<indexterm><primary>hilite</primary></indexterm>
+<indexterm><primary>menu object</primary><secondary>hilite</secondary></indexterm>
+<programlisting>
+<![CDATA[
+>>--hilite(--+--------+--)---------------------------------------------><
+ +--type--+
+]]>
+</programlisting>
+
+<para>
+ xx
+</para>
+<variablelist>
+ <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">Arguments:</emphasis></term>
+ <listite...
[truncated message content] |