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

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

wxWindows 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
wxWindows 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}

wxWindows also defines a few standard command identifiers which may be used by
the user code and also are sometimes used by wxWindows 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_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,

    // 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}
	2
	3	wxWindows defines a special identifier value {\tt wxID\_ANY} which is used in
	4	the following two situations:
d2c2afc9	5
ab246904	6	\begin{itemize}
d2c2afc9 JS	7	\item when creating a new window you may specify {\tt wxID\_ANY} to let
	8	wxWindows assign an unused identifier to it automatically
	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}
	14
	15	wxWindows also defines a few standard command identifiers which may be used by
	16	the user code and also are sometimes used by wxWindows itself. These reserved
	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,
	51
	52	wxID_FILE1 = 5050,
	53	wxID_FILE2,
	54	wxID_FILE3,
	55	wxID_FILE4,
	56	wxID_FILE5,
	57	wxID_FILE6,
	58	wxID_FILE7,
	59	wxID_FILE8,
	60	wxID_FILE9,
	61
	62	// Standard button IDs
	63	wxID_OK = 5100,
	64	wxID_CANCEL,
	65	wxID_APPLY,
	66	wxID_YES,
	67	wxID_NO,
	68	wxID_STATIC,
	69	wxID_FORWARD,
	70	wxID_BACKWARD,
	71	wxID_DEFAULT,
	72	wxID_MORE,
	73	wxID_SETUP,
	74	wxID_RESET,
	75	wxID_CONTEXT_HELP,
	76	wxID_YESTOALL,
77	wxID_NOTOALL,
78	wxID_ABORT,
79	wxID_RETRY,
80	wxID_IGNORE,
81
82	// System menu IDs (used by wxUniv):
83	wxID_SYSTEM_MENU = 5200,
84	wxID_CLOSE_FRAME,
85	wxID_MOVE_FRAME,
86	wxID_RESIZE_FRAME,
87	wxID_MAXIMIZE_FRAME,
88	wxID_ICONIZE_FRAME,
89	wxID_RESTORE_FRAME,
90
91	// IDs used by generic file dialog (13 consecutive starting from this value)
92	wxID_FILEDLGG = 5900,
93
94	wxID_HIGHEST = 5999
95	\end{verbatim}
96