IliDialogComboBox Class Reference

Field gadget class. More...

#include <ilviews/dataccess/gadgets/dlgcombo.h>

Inheritance diagram for IliDialogComboBox:

List of all members.

Public Member Functions
virtual void	close ()
	Hides the pull-down menu or dialog box.
virtual IlBoolean	isOpen () const
	Returns IlTrue if the pull-down menu or the dialog box is currently displayed.
virtual void	onApply ()
	Called when the dialog interaction with the user is completed, the dialog has been dismissed and when the outcome of the interaction is not a user cancellation.
virtual void	open (IlBoolean grab)
	Causes a pull-down menu or dialog box to be displayed.
virtual IlBoolean	wasCanceled () const
	Returns IlTrue if the user has canceled the last dialog interaction.
Static Public Member Functions
static IlvSymbol *	ApplySymbol ()
	Returns the symbol that names the callback called by onApply.
Protected Member Functions
	IliDialogComboBox (IlvDisplay *display, const IlvRect &rect, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
	The constructor creates an IliDialogComboBox.
IlvDialog *	getDialog () const
	Returns the dialog that is used by the combo box.
virtual void	onEndDialog ()
	Called just after the dialog interaction with the user is completed and the dialog has been dismissed.
virtual void	onInitDialog ()
	Called when the dialog box is about to be shown.
void	setDialog (IlvDialog *dlg, IlBoolean owner=IlTrue)
	Sets the dialog of the combo box.
virtual void	showDialog (IlBoolean grab)
	Called when the dialog needs to be shown.

---

Detailed Description

Field gadget class.

Library: dbgadget

The IliDialogComboBox defines a combo box gadget that opens a dialog box when the user clicks on the button inside the gadget. The button in this combo box gadget shows three dots instead of an arrow. This class serves as a base class for other, more specialized classes, that define precisely which dialog box should be used.

See also:

IliAbstractComboBox, IlvDialog.

---

Constructor & Destructor Documentation

IliDialogComboBox::IliDialogComboBox	(	IlvDisplay *	display,
		const IlvRect &	rect,
		IlUShort	thickness = IlvDefaultGadgetThickness,
		IlvPalette *	palette = 0
	)			[protected]

The constructor creates an IliDialogComboBox.

Parameters:

	display	The display.
	rect	The location.
	thickness	The border thickness.
	palette	The palette.

---

Member Function Documentation

static IlvSymbol* IliDialogComboBox::ApplySymbol

(

)

[static]

Returns the symbol that names the callback called by onApply.

Returns:

The callback name.

virtual void IliDialogComboBox::close

(

)

[virtual]

Hides the pull-down menu or dialog box.

The type of object that is hidden depends on the subclass of IliAbstractComboBox being used.

Reimplemented from IliAbstractComboBox.

IlvDialog* IliDialogComboBox::getDialog

(

)

const [protected]

Returns the dialog that is used by the combo box.

Initially, this property is set to NULL.

Returns:

The dialog.

virtual IlBoolean IliDialogComboBox::isOpen

(

)

const [virtual]

Returns IlTrue if the pull-down menu or the dialog box is currently displayed.

Returns:

The pull-down menu (or dialog box) visibility.

Reimplemented from IliAbstractComboBox.

virtual void IliDialogComboBox::onApply

(

)

[virtual]

Called when the dialog interaction with the user is completed, the dialog has been dismissed and when the outcome of the interaction is not a user cancellation.

The default implementation calls the Apply callback.

virtual void IliDialogComboBox::onEndDialog

(

)

[protected, virtual]

Called just after the dialog interaction with the user is completed and the dialog has been dismissed.

The default implementation does nothing.

virtual void IliDialogComboBox::onInitDialog

(

)

[protected, virtual]

Called when the dialog box is about to be shown.

It sets the dialog properties using the setDialog member function. The default implementation does nothing.

virtual void IliDialogComboBox::open

(

IlBoolean

grab

)

[virtual]

Causes a pull-down menu or dialog box to be displayed.

Whether the object displayed is a pull-down menu or a dialog box depends on the subclass of IliAbstractComboBox being used.

Parameters:

grab

Reserved for future use and its value must always be IlFalse.

Reimplemented from IliAbstractComboBox.

void IliDialogComboBox::setDialog	(	IlvDialog *	dlg,
		IlBoolean	owner = IlTrue
	)			[protected]

Sets the dialog of the combo box.

Parameters:

	dlg	The dialog.
	owner	If IlTrue, the combo box becomes the owner of the dialog.

virtual void IliDialogComboBox::showDialog

(

IlBoolean

grab

)

[protected, virtual]

Called when the dialog needs to be shown.

The default implementation does the following:

 getDialog()->wait(grab);

virtual IlBoolean IliDialogComboBox::wasCanceled

(

)

const [virtual]

Returns IlTrue if the user has canceled the last dialog interaction.

Returns:

IlTrue if the user has canceled the last dialog interaction.