X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/17808a759627b03c2acbe7333dd2386557e1b804..6f67af05cab3d08a0c54f55b49759b2b9867aeb0:/docs/latex/wx/window.tex diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index cf6e0c3eca..d7796285d0 100644 --- a/docs/latex/wx/window.tex +++ b/docs/latex/wx/window.tex @@ -1934,20 +1934,30 @@ Performs a keyboard navigation action inside this window. See \helpref{Navigate}{wxwindownavigate} for more information. -\membersection{wxWindow::NextControlId}\label{wxwindownextcontrolid} +\membersection{wxWindow::NewControlId}\label{wxwindownewcontrolid} -\func{static int}{NextControlId}{\param{int }{winid}} +\func{static wxWindowID}{NewControlId}{\param{int}{ count = 1}} -If two controls are created consecutively using \texttt{wxID\_ANY} id, this -function allows to retrieve the effective id of the latter control from the id -of the former. This is useful for example to find the control following its -\helpref{wxStaticText}{wxstatictext} label if only the id of or pointer to the -label is available to the caller but it is known that the two controls were -created together. +Create a new ID or range of IDs that are not currently in use. The +IDs will be reserved until assigned to a \helpref{wxWindowIDRef}{windowidsoverview} +or unreserved with \helpref{UnreserveControlId}{wxwindowunreservecontrolid}. + +See \helpref{Window IDs overview}{windowidsoverview} for more information. + +\wxheading{Parameters} + +\docparam{count}{The number of sequential IDs to reserve.} + +\wxheading{Return value} + +Returns the ID or the first ID of the range, or \texttt{wxID\_NONE} if the +specified number of identifiers couldn't be allocated. \wxheading{See also} -\helpref{PrevControlId}{wxwindowprevcontrolid} +\helpref{UnreserveControlId}{wxwindowunreservecontrolid} +\helpref{wxIdManager}{wxidmanager} +\helpref{Window IDs overview}{windowidsoverview} %% VZ: wxWindow::OnXXX() functions should not be documented but I'm leaving @@ -2508,15 +2518,6 @@ implements the following methods:\par \end{twocollist}} } - -\membersection{wxWindow::PrevControlId}\label{wxwindowprevcontrolid} - -\func{static int}{PrevControlId}{\param{int }{winid}} - -This is similar to \helpref{NextControlId}{wxwindownextcontrolid} but returns -the id of the control created just before the one with the given \arg{winid}. - - \membersection{wxWindow::PushEventHandler}\label{wxwindowpusheventhandler} \func{void}{PushEventHandler}{\param{wxEvtHandler* }{handler}} @@ -3594,8 +3595,11 @@ only the sizer will have effect. \func{void}{SetSizerAndFit}{\param{wxSizer* }{sizer}, \param{bool }{deleteOld=true}} -The same as \helpref{SetSizer}{wxwindowsetsizer}, except it also sets the size hints -for the window based on the sizer's minimum size. +This method calls \helpref{SetSizer}{wxwindowsetsizer} and then +\helpref{wxSizer::SetSizeHints}{wxsizersetsizehints} which sets the initial +window size to the size needed to accommodate all sizer elements and sets the +size hints which, if this window is a top level one, prevent the user from +resizing it to be less than this minimial size. \membersection{wxWindow::SetThemeEnabled}\label{wxwindowsetthemeenabled} @@ -3894,6 +3898,25 @@ This function is currently only implemented under MSW. \helpref{wxWindow::RegisterHotKey}{wxwindowregisterhotkey} +\membersection{wxWindow::UnreserveControlId}\label{wxwindowunreservecontrolid} + +\func{static void}{UnreserveControlId}{\param{wxWindowID}{ id}, \param{int}{ count = 1}} + +Unreserve an ID or range of IDs that was reserved by \helpref{NewControlId}{wxwindownewcontrolid}. + +See \helpref{Window IDs overview}{windowidsoverview} for more information. + +\wxheading{Parameters} + +\docparam{id}{The starting ID of the range of IDs to unreserve.} + +\docparam{count}{The number of sequential IDs to unreserve.} + +\wxheading{See also} + +\helpref{NewControlId}{wxwindownewcontrolid} +\helpref{wxIdManager}{wxidmanager} +\helpref{Window IDs overview}{windowidsoverview} \membersection{wxWindow::Update}\label{wxwindowupdate}