docs/doxygen/mainpages/const_stdevtid.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        const_stdevtid.h
   3 // Purpose:     std event values enumerated
   4 // Author:      wxWidgets team
   5 // Licence:     wxWindows licence
   6 /////////////////////////////////////////////////////////////////////////////
   7
   8
   9 /**
  10
  11 @page page_stdevtid Standard Event Identifiers
  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
  32 Refer to @ref page_stockitems "the list of stock items" for the subset of standard IDs
  33 which are stock IDs as well.
  34
  35 */