[wxWidgets.git] / docs / latex / wx / stdevtid.tex

\section{Standard event identifiers}\label{stdevtid}

wxWidgets defines a special identifier value {\tt wxID\_ANY} which is used in
the following two situations:

\begin{itemize}
\item when creating a new window you may specify {\tt wxID\_ANY} to let
wxWidgets assign an unused identifier to it automatically
\item when installing an event handler using either the event table
macros or \helpref{wxEvtHandler::Connect}{wxevthandlerconnect},
you may use it to indicate that you want to handle the events
coming from any control, regardless of its identifier
\end{itemize}

wxWidgets also defines a few standard command identifiers which may be used by
the user code and also are sometimes used by wxWidgets itself. These reserved
identifiers are all in the range between {\tt wxID\_LOWEST} and 
{\tt wxID\_HIGHEST} and, accordingly, the user code should avoid defining its
own constants in this range.

\begin{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_PREVIEW,
    wxID_ABOUT,
    wxID_HELP_CONTENTS,
    wxID_HELP_COMMANDS,
    wxID_HELP_PROCEDURES,
    wxID_HELP_CONTEXT,
    wxID_CLOSE_ALL,

    wxID_CUT = 5030,
    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_FILE1 = 5050,
    wxID_FILE2,
    wxID_FILE3,
    wxID_FILE4,
    wxID_FILE5,
    wxID_FILE6,
    wxID_FILE7,
    wxID_FILE8,
    wxID_FILE9,

    // Standard button 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_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,

    // IDs used by generic file dialog (13 consecutive starting from this value)
    wxID_FILEDLGG = 5900,

    wxID_HIGHEST = 5999
\end{verbatim}
Commit	Line	Data
ab246904 VZ	1	\section{Standard event identifiers}\label{stdevtid}
ab246904 VZ	2
fc2171bd	3	wxWidgets defines a special identifier value {\tt wxID\_ANY} which is used in
ab246904	4	the following two situations:
d2c2afc9	5
ab246904	6	\begin{itemize}
d2c2afc9	7	\item when creating a new window you may specify {\tt wxID\_ANY} to let
fc2171bd	8	wxWidgets assign an unused identifier to it automatically
d2c2afc9 JS	9	\item when installing an event handler using either the event table
	10	macros or \helpref{wxEvtHandler::Connect}{wxevthandlerconnect},
	11	you may use it to indicate that you want to handle the events
	12	coming from any control, regardless of its identifier
ab246904 VZ	13	\end{itemize}
ab246904 VZ	14
fc2171bd JS	15	wxWidgets also defines a few standard command identifiers which may be used by
fc2171bd JS	16	the user code and also are sometimes used by wxWidgets itself. These reserved
ab246904 VZ	17	identifiers are all in the range between {\tt wxID\_LOWEST} and
	18	{\tt wxID\_HIGHEST} and, accordingly, the user code should avoid defining its
	19	own constants in this range.
	20
	21	\begin{verbatim}
	22	wxID_LOWEST = 4999,
	23
	24	wxID_OPEN,
	25	wxID_CLOSE,
	26	wxID_NEW,
	27	wxID_SAVE,
	28	wxID_SAVEAS,
	29	wxID_REVERT,
	30	wxID_EXIT,
	31	wxID_UNDO,
	32	wxID_REDO,
	33	wxID_HELP,
	34	wxID_PRINT,
	35	wxID_PRINT_SETUP,
	36	wxID_PREVIEW,
	37	wxID_ABOUT,
	38	wxID_HELP_CONTENTS,
	39	wxID_HELP_COMMANDS,
	40	wxID_HELP_PROCEDURES,
	41	wxID_HELP_CONTEXT,
	42	wxID_CLOSE_ALL,
	43
	44	wxID_CUT = 5030,
	45	wxID_COPY,
	46	wxID_PASTE,
	47	wxID_CLEAR,
	48	wxID_FIND,
	49	wxID_DUPLICATE,
	50	wxID_SELECTALL,
e9f4f51d JS	51	wxID_DELETE,
	52	wxID_REPLACE,
	53	wxID_REPLACE_ALL,
	54	wxID_PROPERTIES,
	55
	56	wxID_VIEW_DETAILS,
	57	wxID_VIEW_LARGEICONS,
	58	wxID_VIEW_SMALLICONS,
	59	wxID_VIEW_LIST,
	60	wxID_VIEW_SORTDATE,
	61	wxID_VIEW_SORTNAME,
	62	wxID_VIEW_SORTSIZE,
	63	wxID_VIEW_SORTTYPE,
ab246904 VZ	64
	65	wxID_FILE1 = 5050,
	66	wxID_FILE2,
	67	wxID_FILE3,
	68	wxID_FILE4,
	69	wxID_FILE5,
	70	wxID_FILE6,
	71	wxID_FILE7,
	72	wxID_FILE8,
	73	wxID_FILE9,
	74
	75	// Standard button IDs
	76	wxID_OK = 5100,
	77	wxID_CANCEL,
	78	wxID_APPLY,
	79	wxID_YES,
	80	wxID_NO,
	81	wxID_STATIC,
	82	wxID_FORWARD,
	83	wxID_BACKWARD,
	84	wxID_DEFAULT,
	85	wxID_MORE,
	86	wxID_SETUP,
	87	wxID_RESET,
	88	wxID_CONTEXT_HELP,
	89	wxID_YESTOALL,
	90	wxID_NOTOALL,
	91	wxID_ABORT,
	92	wxID_RETRY,
	93	wxID_IGNORE,
	94
e9f4f51d JS	95	wxID_UP,
	96	wxID_DOWN,
	97	wxID_HOME,
	98	wxID_REFRESH,
	99	wxID_STOP,
	100	wxID_INDEX,
	101
	102	wxID_BOLD,
	103	wxID_ITALIC,
	104	wxID_JUSTIFY_CENTER,
	105	wxID_JUSTIFY_FILL,
	106	wxID_JUSTIFY_RIGHT,
	107	wxID_JUSTIFY_LEFT,
	108	wxID_UNDERLINE,
	109	wxID_INDENT,
	110	wxID_UNINDENT,
	111	wxID_ZOOM_100,
	112	wxID_ZOOM_FIT,
	113	wxID_ZOOM_IN,
	114	wxID_ZOOM_OUT,
	115	wxID_UNDELETE,
	116	wxID_REVERT_TO_SAVED,
	117
ab246904 VZ	118	// System menu IDs (used by wxUniv):
	119	wxID_SYSTEM_MENU = 5200,
	120	wxID_CLOSE_FRAME,
	121	wxID_MOVE_FRAME,
	122	wxID_RESIZE_FRAME,
	123	wxID_MAXIMIZE_FRAME,
	124	wxID_ICONIZE_FRAME,
	125	wxID_RESTORE_FRAME,
	126
	127	// IDs used by generic file dialog (13 consecutive starting from this value)
	128	wxID_FILEDLGG = 5900,
	129
	130	wxID_HIGHEST = 5999
	131	\end{verbatim}
	132