|
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 flag) |
| Sets the completion property of the field. 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...
|
|
IliDataSource * | f_getDataSource () |
| Returns the data source. More...
|
|
const IliDataSource * | f_getDataSource () const |
| 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 IliTablePropertyManager * | f_getEffectiveTablePropertyManager () |
| Returns the effective table property manager. More...
|
|
virtual const IliTablePropertyManager * | f_getEffectiveTablePropertyManager () const |
| 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...
|
|
IliTable * | f_getForeignTable () |
| Returns the foreign table. More...
|
|
const IliTable * | f_getForeignTable () const |
| 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...
|
|
virtual const IliFormat & | f_getFormat () const |
| Returns the format used to derive the external representation of the field from its internal value. More...
|
|
IlvGadget * | f_getGadget () |
| Returns the gadget associated with this field through multiple inheritance. More...
|
|
const IlvGadget * | f_getGadget () const |
| Returns the constant gadget associated with this field through multiple inheritance. More...
|
|
IlvGraphic * | f_getGraphic () |
| Returns the graphic associated with this field through multiple inheritance. More...
|
|
const IlvGraphic * | f_getGraphic () const |
| Returns the constant graphic associated with this field through multiple inheritance. More...
|
|
virtual const char * | f_getLabel () const |
| Returns the label displayed by the field gadget. More...
|
|
virtual const IliInputMask & | f_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...
|
|
const char * | f_getTablePropertyManagerName () const |
| Returns the name of the table property manager used by this field. More...
|
|
virtual const IliValue & | f_getValue (IlBoolean internal=IlFalse) const |
| Returns the value of the 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 void | f_internalToExternal () |
| Updates the external representation of the field and its display according to its current internal value.
|
|
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...
|
|
virtual IlBoolean | f_isConsistent () const |
| Returns IlTrue if the internal value of the field corresponds to its current external representation. 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...
|
|
virtual IlBoolean | f_isReadOnly () const |
| Returns IlTrue if the field is read-only. 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_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 align) |
| Sets the text alignment of the field. More...
|
|
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_setFormat (const IliFormat &fmt) |
| Sets the format used to derive the external representation of the field from its internal value. More...
|
|
virtual void | f_setInputModified (IlBoolean flag) |
| Sets the input-modified attribute of the field. More...
|
|
virtual void | f_setLabel (const char *label) |
| Sets the label of the field gadget. More...
|
|
virtual void | f_setMask (const IliInputMask &msk) |
| Sets the input mask. More...
|
|
virtual void | f_setMaxLength (IlShort vmax) |
| Sets the maximum length allowed for the external representation of the field. More...
|
|
virtual void | f_setReadOnly (IlBoolean flag) |
| Sets the read-only property for the field. More...
|
|
virtual void | f_setTablePropertyManagerName (const char *name) |
| Sets the name of the table property manager to use. More...
|
|
virtual IlBoolean | f_setValue (const IliValue &val, IlBoolean internal=IlFalse) |
| Sets the value of the field. 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...
|
|
Field class.
Library: dataccess
This class defines the interface that is common to all data-source-aware gadgets. A data-source-aware gadget can connect to a data source and participate in the data source protocol. A data-source-aware gadget class is usually a subclass of both IlvGadget
and IliFieldItf
.
- Warning
- The
IliFieldItf
class also supports subclassing from the IlvGraphic
class. But since it is most often used in conjunction with the IlvGadget
class, we usually refer to such subclasses as data-source-aware gadgets.
A data-source-aware gadget (or field) has an internal value and an external representation. Sometimes the external representation corresponds exactly to the internal value. The end-user may then edit the external representation, therefore breaking the correspondence between them. At this point, it is possible to request that the field parse its external representation deriving a new internal value or, alternatively, that the end user edits are canceled and that the external representation is reset. The internal value is always represented as an instance of the IliValue
class, whereas the external representation is specific to the gadget class. For instance, a text field will use a character string for its external representation, whereas a toggle field will use a shaded rectangle. The external representation is what the end-user sees; the internal value is what the application sees. A field can also be connected to a data source column. In this situation, the data source will set the internal value of the field each time a row change event occurs on the data source.
- See also
- IliDataSource, IliFormat, IliTable, IliValue, IlvGadget.
Accessors\nAccessors provide a scriptable and uniform way to inspect and modify an object by using its base class methods <tt>IlvValueInterface::queryValue()</tt>, <tt>IlvValueInterface::queryValues()</tt>, <tt>IlvValueInterface::changeValue()</tt>, <tt>IlvValueInterface::changeValues()</tt>.\n\nThis class defines the following accessors:
Data accessors
Name | Type | Equivalent methods |
alignment | Direction | f_getAlignment() , f_setAlignment() . See [Alignment] below. |
columnName | String | f_getDataSourceColumnName() , f_setDataSourceColumnName() . See [ColumnName] below. |
completion | Boolean | f_isCompletionEnabled() , f_enableCompletion() . See [Completion] below. |
constrained | Boolean | f_isConstrained() , f_setConstrained() . See [Contrained] below. |
dataSource | Object | f_getDataSource() . See [DataSource]"</b> below.\ilinebr </td> </tr>
<tr class="markdownTableRowEven"> <td class="markdownTableBodyNone"> `dataSourceName`\ilinebr </td> <td class="markdownTableBodyNone"> String\ilinebr </td> <td class="markdownTableBodyNone"> `f_getDataSourceName()`, `f_setDataSourceName()`. See <b>\ref IliFieldItf_DataSource "[DataSource]"</b> below.\ilinebr </td> </tr>
<tr class="markdownTableRowOdd"> <td class="markdownTableBodyNone"> `foreignDataSourceName`\ilinebr </td> <td class="markdownTableBodyNone"> String\ilinebr </td> <td class="markdownTableBodyNone"> `f_getForeignDataSourceName()`, `f_setForeignDataSourceName()`. See <b>\ref IliFieldItf_ForeignDataSourceName "[ForeignDataSourceName]"</b> below.\ilinebr </td> </tr>
<tr class="markdownTableRowEven"> <td class="markdownTableBodyNone"> `foreignDisplayColumnName`\ilinebr </td> <td class="markdownTableBodyNone"> String\ilinebr </td> <td class="markdownTableBodyNone"> `f_getForeignDisplayColumnName()`, `f_setForeignDisplayColumnName()`. See <b>\ref IliFieldItf_ForeignDisplayColumnName "[ForeignDisplayColumnName]"</b> below.\ilinebr </td> </tr>
<tr class="markdownTableRowOdd"> <td class="markdownTableBodyNone"> `foreignTable`\ilinebr </td> <td class="markdownTableBodyNone"> Object\ilinebr </td> <td class="markdownTableBodyNone"> `f_getForeignTable()`, `f_setForeignTable()`. See <b>\ref IliFieldItf_ForeignTable "[ForeignTable]"</b> below.\ilinebr </td> </tr>
<tr class="markdownTableRowEven"> <td class="markdownTableBodyNone"> `foreignValueColumnName`\ilinebr </td> <td class="markdownTableBodyNone"> String\ilinebr </td> <td class="markdownTableBodyNone"> `f_getForeignValueColumnName()`, `f_setForeignValueColumnName()`. See <b>\ref IliFieldItf_ForeignValueColumnName "[ForeignValueColumnName]"</b> below.\ilinebr </td> </tr>
<tr class="markdownTableRowOdd"> <td class="markdownTableBodyNone"> `format`\ilinebr </td> <td class="markdownTableBodyNone"> String\ilinebr </td> <td class="markdownTableBodyNone"> `f_getFormat()`, `f_setFormat()`. See <b>\ref IliFieldItf_Format "[Format]"</b> below.\ilinebr </td> </tr>
<tr class="markdownTableRowEven"> <td class="markdownTableBodyNone"> `inputModified`\ilinebr </td> <td class="markdownTableBodyNone"> Boolean\ilinebr </td> <td class="markdownTableBodyNone"> `f_isInputModified()`, `f_setInputModified()`. See <b>\ref IliFieldItf_InputModified "[InputModified]"</b> below.\ilinebr </td> </tr>
<tr class="markdownTableRowOdd"> <td class="markdownTableBodyNone"> `label`\ilinebr </td> <td class="markdownTableBodyNone"> String\ilinebr </td> <td class="markdownTableBodyNone"> `f_getLabel()`, `f_setLabel()`. See <b>\ref IliFieldItf_Label "[Label]"</b> below.\ilinebr </td> </tr>
<tr class="markdownTableRowEven"> <td class="markdownTableBodyNone"> `mask`\ilinebr </td> <td class="markdownTableBodyNone"> String\ilinebr </td> <td class="markdownTableBodyNone"> `f_getMask()`, `f_setMask()`. See <b>\ref IliFieldItf_Mask "[Mask]"</b> below.\ilinebr </td> </tr>
<tr class="markdownTableRowOdd"> <td class="markdownTableBodyNone"> `maxLength`\ilinebr </td> <td class="markdownTableBodyNone"> Int\ilinebr </td> <td class="markdownTableBodyNone"> `f_getMaxLength()`, `f_setMaxLength()`. See <b>\ref IliFieldItf_MaxLength "[MaxLength]"</b> below.\ilinebr </td> </tr>
<tr class="markdownTableRowEven"> <td class="markdownTableBodyNone"> `readOnly`\ilinebr </td> <td class="markdownTableBodyNone"> Boolean\ilinebr </td> <td class="markdownTableBodyNone"> `f_isReadOnly()`, `f_setReadOnly()`. See <b>\ref IliFieldItf_ReadOnly "[ReadOnly]"</b> below.\ilinebr </td> </tr>
<tr class="markdownTableRowOdd"> <td class="markdownTableBodyNone"> `tablePropertyManagerName`\ilinebr </td> <td class="markdownTableBodyNone"> String\ilinebr </td> <td class="markdownTableBodyNone"> `f_getTablePropertyManagerName()`, `f_setTablePropertyManagerName()`. See <b>\ref IliFieldItf_TablePropertyManagerName "[TablePropertyManagerName]"</b> below.\ilinebr </td> </tr>
<tr class="markdownTableRowEven"> <td class="markdownTableBodyNone"> `useTableProperties`\ilinebr </td> <td class="markdownTableBodyNone"> Boolean\ilinebr </td> <td class="markdownTableBodyNone"> `f_isUsingTableProperties()`, `f_useTableProperties()`. See <b>\ref IliFieldItf_UseTableProperties "[UseTableProperties]"</b> below.\ilinebr </td> </tr>
<tr class="markdownTableRowOdd"> <td class="markdownTableBodyNone"> `value`\ilinebr </td> <td class="markdownTableBodyNone"> Object\ilinebr </td> <td class="markdownTableBodyNone"> `f_getValue()`, `f_setValue()`. See <b>\ref IliFieldItf_Value "[Value]"</b> below.\ilinebr </td> </tr>
<tr class="markdownTableRowEven"> <td class="markdownTableBodyNone"> `visibleRowsCount`\ilinebr </td> <td class="markdownTableBodyNone"> Int\ilinebr </td> <td class="markdownTableBodyNone"> `f_getVisibleRowsCount()`, `f_setVisibleRowsCount()`. See <b>\ref IliFieldItf_VisibleRowsCount "[VisibleRowsCount]"</b> below.\ilinebr </td> </tr>
<tr class="markdownTableRowOdd"> <td class="markdownTableBodyNone"> \ilinebr </td> </tr>
<tr class="markdownTableRowEven"> <td class="markdownTableBodyNone"> |
[Alignment]: available for IliDbField
, IliDbPicture
, IliEntryField
only.
[ColumnName]: available for IliDbField
, IliDbPicture
, IliDbStringList
, IliEntryField
, IliDbOptionMenu
, IliDbText
, IliDbToggle
, IliToggleSelector
only.
[Completion]: available for IliDbField
only.
[Contrained]: available for IliDbField
only.
[DataSource]: available for IliDbField
, IliEntryField
, IliDbNavigator
, IliDbOptionMenu
, IliDbPicture
, IliDbStringList
, IliDbText
, IliDbToggle
, IliTableGadget
, IliToggleSelector
only.
[ForeignTable]: available for IliDbField
, IliDbOptionMenu
, IliDbStringList
, IliDbToggle
, IliToggleSelector
only.
[ForeignDisplayColumnName]: available for IliDbField
, IliDbOptionMenu
, IliDbStringList
, IliDbToggle
, IliToggleSelector
only.
[ForeignValueColumnName]: available for IliDbField
, IliDbOptionMenu
, IliDbStringList
, IliDbToggle
, IliToggleSelector
only.
[Format]: available for IliDbField
, IliEntryField
only.
[InputModified]: available for IliEntryField
, IliDbOptionMenu
, IliDbPicture
, IliDbStringList
, IliDbText
, IliDbToggle
, IliTableGadget
, IliToggleSelector
only.
[Label]: available for IliDbField
, IliDbToggle
, IliToggleSelector
only.
[Mask]: available for IliDbField
, IliEntryField
only.
[MaxLength]: available for IliDbField
, IliEntryField
, IliDbOptionMenu
only.
[ReadOnly]: available for IliDbField
, IliEntryField
, IliDbOptionMenu
, IliDbStringList
, IliDbText
, IliDbToggle
, IliTableGadget
, IliToggleSelector
only.
[TablePropertyManagerName]: available for IliDbField
, IliEntryField
, IliDbOptionMenu
, IliDbStringList
, IliDbText
, IliDbToggle
, IliTableGadget
, IliToggleSelector
only.
[UseTableProperties]: available for IliDbField
, IliEntryField
, IliDbOptionMenu
, IliDbStringList
, IliDbText
, IliDbToggle
, IliTableGadget
, IliToggleSelector
only.
[Value]: available for IliDbField
, IliEntryField
, IliDbOptionMenu
, IliDbPicture
, IliDbStringList
, IliDbText
, IliDbToggle
, IliToggleSelector
only.
[VisibleRowsCount]: available for IliDbField
only.