IlvDialog Class Reference

Dialog class. More...

#include <ilviews/gadgets/idialog.h>

Inheritance diagram for IlvDialog:

List of all members.

Public Member Functions
	IlvDialog (IlvDisplay *display, const char *name, const char *title, const char *filename, IlUInt properties, const IlvRect *rect=0, IlvSystemView transientFor=0)
	Constructor.
	IlvDialog (IlvDisplay *display, const char *name, const char *title, const char *filename, const IlvRect *rect=0)
	Constructor.
	IlvDialog (IlvDisplay *display, const char *name, const char *title, const IlvRect &rect, IlUInt properties=0, IlvSystemView transientFor=0)
	Constructor.
virtual void	apply ()
	Is called when the callback associated with the apply symbol is triggered.
virtual void	cancel ()
	Is called when the callback associated with the cancel symbol is triggered.
virtual void	wait (IlBoolean grab=IlFalse, IlvCursor *cursor=0)
	Displays a modal dialog.
IlBoolean	wasCanceled () const
	Returns the status of the dialog after closing it.

---

Detailed Description

Dialog class.

Library: ilvgadgt

The IlvDialog class is a predefined gadget container with two predefined callbacks: apply and cancel.

See also:

IlvIMessageDialog, IlvColorSelector, IlvFontSelector, IlvIFileSelector, IlvIPromptString

---

Constructor & Destructor Documentation

IlvDialog::IlvDialog	(	IlvDisplay *	display,
		const char *	name,
		const char *	title,
		const IlvRect &	rect,
		IlUInt	properties = 0,
		IlvSystemView	transientFor = 0
	)

Constructor.

Initializes a new instance of the IlvDialog class as a top view.

Parameters:

	display	The connection to the display.
	name	The name of the dialog.
	title	The title of the dialog.
	rect	The size and position of the dialog.
	properties	The properties of the dialog. See the IlvView constructors for more details.
	transientFor	A system view for which the dialog is transient. See the IlvView constructors for more details.

IlvDialog::IlvDialog	(	IlvDisplay *	display,
		const char *	name,
		const char *	title,
		const char *	filename,
		const IlvRect *	rect = 0
	)

Constructor.

Initializes a new instance of the IlvDialog class as a top view, and reads the file specified by filename.

Parameters:

	display	The connection to the display.
	name	The name of the dialog.
	title	The title of the dialog.
	filename	The name of the file to be read.
	rect	The size and position of the dialog. If this parameter is not provided, the size used is the one found in the file read.

IlvDialog::IlvDialog	(	IlvDisplay *	display,
		const char *	name,
		const char *	title,
		const char *	filename,
		IlUInt	properties,
		const IlvRect *	rect = 0,
		IlvSystemView	transientFor = 0
	)

Constructor.

Initializes a new instance of the IlvDialog class as a top view.

Parameters:

	display	The connection to the display.
	name	The name of the dialog.
	title	The title of the dialog.
	filename	The name of the file to be read.
	properties	The properties of the dialog. See the IlvView constructors for more details.
	rect	The size and position of the dialog. If this parameter is not provided, the size used is the one found in the file read.
	transientFor	A system view for which the dialog is transient. See the IlvView constructors for more details.

---

Member Function Documentation

virtual void IlvDialog::apply

(

)

[virtual]

Is called when the callback associated with the apply symbol is triggered.

Sets this object so that wasCanceled returns IlFalse, then hides the dialog box.

See also:

cancel, wasCanceled

Reimplemented in IlvIFileSelector.

virtual void IlvDialog::cancel

(

)

[virtual]

Is called when the callback associated with the cancel symbol is triggered.

Sets this object so that wasCanceled returns IlTrue, then hides the dialog box.

virtual void IlvDialog::wait	(	IlBoolean	grab = IlFalse,
		IlvCursor *	cursor = 0
	)			[virtual]

Displays a modal dialog.

This method is used to implement modal and preemptive dialogs. It basically calls the IlvView method showModal(grab, cursor), which calls show and enters a modal event loop. If an event player (IlvEventPlayer) is active, it tries to use it as a source of events. This method is often used by subclasses of IlvDialog to implement a method that returns a value from the user.

Parameters:

	grab	A Boolean value specifying whether the dialog should be system modal, that is, it grabs input events on the whole system so that, until the function returns, other applications will not be able to get any keyboard or mouse event. In this case, you can specify a cursor to be displayed in through cursor. If grab is set to IlFalse(default), the dialog is application modal, that is, the application does not receive input events in other windows.
	cursor	The cursor that will be used when the dialog is system modal.

IlBoolean IlvDialog::wasCanceled

(

)

const

Returns the status of the dialog after closing it.

Returns:

IlTrue if the dialog has disappeared by calling the cancel method, or IlFalse if the dialog box has disappeared by calling the apply.

See also:

apply, cancel