Rogue Wave Views Data Access Package API Reference Guide |
Rogue Wave Views Documentation Home |
Field gadget class. More...
#include <ilviews/dataccess/gadgets/dlgcombo.h>
Public Member Functions | |
virtual void | close () |
Hides the pull-down menu or dialog box. More... | |
virtual IlBoolean | isOpen () const |
Returns IlTrue if the pull-down menu or the dialog box is currently displayed. More... | |
virtual void | onApply () |
Called when the dialog interaction with the user is completed, the dialog has been dismissed and when the outcome of the interaction is not a user cancellation. More... | |
virtual void | open (IlBoolean grab) |
Causes a pull-down menu or dialog box to be displayed. More... | |
virtual IlBoolean | wasCanceled () const |
Returns IlTrue if the user has canceled the last dialog interaction. More... | |
Public Member Functions inherited from IliAbstractComboBox | |
void | allowEdit (IlBoolean enable) |
Specifies whether editing is allowed for the abstract combo box. More... | |
virtual IlBoolean | f_isReadOnly () const |
Returns IlTrue if the field is read-only. More... | |
virtual void | f_setReadOnly (IlBoolean) |
Sets the read-only property for the field. More... | |
IlBoolean | isArrowShown () const |
Returns IlTrue if the button is shown. More... | |
IlBoolean | isEditAllowed () const |
Returns IlTrue if editing is allowed for the abstract combo box. More... | |
virtual void | onClose () |
Called just after the pull-down menu or the dialog box is dismissed. More... | |
virtual void | onOpen () |
Called just before the pull-down menu or the dialog box is displayed. More... | |
void | showArrow (IlBoolean show) |
Shows or hides the arrow button. More... | |
Public Member Functions inherited from IliEntryField | |
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 IliFormat & | f_getFormat () const |
Returns the format used to derive the external representation of the field from its internal value. 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... | |
virtual const IliValue & | f_getValue (IlBoolean=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 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) |
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 IlBoolean | f_setValue (const IliValue &, IlBoolean=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 flag) |
Sets the completion property 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... | |
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... | |
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... | |
Static Public Member Functions | |
static IlvSymbol * | ApplySymbol () |
Returns the symbol that names the callback called by onApply . More... | |
Static Public Member Functions inherited from IliAbstractComboBox | |
static IlvSymbol * | CloseSymbol () |
Returns the symbol name of the Close callback. More... | |
static void | GetOpenShortCut (IlUShort &modifiers, IlUShort &key) |
Returns the definition of the shortcut key that causes the pull-down menu or dialog box to be displayed. More... | |
static IlvSymbol * | OpenSymbol () |
Returns the symbol name of the Open callback. More... | |
static void | SetOpenShortCut (IlUShort modifiers, IlUShort key) |
Defines the shortcut key that causes the pull-down menu or dialog box to be displayed. More... | |
Static Public Member Functions inherited from IliFieldItf | |
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 | |
IliDialogComboBox (IlvDisplay *display, const IlvRect &rect, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0) | |
The constructor creates an IliDialogComboBox . More... | |
IlvDialog * | getDialog () const |
Returns the dialog that is used by the combo box. More... | |
virtual void | onEndDialog () |
Called just after the dialog interaction with the user is completed and the dialog has been dismissed. More... | |
virtual void | onInitDialog () |
Called when the dialog box is about to be shown. More... | |
void | setDialog (IlvDialog *dlg, IlBoolean owner=IlTrue) |
Sets the dialog of the combo box. More... | |
virtual void | showDialog (IlBoolean grab) |
Called when the dialog needs to be shown. More... | |
Protected Member Functions inherited from IliAbstractComboBox | |
IliAbstractComboBox (IlvDisplay *display, const IlvRect &rect, IlUShort thickness=IlvDefaultGadgetThickness, IlvPalette *palette=0) | |
Initializes a new abstract combo box. More... | |
Protected Member Functions inherited from IliEntryField | |
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... | |
Field gadget class.
Library: dbgadget
The IliDialogComboBox
defines a combo box gadget that opens a dialog box when the user clicks on the button inside the gadget. The button in this combo box gadget shows three dots instead of an arrow. This class serves as a base class for other, more specialized classes, that define precisely which dialog box should be used.
|
protected |
The constructor creates an IliDialogComboBox
.
display | The display. |
rect | The location. |
thickness | The border thickness. |
palette | The palette. |
|
static |
Returns the symbol that names the callback called by onApply
.
|
virtual |
Hides the pull-down menu or dialog box.
The type of object that is hidden depends on the subclass of IliAbstractComboBox
being used.
Reimplemented from IliAbstractComboBox.
|
protected |
Returns the dialog that is used by the combo box.
Initially, this property is set to NULL
.
|
virtual |
Returns IlTrue
if the pull-down menu or the dialog box is currently displayed.
Reimplemented from IliAbstractComboBox.
|
virtual |
Called when the dialog interaction with the user is completed, the dialog has been dismissed and when the outcome of the interaction is not a user cancellation.
The default implementation calls the Apply
callback.
|
protectedvirtual |
Called just after the dialog interaction with the user is completed and the dialog has been dismissed.
The default implementation does nothing.
|
protectedvirtual |
Called when the dialog box is about to be shown.
It sets the dialog properties using the setDialog
member function. The default implementation does nothing.
|
virtual |
Causes a pull-down menu or dialog box to be displayed.
Whether the object displayed is a pull-down menu or a dialog box depends on the subclass of IliAbstractComboBox
being used.
grab | Reserved for future use and its value must always be IlFalse . |
Reimplemented from IliAbstractComboBox.
Sets the dialog of the combo box.
dlg | The dialog. |
owner | If IlTrue , the combo box becomes the owner of the dialog. |
|
protectedvirtual |
|
virtual |
Returns IlTrue
if the user has canceled the last dialog interaction.
IlTrue
if the user has canceled the last dialog interaction. © 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.