Jw: /* Parameters: */

2019-10-23T08:21:34Z

Parameters:

← Older revision		Revision as of 10:21, 23 October 2019
Line 58:		Line 58:
	;<var>windowPos</var>		;<var>windowPos</var>

	:The position to display the dialog window. See DoModalDialog Begin for a description of this parameter.		:The position to display the dialog window. See [[Programmer_Guide/Macro_Library/DOMODALDIALOG#BEGIN\|DoModalDialog Begin]] for a description of this parameter.

	=====Notes:=====		=====Notes:=====

Jw: /* Result: */

2018-11-14T08:25:38Z

Result:

← Older revision		Revision as of 10:25, 14 November 2018
Line 165:		Line 165:

	The name of the control (<var>controlName</var>) if the control is defined, or an empty string.		The name of the control (<var>controlName</var>) if the control is defined, or an empty string.



	===LOOP===		===LOOP===

Jw: /* CDlgMap Member Variables */

2018-07-20T10:48:35Z

CDlgMap Member Variables

← Older revision		Revision as of 12:48, 20 July 2018
Line 33:		Line 33:
	The <code>CDlgMap</code> class has the following member variables:		The <code>CDlgMap</code> class has the following member variables:

	;<var>&dlg</var>		;<var>&dlg</var>:The dialog this class is mapping control ids to names.
			;<var>&map</var>:The extended table mapping indices to names.
	:The dialog this class is mapping control ids to names.		;<var>&owned</var>: True if the dialog was created by CDlgMap in the constructor.
			;<var>&modal</var>: Flag used for begin/end modal dialog
	;<var>&map</var>

	:The extended table mapping indices to names.

	;<var>&~~ciBase~~</var>

	:~~The control index base. Mapping starts from this value.~~

	====Member Functions====		====Member Functions====

Jw: /* CDlgMap : CObj */

2017-10-23T06:40:24Z

CDlgMap : CObj

← Older revision		Revision as of 08:40, 23 October 2017
Line 3:		Line 3:
	==CDlgMap : CObj==		==CDlgMap : CObj==

	A class to help map dialog control indices to meaningful keywords. If you use lots of controls in your dialogs, then associating them to keywords makes programming and maintenance a lot easier.		A class to help map [[Programmer_Guide/Shell_Items/Dialog\|dialog]] control indices to meaningful keywords. If you use lots of controls in your dialogs, then associating them to keywords makes programming and maintenance a lot easier.

	'''Constructor'''		'''Constructor'''

Jw: /* Parameters: */

2016-09-19T09:53:31Z

Parameters:

← Older revision		Revision as of 11:53, 19 September 2016
Line 19:		Line 19:
	:The id of a dialog item or an asterisk if the dialog should be created on construction. If the dialog map creates it's own dialog, it also destroys it on destruction.		:The id of a dialog item or an asterisk if the dialog should be created on construction. If the dialog map creates it's own dialog, it also destroys it on destruction.

	See the macro <code>CREATEMENU</code> for details of the other parameters.		See the macro <code>[[Programmer_Guide/Macro_Library/CREATEMENU\|CREATEMENU]]</code> for details of the other parameters.

	=====Result:=====		=====Result:=====

Jw at 09:52, 19 September 2016

2016-09-19T09:52:19Z

← Older revision		Revision as of 11:52, 19 September 2016
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
			{{TOC limit\|3}}
	==CDlgMap : CObj==		==CDlgMap : CObj==

Toni: moved Programmer Guide/Class Library/CDlgMap : CObj to Programmer Guide/Macro Library/CDlgMap

2011-04-28T07:58:10Z

moved Programmer Guide/Class Library/CDlgMap : CObj to Programmer Guide/Macro Library/CDlgMap

← Older revision	Revision as of 09:58, 28 April 2011
(No difference)

Admin: 1 revision: Initial import

2010-11-18T16:31:30Z

1 revision: Initial import

← Older revision	Revision as of 18:31, 18 November 2010
(No difference)

193.171.195.8: initial import

2010-05-17T13:05:27Z

initial import

New page

{{DISPLAYTITLE:{{SUBPAGENAME}}}}
==CDlgMap : CObj==

A class to help map dialog control indices to meaningful keywords. If you use lots of controls in your dialogs, then associating them to keywords makes programming and maintenance a lot easier.

'''Constructor'''

Create a new dialog map instance for the dialog-item <var>dlg</var>. Note that this is the same as <code>CObj NEW CDlgMap</code> <var>dlg</var>.

=====Usage:=====

<code>CDlgMap <var>dlg</var>|* [ <var>type</var> <var>icon</var> <var>title</var> ]</code>

=====Parameters:=====

;<var>dlg</var>

:The id of a dialog item or an asterisk if the dialog should be created on construction. If the dialog map creates it's own dialog, it also destroys it on destruction.

See the macro <code>CREATEMENU</code> for details of the other parameters.

=====Result:=====

Always returns 0.

=====Examples:=====

<code>#map := CDlgMap $#dlg</code>

====CDlgMap Member Variables====

The <code>CDlgMap</code> class has the following member variables:

;<var>&dlg</var>

:The dialog this class is mapping control ids to names.

;<var>&map</var>

:The extended table mapping indices to names.

;<var>&ciBase</var>

:The control index base. Mapping starts from this value.

====Member Functions====

The <code>CDlgMap</code> class has the following member functions. See CObj Member Functions for a list of functions implemented in the parent class.

===BEGIN===

Displays the dialog as a modal dialog.

=====Usage:=====

<code><var>mapinst</var> BEGIN [ <var>focuscontrol</var> ; <var>windowpos</var> ]</code>

=====Parameters:=====

;<var>focusControl</var>

:The control name assigned to the control which should receive keyboard focus.

;<var>windowPos</var>

:The position to display the dialog window. See DoModalDialog Begin for a description of this parameter.

=====Notes:=====

This function uses the macro <code>DoModalDialog</code>.

===CI===

Get the control index mapped to the string <var>controlName</var>. If the name does not exist in the mapping table, then the next free index is mapped to the string <var>controlName</var> and the index is returned. The first index returned by <code>CI</code> is the same as the number of dialog controls (0 for a new dialog).

=====Usage:=====

<code><var>dlgmap</var> CI <var>controlName</var></code>

=====Parameters:=====

;<var>controlName</var>

:The name to map to the control or an empty string to use the control index as the name.

=====Result:=====

The control index mapped to the string <var>controlName</var>.

===CN===

Get the name mapped to the control index <var>cindex</var>.

=====Usage:=====

<code><var>dlgmap</var> CN <var>cindex</var></code>

=====Parameters:=====

;<var>cindex</var>

:The index of the control.

=====Result:=====

The name mapped to the control index <var>cindex</var> or an empty string if the index is not mapped.

===DESTROY===

=====Usage:=====

<code><var>dlgmap</var> DESTROY</code>

=====Description:=====

Delete the dialog map object <var>dlgmap</var>. Note that this is the same as calling <code>COBJ DELETE</code> <var>dlgmap</var>.

===DLG===

Returns the dialog map's dialog item.

=====Usage:=====

<code><var>mapinst</var> Dlg</code>

=====Result:=====

The dialog map's dialog item.

===END===

End the modal dialog and destroy map. This is the same as <var>mapinst</var> <code>DESTROY</code>. If the dialog item was created in the constructer or a modal dialog loop has been started, the dialog item is also deleted.

=====Usage:=====

<code><var>mapinst</var> END</code>

===FCI===

=====Usage:=====

<code><var>dlgmap</var> FCI</code>

=====Result:=====

The index of the first (lowest) mapped control.

=====Description:=====

Get the index of the first mapped control. This is actually the next free dialog index at the time of construction and therefore can be greater than 1 even if there are no mapped controls.

===ISCI===

Query whether a control with a specified name or index exists.

=====Usage:=====

<code><var>dlgmap</var> ISCI <var>controlName</var>|<var>controlIndex</var></code>

=====Parameters:=====

;<var>controlName</var>

:The name used to map a control index in a previous <code>ci</code> function call.

;<var>controlIndex</var>

:An index greater or equal to <code>0</code>.

=====Result:=====

The name of the control (<var>controlName</var>) if the control is defined, or an empty string.

===LOOP===

Executes the modal dialog message loop (via DoModalDialog Loop).

=====Usage:=====

<code><var>mapinst</var> LOOP <var>okayControl</var> <var>cancelControl</var></code>

=====Parameters:=====

;<var>okayControl</var>

:Either the index or control name of the dialog control to use as the OK button (when it is pressed, the dialog closes).

;<var>cancelControl</var>

:Either the index or control name of the dialog control to use as the cancel button (when it is pressed, the dialog closes).

=====Result:=====

A message id and parameters :

<code>msgId msgPar</code>

For <code>COMMAND</code> and <code>UPDATE</code> messages, the original <code>msgPar</code> is converted to a control name string if possible (if it has an associated name in the map).

===NC===

=====Usage:=====

<code><var>dlgmap</var> NC</code>

=====Result:=====

The number of controls that have been mapped.

=====Description:=====

Get the total number of controls which are mapped.

===SETCI===

Like the CI member function, this function creates a map between a string and an integer id. The result returned, however, can be used directly as the first part of a <code>SET dialog controlIndex</code> command.

=====Usage:=====

<code><var>dlgmap</var> SETCI <var>controlName</var></code>

=====Parameters:=====

;<var>controlName</var>

:The name to map to the control or an empty string to use the control index as the name.

=====Result:=====

Returns the dialog item and control index mapped to the string <var>controlName</var>:

<code>dialogItem controlIndex</code>

===SETHELP===

The <code>CDlgMap</code> function <code>SETHELP</code> associates the dialog with a help topic referenced by an <code>IREF</code>. When used in conjunction with the <code>CDlgMap</code> functions <code>BEGIN</code> and <code>END</code>, the F1 key will call the relevant help topic if pressed whilst the associated dialog is being displayed.

=====Usage:=====

<code><var>dlgmap</var> SETHELP <var>iref</var></code>

=====Parameters:=====

;<var>iref</var>

:The IREF to the relevant help topic. Note that the IREF must be present in the stxconfig.xml file.

=====Result:=====

Returns the dialog item and control index mapped to the string <var>controlName</var>:

<code>dialogItem controlIndex</code>

=====Examples:=====

<code>$#dmap sethelp 'Toolbox/AutoSeg/ASeg_Short_Clicks_Segmentation'</code>

====Examples====

<pre>
[Macro cdlgmap_example]
// create map and dialog
#dmap := cdlgmap * dialog * 'CDlgMap Test'
// create controls
$($#dmap setci ok) button 0 0 '&OK' * 8
$($#dmap setci cancel) button 1 0 '&Cancel' * 8
// display dialog and react to user input
$#dmap begin
do forever
$($#dmap dlg) /W
// use the CDlgMap LOOP command, which translates dialog ids
// into control names
readstr '$($#dmap loop ok cancel)' #msgId #ctrlName
$($#dmap dlg) /R
if '$#msgId' == 'command' then
if '$#ctrlName' == 'ok' then
// save settings
break
else if '$#ctrlName' == 'cancel' then
break
end
else if '$#msgId' == 'update' then
// react to update
end
end
// destroy dialog and map
$#dmap end
exit 1 int 0
</pre>

Programmer Guide/Macro Library/CDlgMap - Revision history

Jw: /* Parameters: */

Jw: /* Result: */

Jw: /* CDlgMap Member Variables */

Jw: /* CDlgMap : CObj */

Jw: /* Parameters: */

Jw at 09:52, 19 September 2016

Toni: moved Programmer Guide/Class Library/CDlgMap : CObj to Programmer Guide/Macro Library/CDlgMap

Admin: 1 revision: Initial import

193.171.195.8: initial import