rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Data Access Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions | Protected Member Functions
IliEntryField Class Reference

Gadget class. More...

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

Inheritance diagram for IliEntryField:
IlvTextField IliFieldItf IlvGadget IlvSimpleGraphic IlvGraphic IliAbstractComboBox IliDialogComboBox IliTableComboBox

Public Member Functions

 IliEntryField (IlvDisplay *display, const IlvRect &rect, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
 Initializes a new IliEntryField instance. More...
 
 IliEntryField (IlvDisplay *display, const char *label, const IlvRect &rect, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
 Initializes a new IliEntryField instance. More...
 
 IliEntryField (IlvDisplay *display, const IlvPoint &at, const char *label, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0)
 Initializes a new IliEntryField instance. More...
 
virtual IlBoolean f_externalToInternal ()
 Updates the internal value of a field according to its current external representation. More...
 
virtual IlvAlignment f_getAlignment () const
 Returns the text alignment of the field. More...
 
virtual const IliFormatf_getFormat () const
 Returns the format used to derive the external representation of the field from its internal value. More...
 
virtual const IliInputMaskf_getMask () const
 Returns the input mask used to edit values in the field. More...
 
virtual IlShort f_getMaxLength () const
 Returns the maximum length allowed for the external representation of the field. More...
 
virtual const IliValuef_getValue (IlBoolean internalP=IlFalse) const
 Returns the value of the field. More...
 
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. More...
 
virtual IlBoolean f_isReadOnly () const
 Returns IlTrue if the field is read-only. More...
 
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_setAlignment (IlvAlignment)
 Sets the text alignment of the field. More...
 
virtual void f_setFormat (const IliFormat &)
 Sets the format used to derive the external representation of the field from its internal value. More...
 
virtual void f_setInputModified (IlBoolean f)
 Sets the input-modified attribute of the field. More...
 
virtual void f_setMask (const IliInputMask &)
 Sets the input mask. More...
 
virtual void f_setMaxLength (IlShort)
 Sets the maximum length allowed for the external representation of the field. More...
 
virtual void f_setReadOnly (IlBoolean)
 Sets the read-only property for the field. More...
 
virtual IlBoolean f_setValue (const IliValue &, IlBoolean internalP=IlFalse)
 Sets the value of the field. More...
 
- Public Member Functions inherited from IliFieldItf
void f_applyReferences (IlvApplyObject f, IlAny a)
 Should be called when the applyReferences member function, of the gadget class, is called. More...
 
virtual IlBoolean f_complete ()
 Updates the internal value of the field, according to its current external representation and its foreign table, provided completion is enabled for the field. More...
 
virtual void f_enableCompletion (IlBoolean)
 Sets the completion property of the field. More...
 
const IliDataSourcef_getDataSource () const
 Returns the data source. More...
 
IliDataSourcef_getDataSource ()
 Returns the data source. More...
 
const char * f_getDataSourceColumnName () const
 Returns the name of the column. More...
 
const char * f_getDataSourceName () const
 Returns the name of the data source, which this field is (or must be) connected to. More...
 
virtual const
IliTablePropertyManager
f_getEffectiveTablePropertyManager () const
 Returns the effective table property manager. More...
 
virtual IliTablePropertyManagerf_getEffectiveTablePropertyManager ()
 Returns the effective table property manager. More...
 
const char * f_getForeignDataSourceName () const
 Returns the name of the foreign data source. More...
 
const char * f_getForeignDisplayColumnName () const
 Returns the name of the column of the foreign table that will serve as a result. More...
 
const IliTablef_getForeignTable () const
 Returns the foreign table. More...
 
IliTablef_getForeignTable ()
 Returns the foreign table. More...
 
const char * f_getForeignValueColumnName () const
 Returns the name of the column of the foreign table that will serve as a key. More...
 
const IlvGadgetf_getGadget () const
 Returns the constant gadget associated with this field through multiple inheritance. More...
 
IlvGadgetf_getGadget ()
 Returns the gadget associated with this field through multiple inheritance. More...
 
const IlvGraphicf_getGraphic () const
 Returns the constant graphic associated with this field through multiple inheritance. More...
 
IlvGraphicf_getGraphic ()
 Returns the graphic associated with this field through multiple inheritance. More...
 
virtual const char * f_getLabel () const
 Returns the label displayed by the field gadget. More...
 
const char * f_getTablePropertyManagerName () const
 Returns the name of the table property manager used by this field. More...
 
IlInt f_getVisibleRowsCount () const
 Returns the number of rows that will be displayed when the foreign table is displayed. More...
 
virtual IlBoolean f_hasLabel () const
 Returns IlTrue if the field gadget can display a label. More...
 
virtual void f_ignoreModifiedState (IlBoolean ignore)
 Sets the ignore modified state attribute of the field. More...
 
virtual IlBoolean f_isAutoFitPullDown () const
 Returns IlTrue if the width of the pull-down menu is automatically computed so that its contents fit. More...
 
IlBoolean f_isCompletionEnabled () const
 Returns IlTrue if completion is enabled. More...
 
IlBoolean f_isConnectedToDataSource () const
 Returns IlTrue if the field is currently connected to a column of a data source. More...
 
IlBoolean f_isConstrained () const
 Returns IlTrue if the foreign table limits the set of possible internal values for this field. More...
 
IlBoolean f_isDataSourceOwner () const
 Returns IlTrue if the field owns the data source. More...
 
IlBoolean f_isForeignTableOwner () const
 Returns IlTrue if the field owns its foreign table. More...
 
virtual IlBoolean f_isInputModified () const
 Returns IlTrue if the external representation has been edited by the end-user. More...
 
virtual IlBoolean f_isModifiedStateIgnored () const
 Returns IlTrue if the modified states are ignored when the f_setValue function is called. More...
 
IlBoolean f_isUsingTableProperties () const
 Returns IlTrue if the field uses table properties. More...
 
void f_killFocus ()
 Should be called when the gadget loses the focus.
 
virtual void f_setAutoFitPullDown (IlBoolean flag)
 Enables/disables the automatic width computing of the pull-down menu. More...
 
virtual void f_setConstrained (IlBoolean flag)
 Sets the constrained property of the field. More...
 
virtual void f_setDataSourceColumnName (const char *name)
 Sets the name of the column. More...
 
virtual void f_setDataSourceName (const char *name)
 Sets the name of the data source. More...
 
void f_setFocus ()
 Should be called when the gadget receives the focus.
 
virtual void f_setForeignDataSourceName (const char *name)
 Sets the name of the foreign data source. More...
 
virtual void f_setForeignDisplayColumnName (const char *name)
 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. More...
 
virtual void f_setForeignTable (IliTable *tbl, IlBoolean owner=IlFalse)
 Sets the foreign table of the field. More...
 
virtual void f_setForeignValueColumnName (const char *name)
 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. More...
 
virtual void f_setLabel (const char *label)
 Sets the label of the field gadget. More...
 
virtual void f_setTablePropertyManagerName (const char *name)
 Sets the name of the table property manager to use. More...
 
virtual void f_setVisibleRowsCount (IlInt count)
 Sets the number of rows to be displayed when the foreign table is displayed. More...
 
virtual IlBoolean f_supportsTableProperties () const
 Returns IlTrue if this gadget supports table properties. More...
 
virtual void f_useTableProperties (IlBoolean flag)
 Enables/Disables the use of the table properties. More...
 

Protected Member Functions

const char * formatValue (IliString &dest, const IliValue &val)
 Returns a character string which contains the formatted value. More...
 
void setLabelSilently (const char *label)
 Sets a new label and launches the drawing of the new label. More...
 
virtual void valueToLabel (const IliValue &value)
 Sets the value to the label of the entry field. More...
 
- Protected Member Functions inherited from IliFieldItf
void f_read (IlvInputFile &input)
 Should be called by the stream-based constructor of the gadget. More...
 
void f_set (IlvGraphic *g, const IliFieldItf &other)
 Should be called by the copy constructor of the graphic class that is passed. More...
 
void f_setGraphic (IlvGraphic *g)
 Should be called by all constructors of the graphic class (except the copy constructor). More...
 
void f_subscribe ()
 Should be called after the setHolder member function of the gadget class.
 
void f_unsubscribe ()
 Should be called before the setHolder member function of the gadget class. More...
 
void f_write (IlvOutputFile &output) const
 Should be called by the write member function of the gadget class. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from IliFieldItf
static IlvSymbolInputModifiedSymbol ()
 Returns the name of the callback that the field gadget will invoke every time the field input-modified property changes from IlFalse to IlTrue. More...
 

Detailed Description

Gadget class.

Library: dbgadget

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

Constructor & Destructor Documentation

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

Initializes a new IliEntryField instance.

Parameters
displayThe display.
rectThe location.
thicknessThe border thickness.
paletteThe palette.
IliEntryField::IliEntryField ( IlvDisplay display,
const char *  label,
const IlvRect rect,
IlUShort  thickness = IlvDefaultGadgetThickness,
IlvPalette palette = 0 
)

Initializes a new IliEntryField instance.

Parameters
displayThe display.
labelThe label.
rectThe location.
thicknessThe border thickness.
paletteThe palette.
IliEntryField::IliEntryField ( IlvDisplay display,
const IlvPoint at,
const char *  label,
IlUShort  thickness = IlvDefaultGadgetThickness,
IlvPalette palette = 0 
)

Initializes a new IliEntryField instance.

Parameters
displayThe display.
atThe position.
labelThe label.
thicknessThe border thickness.
paletteThe palette.

Member Function Documentation

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

Reimplemented in IliTableComboBox.

virtual IlvAlignment IliEntryField::f_getAlignment ( ) const
virtual

Returns the text alignment of the field.

Returns
The alignment.

Reimplemented from IliFieldItf.

virtual const IliFormat& IliEntryField::f_getFormat ( ) const
virtual

Returns the format used to derive the external representation of the field from its internal value.

Returns
The format.

Reimplemented from IliFieldItf.

virtual const IliInputMask& IliEntryField::f_getMask ( ) const
virtual

Returns the input mask used to edit values in the field.

Currently, the classes that take into account the input mask are: IliEntryField and its subclasses.

Returns
The mask.

Reimplemented from IliFieldItf.

virtual IlShort IliEntryField::f_getMaxLength ( ) const
virtual

Returns the maximum length allowed for the external representation of the field.

Returns
The maximum.

Reimplemented from IliFieldItf.

virtual const IliValue& IliEntryField::f_getValue ( IlBoolean  internal = IlFalse) const
virtual

Returns the value of the field.

Parameters
internalIf 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 IliEntryField::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.

Reimplemented in IliTableComboBox.

virtual IlBoolean IliEntryField::f_isReadOnly ( ) const
virtual

Returns IlTrue if the field is read-only.

Returns
IlTrue if the field is read-only.

Reimplemented from IliFieldItf.

Reimplemented in IliAbstractComboBox.

virtual void IliEntryField::f_setAlignment ( IlvAlignment  align)
virtual

Sets the text alignment of the field.

Parameters
alignThe alignment.

Reimplemented from IliFieldItf.

virtual void IliEntryField::f_setFormat ( const IliFormat fmt)
virtual

Sets the format used to derive the external representation of the field from its internal value.

Parameters
fmtThe format.

Reimplemented from IliFieldItf.

virtual void IliEntryField::f_setInputModified ( IlBoolean  flag)
virtual

Sets the input-modified attribute of the field.

This member function is presented here for completeness. However, it should be used with care since it may cause the field, and other related components, to be in error with regard to the current state of the field.

Parameters
flagThe input-modified attribute.

Reimplemented from IliFieldItf.

virtual void IliEntryField::f_setMask ( const IliInputMask msk)
virtual

Sets the input mask.

Parameters
mskThe mask.

Reimplemented from IliFieldItf.

virtual void IliEntryField::f_setMaxLength ( IlShort  vmax)
virtual

Sets the maximum length allowed for the external representation of the field.

Parameters
vmaxThe maximum length.

Reimplemented from IliFieldItf.

virtual void IliEntryField::f_setReadOnly ( IlBoolean  flag)
virtual

Sets the read-only property for the field.

Parameters
flagThe read-only flag.

Reimplemented from IliFieldItf.

Reimplemented in IliAbstractComboBox.

virtual IlBoolean IliEntryField::f_setValue ( const IliValue val,
IlBoolean  internal = IlFalse 
)
virtual

Sets the value of the field.

Parameters
valThe value.
internalIf IlFalse, then the external representation and the display of the field are automatically updated.
Returns
IlTrue if successful, and IlFalse otherwise.

Reimplemented from IliFieldItf.

Reimplemented in IliTableComboBox.

const char* IliEntryField::formatValue ( IliString dest,
const IliValue val 
)
protected

Returns a character string which contains the formatted value.

Parameters
destThe string which contains the formatted value.
valThe value.
Returns
A character string which contains the formatted value.
void IliEntryField::setLabelSilently ( const char *  label)
protected

Sets a new label and launches the drawing of the new label.

Parameters
labelThe label.
virtual void IliEntryField::valueToLabel ( const IliValue value)
protectedvirtual

Sets the value to the label of the entry field.

However if a format is defined the function formatValue is called to format the value. If there is no format but there is a mask, the value is formatted with the mask.

At the end the function setLabelSilently is called to set the value to the label and to launch the drawing of the label.

Parameters
valueThe value.

Reimplemented in IliTableComboBox.


© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.