minor corrections: document typeDefault, remove text copied from the header (closes...

[wxWidgets.git] / interface / wx / windowid.h

diff --git a/interface/wx/windowid.h b/interface/wx/windowid.h
index 031be36a8a654ef31c323885faadd57bbf14edde..002c11eb00d555af2048517a497f36e993e36e3a 100644 (file)
--- a/interface/wx/windowid.h
+++ b/interface/wx/windowid.h
@@ -6,30 +6,33 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
+/**
+    The type of unique identifiers (ID) used for wxWindow-derived classes.
+*/
+typedef int wxWindowID;
+
 /**
     @class wxIdManager
 
-    wxIdManager is responsible for allocating and releasing window IDs.  It
-    is used by wxWindow::NewControlId and
-    wxWindow::UnreserveControlId, and can also
-    be used be used directly.
+    wxIdManager is responsible for allocating and releasing window IDs.
+    It is used by wxWindow::NewControlId() and wxWindow::UnreserveControlId(),
+    and can also be used be used directly.
 
     @library{wxcore}
-    @category{FIXME}
+    @category{cfg}
 
-    @see wxWindow::NewControlId, wxWindow::UnreserveControlId, @ref
-    overview_windowidsoverview "Window IDs overview"
+    @see wxWindow::NewControlId(), wxWindow::UnreserveControlId(),
+         @ref overview_windowids
 */
 class wxIdManager
 {
 public:
     /**
-        Called directly by wxWindow::NewControlId,
-        this function will create a new ID or range of IDs.  The IDs will be
-        reserved until assigned to a wxWindowIDRef()
-        or unreserved with UnreserveControlId().
-        Only ID values that are not assigned to a wxWindowIDRef()
-        need to be unreserved.
+        Called directly by wxWindow::NewControlId(), this function will create
+        a new ID or range of IDs.
+        The IDs will be reserved until assigned to a wxWindowIDRef() or unreserved
+        with UnreserveControlId().
+        Only ID values that are not assigned to a wxWindowIDRef() need to be unreserved.
 
         @param count
             The number of sequential IDs to reserve.
@@ -37,5 +40,20 @@ public:
         @return The value of the first ID in the sequence, or wxID_NONE.
     */
     static wxWindowID ReserveControlId(int count = 1);
+
+    /**
+        Called directly by wxWindow::UnreserveControlId(), this function will
+        unreserve an ID or range of IDs that is currently reserved.
+        This should only be called for IDs returned by ReserveControlId() that
+        have NOT been assigned to a wxWindowIDRef (see @ref overview_windowids).
+
+        @param id
+            The first of the range of IDs to unreserve.
+        @param count
+            The number of sequential IDs to unreserve.
+
+        @return The value of the first ID in the sequence, or wxID_NONE.
+    */
+    static wxWindowID UnreserveControlId(wxWindowID id, int count = 1);
 };