12ec9c090c
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@51253 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
65 lines
2.2 KiB
TeX
65 lines
2.2 KiB
TeX
\section{\class{wxIdManager}}\label{wxidmanager}
|
|
|
|
wxIdManager is responsible for allocating and releasing window IDs. It
|
|
is used by \helpref{wxWindow::NewControlId}{wxwindownewcontrolid} and
|
|
\helpref{wxWindow::UnreserveControlId}{wxwindowunreservecontrolid}, and can also
|
|
be used be used directly.
|
|
|
|
\wxheading{Derived from}
|
|
|
|
No base class
|
|
|
|
\wxheading{Include files}
|
|
|
|
<wx/windowid.h> included from defs.h
|
|
|
|
\wxheading{Library}
|
|
|
|
\helpref{wxCore}{librarieslist}
|
|
|
|
\wxheading{See also}
|
|
|
|
\helpref{wxWindow::NewControlId}{wxwindownewcontrolid}
|
|
\helpref{wxWindow::UnreserveControlId}{wxwindowunreservecontrolid}
|
|
\helpref{Window IDs overview}{windowidsoverview}
|
|
|
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
|
|
|
\membersection{wxIdManager::ReserveControlId}\label{wxidmanagerreservecontrolid}
|
|
|
|
\func{static wxWindowID}{ReserveControlId}{\param{int}{ count = 1}}
|
|
|
|
Called directly by \helpref{wxWindow::NewControlId}{wxwindownewcontrolid},
|
|
this function will create a new ID or range of IDs. The IDs will be
|
|
reserved until assigned to a \helpref{wxWindowIDRef}{windowidsoverview}
|
|
or unreserved with \helpref{UnreserveControlId}{wxidmanagerunreservecontrolid}.
|
|
Only ID values that are not assigned to a \helpref{wxWindowIDRef}{windowidsoverview}
|
|
need to be unreserved.
|
|
|
|
\wxheading{Parameters}
|
|
|
|
\docparam{count}{The number of sequential IDs to reserve.}
|
|
|
|
\wxheading{Return value}
|
|
|
|
The value of the first ID in the sequence, or \texttt{wxID\_NONE}.
|
|
|
|
\membersection{wxIdManager::UnreserveControlId}\label{wxidmanagerunreservecontrolid}
|
|
|
|
\func{static wxWindowID}{UnreserveControlId}{\param{wxWindowID}{ id}, \param{int}{ count = 1}}
|
|
|
|
Called directly by \helpref{wxWindow::UnreserveControlId}{wxwindowunreservecontrolid},
|
|
this function will unreserve an ID or range of IDs that is currently reserved. This
|
|
should only be called for IDs returned by \helpref{ReserveControlId}{wxidmanagerreservecontrolid}
|
|
that have NOT been assigned to a \helpref{wxWindowIDRef}{windowidsoverview}
|
|
|
|
\wxheading{Parameters}
|
|
|
|
\docparam{id}{The first of the range of IDs to unreserve.}
|
|
|
|
\docparam{count}{The number of sequential IDs to unreserve.}
|
|
|
|
\wxheading{Return value}
|
|
|
|
The value of the first ID in the sequence, or \texttt{wxID\_NONE}.
|