Jw: /* LOOP */

2019-06-14T10:51:06Z

LOOP

← Older revision		Revision as of 12:51, 14 June 2019
Line 164:		Line 164:
	The following dialog messages are directly returned to the caller:		The following dialog messages are directly returned to the caller:

	commands and updates ("COMMAND\|UPDATE ctrlidx"),		* commands and updates ("COMMAND\|UPDATE ctrlidx"),
			* popup menu selections ("POPUP itemindex"),
	popup menu selections ("POPUP itemindex"),		* context menu selections ("CMSTAT ctrlidx") and
			* key strokes ("KEY keycode keyname")
	context menu selections ("CMSTAT ctrlidx") and

	key strokes ("KEY keycode keyname")

	Translations are performed for the close/cancel-message ("COMMAND cclt") and the okay-message ("COMMAND oclt"). Because most macros bind local or instance variables to dialog controls, the data exchange must be performed in the calling macro.		Translations are performed for the close/cancel-message ("COMMAND cclt") and the okay-message ("COMMAND oclt"). Because most macros bind local or instance variables to dialog controls, the data exchange must be performed in the calling macro.

Jw at 08:48, 12 December 2017

2017-12-12T08:48:28Z

← Older revision		Revision as of 10:48, 12 December 2017
Line 1:		Line 1:

	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
			{{TOC limit\|2}}
	~~==DOMODALDIALOG==~~

	This function implements a package of commands to work with modal dialogs. The standard program flow for a modal dialog is:		This function implements a package of commands to work with modal dialogs. The standard program flow for a modal dialog is:

Admin: 1 revision: Initial import

2010-11-18T16:31:27Z

1 revision: Initial import

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

Unknown user: initial import

1970-01-01T00:00:00Z

initial import

New page

{{DISPLAYTITLE:{{SUBPAGENAME}}}}

==DOMODALDIALOG==

This function implements a package of commands to work with modal dialogs. The standard program flow for a modal dialog is:

<pre>
[Macro DoModalDialogExample]

// create the dialog item
#dlg := createmenu dialog * $#mac
if '$#dlg[?]' != 'menu' em -1 ; Failed to create the dialog $#mac
// create a dialog map to map control ids to strings
#map := CDlgMap $#dlg
if '$#map[?]' != 'instance' em -1 ; Failed to create the dialog map

// initialize dialog controls
$#dlg $($#map ci ok) BUTTON 0 0 '&OK' * 8
$#dlg $($#map ci cancel) BUTTON 1 0 '&Cancel' * 8

// show the dialog
domodaldialog begin $#dlg

// dialog loop
do forever
// write data from variables to the controls
$#dlg * /W

// get dialog message
readstr '$(domodaldialog loop $#dlg $($#map ci ok) $($#map ci cancel))' #id #par

// update variables with values from the controls
$#dlg * /R

// process message
if '$#id' == COMMAND then
#ctl := set $($#map cn $#par) // get control string (as assigned on control creation)
if '$#ctl' == 'ok' then
// OK - add code here to save changes & end loop
break
else if '$#ctl' == 'cancel' then
// Cancel - end loop
break
else
// process other messages
end
end
end
// close dialog window and delete dialog item
domodaldialog end

// clean up
delete $#dlg $#map

exit 1 int 0
</pre>
For simple dialogs the commands <code>DOMODALDIALOG FOREVER</code> (instead of the message loop) or <code>DOMODALDIALOG BOX</code> (instead of <code>BEGIN</code>, message loop and <code>END</code>) can be used. Instead of this function package also the dialog class <code>MODALDIALOG</code> can be used to implement modal dialogs.

Note that if you want a simple dialog which just displays a message, you can try <code>BUTIL MSGBOX</code> or <code>UM</code>.

Note also, that the class <code>CDlgMap</code> is a nice alternative to <code>DOMODALDIALOG</code>, since it has the same features, but uses control names rather than control indices.

==BEGIN==

Display a modal dialog. The dialog item <var>dlg</var> must be created and configured. For all other modal dialog functions which takes a dialog item argument, the same dialog item <var>dlg</var> as for <code>BEGIN</code> must be used.

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

<code>DOMODALDIALOG BEGIN <var>dlg</var> [ <var>clt</var> ] [ ; <var>wndPos</var> ]</code>

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

;<var>dlg</var>

:The name of the dialog (menu) item.

;<var>ctl</var>

:The index of the control to receive the focus.

;<var>wndPos</var>

:The x and y positions of the window or the keywords <code>left</code>|<code>center</code>|<code>right</code> (x) or <code>top</code>|<code>center</code>|<code>bottom</code> (y) and the monitor in the following format:

:<code>x y ; monitor</code>

:If no monitor is specified, the first monitor is used.

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

void

==BOX==

This is an alternative message loop function for modal dialogs. The BOX function implements the whole dialog processing. First the dialog is displayed (BEGIN), the dialog loop is entered (FOREVER) and the dialog is removed (END). The programmer is only responible to create the dialog. The dialog can not use popup/context-menus and hotkeys.

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

<code>DOMODALDIALOG BOX <var>dlg oclt cclt</var></code>

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

;<var>dlg</var>

:The name of a dialog item.

;<var>oclt</var>

:The index of the OK control.

;<var>cclt</var>

:The index of the Cancel control.

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

The control index of the first command message.

==END==

Closes the last opened modal dialog window and deletes the dialog item.

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

<code>DOMODALDIALOG END</code>

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

void

==FOREVER==

This is an alternative message loop function for modal dialogs. The command FOREVER stays in the message loop (using LOOP) until the first COMMAND message is received. The programmer is responsible to create the dialog and to call the BEGIN and END function. All message processing is performed by the FOREVER function. The dialog can not use popup/context-menus and hotkeys.

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

<code>DOMODALDIALOG FOREVER <var>dlg</var> <var>oclt</var> <var>cclt</var></code>

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

;<var>dlg</var>

:The name of a dialog item.

;<var>oclt</var>

:The index of the OK control.

;<var>cclt</var>

:The index of the Cancel control.

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

The control index of the first command message.

==LOOP==

The <code>LOOP</code> function implements the modal message loop. All non-dialog messages and messages not processed by previously installed message handlers are queued for later processing. The messages from the dialog are returned. Some messages are translated before they are returned.

The following dialog messages are directly returned to the caller:

commands and updates ("COMMAND|UPDATE ctrlidx"),

popup menu selections ("POPUP itemindex"),

context menu selections ("CMSTAT ctrlidx") and

key strokes ("KEY keycode keyname")

Translations are performed for the close/cancel-message ("COMMAND cclt") and the okay-message ("COMMAND oclt"). Because most macros bind local or instance variables to dialog controls, the data exchange must be performed in the calling macro.

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

<code>DOMODALDIALOG LOOP <var>dlg</var> <var>oclt</var> <var>cclt</var></code>

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

;<var>dlg</var>

:The name of dialog (menu) item.

;<var>oclt</var>

:The index of the OKAY control. This is used for translating close messages into a <code><code>COMMAND</code> <var>oclt</var> message.</code>

;<var>cclt</var>

:The index of the CANCEL control. This is used for translating cancel messages into a <code>COMMAND</code> <var>cclt</var> message.

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

The id and parameters of dialog messages:

<code>id par</code>

Array

Programmer Guide/Macro Library/DOMODALDIALOG - Revision history

Jw: /* LOOP */

Jw at 08:48, 12 December 2017

Admin: 1 revision: Initial import

Unknown user: initial import