wxAcceleratorEntry Class Reference
[Data Structures]
#include <wx/accel.h>
Detailed Description
An object used by an application wishing to create an accelerator table (see wxAcceleratorTable).
- See also:
- 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 | Should be a string in the form "flags-keycode" |
- 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::ToString |
( |
|
) |
const |
Returns a wxString for this accelerator.
This function formats it using the "flags-keycode"
format where flags
maybe a hyphen-separed list of "shift|alt|ctrl"
.