IliDbText Class Reference

Field gadget class. More...

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

Inheritance diagram for IliDbText:

List of all members.

Public Member Functions
	IliDbText (IlvDisplay *display, const IlvRect &rect, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
	The constructor creates a db-text gadget.
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_selectTextForAppend ()
	Deselects all the text and positions the editing caret at the end of the text, provided the field gadget supports text selection.
virtual void	f_selectTextForOverwrite ()
	Selects all the text, provided the field gadget supports text selection.
virtual void	f_setReadOnly (IlBoolean f)
	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 class.

Library: dbgadget

The IliDbText class defines a text gadget that can be connected to a data source.

See also:

IliFieldItf.

---

Constructor & Destructor Documentation

IliDbText::IliDbText	(	IlvDisplay *	display,
		const IlvRect &	rect,
		IlUShort	thickness = IlvDefaultGadgetThickness,
		IlvPalette *	palette = 0
	)

The constructor creates a db-text gadget.

Parameters:

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

---

Member Function Documentation

virtual IlBoolean IliDbText::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& IliDbText::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 IliDbText::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 IliDbText::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 IliDbText::f_setReadOnly

(

IlBoolean

flag

)

[virtual]

Sets the read-only property for the field.

Parameters:

flag

The read-only flag.

Reimplemented from IliFieldItf.

virtual IlBoolean IliDbText::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.