From: <mie...@us...> - 2011-08-19 05:23:43
|
Revision: 7132 http://oorexx.svn.sourceforge.net/oorexx/?rev=7132&view=rev Author: miesfeld Date: 2011-08-19 03:32:54 +0000 (Fri, 19 Aug 2011) Log Message: ----------- Continue ooDialog doc update Modified Paths: -------------- docs/trunk/oodialog/overview.xml docs/trunk/oodialog/utilityclasses.xml Modified: docs/trunk/oodialog/overview.xml =================================================================== --- docs/trunk/oodialog/overview.xml 2011-08-18 23:45:18 UTC (rev 7131) +++ docs/trunk/oodialog/overview.xml 2011-08-19 03:32:54 UTC (rev 7132) @@ -717,11 +717,9 @@ <computeroutput>constDir</computeroutput>, which probably refers to a directory of constants (symbols.) When an argument in a method is a resource ID, ooDialog first checks to see if the argument is a whole number. If so, it simply uses the number. When the argument is not a number, ooDialog uses the argument to do a look up in the constDir - object. If the argument matches an index in the <computeroutput>.Directory</computeroutput> object, the value of the - index is used as the numeric value of the resource ID. When the argument does not match an index in the constDir, the - method fails. - </para> - </listitem></varlistentry> + object. If the argument matches an index in the object, the value of the index is used as the numeric value of the + resource ID. When the argument does not match an index in the constDir, the method fails. + </para> </listitem></varlistentry> <varlistentry><term><emphasis role="bold">constDir Attribute:</emphasis></term> <listitem> <para> @@ -745,20 +743,17 @@ <para> The global <link linkend="dotConstDir">.constDir</link> works in the same way as the dialog object's constDir attribute. When a symbolic ID needs to be resolved, it can be looked up in the global <computeroutput>.constDir</computeroutput>. - The integration of the global <computeroutput>.constDir</computeroutput> into the ooDialog framework's mechanism for - resolving symbolic IDs is done by allowing the programmer to specify how, or even if, the - <computeroutput>.constDir</computeroutput> should be used. The four choices are to use <emphasis - role="italic">only</emphasis> the <computeroutput>.constDir</computeroutput>, use the - <computeroutput>.constDir</computeroutput> <emphasis role="italic">first</emphasis> and the constDir attribute second, - use the constDir attribute first and the <computeroutput>.consDir</computeroutput> <emphasis - role="italic">last</emphasis>, or <emphasis role="italic">never</emphasis> use the - <computeroutput>.constDir</computeroutput> (i.e., use on the cosntDir attribute). The programmer specifies which of - these strategies is to be used through the <link linkend="mthUseGlobalConstDir">useGlobalConstDir</link> method of the - <link linkend="dotApplication">.application</link> object. (The <computeroutput>.application</computeroutput> object - is an instance of the <link linkend="clsApplicationManager">ApplicationManager</link> class.) + The integration of the global <computeroutput>.constDir</computeroutput> into the mechanism for resolving symbolic + IDs is done by allowing the programmer to specify how, or even if, the <computeroutput>.constDir</computeroutput> + should be used. The four choices are <emphasis role="italic">only</emphasis>, <emphasis + role="italic">first</emphasis>, <emphasis role="italic">last</emphasis>, or <emphasis + role="italic">never</emphasis>. The programmer specifies which of these strategies is to be used through one of the + methods of the <link linkend="dotApplication">.application</link> object. (The + <computeroutput>.application</computeroutput> object is an instance of the <link + linkend="clsApplicationManager">ApplicationManager</link> class.) </para> </listitem></varlistentry> - <varlistentry><term><emphasis role="bold">Usage Strategies:</emphasis></term> + <varlistentry><term><emphasis role="bold">Global .constDir Usage Strategies:</emphasis></term> <listitem> <para> The four strategies work this way. Modified: docs/trunk/oodialog/utilityclasses.xml =================================================================== --- docs/trunk/oodialog/utilityclasses.xml 2011-08-18 23:45:18 UTC (rev 7131) +++ docs/trunk/oodialog/utilityclasses.xml 2011-08-19 03:32:54 UTC (rev 7132) @@ -136,12 +136,30 @@ </para> <para> The <computeroutput>.application</computeroutput> object is used by the programmer to manage application wide settings - and constants. Its use is primarily to change global default values of ooDialog. For instance, by default, a part of - <link linkend="paraAutomaticDataDetection">automatic</link> data detection, part of <link - linkend="sctUnderstandingDataAttributes">data </link> attributes, is on. The - <computeroutput>.application</computeroutput> object can be used to change the default for all dialogs in a - application to off. + and constants. Its use is primarily to change global default values of ooDialog. For instance, by default, <link + linkend="paraAutomaticDataDetection">automatic</link> data detection is on. (Automatic data detection is part of <link + linkend="sctUnderstandingDataAttributes">data </link> attributes.) The <computeroutput>.application</computeroutput> + object can be used to change the default for all dialogs in a application to off. </para> +<para> + It would be most common to use the <computeroutput>.application</computeroutput> object at the start of a program. + This example shows a typical way of changing the default for automatic data detection off for the entire application: +</para> +<programlisting> +<![CDATA[ + + .application~autoDetection(.false) + + dlg = .SimpleDialog~new("UserMenuBar.rc", IDD_MAIN_DIALOG) + if dlg~initCode <> 0 then do + return 99 + end + + dlg~execute("SHOWTOP") + ... + +]]> +</programlisting> </section> @@ -158,9 +176,37 @@ The <computeroutput>.constDir</computeroutput> is the most efficient way to use sybmolic IDs. However, to maintain backwards compatiblity with older ooDialog programs its use is turned off by default. The <link linkend="dotApplication">.application</link> object, through its <link - linkend="mthUseGlobalConstDir">useGlobalConstDir</link> or <link linkend="mthSetDefaults">setDefaults</link> methods - is used to specify how the <computeroutput>.constDir</computeroutput> is used. + linkend="mthUseGlobalConstDir">useGlobalConstDir</link> method or <link linkend="mthSetDefaults">setDefaults</link> + method is used to specify how the <computeroutput>.constDir</computeroutput> is used. </para> +<para> + Other than specifying <emphasis role="italic">how</emphasis> the <computeroutput>.constDir</computeroutput> is to be + used, the <computeroutput>.constDir</computeroutput> is mostly transparent to the programmer. To take best advantage + of the <computeroutput>.constDir</computeroutput> the programmer should read the section in the Brief Overview chapter + that discusses the symbolic ID <link linkend="ovvSymbolicIDMechanism">mechanism</link> in ooDialog. +</para> +<para> + This example shows a typical use of the <computeroutput>.constDir</computeroutput> in a program. The example sets the + program to use <emphasis role="bold">only</emphasis> the <computeroutput>.constDir</computeroutput> and populates the + <computeroutput>.constDir</computeroutput> with the symbolic IDs contained in the file: + <computeroutput>accountingApp.h</computeroutput>. Notice that the <computeroutput>.constDir</computeroutput> is not + even directly referenced. Typically, the programmer never needs to directly access the + <computeroutput>.constDir</computeroutput>. Again, the details are explained in the discussion on the symbolic ID + <link linkend="ovvSymbolicIDMechanism">mechanism</link>. +</para> +<programlisting> +<![CDATA[ + + .application~useGlobalConstDir('O', 'accountingApp.h') + + dlg = .MainMenuDlg~new("QuickBooks.dll", IDD_MAIN_MENU_DIALOG) + if dlg~initCode == 0 then do + dlg~execute("SHOWTOP", IDI_BOOKS) + end + ... + +]]> +</programlisting> </section> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |