Rogue Wave Views Data Access Package API Reference Guide |
Rogue Wave Views Documentation Home |
Gadget class. More...
#include <ilviews/dataccess/inpmask.h>
Public Member Functions | |
IliInputMaskIpl (const char *definition) | |
This constructor creates a mask according to one definition. More... | |
IlBoolean | checkIndexChar (IlInt pos) const |
IlTrue if the position is valid. More... | |
virtual wchar_t | filterChar (IlInt pos, wchar_t c) |
Returns the filtered character which corresponds to a character. More... | |
virtual IlBoolean | format (IliString &dest, const IliValue &src, IlBoolean forEdit) const |
Uses the mask to format a value. More... | |
virtual void | formatForClipboard (IliString &dest, const char *src, IlInt startPos) const |
Formats a value for the clipboard. More... | |
const char * | getDefinition () const |
Increments the reference count for the mask. | |
IlInt | getFirstEditablePos () const |
Returns the position of the first character that can be edited. More... | |
IlInt | getLastEditablePos () const |
Returns the position of the last character that can be edited. More... | |
IlInt | getMaxCharMask () const |
Returns the maximum length of the mask. More... | |
virtual IlInt | getMaxEntryChar () const |
Returns the maximum number of characters that can be entered. More... | |
virtual IlInt | getNextEditablePos (IlInt pos) const |
Returns the position of the next character that can be edited. More... | |
virtual IlInt | getPreviousEditablePos (IlInt pos) const |
Returns the position of the previous character that can be edited. More... | |
virtual IlBoolean | isConstantChar (IlInt pos) const |
Returns IlTrue if a character is Constant. More... | |
virtual IlBoolean | isFixChar (IlInt pos) const |
Returns IlTrue if a character is Fix. More... | |
virtual IlBoolean | isNeededChar (IlInt pos) const |
Returns IlTrue if a character is Standard and Mandatory. More... | |
virtual IlBoolean | isValidChar (IlInt pos, wchar_t c, IlBoolean editMode) const |
Returns IlTrue if a character on the mask is valid. More... | |
virtual wchar_t | killChar (IlInt pos, wchar_t c) |
Returns the character used to replace a deleted character. More... | |
void | setMaxCharMask (IlInt v) |
Sets the maximum length of the mask. More... | |
virtual IlBoolean | unFormat (IliString &dest, const char *src) const |
Unformats a string. More... | |
Public Member Functions inherited from IliRefCounted | |
IlInt | getRefCount () const |
Returns the reference count of the object. Initially, this property is set to 0 . More... | |
void | lock () const |
Increments the reference count of the object. | |
void | unLock () const |
Decrements the reference count of the object. More... | |
Static Public Member Functions | |
static void | AddCustomMask (IliInputMaskIpl *msk) |
Adds a mask into the list of predefined masks. More... | |
static IliInputMaskIpl * | FindMask (const char *definition) |
Returns a pointer to the mask that corresponds to the definition. More... | |
static IliInputMaskIpl * | GetNullMask () |
Returns a pointer to the null mask. More... | |
static void | RemoveCustomMask (IliInputMaskIpl *msk) |
Removes a mask from the list of predefined masks. More... | |
Protected Member Functions | |
virtual const char * | getEffectiveDefinition () const |
Returns the effective definition of the mask. More... | |
virtual const IliFormat & | getValueFormat () const |
Returns the format used to format the value (from the database) into a string. More... | |
Protected Member Functions inherited from IliRefCounted | |
virtual | ~IliRefCounted () |
This is the virtual destructor of the IliRefCounted class. More... | |
Friends | |
class | IliInputMask |
Gadget class.
Library: dataccess
The IliInputMaskIpl
class defines an abstract class to create a mask used to enter data into IliEntryField
. The mask defines the different possibilities for each type of character entered. The User's Manual
has a sample of this class to help you define your mask. A mask has three types of visible characters:
IliInputMaskIpl::IliInputMaskIpl | ( | const char * | definition | ) |
This constructor creates a mask according to one definition.
definition | The definition or an alias. |
|
static |
Adds a mask into the list of predefined masks.
msk | The mask. |
IlTrue
if the position is valid.
pos | The position. |
IlTrue
if the position pos
is valid, otherwise returns IlFalse
.
|
virtual |
Returns the filtered character which corresponds to a character.
pos | The character position. |
c | The character. |
c
at position pos
.
|
static |
Returns a pointer to the mask that corresponds to the definition.
definition | The definition or an alias. |
null
.
|
virtual |
Uses the mask to format a value.
dest | The formatted string. |
src | The value. |
forEdit | If IlTrue , the mask is used to enter data, otherwise the mask is used for display. |
|
virtual |
Formats a value for the clipboard.
dest | The formatted string. |
src | The value. |
startPos | The position of the first character that is selected. |
|
protectedvirtual |
Returns the effective definition of the mask.
An effective definition is a string of characters.
IlInt IliInputMaskIpl::getFirstEditablePos | ( | ) | const |
Returns the position of the first character that can be edited.
IlInt IliInputMaskIpl::getLastEditablePos | ( | ) | const |
Returns the position of the last character that can be edited.
IlInt IliInputMaskIpl::getMaxCharMask | ( | ) | const |
Returns the maximum length of the mask.
|
virtual |
Returns the maximum number of characters that can be entered.
Returns the position of the next character that can be edited.
pos | The current position. |
|
static |
Returns a pointer to the null mask.
Returns the position of the previous character that can be edited.
pos | The current position. |
|
protectedvirtual |
Returns the format used to format the value (from the database) into a string.
Returns IlTrue
if a character is Constant.
pos | The character position. |
IlTrue
if the character at the position pos
is Constant, otherwise returns IlFalse
. Returns IlTrue
if a character is Fix.
pos | The character position. |
IlTrue
if the character at the position pos
is Fix, otherwise returns IlFalse
. Returns IlTrue
if a character is Standard and Mandatory.
pos | The character position. |
IlTrue
if the character at the position pos
is Standard and Mandatory, otherwise returns IlFalse
.
|
virtual |
Returns IlTrue
if a character on the mask is valid.
pos | The character position on the mask. |
c | The character. |
editMode | If IlTrue , the mask is used to enter data, otherwise the mask is used to display the valid characters. |
IlTrue
if the character is valid.
|
virtual |
Returns the character used to replace a deleted character.
pos | The character position. |
c | The character. |
c
at position pos
.
|
static |
Removes a mask from the list of predefined masks.
msk | The mask. |
void IliInputMaskIpl::setMaxCharMask | ( | IlInt | v | ) |
Sets the maximum length of the mask.
v | The maximum length. |
© 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.