CMFCAcceleratorKey Class
A helper class that implements virtual key mapping and formatting.
Syntax
class CMFCAcceleratorKey : public CObject
Members
Public Constructors
| Name | Description |
|---|---|
| CMFCAcceleratorKey::CMFCAcceleratorKey | Constructs a CMFCAcceleratorKey object. |
Public Methods
| Name | Description |
|---|---|
| CMFCAcceleratorKey::Format | Translates the ACCEL structure to its visual representation. |
| CMFCAcceleratorKey::SetAccelerator | Sets the shortcut key for the CMFCAcceleratorKey object. |
Remarks
Accelerator keys are also known as shortcut keys. If you want to display keyboard shortcuts that a user enters, the CMFCAcceleratorKeyAssignCtrl Class maps keyboard shortcuts, such as Alt+Shift+S, to a custom text format, such as "Alt + Shift + S". Each CMFCAcceleratorKey object maps a single shortcut key to a text format.
For more information about how to use shortcut keys and accelerator tables, see CKeyboardManager Class.
Example
The following example demonstrates how to construct a CMFCAcceleratorKey object and how to use its Format method.
CString strKey;
ACCEL accel;
accel.fVirt = FVIRTKEY | FCONTROL;
accel.key = VK_DOWN;
CMFCAcceleratorKey helper(&accel);
helper.Format(strKey);
Inheritance Hierarchy
CMFCAcceleratorKey
Requirements
Header: afxacceleratorkey.h
CMFCAcceleratorKey::CMFCAcceleratorKey
Constructs a CMFCAcceleratorKey object.
CMFCAcceleratorKey();
CMFCAcceleratorKey(LPACCEL lpAccel);
Parameters
lpAccel
[in] A pointer to a shortcut key.
Remarks
If you do not provide a shortcut key when you create a CMFCAccleratorKey, use the CMFCAcceleratorKey::SetAccelerator method to associate a shortcut key with your CMFCAcceleratorKey object.
CMFCAcceleratorKey::Format
Translates the ACCEL structure to its associated string value.
void Format(CString& str) const;
Parameters
str
[out] A reference to a CString object where the method writes the translated shortcut key.
Remarks
This method retrieves the string format of the associated shortcut key. You can set the string format of a CMFCAcceleratorKey object using either the constructor or the method CMFCAcceleratorKey::SetAccelerator.
CMFCAcceleratorKey::SetAccelerator
Sets the shortcut key for the CMFCAcceleratorKey object.
void SetAccelerator(LPACCEL lpAccel);
Parameters
lpAccel
[in] A pointer to a shortcut key.
Remarks
Use this method to set the shortcut key for a CMFCAcceleratorKey if you did not provide a shortcut key when you created the CMFCAcceleratorKey.