Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
None.
Inherited By:
None.
Purpose:
This class contains the virtual key codes that can be mapped to the keyboards that will run under the CommonPoint application system. TVirtualKeyCode contains both standard, extended, and non-portable key codes. The standard key codes represent keys that will be common to all keyboards. The extended key codes are for keys found on IBM 101/102/103 series of keyboards and Mac Extended II style of keyboards. The non-portable key codes are for non-standard keyboards and are not guaranteed to be usable on all platforms.
The standard text virtual key codes represent typical key caps as shown. Actual text results will vary with keyboard mappings. For example, virtual keys kD01...kD06 using a standard French keyboard would yield a, z, e, r, t, y.
Please note that the comments for each code suggest, but are not limited to, the common key cap appearance and semantic.
Instantiation:
This class is never instantiated directly.
Deriving Classes:
None.
Concurrency:
Multithread safe.
Resource Use:
No special requirements.
Member Function: TVirtualKeyCode::GetClassificationAndType
static void GetClassificationAndType (EVirtualKey theKey, EVirtualKeyClassification & classification, EVirtualKeyType & type)
Interface Category:
API.
Purpose:
Returns the classification (standard, extended, or non-portable) and type (modifier, action, or text) for the specified key code.
Calling Context:
While handling keyboard events, this function can be invoked to get the key code classification and type.
Parameters:
- EVirtualKey theKey -The key code for which we need information.
- EVirtualKeyClassification & classification -The key code's classification as returned by this function.
- EVirtualKeyType & type -The key code type as returned by this function.
Return Value:
None.
Exceptions:
Throws no exceptions.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TVirtualKeyCode::VirtualKeyIsModifier
static bool VirtualKeyIsModifier (EVirtualKey theKey)
Interface Category:
API.
Purpose:
Tests whether or not the specified key code is a modifier.
Calling Context:
While handling keyboard events, this function can be invoked to test whether or not the specified key code is a modifier.
Parameters:
- EVirtualKey theKey -The virtual key code in question.
Return Value:
Returns true if the key code is of type modifier; false otherwise.
Exceptions:
Throws no exceptions.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TVirtualKeyCode::VirtualKeyIsAction
static bool VirtualKeyIsAction (EVirtualKey theKey)
Interface Category:
API.
Purpose:
Tests whether or not the specified key code is of type action.
Calling Context:
While handling keyboard events, this function can be invoked to test whether or not the specified key code is of type action.
Parameters:
- EVirtualKey theKey -The key code in question.
Return Value:
Returns true if the key code is of type action; false otherwise.
Exceptions:
Throws no exceptions.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TVirtualKeyCode::VirtualKeyIsText
static bool VirtualKeyIsText (EVirtualKey theKey)
Interface Category:
API.
Purpose:
Tests whether or not the specified key code is of type text.
Calling Context:
While handling keyboard events, this function can be invoked to test whether or not the specified key code is of type text.
Parameters:
- EVirtualKey theKey -The key code in question.
Return Value:
Returns true if the key code is of type text; false otherwise.
Exceptions:
Throws no exceptions.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TVirtualKeyCode::VirtualKeyIsStandard
static bool VirtualKeyIsStandard (EVirtualKey theKey)
Interface Category:
API.
Purpose:
Tests whether or not the specified key code is classified as standard.
Calling Context:
While handling keyboard events, this function can be invoked to test whether or not the specified key code is classified as standard.
Parameters:
- EVirtualKey theKey -The key code in question.
Return Value:
Returns true if the key code is classified as standard; false otherwise.
Exceptions:
Throws no exceptions.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TVirtualKeyCode::VirtualKeyIsExtended
static bool VirtualKeyIsExtended (EVirtualKey theKey)
Interface Category:
API.
Purpose:
Tests whether or not the specified key code is classified as extended.
Calling Context:
While handling keyboard events, this function can be invoked to test whether or not the specified key code is classified extended.
Parameters:
- EVirtualKey theKey -The key code in question.
Return Value:
Returns true if the key code is classified as extended; false otherwise.
Exceptions:
Throws no exceptions.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TVirtualKeyCode::VirtualKeyIsNonPortable
static bool VirtualKeyIsNonPortable (EVirtualKey theKey)
Interface Category:
API.
Purpose:
Tests whether or not the specified key code is classified as non-portable.
Calling Context:
While handling keyboard events, this function can be invoked to whether or not the specified key code is classified as non-portable.
Parameters:
- EVirtualKey theKey -The key code in question.
Return Value:
Returns true if the key code is classified as non-portable, false if it is not.
Exceptions:
Throws no exceptions.
Concurrency:
Multithread safe.
Other Considerations:
None.
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.