Rogue Wave Views 5.5.1 |
Rogue Wave Views |
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. | |
IlBoolean | checkIndexChar (IlInt pos) const |
IlTrue if the position is valid. | |
virtual wchar_t | filterChar (IlInt pos, wchar_t c) |
Returns the filtered character which corresponds to a character. | |
virtual IlBoolean | format (IliString &dest, const IliValue &src, IlBoolean forEdit) const |
Uses the mask to format a value. | |
virtual void | formatForClipboard (IliString &dest, const char *src, IlInt startPos) const |
Formats a value for the clipboard. | |
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. | |
IlInt | getLastEditablePos () const |
Returns the position of the last character that can be edited. | |
IlInt | getMaxCharMask () const |
Returns the maximum length of the mask. | |
virtual IlInt | getMaxEntryChar () const |
Returns the maximum number of characters that can be entered. | |
virtual IlInt | getNextEditablePos (IlInt pos) const |
Returns the position of the next character that can be edited. | |
virtual IlInt | getPreviousEditablePos (IlInt pos) const |
Returns the position of the previous character that can be edited. | |
virtual IlBoolean | isConstantChar (IlInt pos) const |
Returns IlTrue if a character is Constant. | |
virtual IlBoolean | isFixChar (IlInt pos) const |
Returns IlTrue if a character is Fix. | |
virtual IlBoolean | isNeededChar (IlInt pos) const |
Returns IlTrue if a character is Standard and Mandatory. | |
virtual IlBoolean | isValidChar (IlInt pos, wchar_t c, IlBoolean editMode) const |
Returns IlTrue if a character on the mask is valid. | |
virtual wchar_t | killChar (IlInt pos, wchar_t c) |
Returns the character used to replace a deleted character. | |
void | setMaxCharMask (IlInt v) |
Sets the maximum length of the mask. | |
virtual IlBoolean | unFormat (IliString &dest, const char *src) const |
Unformats a string. | |
Static Public Member Functions | |
static void | AddCustomMask (IliInputMaskIpl *msk) |
Adds a mask into the list of predefined masks. | |
static IliInputMaskIpl * | FindMask (const char *definition) |
Returns a pointer to the mask that corresponds to the definition. | |
static IliInputMaskIpl * | GetNullMask () |
Returns a pointer to the null mask. | |
static void | RemoveCustomMask (IliInputMaskIpl *msk) |
Removes a mask from the list of predefined masks. | |
Protected Member Functions | |
virtual const char * | getEffectiveDefinition () const |
Returns the effective definition of the mask. | |
virtual const IliFormat & | getValueFormat () const |
Returns the format used to format the value (from the database) into a string. | |
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 void IliInputMaskIpl::AddCustomMask | ( | IliInputMaskIpl * | msk | ) | [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 wchar_t IliInputMaskIpl::filterChar | ( | IlInt | pos, | |
wchar_t | c | |||
) | [virtual] |
Returns the filtered character which corresponds to a character.
pos | The character position. | |
c | The character. |
c
at position pos
. static IliInputMaskIpl* IliInputMaskIpl::FindMask | ( | const char * | definition | ) | [static] |
Returns a pointer to the mask that corresponds to the definition.
definition | The definition or an alias. |
null
. virtual IlBoolean IliInputMaskIpl::format | ( | IliString & | dest, | |
const IliValue & | src, | |||
IlBoolean | forEdit | |||
) | const [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 void IliInputMaskIpl::formatForClipboard | ( | IliString & | dest, | |
const char * | src, | |||
IlInt | startPos | |||
) | const [virtual] |
Formats a value for the clipboard.
dest | The formatted string. | |
src | The value. | |
startPos | The position of the first character that is selected. |
virtual const char* IliInputMaskIpl::getEffectiveDefinition | ( | ) | const [protected, virtual] |
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 IlInt IliInputMaskIpl::getMaxEntryChar | ( | ) | const [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 IliInputMaskIpl* IliInputMaskIpl::GetNullMask | ( | ) | [static] |
Returns a pointer to the null mask.
Returns the position of the previous character that can be edited.
pos | The current position. |
virtual const IliFormat& IliInputMaskIpl::getValueFormat | ( | ) | const [protected, virtual] |
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
. Returns IlTrue
if a character on the mask is valid.
pos | The character position on the mask. | |
c | The character. | |
editMod | 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 wchar_t IliInputMaskIpl::killChar | ( | IlInt | pos, | |
wchar_t | c | |||
) | [virtual] |
Returns the character used to replace a deleted character.
pos | The character position. | |
c | The character. |
c
at position pos
. static void IliInputMaskIpl::RemoveCustomMask | ( | IliInputMaskIpl * | msk | ) | [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 2012, 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.