[wxWidgets.git] / docs / doxygen / mainpages / const_stdevtid.h

/////////////////////////////////////////////////////////////////////////////
// Name:        const_stdevtid.h
// Purpose:     std event values enumerated
// Author:      wxWidgets team
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////


/**

@page page_stdevtid Standard Event Identifiers

wxWidgets defines a special identifier value @c wxID_ANY which is used in
the following two situations:

@li when creating a new window you may specify @c wxID_ANY to let
    wxWidgets assign an unused identifier to it automatically
@li when installing an event handler using either the event table
    macros or wxEvtHandler::Connect,
    you may use it to indicate that you want to handle the events
    coming from any control, regardless of its identifier

Another standard special identifier value is @c 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 @c wxID_LOWEST and
@c wxID_HIGHEST and, accordingly, the user code should avoid defining its
own constants in this range (e.g. by using wxNewId()).

Refer to @ref page_stockitems "the list of stock items" for the subset of standard IDs 
which are stock IDs as well.

*/
Commit	Line	Data
4514447c FM	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: const_stdevtid.h
	3	// Purpose: std event values enumerated
	4	// Author: wxWidgets team
526954c5	5	// Licence: wxWindows licence
4514447c FM	6	/////////////////////////////////////////////////////////////////////////////
	7
	8
880efa2a	9	/**
4514447c	10
e7054054	11	@page page_stdevtid Standard Event Identifiers
928f1a07 FM	12
	13	wxWidgets defines a special identifier value @c wxID_ANY which is used in
	14	the following two situations:
	15
	16	@li when creating a new window you may specify @c wxID_ANY to let
	17	wxWidgets assign an unused identifier to it automatically
	18	@li when installing an event handler using either the event table
	19	macros or wxEvtHandler::Connect,
	20	you may use it to indicate that you want to handle the events
	21	coming from any control, regardless of its identifier
	22
	23	Another standard special identifier value is @c wxID_NONE: this is a value
	24	which is not matched by any other id.
	25
	26	wxWidgets also defines a few standard command identifiers which may be used by
	27	the user code and also are sometimes used by wxWidgets itself. These reserved
	28	identifiers are all in the range between @c wxID_LOWEST and
	29	@c wxID_HIGHEST and, accordingly, the user code should avoid defining its
	30	own constants in this range (e.g. by using wxNewId()).
	31
38ea03c9 FM	32	Refer to @ref page_stockitems "the list of stock items" for the subset of standard IDs
38ea03c9 FM	33	which are stock IDs as well.
4514447c FM	34
4514447c FM	35	*/