keybinder.h File Reference

#include "wx/keybinderdef.h"
#include "wx/panel.h"
#include "wx/dialog.h"
#include "wx/listbox.h"
#include "wx/treectrl.h"
#include "wx/menu.h"
#include "wx/button.h"
#include "wx/stattext.h"
#include "wx/textctrl.h"
#include "wx/combobox.h"
#include "wx/app.h"

Include dependency graph for keybinder.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	wxKeyBind
	Identifies a keypress, that is a key binding. More...
class	wxCmd
	Represents one of the commands which are handled by a wxKeyBinder. More...
struct	wxCmd::wxCmdType
	A registered type of wxCmd-derived class. More...
class	wxCmdArray
	Defines a wxObjArray-like array of wxCmd. More...
class	wxBinderEvtHandler
	This is a wxEvtHandler which can be attached to any wxWindow-derived class. More...
class	wxBinderApp
	A special wxApp. More...
class	wxKeyBinder
	This is the real keybinder. More...
class	wxKeyProfile
	A little extension of the wxKeyBinder class. More...
class	wxKeyProfileArray
	An array of wxKeyProfiles. More...
class	wxKeyMonitorTextCtrl
	A special text control where the user keypresses are displayed as the contained text. More...
class	wxKeyConfigPanel
	A powerful keybinding editing panel. More...
wxKeyConfigPanel styles
These flags affect the way a wxKeyConfigPanel is created. See wxKeyConfigPanel::wxKeyConfigPanel.
#define	wxKEYBINDER_USE_TREECTRL   1
	If specified, the wxKeyConfigPanel will use a wxTreeCtrl to group the keybindings.
#define	wxKEYBINDER_USE_LISTBOX   2
	If specified, the wxKeyConfigPanel will use a wxComboBox+wxListBox to group the keybindings.
#define	wxKEYBINDER_SHOW_APPLYBUTTON   4
	If specified, an "Apply" and a "Cancel" button will be added in the bottom part of the wxKeyConfigPanel.
#define	wxKEYBINDER_SHOW_ADDREMOVE_PROFILE   8
	If specified a "Add new" and a "Remove" button will be added next to key profiles combobox.
#define	wxKEYBINDER_ENABLE_PROFILE_EDITING   16
	If specified, the user will be able to edit the name of the currently selected profile.
#define	wxKEYBINDER_DEFAULT_STYLE
	The default style for a wxKeyConfigPanel.
Defines
#define	wxCMD_MAX_SHORTCUTS   3
#define	wxID_INVALID   -1
#define	wxKEYBINDER_DEBUG_MSG   0
#define	wxCMD_MAX_TYPES   16
	The maximum number of wxCmd-derived classes.
#define	wxCMD_CONFIG_PREFIX   wxT("bind")
	This is a string used by wxCmd::Load/Save to read/write wxCmds into wxConfig objects.
#define	wxADD_KEYBINDER_SUPPORT()
#define	wxKEYPROFILE_CONFIG_PREFIX   wxT("keyprof")
	This is a string used by wxKeyProfileArray::Load/Save to read/write wxKeyProfileArrays into wxConfig objects.
#define	wxKEYBINDER_BASEID   30000
#define	wxKEYBINDER_COMMANDS_BOX_ID   wxKEYBINDER_BASEID+1
#define	wxKEYBINDER_BINDINGS_BOX_ID   wxKEYBINDER_BASEID+2
#define	wxKEYBINDER_KEY_FIELD_ID   wxKEYBINDER_BASEID+3
#define	wxKEYBINDER_ASSIGN_KEY_ID   wxKEYBINDER_BASEID+4
#define	wxKEYBINDER_REMOVE_KEY_ID   wxKEYBINDER_BASEID+5
#define	wxKEYBINDER_REMOVEALL_KEY_ID   wxKEYBINDER_BASEID+6
#define	wxKEYBINDER_KEYPROFILES_ID   wxKEYBINDER_BASEID+7
#define	wxKEYBINDER_CATEGORIES_ID   wxKEYBINDER_BASEID+8
#define	wxKEYBINDER_ADD_PROFILEBTN_ID   wxKEYBINDER_BASEID+9
#define	wxKEYBINDER_REMOVE_PROFILEBTN_ID   wxKEYBINDER_BASEID+10
#define	wxKEYBINDER_SELECTED_POSTFIX   wxT(" (selected)")
Functions
void	wxKBLogDebug (const wxChar *WXUNUSED(fmt),...)

---

Define Documentation

 

#define wxADD_KEYBINDER_SUPPORT

(

)

#define wxCMD_CONFIG_PREFIX   wxT("bind")

This is a string used by wxCmd::Load/Save to read/write wxCmds into wxConfig objects.

#define wxCMD_MAX_SHORTCUTS   3

#define wxCMD_MAX_TYPES   16

The maximum number of wxCmd-derived classes.

#define wxID_INVALID   -1

#define wxKEYBINDER_ADD_PROFILEBTN_ID   wxKEYBINDER_BASEID+9

#define wxKEYBINDER_ASSIGN_KEY_ID   wxKEYBINDER_BASEID+4

#define wxKEYBINDER_BASEID   30000

#define wxKEYBINDER_BINDINGS_BOX_ID   wxKEYBINDER_BASEID+2

#define wxKEYBINDER_CATEGORIES_ID   wxKEYBINDER_BASEID+8

#define wxKEYBINDER_COMMANDS_BOX_ID   wxKEYBINDER_BASEID+1

#define wxKEYBINDER_DEBUG_MSG   0

#define wxKEYBINDER_DEFAULT_STYLE

Value:

(wxKEYBINDER_SHOW_APPLYBUTTON|wxKEYBINDER_USE_TREECTRL|                 \
         wxKEYBINDER_SHOW_ADDREMOVE_PROFILE|wxKEYBINDER_ENABLE_PROFILE_EDITING| \
         wxTAB_TRAVERSAL)

The default style for a wxKeyConfigPanel.

#define wxKEYBINDER_ENABLE_PROFILE_EDITING   16

If specified, the user will be able to edit the name of the currently selected profile.

#define wxKEYBINDER_KEY_FIELD_ID   wxKEYBINDER_BASEID+3

#define wxKEYBINDER_KEYPROFILES_ID   wxKEYBINDER_BASEID+7

#define wxKEYBINDER_REMOVE_KEY_ID   wxKEYBINDER_BASEID+5

#define wxKEYBINDER_REMOVE_PROFILEBTN_ID   wxKEYBINDER_BASEID+10

#define wxKEYBINDER_REMOVEALL_KEY_ID   wxKEYBINDER_BASEID+6

#define wxKEYBINDER_SELECTED_POSTFIX   wxT(" (selected)")

#define wxKEYBINDER_SHOW_ADDREMOVE_PROFILE   8

If specified a "Add new" and a "Remove" button will be added next to key profiles combobox.

#define wxKEYBINDER_SHOW_APPLYBUTTON   4

If specified, an "Apply" and a "Cancel" button will be added in the bottom part of the wxKeyConfigPanel.

#define wxKEYBINDER_USE_LISTBOX   2

If specified, the wxKeyConfigPanel will use a wxComboBox+wxListBox to group the keybindings.

Note:

This flag must be specified if and only if wxKEYBINDER_USE_TREECTRL has not been specified.

#define wxKEYBINDER_USE_TREECTRL   1

If specified, the wxKeyConfigPanel will use a wxTreeCtrl to group the keybindings.

Note:

This flag must be specified if and only if wxKEYBINDER_USE_LISTBOX has not been specified.

#define wxKEYPROFILE_CONFIG_PREFIX   wxT("keyprof")

This is a string used by wxKeyProfileArray::Load/Save to read/write wxKeyProfileArrays into wxConfig objects.

---

Function Documentation

void wxKBLogDebug	(	const wxChar *	WXUNUSED(fmt),
			...
	)			[inline]

---