projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| 302511a3 VZ |
1 | \section{\class{wxIdManager}}\label{wxidmanager} |
| 2 | ||
| 3 | wxIdManager is responsible for allocating and releasing window IDs. It | |
| 4 | is used by \helpref{wxWindow::NewControlId}{wxwindownewcontrolid} and | |
| 5 | \helpref{wxWindow::UnreserveControlId}{wxwindowunreservecontrolid}, and can also | |
| 6 | be used be used directly. | |
| 7 | ||
| 8 | \wxheading{Derived from} | |
| 9 | ||
| 10 | No base class | |
| 11 | ||
| 12 | \wxheading{Include files} | |
| 13 | ||
| 14 | <wx/windowid.h> included from defs.h | |
| 15 | ||
| 16 | \wxheading{Library} | |
| 17 | ||
| 18 | \helpref{wxCore}{librarieslist} | |
| 19 | ||
| 20 | \wxheading{See also} | |
| 21 | ||
| 22 | \helpref{wxWindow::NewControlId}{wxwindownewcontrolid} | |
| 23 | \helpref{wxWindow::UnreserveControlId}{wxwindowunreservecontrolid} | |
| 24 | \helpref{Window IDs overview}{windowidsoverview} | |
| 25 | ||
| 26 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 27 | ||
| 28 | \membersection{wxIdManager::ReserveControlId}\label{wxidmanagerreservecontrolid} | |
| 29 | ||
| 30 | \func{static wxWindowID}{ReserveControlId}{\param{int}{ count = 1}} | |
| 31 | ||
| 32 | Called directly by \helpref{wxWindow::NewControlId}{wxwindownewcontrolid}, | |
| 33 | this function will create a new ID or range of IDs. The IDs will be | |
| 34 | reserved until assigned to a \helpref{wxWindowIDRef}{windowidsoverview} | |
| 35 | or unreserved with \helpref{UnreserveControlId}{wxidmanagerunreservecontrolid}. | |
| 36 | Only ID values that are not assigned to a \helpref{wxWindowIDRef}{windowidsoverview} | |
| 37 | need to be unreserved. | |
| 38 | ||
| 39 | \wxheading{Parameters} | |
| 40 | ||
| 41 | \docparam{count}{The number of sequential IDs to reserve.} | |
| 42 | ||
| 43 | \wxheading{Return value} | |
| 44 | ||
| 12ec9c09 | 45 | The value of the first ID in the sequence, or \texttt{wxID\_NONE}. |
| 302511a3 VZ |
46 | |
| 47 | \membersection{wxIdManager::UnreserveControlId}\label{wxidmanagerunreservecontrolid} | |
| 48 | ||
| 49 | \func{static wxWindowID}{UnreserveControlId}{\param{wxWindowID}{ id}, \param{int}{ count = 1}} | |
| 50 | ||
| 51 | Called directly by \helpref{wxWindow::UnreserveControlId}{wxwindowunreservecontrolid}, | |
| 52 | this function will unreserve an ID or range of IDs that is currently reserved. This | |
| 53 | should only be called for IDs returned by \helpref{ReserveControlId}{wxidmanagerreservecontrolid} | |
| 54 | that have NOT been assigned to a \helpref{wxWindowIDRef}{windowidsoverview} | |
| 55 | ||
| 56 | \wxheading{Parameters} | |
| 57 | ||
| 58 | \docparam{id}{The first of the range of IDs to unreserve.} | |
| 59 | ||
| 60 | \docparam{count}{The number of sequential IDs to unreserve.} | |
| 61 | ||
| 62 | \wxheading{Return value} | |
| 63 | ||
| 12ec9c09 | 64 | The value of the first ID in the sequence, or \texttt{wxID\_NONE}. |