Class: TKeyResultPair

Declaration: Keyboards.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

Concrete class that represents the rules in a virtual keyboard. Used by TKeyMapRuleIterator.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derive as necessary for derived classes of TStandardEditableVirtualKeyboard that have different rule structures.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TKeyResultPair::SetModifiersOn

virtual void SetModifiersOn (const TModifierKeys & modsOn)

Interface Category:

API.

Purpose:

Sets the modifier keys that must be on for this key mapping rule.

Calling Context:

Called by keyboard editor programs.

Parameters:

const TModifierKeys & modsOn -The modifier keys that must be on.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TKeyResultPair::SetResult

virtual void SetResult (const TText & text)

Interface Category:

API.

Purpose:

Specifies a TText result for this mapping rule.

Calling Context:

Called by keyboard editor programs and internally.

Parameters:

const TText & text -The TText that will be generated by this rule.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TKeyResultPair::GetResult

virtual void GetResult (TText & text) const

Interface Category:

API.

Purpose:

Returns the TText result that is generated in this rule.

Calling Context:

Called directly by keyboard editor programs and internally.

Parameters:

TText & text -The TText key mapping result.

Return Value:

The result returned in the text parameter.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TKeyResultPair::operator=

TKeyResultPair & operator =(const TKeyResultPair & copy)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TKeyResultPair & copy -The source object for the assignment.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TKeyResultPair::operator<<=

virtual TStream & operator <<= (TStream & fromStream)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromWhere -The stream the object is streamed in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TKeyResultPair::operator>>=

virtual TStream & operator >>=(TStream & toStream) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & toWhere -The stream the object is streamed out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TKeyResultPair::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Generates a hash value.

Calling Context:

Called to generate a hash value.

Parameters:

Takes no parameters.

Return Value:

The numeric value of the hash.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TKeyResultPair::GetVirtualKey

virtual TVirtualKeyCode :: EVirtualKey GetVirtualKey () const

Interface Category:

API.

Purpose:

Returns the virtual key that generates this mapping.

Calling Context:

Called directly by keyboard editor programs and internally.

Parameters:

Takes no parameters.

Return Value:

Returns the key identifier.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TKeyResultPair::SetVirtualKey

virtual void SetVirtualKey (TVirtualKeyCode :: EVirtualKey virtualKey)

Interface Category:

API.

Purpose:

Sets the virtual key that generates this mapping.

Calling Context:

Called directly by keyboard editor programs when adding rules.

Parameters:

TVirtualKeyCode :: EVirtualKey virtualKey -The key that generates this rule.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TKeyResultPair::GetModifiersOn

virtual const TModifierKeys & GetModifiersOn () const

Interface Category:

API.

Purpose:

Returns the modifier keys that must be on for this rule.

Calling Context:

Called by keyboard editor programs and internally.

Parameters:

Takes no parameters.

Return Value:

The value of the modifier keys that must be on.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TKeyResultPair::TKeyResultPair

TKeyResultPair ()
TKeyResultPair (const TKeyResultPair & from)
TKeyResultPair (const UniChar singleCharResult, TVirtualKeyCode :: EVirtualKey key, const TModifierKeys & modsOn)
TKeyResultPair (const TText & textResult, TVirtualKeyCode :: EVirtualKey key, const TModifierKeys & modsOn)

Interface Category:

API.

Purpose:

Default constructor. Creates an empty rule.
Copy constructor.
Creates a usable rule for mapping to a single UniChar.
Creates a usable rule for mapping to zero or more UniChars.

Calling Context:

Called by the stream-in operators.
Called to copy an object.
Called directly by keyboard editor programs.
Called directly by keyboard editor programs.

Parameters:

Takes no parameters.
const TKeyResultPair & from -The object to copy.
const UniChar singleCharResult -The UniChar mapping result for this rule.
TVirtualKeyCode :: EVirtualKey key -The key that generates the UniChar.
const TModifierKeys & modsOn -The modifiers that must be on for the key to generate this UniChar.
const TText & textResult -The TText result for this rule.
TVirtualKeyCode :: EVirtualKey key -The key that generates the TText.
const TModifierKeys & modsOn -The modifiers that must be on for the key to generate this TText.

Return Value:

None.

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.