docs/doxygen/mainpages/const_stdevtid.h

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