document various enumerations defined in defs.h; give a name to the anonymous enum for the standard IDs; move wxKeyCode and wxKeyModifier enums in defs.h removing their dedicated pages of the manual
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@58472 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -1,154 +0,0 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: platdetails.h
|
||||
// Purpose: wxKeyCode values enumerated
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
|
||||
/**
|
||||
|
||||
@page page_keycodes Keycodes
|
||||
|
||||
@header{wx/defs.h}
|
||||
|
||||
Keypresses are represented by an enumerated type, wxKeyCode. The possible
|
||||
values are the ASCII character codes, plus the following:
|
||||
|
||||
@verbatim
|
||||
WXK_BACK = 8
|
||||
WXK_TAB = 9
|
||||
WXK_RETURN = 13
|
||||
WXK_ESCAPE = 27
|
||||
WXK_SPACE = 32
|
||||
WXK_DELETE = 127
|
||||
|
||||
// These are by design not compatible with unicode characters.
|
||||
// If you want to get a unicode character from a key event use
|
||||
// wxKeyEvent::GetUnicodeKey instead.
|
||||
WXK_START = 300
|
||||
WXK_LBUTTON
|
||||
WXK_RBUTTON
|
||||
WXK_CANCEL
|
||||
WXK_MBUTTON
|
||||
WXK_CLEAR
|
||||
WXK_SHIFT
|
||||
WXK_ALT
|
||||
WXK_CONTROL
|
||||
WXK_MENU
|
||||
WXK_PAUSE
|
||||
WXK_CAPITAL
|
||||
WXK_END
|
||||
WXK_HOME
|
||||
WXK_LEFT
|
||||
WXK_UP
|
||||
WXK_RIGHT
|
||||
WXK_DOWN
|
||||
WXK_SELECT
|
||||
WXK_PRINT
|
||||
WXK_EXECUTE
|
||||
WXK_SNAPSHOT
|
||||
WXK_INSERT
|
||||
WXK_HELP
|
||||
WXK_NUMPAD0
|
||||
WXK_NUMPAD1
|
||||
WXK_NUMPAD2
|
||||
WXK_NUMPAD3
|
||||
WXK_NUMPAD4
|
||||
WXK_NUMPAD5
|
||||
WXK_NUMPAD6
|
||||
WXK_NUMPAD7
|
||||
WXK_NUMPAD8
|
||||
WXK_NUMPAD9
|
||||
WXK_MULTIPLY
|
||||
WXK_ADD
|
||||
WXK_SEPARATOR
|
||||
WXK_SUBTRACT
|
||||
WXK_DECIMAL
|
||||
WXK_DIVIDE
|
||||
WXK_F1
|
||||
WXK_F2
|
||||
WXK_F3
|
||||
WXK_F4
|
||||
WXK_F5
|
||||
WXK_F6
|
||||
WXK_F7
|
||||
WXK_F8
|
||||
WXK_F9
|
||||
WXK_F10
|
||||
WXK_F11
|
||||
WXK_F12
|
||||
WXK_F13
|
||||
WXK_F14
|
||||
WXK_F15
|
||||
WXK_F16
|
||||
WXK_F17
|
||||
WXK_F18
|
||||
WXK_F19
|
||||
WXK_F20
|
||||
WXK_F21
|
||||
WXK_F22
|
||||
WXK_F23
|
||||
WXK_F24
|
||||
WXK_NUMLOCK
|
||||
WXK_SCROLL
|
||||
WXK_PAGEUP,
|
||||
WXK_PAGEDOWN,
|
||||
|
||||
WXK_NUMPAD_SPACE,
|
||||
WXK_NUMPAD_TAB,
|
||||
WXK_NUMPAD_ENTER,
|
||||
WXK_NUMPAD_F1,
|
||||
WXK_NUMPAD_F2,
|
||||
WXK_NUMPAD_F3,
|
||||
WXK_NUMPAD_F4,
|
||||
WXK_NUMPAD_HOME,
|
||||
WXK_NUMPAD_LEFT,
|
||||
WXK_NUMPAD_UP,
|
||||
WXK_NUMPAD_RIGHT,
|
||||
WXK_NUMPAD_DOWN,
|
||||
WXK_NUMPAD_PAGEUP,
|
||||
WXK_NUMPAD_PAGEDOWN,
|
||||
WXK_NUMPAD_END,
|
||||
WXK_NUMPAD_BEGIN,
|
||||
WXK_NUMPAD_INSERT,
|
||||
WXK_NUMPAD_DELETE,
|
||||
WXK_NUMPAD_EQUAL,
|
||||
WXK_NUMPAD_MULTIPLY,
|
||||
WXK_NUMPAD_ADD,
|
||||
WXK_NUMPAD_SEPARATOR,
|
||||
WXK_NUMPAD_SUBTRACT,
|
||||
WXK_NUMPAD_DECIMAL,
|
||||
WXK_NUMPAD_DIVIDE,
|
||||
|
||||
// the following key codes are only generated under Windows currently
|
||||
WXK_WINDOWS_LEFT,
|
||||
WXK_WINDOWS_RIGHT,
|
||||
WXK_WINDOWS_MENU,
|
||||
WXK_COMMAND,
|
||||
|
||||
// Hardware-specific buttons
|
||||
WXK_SPECIAL1 = 193,
|
||||
WXK_SPECIAL2,
|
||||
WXK_SPECIAL3,
|
||||
WXK_SPECIAL4,
|
||||
WXK_SPECIAL5,
|
||||
WXK_SPECIAL6,
|
||||
WXK_SPECIAL7,
|
||||
WXK_SPECIAL8,
|
||||
WXK_SPECIAL9,
|
||||
WXK_SPECIAL10,
|
||||
WXK_SPECIAL11,
|
||||
WXK_SPECIAL12,
|
||||
WXK_SPECIAL13,
|
||||
WXK_SPECIAL14,
|
||||
WXK_SPECIAL15,
|
||||
WXK_SPECIAL16,
|
||||
WXK_SPECIAL17,
|
||||
WXK_SPECIAL18,
|
||||
WXK_SPECIAL19,
|
||||
WXK_SPECIAL20
|
||||
@endverbatim
|
||||
|
||||
*/
|
@@ -1,42 +0,0 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: keymod.h
|
||||
// Purpose: key modifiers
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
|
||||
/**
|
||||
|
||||
@page page_keymodifiers Key Modifiers
|
||||
|
||||
@header{wx/defs.h}
|
||||
|
||||
The following key modifier constants are defined:
|
||||
|
||||
@verbatim
|
||||
enum wxKeyModifier
|
||||
{
|
||||
wxMOD_NONE = 0x0000,
|
||||
wxMOD_ALT = 0x0001,
|
||||
wxMOD_CONTROL = 0x0002,
|
||||
wxMOD_ALTGR = wxMOD_ALT | wxMOD_CONTROL,
|
||||
wxMOD_SHIFT = 0x0004,
|
||||
wxMOD_META = 0x0008,
|
||||
#if defined(__WXMAC__) || defined(__WXCOCOA__)
|
||||
wxMOD_CMD = wxMOD_META,
|
||||
#else
|
||||
wxMOD_CMD = wxMOD_CONTROL,
|
||||
#endif
|
||||
wxMOD_ALL = 0xffff
|
||||
};
|
||||
@endverbatim
|
||||
|
||||
Notice that @c wxMOD_CMD should be used instead of @c wxMOD_CONTROL
|
||||
in portable code to account for the fact that although
|
||||
@c Control modifier exists under Mac OS, it is not used for the same
|
||||
purpose as under Windows or Unix there while the special Mac-specific
|
||||
@c Command modifier is used in exactly the same way.
|
||||
|
||||
*/
|
@@ -30,137 +30,6 @@ identifiers are all in the range between @c wxID_LOWEST and
|
||||
@c wxID_HIGHEST and, accordingly, the user code should avoid defining its
|
||||
own constants in this range (e.g. by using wxNewId()).
|
||||
|
||||
@verbatim
|
||||
wxID_LOWEST = 4999,
|
||||
|
||||
wxID_OPEN,
|
||||
wxID_CLOSE,
|
||||
wxID_NEW,
|
||||
wxID_SAVE,
|
||||
wxID_SAVEAS,
|
||||
wxID_REVERT,
|
||||
wxID_EXIT,
|
||||
wxID_UNDO,
|
||||
wxID_REDO,
|
||||
wxID_HELP,
|
||||
wxID_PRINT,
|
||||
wxID_PRINT_SETUP,
|
||||
wxID_PAGE_SETUP,
|
||||
wxID_PREVIEW,
|
||||
wxID_ABOUT,
|
||||
wxID_HELP_CONTENTS,
|
||||
wxID_HELP_INDEX,
|
||||
wxID_HELP_SEARCH,
|
||||
wxID_HELP_COMMANDS,
|
||||
wxID_HELP_PROCEDURES,
|
||||
wxID_HELP_CONTEXT,
|
||||
wxID_CLOSE_ALL,
|
||||
wxID_PREFERENCES,
|
||||
|
||||
wxID_EDIT = 5030,
|
||||
wxID_CUT,
|
||||
wxID_COPY,
|
||||
wxID_PASTE,
|
||||
wxID_CLEAR,
|
||||
wxID_FIND,
|
||||
wxID_DUPLICATE,
|
||||
wxID_SELECTALL,
|
||||
wxID_DELETE,
|
||||
wxID_REPLACE,
|
||||
wxID_REPLACE_ALL,
|
||||
wxID_PROPERTIES,
|
||||
|
||||
wxID_VIEW_DETAILS,
|
||||
wxID_VIEW_LARGEICONS,
|
||||
wxID_VIEW_SMALLICONS,
|
||||
wxID_VIEW_LIST,
|
||||
wxID_VIEW_SORTDATE,
|
||||
wxID_VIEW_SORTNAME,
|
||||
wxID_VIEW_SORTSIZE,
|
||||
wxID_VIEW_SORTTYPE,
|
||||
|
||||
wxID_FILE = 5050,
|
||||
wxID_FILE1,
|
||||
wxID_FILE2,
|
||||
wxID_FILE3,
|
||||
wxID_FILE4,
|
||||
wxID_FILE5,
|
||||
wxID_FILE6,
|
||||
wxID_FILE7,
|
||||
wxID_FILE8,
|
||||
wxID_FILE9,
|
||||
|
||||
// Standard button and menu IDs
|
||||
wxID_OK = 5100,
|
||||
wxID_CANCEL,
|
||||
wxID_APPLY,
|
||||
wxID_YES,
|
||||
wxID_NO,
|
||||
wxID_STATIC,
|
||||
wxID_FORWARD,
|
||||
wxID_BACKWARD,
|
||||
wxID_DEFAULT,
|
||||
wxID_MORE,
|
||||
wxID_SETUP,
|
||||
wxID_RESET,
|
||||
wxID_CONTEXT_HELP,
|
||||
wxID_YESTOALL,
|
||||
wxID_NOTOALL,
|
||||
wxID_ABORT,
|
||||
wxID_RETRY,
|
||||
wxID_IGNORE,
|
||||
wxID_ADD,
|
||||
wxID_REMOVE,
|
||||
|
||||
wxID_UP,
|
||||
wxID_DOWN,
|
||||
wxID_HOME,
|
||||
wxID_REFRESH,
|
||||
wxID_STOP,
|
||||
wxID_INDEX,
|
||||
|
||||
wxID_BOLD,
|
||||
wxID_ITALIC,
|
||||
wxID_JUSTIFY_CENTER,
|
||||
wxID_JUSTIFY_FILL,
|
||||
wxID_JUSTIFY_RIGHT,
|
||||
wxID_JUSTIFY_LEFT,
|
||||
wxID_UNDERLINE,
|
||||
wxID_INDENT,
|
||||
wxID_UNINDENT,
|
||||
wxID_ZOOM_100,
|
||||
wxID_ZOOM_FIT,
|
||||
wxID_ZOOM_IN,
|
||||
wxID_ZOOM_OUT,
|
||||
wxID_UNDELETE,
|
||||
wxID_REVERT_TO_SAVED,
|
||||
|
||||
// System menu IDs (used by wxUniv)
|
||||
wxID_SYSTEM_MENU = 5200,
|
||||
wxID_CLOSE_FRAME,
|
||||
wxID_MOVE_FRAME,
|
||||
wxID_RESIZE_FRAME,
|
||||
wxID_MAXIMIZE_FRAME,
|
||||
wxID_ICONIZE_FRAME,
|
||||
wxID_RESTORE_FRAME,
|
||||
|
||||
// MDI window menu ids
|
||||
wxID_MDI_WINDOW_FIRST = 5230,
|
||||
wxID_MDI_WINDOW_CASCADE = wxID_MDI_WINDOW_FIRST,
|
||||
wxID_MDI_WINDOW_TILE_HORZ,
|
||||
wxID_MDI_WINDOW_TILE_VERT,
|
||||
wxID_MDI_WINDOW_ARRANGE_ICONS,
|
||||
wxID_MDI_WINDOW_PREV,
|
||||
wxID_MDI_WINDOW_NEXT,
|
||||
wxID_MDI_WINDOW_LAST = wxID_MDI_WINDOW_NEXT,
|
||||
|
||||
// IDs used by generic file dialog (13 consecutive starting from this value)
|
||||
wxID_FILEDLGG = 5900,
|
||||
|
||||
// IDs used by generic file ctrl (4 consecutive starting from this value)
|
||||
wxID_FILECTRL = 5950,
|
||||
|
||||
wxID_HIGHEST = 5999
|
||||
@endverbatim
|
||||
Refer to ::wxStockID enumeration values for the reference of these IDs.
|
||||
|
||||
*/
|
||||
|
@@ -13,8 +13,6 @@
|
||||
|
||||
This chapter describes the constants defined by wxWidgets.
|
||||
|
||||
@li @subpage page_keycodes
|
||||
@li @subpage page_keymodifiers
|
||||
@li @subpage page_stdevtid
|
||||
@li @subpage page_stockitems
|
||||
@li @subpage page_cppconst
|
||||
|
Reference in New Issue
Block a user