[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_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_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 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,
e63f19ba	39	wxID_PAGE_SETUP,
ab246904 VZ	40	wxID_PREVIEW,
	41	wxID_ABOUT,
	42	wxID_HELP_CONTENTS,
40f51262 VZ	43	wxID_HELP_INDEX,
40f51262 VZ	44	wxID_HELP_SEARCH,
ab246904 VZ	45	wxID_HELP_COMMANDS,
	46	wxID_HELP_PROCEDURES,
	47	wxID_HELP_CONTEXT,
	48	wxID_CLOSE_ALL,
	49
ee0a94cf RR	50	wxID_EDIT = 5030,
ee0a94cf RR	51	wxID_CUT,
ab246904 VZ	52	wxID_COPY,
	53	wxID_PASTE,
	54	wxID_CLEAR,
	55	wxID_FIND,
	56	wxID_DUPLICATE,
	57	wxID_SELECTALL,
e9f4f51d JS	58	wxID_DELETE,
	59	wxID_REPLACE,
	60	wxID_REPLACE_ALL,
	61	wxID_PROPERTIES,
	62
	63	wxID_VIEW_DETAILS,
	64	wxID_VIEW_LARGEICONS,
	65	wxID_VIEW_SMALLICONS,
	66	wxID_VIEW_LIST,
	67	wxID_VIEW_SORTDATE,
	68	wxID_VIEW_SORTNAME,
	69	wxID_VIEW_SORTSIZE,
	70	wxID_VIEW_SORTTYPE,
ab246904	71
ee0a94cf RR	72	wxID_FILE = 5050,
ee0a94cf RR	73	wxID_FILE1,
ab246904 VZ	74	wxID_FILE2,
	75	wxID_FILE3,
	76	wxID_FILE4,
	77	wxID_FILE5,
	78	wxID_FILE6,
	79	wxID_FILE7,
	80	wxID_FILE8,
	81	wxID_FILE9,
	82
	83	// Standard button IDs
	84	wxID_OK = 5100,
	85	wxID_CANCEL,
	86	wxID_APPLY,
	87	wxID_YES,
	88	wxID_NO,
	89	wxID_STATIC,
	90	wxID_FORWARD,
	91	wxID_BACKWARD,
	92	wxID_DEFAULT,
	93	wxID_MORE,
	94	wxID_SETUP,
	95	wxID_RESET,
	96	wxID_CONTEXT_HELP,
	97	wxID_YESTOALL,
	98	wxID_NOTOALL,
	99	wxID_ABORT,
	100	wxID_RETRY,
	101	wxID_IGNORE,
	102
e9f4f51d JS	103	wxID_UP,
	104	wxID_DOWN,
	105	wxID_HOME,
	106	wxID_REFRESH,
	107	wxID_STOP,
	108	wxID_INDEX,
	109
	110	wxID_BOLD,
	111	wxID_ITALIC,
	112	wxID_JUSTIFY_CENTER,
	113	wxID_JUSTIFY_FILL,
	114	wxID_JUSTIFY_RIGHT,
	115	wxID_JUSTIFY_LEFT,
	116	wxID_UNDERLINE,
	117	wxID_INDENT,
	118	wxID_UNINDENT,
	119	wxID_ZOOM_100,
	120	wxID_ZOOM_FIT,
	121	wxID_ZOOM_IN,
	122	wxID_ZOOM_OUT,
	123	wxID_UNDELETE,
	124	wxID_REVERT_TO_SAVED,
	125
ab246904 VZ	126	// System menu IDs (used by wxUniv):
	127	wxID_SYSTEM_MENU = 5200,
	128	wxID_CLOSE_FRAME,
	129	wxID_MOVE_FRAME,
	130	wxID_RESIZE_FRAME,
	131	wxID_MAXIMIZE_FRAME,
	132	wxID_ICONIZE_FRAME,
	133	wxID_RESTORE_FRAME,
	134
	135	// IDs used by generic file dialog (13 consecutive starting from this value)
	136	wxID_FILEDLGG = 5900,
	137
	138	wxID_HIGHEST = 5999
	139	\end{verbatim}
	140