interface/windowid.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        windowid.h
   3 // Purpose:     documentation for wxIdManager class
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxIdManager
  11     @wxheader{windowid.h}
  12
  13     wxIdManager is responsible for allocating and releasing window IDs.  It
  14     is used by wxWindow::NewControlId and
  15     wxWindow::UnreserveControlId, and can also
  16     be used be used directly.
  17
  18     @library{wxcore}
  19     @category{FIXME}
  20
  21     @seealso
  22     wxWindow::NewControlId, wxWindow::UnreserveControlId, @ref
  23     overview_windowidsoverview "Window IDs overview"
  24 */
  25 class wxIdManager
  26 {
  27 public:
  28     /**
  29         Called directly by wxWindow::NewControlId,
  30         this function will create a new ID or range of IDs.  The IDs will be
  31         reserved until assigned to a wxWindowIDRef
  32         or unreserved with UnreserveControlId().
  33         Only ID values that are not assigned to a wxWindowIDRef
  34         need to be unreserved.
  35
  36         @param count
  37         The number of sequential IDs to reserve.
  38
  39         @returns The value of the first ID in the sequence, or wxID_NONE.
  40     */
  41     static wxWindowID ReserveControlId(int count = 1);
  42 };