IliInputMaskIpl Class Reference

Gadget class. More...

#include <ilviews/dataccess/inpmask.h>

Inheritance diagram for IliInputMaskIpl:

List of all members.

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

---

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:

• Standard characters that can be edited.
• Constant characters that cannot be edited but can be written into the value.
• Fix characters that are just for display. They can be neither edited nor written into the value.

See also:

IliInputMask

---

Constructor & Destructor Documentation

IliInputMaskIpl::IliInputMaskIpl

(

const char *

definition

)

This constructor creates a mask according to one definition.

Parameters:

definition

The definition or an alias.

---

Member Function Documentation

static void IliInputMaskIpl::AddCustomMask

(

IliInputMaskIpl *

msk

)

[static]

Adds a mask into the list of predefined masks.

Parameters:

msk

The mask.

IlBoolean IliInputMaskIpl::checkIndexChar

(

IlInt

pos

)

const

IlTrue if the position is valid.

Parameters:

pos

The 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:

	pos	The character position.
	c	The 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:

definition

The 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:

	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.

Parameters:

	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.

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:

pos

The 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:

pos

The current position.

Returns:

The position.

virtual const IliFormat& IliInputMaskIpl::getValueFormat

(

)

const [protected, virtual]

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:

pos

The 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:

pos

The 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:

pos

The 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:

	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.

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:

	pos	The character position.
	c	The 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:

msk

The mask.

void IliInputMaskIpl::setMaxCharMask

(

IlInt

v

)

Sets the maximum length of the mask.

Parameters:

v

The maximum length.

virtual IlBoolean IliInputMaskIpl::unFormat	(	IliString &	dest,
		const char *	src
	)			const [virtual]

Unformats a string.

Parameters:

	dest	The unformatted string.
	src	The string.