Class: TKeyMapRuleIterator

Declaration: Keyboards.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

Provides a means of displaying the contents of a virtual keyboard by iterating over those contents. Returns a copy of the rule. The caller is responsible for deleting each returned rule.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derive as necessary for derived classes of TStandardEditableVirtualKeyboard.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TKeyMapRuleIterator::TKeyMapRuleIterator

TKeyMapRuleIterator (TStandardEditableVirtualKeyboard * mapping)
TKeyMapRuleIterator ()

Interface Category:

API.

Purpose:

Creates an iterator from the TStandardEditableVirtualKeyboard specified in mapping.
Default constructor.

Calling Context:

Called by TStandardEditableVirtualKeyboard::CreateIterator and directly.
Called by the stream-in operators.

Parameters:

TStandardEditableVirtualKeyboard * mapping -The keyboard over which this iterator will iterate.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TKeyMapRuleIterator::~TKeyMapRuleIterator

virtual ~ TKeyMapRuleIterator ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TKeyMapRuleIterator::Next

virtual bool Next (TKeyResultPair & next)

Interface Category:

API.

Purpose:

Returns the next rule (TKeyResultPair) in this keyboard. The caller is responsible for deleting the rule.

Calling Context:

Called by keyboard editor programs. TKeyMapRuleIterator::First must have been previously called.

Parameters:

TKeyResultPair & next -Receives the next rule in this keyboard.

Return Value:

Returns true if a rule was returned in next.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TKeyMapRuleIterator::First

virtual bool First (TKeyResultPair & first)

Interface Category:

API.

Purpose:

Synchronizes the iterator and returns the first rule (TKeyResultPair) in this keyboard.

Calling Context:

Called directly by keyboard editor programs. Must be called before TKeyMapRuleIterator::Next .

Parameters:

TKeyResultPair & first -Receives the first rule in this keyboard.

Return Value:

Returns true if a rule was returned in first.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.