[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:
	5	\begin{itemize}
	6	\item when creating a new window you may specify {\tt wxID\_ANY} to let
	7	wxWindows assign an unused identifier to it automatically
	8	\item when installing an event handler using either the event table
	9	macros or \helpref{wxEvtHandler::Connect}{wxevthandlerconnect}
	10	you may use it to indicate that you want to handle the events
	11	coming from any control, regardless of its identifier
	12	\end{itemize}
	13
	14	wxWindows also defines a few standard command identifiers which may be used by
	15	the user code and also are sometimes used by wxWindows itself. These reserved
	16	identifiers are all in the range between {\tt wxID\_LOWEST} and
	17	{\tt wxID\_HIGHEST} and, accordingly, the user code should avoid defining its
	18	own constants in this range.
	19
	20	\begin{verbatim}
	21	wxID_LOWEST = 4999,
	22
	23	wxID_OPEN,
	24	wxID_CLOSE,
	25	wxID_NEW,
	26	wxID_SAVE,
	27	wxID_SAVEAS,
	28	wxID_REVERT,
	29	wxID_EXIT,
	30	wxID_UNDO,
	31	wxID_REDO,
	32	wxID_HELP,
	33	wxID_PRINT,
	34	wxID_PRINT_SETUP,
	35	wxID_PREVIEW,
	36	wxID_ABOUT,
	37	wxID_HELP_CONTENTS,
	38	wxID_HELP_COMMANDS,
	39	wxID_HELP_PROCEDURES,
	40	wxID_HELP_CONTEXT,
	41	wxID_CLOSE_ALL,
	42
	43	wxID_CUT = 5030,
	44	wxID_COPY,
	45	wxID_PASTE,
	46	wxID_CLEAR,
	47	wxID_FIND,
	48	wxID_DUPLICATE,
	49	wxID_SELECTALL,
	50
	51	wxID_FILE1 = 5050,
	52	wxID_FILE2,
	53	wxID_FILE3,
	54	wxID_FILE4,
	55	wxID_FILE5,
	56	wxID_FILE6,
	57	wxID_FILE7,
	58	wxID_FILE8,
	59	wxID_FILE9,
	60
	61	// Standard button IDs
	62	wxID_OK = 5100,
	63	wxID_CANCEL,
	64	wxID_APPLY,
65	wxID_YES,
66	wxID_NO,
67	wxID_STATIC,
68	wxID_FORWARD,
69	wxID_BACKWARD,
70	wxID_DEFAULT,
71	wxID_MORE,
72	wxID_SETUP,
73	wxID_RESET,
74	wxID_CONTEXT_HELP,
75	wxID_YESTOALL,
76	wxID_NOTOALL,
77	wxID_ABORT,
78	wxID_RETRY,
79	wxID_IGNORE,
80
81	// System menu IDs (used by wxUniv):
82	wxID_SYSTEM_MENU = 5200,
83	wxID_CLOSE_FRAME,
84	wxID_MOVE_FRAME,
85	wxID_RESIZE_FRAME,
86	wxID_MAXIMIZE_FRAME,
87	wxID_ICONIZE_FRAME,
88	wxID_RESTORE_FRAME,
89
90	// IDs used by generic file dialog (13 consecutive starting from this value)
91	wxID_FILEDLGG = 5900,
92
93	wxID_HIGHEST = 5999
94	\end{verbatim}
95