|
| IliDbToggle (IlvDisplay *display, const char *label, const IlvRect &rect, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0) |
| This constructor initializes a new IliDbToggle instance. More...
|
|
| IliDbToggle (IlvDisplay *display, const IlvPoint &at, const char *label, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0) |
| This constructor initializes a new IliDbToggle instance. More...
|
|
| IliDbToggle (IlvDisplay *display, const IlvPoint &at, IlvBitmap *bitmap, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0) |
| This constructor initializes a new IliDbToggle instance. More...
|
|
| IliDbToggle (IlvDisplay *display, IlvBitmap *bitmap, const IlvRect &rect, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0) |
| This constructor initializes a new IliDbToggle instance. 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 IlBoolean | f_externalToInternal () |
| Updates the internal value of a field according to its current external representation. More...
|
|
virtual const char * | f_getLabel () const |
| Returns the label displayed by the field gadget. More...
|
|
virtual const IliValue & | f_getValue (IlBoolean=IlFalse) const |
| Returns the value of the field. More...
|
|
virtual IlBoolean | f_hasLabel () const |
| Returns IlTrue if the field gadget can display a label. 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_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. More...
|
|
virtual void | f_setForeignTable (IliTable *, IlBoolean=IlFalse) |
| Sets the foreign table of the field. More...
|
|
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. More...
|
|
virtual void | f_setLabel (const char *) |
| Sets the label of the field gadget. More...
|
|
virtual void | f_setReadOnly (IlBoolean) |
| Sets the read-only property for the field. More...
|
|
virtual IlBoolean | f_setValue (const IliValue &, IlBoolean=IlFalse) |
| Sets the value of the field. More...
|
|
virtual IlBoolean | is3StatesMode () const |
| Returns IlTrue if the IliDbToggle handles the 0 value in addition to the two Boolean values. More...
|
|
virtual void | set3StatesMode (IlBoolean flag) |
| Enables/disables the handling of 0 values. More...
|
|
void | f_applyReferences (IlvApplyObject f, IlAny a) |
| Should be called when the applyReferences() member function, of the gadget class, is called. More...
|
|
virtual void | f_enableCompletion (IlBoolean flag) |
| Sets the completion property of the field. 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 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...
|
|
IlInt | f_getVisibleRowsCount () const |
| Returns the number of rows that will be displayed when the foreign table is displayed. 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_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_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_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_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...
|
|
Field gadget class.
Library: dbgadget
The IliDbToggle
class defines toggle gadgets that can be connected to a data source. A IliDbToggle
gadget inherits the following properties from the IliFieldItf
class:
- See also
IliFieldItf
.
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\n\nThis class inherits the accessors of its superclasses \c IlvToggle and \c IliFieldItf, and adds the following ones:
Data accessors
By default, the gadget is assigned the integer 1
to its value when it is in the checked state and 0
when it is in the unchecked state.
A table, known as a foreign table, can be used to map the checked and unchecked states to values other than 0
and 1
.
For example, if you want to use strings "True"
and "False"
instead of integers 1
and 0
, you could :
-
Create a data source named
"MAP"
with two columns:
-
Column name:
"DISPLAY"
, type: Integer
-
Column name:
"VALUE"
, type: String
-
Enter the following rows into this data source:
-
Set up the db-toggle as follows:
dbToggle.foreignDataSourceName = "MAP";
dbToggle.foreignDisplayColumnName = "DISPLAY";
dbToggle.foreignValueColumnName = "VALUE";