X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7c913512a4c9f36e11e07ea707002fab1608d324..d317fdebc3d51c4bf17e89b558ff1a6538bf225c:/interface/windowid.h diff --git a/interface/windowid.h b/interface/windowid.h index c3b82fac44..7b14cce3ed 100644 --- a/interface/windowid.h +++ b/interface/windowid.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: windowid.h -// Purpose: documentation for wxIdManager class +// Purpose: interface of wxIdManager // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -18,8 +18,7 @@ @library{wxcore} @category{FIXME} - @seealso - wxWindow::NewControlId, wxWindow::UnreserveControlId, @ref + @see wxWindow::NewControlId, wxWindow::UnreserveControlId, @ref overview_windowidsoverview "Window IDs overview" */ class wxIdManager @@ -28,15 +27,16 @@ 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 + reserved until assigned to a wxWindowIDRef() or unreserved with UnreserveControlId(). - Only ID values that are not assigned to a wxWindowIDRef + Only ID values that are not assigned to a wxWindowIDRef() need to be unreserved. - + @param count - The number of sequential IDs to reserve. - - @returns The value of the first ID in the sequence, or wxID_NONE. + The number of sequential IDs to reserve. + + @return The value of the first ID in the sequence, or wxID_NONE. */ static wxWindowID ReserveControlId(int count = 1); }; +