Rogue Wave Views Data Access Package API Reference Guide |
Rogue Wave Views Documentation Home |
Field class. More...
#include <ilviews/dataccess/fielditf.h>
Public Member Functions | |
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... | |
const IliDataSource * | f_getDataSource () const |
Returns the data source. More... | |
IliDataSource * | f_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 IliTablePropertyManager * | f_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 IliTable * | f_getForeignTable () const |
Returns the foreign table. More... | |
IliTable * | f_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... | |
virtual const IliFormat & | f_getFormat () const |
Returns the format used to derive the external representation of the field from its internal value. More... | |
const IlvGadget * | f_getGadget () const |
Returns the constant gadget associated with this field through multiple inheritance. More... | |
IlvGadget * | f_getGadget () |
Returns the gadget 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... | |
IlvGraphic * | f_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... | |
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... | |
Static Public Member Functions | |
static IlvSymbol * | InputModifiedSymbol () |
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... | |
Protected Member Functions | |
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... | |
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
.
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.
Accessors provide a scriptable and uniform way to inspect and modify an object by using its base class methods IlvValueInterface::queryValue()
, IlvValueInterface::queryValues()
, IlvValueInterface::changeValue()
, IlvValueInterface::changeValues()
. This class defines the following 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.
<tr><td>`dataSourceName` <td> String <td> `f_getDataSourceName()`, `f_setDataSourceName()`. See <b>\ref IliFieldItf_DataSource "[DataSource]"</b> below.
<tr><td>`foreignDataSourceName` <td> String <td> `f_getForeignDataSourceName()`, `f_setForeignDataSourceName()`. See <b>\ref IliFieldItf_ForeignDataSourceName "[ForeignDataSourceName]"</b> below.
<tr><td>`foreignDisplayColumnName` <td> String <td> `f_getForeignDisplayColumnName()`, `f_setForeignDisplayColumnName()`. See <b>\ref IliFieldItf_ForeignDisplayColumnName "[ForeignDisplayColumnName]"</b> below.
<tr><td>`foreignTable` <td> Object <td> `f_getForeignTable()`, `f_setForeignTable()`. See <b>\ref IliFieldItf_ForeignTable "[ForeignTable]"</b> below.
<tr><td>`foreignValueColumnName` <td> String <td> `f_getForeignValueColumnName()`, `f_setForeignValueColumnName()`. See <b>\ref IliFieldItf_ForeignValueColumnName "[ForeignValueColumnName]"</b> below.
<tr><td>`format` <td> String <td> `f_getFormat()`, `f_setFormat()`. See <b>\ref IliFieldItf_Format "[Format]"</b> below.
<tr><td>`inputModified` <td> Boolean <td> `f_isInputModified()`, `f_setInputModified()`. See <b>\ref IliFieldItf_InputModified "[InputModified]"</b> below.
<tr><td>`label` <td> String <td> `f_getLabel()`, `f_setLabel()`. See <b>\ref IliFieldItf_Label "[Label]"</b> below.
<tr><td>`mask` <td> String <td> `f_getMask()`, `f_setMask()`. See <b>\ref IliFieldItf_Mask "[Mask]"</b> below.
<tr><td>`maxLength` <td> Int <td> `f_getMaxLength()`, `f_setMaxLength()`. See <b>\ref IliFieldItf_MaxLength "[MaxLength]"</b> below.
<tr><td>`readOnly` <td> Boolean <td> `f_isReadOnly()`, `f_setReadOnly()`. See <b>\ref IliFieldItf_ReadOnly "[ReadOnly]"</b> below.
<tr><td>`tablePropertyManagerName` <td> String <td> `f_getTablePropertyManagerName()`, `f_setTablePropertyManagerName()`. See <b>\ref IliFieldItf_TablePropertyManagerName "[TablePropertyManagerName]"</b> below.
<tr><td>`useTableProperties` <td> Boolean <td> `f_isUsingTableProperties()`, `f_useTableProperties()`. See <b>\ref IliFieldItf_UseTableProperties "[UseTableProperties]"</b> below.
<tr><td>`value` <td> Object <td> `f_getValue()`, `f_setValue()`. See <b>\ref IliFieldItf_Value "[Value]"</b> below.
<tr><td>`visibleRowsCount` <td> Int <td> `f_getVisibleRowsCount()`, `f_setVisibleRowsCount()`. See <b>\ref IliFieldItf_VisibleRowsCount "[VisibleRowsCount]" below. |
[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.
void IliFieldItf::f_applyReferences | ( | IlvApplyObject | f, |
IlAny | a | ||
) |
Should be called when the applyReferences()
member function, of the gadget class, is called.
f | The function. |
a | The user data. |
|
virtual |
Updates the internal value of the field, according to its current external representation and its foreign table, provided completion is enabled for the field.
For more information on completion, see the f_iscompletionEnabled()
member function.
IlTrue
if successful. Reimplemented in IliTableGadget, IliTableComboBox, IliDbField, and IliDbToggle.
|
virtual |
Sets the completion property of the field.
flag | If IlTrue , the completion property is on. |
Reimplemented in IliDbField.
|
virtual |
Updates the internal value of a field according to its current external representation.
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 in IliTableGadget, IliTableComboBox, IliToggleSelector, IliDbField, IliDbToggle, IliScrolledComboBox, IliEntryField, IliDbPicture, IliDbStringList, IliDbOptionMenu, and IliDbText.
|
virtual |
Returns the text alignment of the field.
Reimplemented in IliDbField, IliDbPicture, and IliEntryField.
const IliDataSource* IliFieldItf::f_getDataSource | ( | ) | const |
Returns the data source.
0
, if it is not currently connected. IliDataSource* IliFieldItf::f_getDataSource | ( | ) |
Returns the data source.
0
, if it is not currently connected. const char* IliFieldItf::f_getDataSourceColumnName | ( | ) | const |
Returns the name of the column.
const char* IliFieldItf::f_getDataSourceName | ( | ) | const |
Returns the name of the data source, which this field is (or must be) connected to.
|
virtual |
Returns the effective table property manager.
useTableProperties
property is IlFalse
or if the data source to which the field is connected has its useTableProperties
property set to IlFalse
, this member function returns 0
. tablePropertyManagerName
property is not empty, the table property manager with that name is returned. tablePropertyManagerName
property that is not empty, the table property manager with that name is returned. Reimplemented in IliTableGadget.
|
virtual |
Returns the effective table property manager.
useTableProperties
property is IlFalse
or if the data source to which the field is connected has its useTableProperties
property set to IlFalse
, this member function returns 0
. tablePropertyManagerName
property is not empty, the table property manager with that name is returned. tablePropertyManagerName
property that is not empty, the table property manager with that name is returned. Reimplemented in IliTableGadget.
const char* IliFieldItf::f_getForeignDataSourceName | ( | ) | const |
Returns the name of the foreign data source.
const char* IliFieldItf::f_getForeignDisplayColumnName | ( | ) | const |
Returns the name of the column of the foreign table that will serve as a result.
const IliTable* IliFieldItf::f_getForeignTable | ( | ) | const |
Returns the foreign table.
IliTable* IliFieldItf::f_getForeignTable | ( | ) |
Returns the foreign table.
const char* IliFieldItf::f_getForeignValueColumnName | ( | ) | const |
Returns the name of the column of the foreign table that will serve as a key.
|
virtual |
Returns the format used to derive the external representation of the field from its internal value.
Reimplemented in IliDbField, and IliEntryField.
const IlvGadget* IliFieldItf::f_getGadget | ( | ) | const |
Returns the constant gadget associated with this field through multiple inheritance.
0
. IlvGadget* IliFieldItf::f_getGadget | ( | ) |
Returns the gadget associated with this field through multiple inheritance.
0
. const IlvGraphic* IliFieldItf::f_getGraphic | ( | ) | const |
Returns the constant graphic associated with this field through multiple inheritance.
IlvGraphic* IliFieldItf::f_getGraphic | ( | ) |
Returns the graphic associated with this field through multiple inheritance.
|
virtual |
Returns the label displayed by the field gadget.
Reimplemented in IliToggleSelector, IliDbField, and IliDbToggle.
|
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.
Reimplemented in IliDbField, and IliEntryField.
|
virtual |
Returns the maximum length allowed for the external representation of the field.
Reimplemented in IliDbField, and IliEntryField.
const char* IliFieldItf::f_getTablePropertyManagerName | ( | ) | const |
Returns the name of the table property manager used by this field.
Initially, this property is 0
.
0
if the default table property manager is to be used. Returns the value of the field.
internal | If IlTrue , the returned value does not necessarily reflect the state of the field as the user sees it. |
Reimplemented in IliTableGadget, IliToggleSelector, IliDbField, IliDbToggle, IliScrolledComboBox, IliDbPicture, IliEntryField, IliDbStringList, IliDbOptionMenu, and IliDbText.
IlInt IliFieldItf::f_getVisibleRowsCount | ( | ) | const |
Returns the number of rows that will be displayed when the foreign table is displayed.
|
virtual |
Returns IlTrue
if the field gadget can display a label.
IlTrue
if the field gadget can display a label. Reimplemented in IliToggleSelector, IliDbField, and IliDbToggle.
|
virtual |
Sets the ignore modified state attribute of the field.
When the modified state are ignored, the input-modified attribute is not modified and the enterModifiedState
callback is not called.
ignore | If the value is IlTrue then all modified state are ignored. |
|
virtual |
Returns IlTrue
if the width of the pull-down menu is automatically computed so that its contents fit.
IlTrue
if the width of the pull-down menu is automatically computed so that its contents fit. The value returned by this virtual member function is currently meaningful only when the field gadget is one of the following:
For a table gadget, this property applies to all table combo boxes contained in the table gadget. Reimplemented in IliTableGadget, and IliTableComboBox.
IlBoolean IliFieldItf::f_isCompletionEnabled | ( | ) | const |
Returns IlTrue
if completion is enabled.
IlTrue
if completion is enabled for the field. Completion is the mechanism that allows an incomplete external representation to be completed using the foreign table to supply a valid external representation, and therefore the corresponding internal value. This allows the user to enter the initial characters of a word and have the field automatically complete the word. IlBoolean IliFieldItf::f_isConnectedToDataSource | ( | ) | const |
Returns IlTrue
if the field is currently connected to a column of a data source.
IlTrue
if the field is currently connected to a column of a data source.
|
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.
IlTrue
if the internal value of the field corresponds to its current external representation. Reimplemented in IliTableGadget, IliTableComboBox, IliToggleSelector, IliDbField, IliDbToggle, IliScrolledComboBox, IliDbPicture, IliEntryField, IliDbStringList, IliDbOptionMenu, IliDbText, and IliSimpleToggle.
IlBoolean IliFieldItf::f_isConstrained | ( | ) | const |
Returns IlTrue
if the foreign table limits the set of possible internal values for this field.
IlTrue
if the foreign table limits the set of possible internal values for this field. IlBoolean IliFieldItf::f_isDataSourceOwner | ( | ) | const |
Returns IlTrue
if the field owns the data source.
IlTrue
if the field owns the data source which it is connected to. IlBoolean IliFieldItf::f_isForeignTableOwner | ( | ) | const |
Returns IlTrue
if the field owns its foreign table.
IlTrue
if the field owns its foreign table.
|
virtual |
Returns IlTrue
if the external representation has been edited by the end-user.
IlTrue
if the external representation 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. Reimplemented in IliTableGadget, and IliDbField.
|
virtual |
Returns IlTrue
if the modified states are ignored when the f_setValue()
function is called.
For example: When you call the cancel()
of the IliDataSource
the modified state are ignored.
IlTrue
if the modified states are ignored when the f_setValue()
function is called. The default value is IlFalse
.
|
virtual |
Returns IlTrue
if the field is read-only.
IlTrue
if the field is read-only. Reimplemented in IliTableGadget, IliToggleSelector, IliDbField, IliDbToggle, IliAbstractComboBox, IliScrolledComboBox, IliDbPicture, IliEntryField, IliDbStringList, IliDbOptionMenu, and IliDbText.
IlBoolean IliFieldItf::f_isUsingTableProperties | ( | ) | const |
Returns IlTrue
if the field uses table properties.
IlTrue
if the field uses table properties. Note that for the field to effectively use table properties, this property must be IlTrue
and the data source to which it is connected must also be using table properties. Initially, this property is true.
|
protected |
Should be called by the stream-based constructor of the gadget.
input | The input stream. |
|
protected |
Should be called by the copy constructor of the graphic class that is passed.
g | The object being constructed. |
other | The object being copied. |
|
virtual |
Sets the text alignment of the field.
align | The alignment. |
Reimplemented in IliDbField, IliDbPicture, and IliEntryField.
|
virtual |
Enables/disables the automatic width computing of the pull-down menu.
flag | If IlTrue , the width of the pull-down menu is automatically computed so that its contents fit. See the description of f_isAutoFitPullDown() for more information on this property. |
Reimplemented in IliTableGadget, and IliTableComboBox.
|
virtual |
Sets the constrained property of the field.
flag | If IlTrue the constrained property is on. |
Reimplemented in IliDbField.
|
virtual |
Sets the name of the column.
Sets the name of the column which the field must connect to. In order for the field to be successfully connected, the column name must designate a valid column of the data source specified by the f_setDataSourceName()
or f_setDataSource()
member functions.
name | The column name. |
|
virtual |
Sets the name of the data source.
Sets the name of the data source, which this field must be connected to. To disconnect the field from a data source, the parameter can be passed as a 0
. Note that actual connection to a data source occurs when the field is given a valid data source name and a valid column name.
name | The data source name. |
|
virtual |
Sets the name of the foreign data source.
name | The data source 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.
name | The column name. |
Reimplemented in IliTableComboBox, IliToggleSelector, IliDbField, IliDbToggle, IliScrolledComboBox, IliDbStringList, and IliDbOptionMenu.
Sets the foreign table of the field.
tbl | The table. |
owner | Determines whether the field will own the table. |
Reimplemented in IliTableComboBox, IliToggleSelector, IliDbField, IliDbToggle, IliScrolledComboBox, IliDbStringList, and IliDbOptionMenu.
|
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.
name | The column name. |
Reimplemented in IliTableComboBox, IliToggleSelector, IliDbField, IliDbToggle, IliScrolledComboBox, IliDbStringList, and IliDbOptionMenu.
|
virtual |
Sets the format used to derive the external representation of the field from its internal value.
fmt | The format. |
Reimplemented in IliDbField, and IliEntryField.
|
protected |
Should be called by all constructors of the graphic class (except the copy constructor).
g | The object being constructed. |
|
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.
flag | The input-modified attribute. |
Reimplemented in IliTableGadget, IliDbField, and IliEntryField.
|
virtual |
Sets the label of the field gadget.
label | The label. |
Reimplemented in IliToggleSelector, IliDbField, and IliDbToggle.
|
virtual |
|
virtual |
Sets the maximum length allowed for the external representation of the field.
vmax | The maximum length. |
Reimplemented in IliDbField, and IliEntryField.
|
virtual |
Sets the read-only property for the field.
flag | The read-only flag. |
Reimplemented in IliTableGadget, IliToggleSelector, IliDbField, IliDbToggle, IliAbstractComboBox, IliScrolledComboBox, IliDbPicture, IliEntryField, IliDbStringList, IliDbOptionMenu, and IliDbText.
|
virtual |
Sets the name of the table property manager to use.
name | The table property manager. If name is 0 or an empty string, the default table property manager is be used. |
Reimplemented in IliTableGadget.
|
virtual |
Sets the value of the field.
val | The value. |
internal | If IlFalse , then the external representation and the display of the field are automatically updated. |
IlTrue
if successful, and IlFalse
otherwise. Reimplemented in IliTableGadget, IliTableComboBox, IliToggleSelector, IliDbField, IliDbToggle, IliScrolledComboBox, IliDbPicture, IliEntryField, IliDbStringList, IliDbOptionMenu, and IliDbText.
|
virtual |
Sets the number of rows to be displayed when the foreign table is displayed.
count | The row count. |
Reimplemented in IliDbField.
|
virtual |
Returns IlTrue
if this gadget supports table properties.
IlTrue
if this gadget supports table properties. Reimplemented in IliDbPicture.
|
protected |
Should be called before the setHolder()
member function of the gadget class.
Here is a synopsis of a minimal class of this nature:
|
virtual |
Enables/Disables the use of the table properties.
flag | If IlTrue , the field will use table properties. |
Reimplemented in IliTableGadget.
|
protected |
Should be called by the write()
member function of the gadget class.
output | The output stream. |
|
static |
Returns the name of the callback that the field gadget will invoke every time the field input-modified property changes from IlFalse
to IlTrue
.
IlFalse
to IlTrue
. © Copyright 2016, 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.