IliDbOptionMenu Class Reference

Field Gadget. More...

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

Inheritance diagram for IliDbOptionMenu:

List of all members.

Public Member Functions
	IliDbOptionMenu (IlvDisplay *display, const IlvRect &rect, const char *const *labels=0, IlUShort count=0, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
	This constructor creates an option menu.
virtual IlBoolean	f_externalToInternal ()
	Updates the internal value of a field according to its current external representation.
virtual const IliValue &	f_getValue (IlBoolean internalP=IlFalse) const
	Returns the value of the field.
virtual void	f_internalToExternal ()
	Updates the external representation of the field and its display according to its current internal value.
virtual IlBoolean	f_isConsistent () const
	Returns IlTrue if the internal value of the field corresponds to its current external representation.
virtual IlBoolean	f_isReadOnly () const
	Returns IlTrue if the field is read-only.
virtual void	f_setForeignDisplayColumnName (const char *)
	Sets the name of the column of the foreign table that will serve as a result, when the table is used as a map to convert internal values into external representations.
virtual void	f_setForeignTable (IliTable *, IlBoolean owner=IlFalse)
	Sets the foreign table of the field.
virtual void	f_setForeignValueColumnName (const char *)
	Sets the name of the column of the foreign table that will serve as a key, when the table is used as a map to convert internal values into external representations.
virtual void	f_setReadOnly (IlBoolean)
	Sets the read-only property for the field.
virtual IlBoolean	f_setValue (const IliValue &, IlBoolean internalP=IlFalse)
	Sets the value of the field.

---

Detailed Description

Field Gadget.

Library: dbgadget

The IliDbOptionMenu class defines an option menu gadget that opens a pull-down menu when the user clicks on the option menu and can be connected to a data source. The pull-down menu displays a column of the foreign table of the field.

See also:

IliFieldItf, IliTableComboBox.

---

Constructor & Destructor Documentation

IliDbOptionMenu::IliDbOptionMenu	(	IlvDisplay *	display,
		const IlvRect &	rect,
		const char *const *	labels = 0,
		IlUShort	count = 0,
		IlUShort	thickness = IlvDefaultGadgetThickness,
		IlvPalette *	palette = 0
	)

This constructor creates an option menu.

Parameters:

	display	The display.
	rect	The location.
	labels	The labels.
	count	The label count.
	thickness	The border thickness.
	palette	The palette.

---

Member Function Documentation

virtual IlBoolean IliDbOptionMenu::f_externalToInternal

(

)

[virtual]

Updates the internal value of a field according to its current external representation.

Returns:

IlTrue if successful and IlFalse otherwise. Note that this may fail due to the fact that not all external representations can be converted to a value object. For example, this is especially true for text fields that are used to edit numeric or date values.

Reimplemented from IliFieldItf.

virtual const IliValue& IliDbOptionMenu::f_getValue

(

IlBoolean

internal = IlFalse

)

const [virtual]

Returns the value of the field.

Parameters:

internal

If IlTrue, the returned value does not necessarily reflect the state of the field as the user sees it.

Returns:

The value.

Reimplemented from IliFieldItf.

virtual IlBoolean IliDbOptionMenu::f_isConsistent

(

)

const [virtual]

Returns IlTrue if the internal value of the field corresponds to its current external representation.

A return value of IlFalse means that the external representation of the field has been edited by the end-user since the last time one of the member functions, f_setValue, f_externalToInternal, f_internalToExternal or f_complete was successfully called.

Returns:

IlTrue if the internal value of the field corresponds to its current external representation.

Reimplemented from IliFieldItf.

virtual IlBoolean IliDbOptionMenu::f_isReadOnly

(

)

const [virtual]

Returns IlTrue if the field is read-only.

Returns:

IlTrue if the field is read-only.

Reimplemented from IliFieldItf.

virtual void IliDbOptionMenu::f_setForeignDisplayColumnName

(

const char *

name

)

[virtual]

Sets the name of the column of the foreign table that will serve as a result, when the table is used as a map to convert internal values into external representations.

Parameters:

name

The column name.

Reimplemented from IliFieldItf.

virtual void IliDbOptionMenu::f_setForeignTable	(	IliTable *	tbl,
		IlBoolean	owner = IlFalse
	)			[virtual]

Sets the foreign table of the field.

Parameters:

	tbl	The table.
	owner	Determines whether the field will own the table.

Reimplemented from IliFieldItf.

virtual void IliDbOptionMenu::f_setForeignValueColumnName

(

const char *

name

)

[virtual]

Sets the name of the column of the foreign table that will serve as a key, when the table is used as a map to convert internal values into external representations.

Parameters:

name

The column name.

Reimplemented from IliFieldItf.

virtual void IliDbOptionMenu::f_setReadOnly

(

IlBoolean

flag

)

[virtual]

Sets the read-only property for the field.

Parameters:

flag

The read-only flag.

Reimplemented from IliFieldItf.

virtual IlBoolean IliDbOptionMenu::f_setValue	(	const IliValue &	val,
		IlBoolean	internal = IlFalse
	)			[virtual]

Sets the value of the field.

Parameters:

	val	The value.
	internal	If IlFalse, then the external representation and the display of the field are automatically updated.

Returns:

IlTrue if successful, and IlFalse otherwise.

Reimplemented from IliFieldItf.