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

Another standard special identifier value is {\tt wxID\_NONE}: this is a value
which is not matched by any other id.

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_INDEX,
    wxID_HELP_SEARCH,
    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
dadacffc VZ	15	Another standard special identifier value is {\tt wxID\_NONE}: this is a value
	16	which is not matched by any other id.
	17
fc2171bd JS	18	wxWidgets also defines a few standard command identifiers which may be used by
fc2171bd JS	19	the user code and also are sometimes used by wxWidgets itself. These reserved
ab246904 VZ	20	identifiers are all in the range between {\tt wxID\_LOWEST} and
	21	{\tt wxID\_HIGHEST} and, accordingly, the user code should avoid defining its
	22	own constants in this range.
	23
	24	\begin{verbatim}
	25	wxID_LOWEST = 4999,
	26
	27	wxID_OPEN,
	28	wxID_CLOSE,
	29	wxID_NEW,
	30	wxID_SAVE,
	31	wxID_SAVEAS,
	32	wxID_REVERT,
	33	wxID_EXIT,
	34	wxID_UNDO,
	35	wxID_REDO,
	36	wxID_HELP,
	37	wxID_PRINT,
	38	wxID_PRINT_SETUP,
	39	wxID_PREVIEW,
	40	wxID_ABOUT,
	41	wxID_HELP_CONTENTS,
40f51262 VZ	42	wxID_HELP_INDEX,
40f51262 VZ	43	wxID_HELP_SEARCH,
ab246904 VZ	44	wxID_HELP_COMMANDS,
	45	wxID_HELP_PROCEDURES,
	46	wxID_HELP_CONTEXT,
	47	wxID_CLOSE_ALL,
	48
	49	wxID_CUT = 5030,
	50	wxID_COPY,
	51	wxID_PASTE,
	52	wxID_CLEAR,
	53	wxID_FIND,
	54	wxID_DUPLICATE,
	55	wxID_SELECTALL,
e9f4f51d JS	56	wxID_DELETE,
	57	wxID_REPLACE,
	58	wxID_REPLACE_ALL,
	59	wxID_PROPERTIES,
	60
	61	wxID_VIEW_DETAILS,
	62	wxID_VIEW_LARGEICONS,
	63	wxID_VIEW_SMALLICONS,
	64	wxID_VIEW_LIST,
	65	wxID_VIEW_SORTDATE,
	66	wxID_VIEW_SORTNAME,
	67	wxID_VIEW_SORTSIZE,
	68	wxID_VIEW_SORTTYPE,
ab246904 VZ	69
	70	wxID_FILE1 = 5050,
	71	wxID_FILE2,
	72	wxID_FILE3,
	73	wxID_FILE4,
	74	wxID_FILE5,
	75	wxID_FILE6,
	76	wxID_FILE7,
	77	wxID_FILE8,
	78	wxID_FILE9,
	79
	80	// Standard button IDs
	81	wxID_OK = 5100,
	82	wxID_CANCEL,
	83	wxID_APPLY,
	84	wxID_YES,
	85	wxID_NO,
	86	wxID_STATIC,
	87	wxID_FORWARD,
	88	wxID_BACKWARD,
	89	wxID_DEFAULT,
	90	wxID_MORE,
	91	wxID_SETUP,
	92	wxID_RESET,
	93	wxID_CONTEXT_HELP,
	94	wxID_YESTOALL,
	95	wxID_NOTOALL,
	96	wxID_ABORT,
	97	wxID_RETRY,
	98	wxID_IGNORE,
	99
e9f4f51d JS	100	wxID_UP,
	101	wxID_DOWN,
	102	wxID_HOME,
	103	wxID_REFRESH,
	104	wxID_STOP,
	105	wxID_INDEX,
	106
	107	wxID_BOLD,
	108	wxID_ITALIC,
	109	wxID_JUSTIFY_CENTER,
	110	wxID_JUSTIFY_FILL,
	111	wxID_JUSTIFY_RIGHT,
	112	wxID_JUSTIFY_LEFT,
	113	wxID_UNDERLINE,
	114	wxID_INDENT,
	115	wxID_UNINDENT,
	116	wxID_ZOOM_100,
	117	wxID_ZOOM_FIT,
	118	wxID_ZOOM_IN,
	119	wxID_ZOOM_OUT,
	120	wxID_UNDELETE,
	121	wxID_REVERT_TO_SAVED,
	122
ab246904 VZ	123	// System menu IDs (used by wxUniv):
	124	wxID_SYSTEM_MENU = 5200,
	125	wxID_CLOSE_FRAME,
	126	wxID_MOVE_FRAME,
	127	wxID_RESIZE_FRAME,
	128	wxID_MAXIMIZE_FRAME,
	129	wxID_ICONIZE_FRAME,
	130	wxID_RESTORE_FRAME,
	131
	132	// IDs used by generic file dialog (13 consecutive starting from this value)
	133	wxID_FILEDLGG = 5900,
	134
	135	wxID_HIGHEST = 5999
	136	\end{verbatim}
	137