]> git.saurik.com Git - wxWidgets.git/blame_incremental - interface/windowid.h
mention the problem with writing enums to wxConfig (see #8656)
[wxWidgets.git] / interface / windowid.h
... / ...
CommitLineData
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 @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 @see wxWindow::NewControlId, wxWindow::UnreserveControlId, @ref
22 overview_windowidsoverview "Window IDs overview"
23*/
24class wxIdManager
25{
26public:
27 /**
28 Called directly by wxWindow::NewControlId,
29 this function will create a new ID or range of IDs. The IDs will be
30 reserved until assigned to a wxWindowIDRef()
31 or unreserved with UnreserveControlId().
32 Only ID values that are not assigned to a wxWindowIDRef()
33 need to be unreserved.
34
35 @param count
36 The number of sequential IDs to reserve.
37
38 @return The value of the first ID in the sequence, or wxID_NONE.
39 */
40 static wxWindowID ReserveControlId(int count = 1);
41};
42