#include </home/zeitlin/src/wx/github/interface/wx/accel.h>
Detailed Description
An object used by an application wishing to create an accelerator table (see wxAcceleratorTable).
- 参照:
- wxAcceleratorTable, wxWindow::SetAcceleratorTable
List of all members.
Constructor & Destructor Documentation
wxAcceleratorEntry::wxAcceleratorEntry |
( |
int |
flags = 0 , |
|
|
int |
keyCode = 0 , |
|
|
int |
cmd = 0 , |
|
|
wxMenuItem * |
item = NULL |
|
) |
| |
Constructor.
- Parameters:
-
flags | A combination of the wxAcceleratorEntryFlags values, which indicates which modifier keys are held down. |
keyCode | The keycode to be detected. See wxKeyCode for a full list of keycodes. |
cmd | The menu or control command identifier (ID). |
item | The menu item associated with this accelerator. |
Member Function Documentation
bool wxAcceleratorEntry::FromString |
( |
const wxString & |
str | ) |
|
Parses the given string and sets the accelerator accordingly.
- Parameters:
-
str | This string may be either in the same format as returned by ToString(), i.e. contain the accelerator itself only, or have the format of a full menu item text with i.e. Label TAB Accelerator . In the latter case, the part of the string before the TAB is ignored. Notice that the latter format is only supported for the compatibility with the previous wxWidgets versions and the new code should pass only the accelerator string itself to this function. |
- Returns:
- true if the given string correctly initialized this object (i.e. if IsOk() returns true after this call)
int wxAcceleratorEntry::GetCommand |
( |
| ) |
const |
Returns the command identifier for the accelerator table entry.
int wxAcceleratorEntry::GetFlags |
( |
| ) |
const |
Returns the flags for the accelerator table entry.
int wxAcceleratorEntry::GetKeyCode |
( |
| ) |
const |
Returns the keycode for the accelerator table entry.
wxMenuItem* wxAcceleratorEntry::GetMenuItem |
( |
| ) |
const |
Returns the menu item associated with this accelerator entry.
bool wxAcceleratorEntry::IsOk |
( |
| ) |
const |
Returns true if this object is correctly initialized.
void wxAcceleratorEntry::Set |
( |
int |
flags, |
|
|
int |
keyCode, |
|
|
int |
cmd, |
|
|
wxMenuItem * |
item = NULL |
|
) |
| |
Sets the accelerator entry parameters.
- Parameters:
-
flags | A combination of the wxAcceleratorEntryFlags values, which indicates which modifier keys are held down. |
keyCode | The keycode to be detected. See wxKeyCode for a full list of keycodes. |
cmd | The menu or control command identifier (ID). |
item | The menu item associated with this accelerator. |
wxString wxAcceleratorEntry::ToRawString |
( |
| ) |
const |
Returns a textual representation of this accelerator which is appropriate for saving in configuration files.
Unlike the string returned by ToString(), this one is never translated so, while it's not suitable for showing to the user, it can be used to uniquely identify the accelerator independently of the user language.
The returned string can still be parsed by FromString().
- Since:
- 2.9.4
wxString wxAcceleratorEntry::ToString |
( |
| ) |
const |
Returns a textual representation of this accelerator.
The returned string is of the form [Alt+][Ctrl+][RawCtrl+][Shift+]Key
where the modifier keys are present only if the corresponding flag is set.