Dialog Event Handlers

Typedefs
using	pcl::Dialog::execute_event_handler = void(Control::*)(Dialog &sender)
using	pcl::Dialog::return_event_handler = void(Control::*)(Dialog &sender, int retCode)

Functions
void	pcl::Dialog::OnExecute (execute_event_handler handler, Control &receiver)
void	pcl::Dialog::OnReturn (return_event_handler handler, Control &receiver)

Detailed Description

Typedef Documentation

execute_event_handler

using pcl::Dialog::execute_event_handler = void (Control::*)( Dialog& sender )

Defines the prototype of a dialog execution event handler.

A dialog execution event is generated when a dialog control is executed by invoking its Execute() member function.

Parameters

sender

The dialog that sends an execution event.

Definition at line 240 of file Dialog.h.

return_event_handler

using pcl::Dialog::return_event_handler = void (Control::*)( Dialog& sender, int retCode )

Defines the prototype of a dialog return event handler.

A dialog return event is generated when a dialog control terminates execution by invoking its Return() member function.

Parameters

sender	The dialog that sends a return event.
retCode	Return code passed to the Return() member function. This is also the return value of Execute().

Definition at line 255 of file Dialog.h.

Function Documentation

OnExecute()

void pcl::Dialog::OnExecute	(	execute_event_handler	handler,
		Control &	receiver
	)

Sets the execution event handler for this dialog.

Parameters

handler	The dialog execution event handler. Must be a member function of the receiver object's class.
receiver	The control that will receive execution events from this dialog.

OnReturn()

void pcl::Dialog::OnReturn	(	return_event_handler	handler,
		Control &	receiver
	)

Sets the return event handler for this dialog.

Parameters

handler	The dialog return event handler. Must be a member function of the receiver object's class.
receiver	The control that will receive return events from this dialog.