|
| IliToggleSelector (IlvDisplay *display, const IlvRect &rect, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0) |
| This constructor creates a toggle selector gadget. Initially, it is empty. More...
|
|
IlBoolean | appendLabel (const char *label) |
| Appends a new toggle after all existing toggles. 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...
|
|
const char * | getLabel (IlInt index) const |
| Returns a label. More...
|
|
IlInt | getLabelIndex (const char *label, IlInt from=0) const |
| Returns a label index. More...
|
|
const char *const * | getLabels (IlInt &count) const |
| Returns the toggle labels. More...
|
|
IlInt | getLabelsCount () const |
| Returns the number of toggles in the toggle selector. More...
|
|
IlBoolean | insertLabel (IlInt index, const char *label) |
| Inserts a new toggle. More...
|
|
IlBoolean | removeLabel (IlInt index) |
| Removes a toggle. More...
|
|
virtual IlBoolean | setFocusObject (IlvGadget *) |
| Sets the focus gadget. More...
|
|
IlBoolean | setLabel (IlInt index, const char *label) |
| Sets a label. More...
|
|
void | setLabels (const char *const *strings, IlInt count) |
| Sets labels. More...
|
|
void | setSelected (IlInt which) |
| Selects a toggle. More...
|
|
IlInt | whichSelected () const |
| Returns the selected toggle position. More...
|
|
| IliGadgetSet (IlvDisplay *display, const IlvRect &rect, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0) |
| Initializes an empty gadget set. More...
|
|
virtual void | addObject (IlvGadget *obj, IlBoolean visible=IlTrue) |
| Adds a gadget to the gadget set. More...
|
|
void | disableToolTip () |
| Disables tooltip display.
|
|
void | enableToolTip () |
| Enables tooltip display. More...
|
|
IlUInt | getCardinal () const |
| Returns the number of gadgets in the gadget set. More...
|
|
IlvGadget * | getFocusObject () const |
| Returns the focus gadget of the gadget set or 0 if no focus gadget is defined. More...
|
|
IlInt | getIndex (IlvGadget *g) const |
| Returns the position of a gadget in the gadget set. More...
|
|
IlvGadget * | getObject (IlUInt index) const |
| Returns a gadget. More...
|
|
IlvGadget * | getObject (const char *name) const |
| Returns a gadget. More...
|
|
IlBoolean | isObjectSensitive (IlvGadget *obj) const |
| Returns IlTrue if gadget is sensitive to user interaction. More...
|
|
IlBoolean | isVisible (const IlvGadget *) const |
| Returns IlTrue if the gadget parameter belongs to the gadget set and if it is visible. More...
|
|
virtual void | objectReceivedEvent (IlvGadget *obj) |
| Called when a gadget received an event. More...
|
|
virtual void | removeObject (IlvGadget *obj, IlBoolean deleteIt=IlTrue) |
| Removes a gadget from the gadget set. More...
|
|
void | setObjectSensitive (IlvGadget *obj, IlBoolean active) |
| Enables/disables user interaction. More...
|
|
void | setVisible (IlvGadget *obj, IlBoolean visible) |
| Shows/Hides a gadget. More...
|
|
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 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 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 IliToggleSelector
class defines a gadget that contains a set of toggle gadgets. Each toggle gadget corresponds to a row of the foreign table. A maximum of one toggle can be checked. The value of the toggle selector is closely related to which toggle is checked. A IliToggleSelector
gadget inherits the following properties from the IliFieldItf
class:
-
a value (which may be connected to a data source),
-
a foreign table,
-
a column of the foreign table known as the value column,
-
a column of the foreign table known as the display column,
-
a label (see
IliFieldItf::f_getLabel()
and IliFieldItf::f_setLabel()
).
When a toggle selector receives a new value, it checks the foreign table to find a row that contains this value in its value column. If such a row is found, the toggle selector checks the toggle that has the value of the display column of this row, as a label. Any other previously checked toggle is unchecked. Therefore, a toggle selector does not display its actual value. Instead, it displays another value that is derived from the original value, through the foreign table. The foreign table serves as a value converter. In addition, if the user edits the value displayed by the toggle selector, the edited value is converted back in a reversal of the procedure described above. A row that contains this value in its display column is searched for in the foreign table. If such a row is found, the value of the combo box changes to the value contained in the value column of the row. As an alternative to using a foreign table, it is possible to alter the toggles and their labels directly, using one of the member functions, setLabels()
, setLabel()
, insertLabel()
, appendLabel()
, or removeLabel()
. Note that these member functions may not be used in conjunction with a foreign table. When the toggle selector has no foreign table, its value is an integer ranging from 0
to one less than the number of toggles.
- See also
IliTable
, IlvToggle
.
Accessors
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 inherits the accessors of its superclasses IliGadgetSet
and IliFieldItf
, and adds the following ones:
Data accessors