rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Data Access Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends
IliInputMaskIpl Class Reference

Gadget class. More...

#include <ilviews/dataccess/inpmask.h>

Inheritance diagram for IliInputMaskIpl:
IliRefCounted

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 IliInputMaskIplFindMask (const char *definition)
 Returns a pointer to the mask that corresponds to the definition. More...
 
static IliInputMaskIplGetNullMask ()
 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 IliFormatgetValueFormat () 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
 

Detailed Description

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:

See Also
IliInputMask

Constructor & Destructor Documentation

IliInputMaskIpl::IliInputMaskIpl ( const char *  definition)

This constructor creates a mask according to one definition.

Parameters
definitionThe definition or an alias.

Member Function Documentation

static void IliInputMaskIpl::AddCustomMask ( IliInputMaskIpl msk)
static

Adds a mask into the list of predefined masks.

Parameters
mskThe mask.
IlBoolean IliInputMaskIpl::checkIndexChar ( IlInt  pos) const

IlTrue if the position is valid.

Parameters
posThe position.
Returns
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.

Parameters
posThe character position.
cThe character.
Returns
The filtered character which corresponds to character c at position pos.
static IliInputMaskIpl* IliInputMaskIpl::FindMask ( const char *  definition)
static

Returns a pointer to the mask that corresponds to the definition.

Parameters
definitionThe definition or an alias.
Returns
A pointer to the mask that corresponds to the definition. If the mask cannot be found, it returns null.
virtual IlBoolean IliInputMaskIpl::format ( IliString dest,
const IliValue src,
IlBoolean  forEdit 
) const
virtual

Uses the mask to format a value.

Parameters
destThe formatted string.
srcThe value.
forEditIf 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.

Parameters
destThe formatted string.
srcThe value.
startPosThe position of the first character that is selected.
virtual const char* IliInputMaskIpl::getEffectiveDefinition ( ) const
protectedvirtual

Returns the effective definition of the mask.

An effective definition is a string of characters.

Returns
The definition.
IlInt IliInputMaskIpl::getFirstEditablePos ( ) const

Returns the position of the first character that can be edited.

Returns
The position.
IlInt IliInputMaskIpl::getLastEditablePos ( ) const

Returns the position of the last character that can be edited.

Returns
The position.
IlInt IliInputMaskIpl::getMaxCharMask ( ) const

Returns the maximum length of the mask.

Returns
The maximum.
virtual IlInt IliInputMaskIpl::getMaxEntryChar ( ) const
virtual

Returns the maximum number of characters that can be entered.

Returns
The maximum.
virtual IlInt IliInputMaskIpl::getNextEditablePos ( IlInt  pos) const
virtual

Returns the position of the next character that can be edited.

Parameters
posThe current position.
Returns
The position.
static IliInputMaskIpl* IliInputMaskIpl::GetNullMask ( )
static

Returns a pointer to the null mask.

Returns
The null mask.
virtual IlInt IliInputMaskIpl::getPreviousEditablePos ( IlInt  pos) const
virtual

Returns the position of the previous character that can be edited.

Parameters
posThe current position.
Returns
The position.
virtual const IliFormat& IliInputMaskIpl::getValueFormat ( ) const
protectedvirtual

Returns the format used to format the value (from the database) into a string.

Returns
The format.
virtual IlBoolean IliInputMaskIpl::isConstantChar ( IlInt  pos) const
virtual

Returns IlTrue if a character is Constant.

Parameters
posThe character position.
Returns
IlTrue if the character at the position pos is Constant, otherwise returns IlFalse.
virtual IlBoolean IliInputMaskIpl::isFixChar ( IlInt  pos) const
virtual

Returns IlTrue if a character is Fix.

Parameters
posThe character position.
Returns
IlTrue if the character at the position pos is Fix, otherwise returns IlFalse.
virtual IlBoolean IliInputMaskIpl::isNeededChar ( IlInt  pos) const
virtual

Returns IlTrue if a character is Standard and Mandatory.

Parameters
posThe character position.
Returns
IlTrue if the character at the position pos is Standard and Mandatory, otherwise returns IlFalse.
IlBoolean IliInputMaskIpl::isValidChar ( IlInt  pos,
wchar_t  c,
IlBoolean  editMode 
) const
virtual

Returns IlTrue if a character on the mask is valid.

Parameters
posThe character position on the mask.
cThe character.
editModIf IlTrue, the mask is used to enter data, otherwise the mask is used to display the valid characters.
Returns
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.

Parameters
posThe character position.
cThe character.
Returns
The character used to replace the deleted character c at position pos.
static void IliInputMaskIpl::RemoveCustomMask ( IliInputMaskIpl msk)
static

Removes a mask from the list of predefined masks.

Parameters
mskThe mask.
void IliInputMaskIpl::setMaxCharMask ( IlInt  v)

Sets the maximum length of the mask.

Parameters
vThe maximum length.
virtual IlBoolean IliInputMaskIpl::unFormat ( IliString dest,
const char *  src 
) const
virtual

Unformats a string.

Parameters
destThe unformatted string.
srcThe string.

© 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.