CP_KeyInputFilter Class Reference

CP_KeyInputFilter. More...

Inheritance diagram for CP_KeyInputFilter:

List of all members.

Validation
virtual CP_CharStatus	IsKeyValid (char inChar)=0
virtual CP_CharStatus	IsKeyValid (const CPUniChar *, UInt32)
Public Member Functions
Constructor / Destructor
virtual	~CP_KeyInputFilter ()
	Destructor.
Protected Member Functions
Constructor / Destructor
	CP_KeyInputFilter ()
	Constructor.

---

Detailed Description

A CP_M_ReferenceCounted class to filter keystrokes in edit fields.

---

Constructor & Destructor Documentation

CP_KeyInputFilter::~CP_KeyInputFilter (   )  [virtual]

Destructor. Exceptions: none

CPLAT_Begin_Namespace_CPLAT CP_KeyInputFilter::CP_KeyInputFilter (   )  [protected]

Constructor. Exceptions: none

---

Member Function Documentation

virtual CP_CharStatus CP_KeyInputFilter::IsKeyValid (  char  inChar  )  [pure virtual]

Subclasses must override this to determine if the character passed in is valid. Parameters: inChar  The character to check. Exceptions: none  Returns: CP_CharStatus Type of character passed in. Implemented in CP_KeyInputFilter_AlphaNumeric, CP_KeyInputFilter_Numeric, and CP_KeyInputFilter_UnicodeAlphaNumeric.

virtual CP_CharStatus CP_KeyInputFilter::IsKeyValid (  const CPUniChar *  , UInt32  )  [virtual]

Subclasses override this to determine if the character passed in is valid. This version checks the passed in Unicode character. Parameters: inChar  The Unicode character to check. inDataLength  Length of the passed in string. Exceptions: none  Returns: CP_CharStatus Returns CP_CharStatus_PassUp. Reimplemented in CP_KeyInputFilter_Numeric, and CP_KeyInputFilter_UnicodeAlphaNumeric.

bool CP_KeyInputFilter::IsADeleteKey (  char  inChar  )  [protected]

Return true if the passed in inChar is a delete key (backspace). Parameters: inChar  The character to test. Exceptions: bool  Return true if the passed in character is a delete key.

bool CP_KeyInputFilter::IsACursorKey (  char  inChar  )  [protected]

Return true if our inChar is one of our cursor keys. i.e. left, right, up and down editing arrows. Parameters: inChar  The character to test. Exceptions: bool  Return true if the passed in character is a cursor key.

bool CP_KeyInputFilter::IsAScrollKey (  char  inChar  )  [protected]

Return true if our inChar is one of our scroling keys. i.e. page up, page down, home or end. Parameters: inChar  The character to test. Exceptions: bool  Return true if the passed in character is a scroll key.

UInt32 CP_M_RefCounted::AddReference (   )  const [inherited]

Add a reference to our object, returning the new reference count. Exceptions: none  Returns: UInt32 const Returns the new reference count.

UInt32 CP_M_RefCounted::RemoveReference (   )  const [inherited]

Remove a reference to our object, returning the new reference count. If the count is 0, then this object is also deleted, and 0 is returned. Exceptions: none  Returns: UInt32 const Returns the new reference count.

void CP_M_RefCounted::Autorelease (   )  const [inherited]

Add the object to the topmost auto-release pool. This will ensure that the object is eventually released. See also: CP_AutoReleasePool Exceptions: none  Returns: void

UInt32 CP_M_RefCounted::GetRefCount (   )  const [inherited]

Returns the current ref count. Exceptions: none  Returns: UInt32 The current referencce count.

---

The documentation for this class was generated from the following files:

• CP_KeyInputFilters.h
• CP_KeyInputFilters.cpp

---