interface/wx/windowid.h

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