]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/window.tex
Documented wxClienData and friends.
[wxWidgets.git] / docs / latex / wx / window.tex
index b08f7f0363ae0417be2ae0b1b819db2e26786313..5ccf411a0d666d860a65d01da1f8874b581aa6f5 100644 (file)
@@ -397,6 +397,11 @@ Destroys all children of a window.  Called automatically by the destructor.
 
 Disables the window, same as \helpref{Enable({\tt FALSE})}{wxwindowenable}.
 
+\wxheading{Return value}
+
+Returns {\tt TRUE} if the window has been disabled, {\tt FALSE} if it had been
+already disabled before the call to this function.
+
 \membersection{wxWindow::DragAcceptFiles}\label{wxwindowdragacceptfiles}
 
 \func{virtual void}{DragAcceptFiles}{\param{bool}{ accept}}
@@ -414,7 +419,7 @@ Windows only.
 
 \membersection{wxWindow::Enable}\label{wxwindowenable}
 
-\func{virtual void}{Enable}{\param{bool}{ enable = {\tt TRUE}}}
+\func{virtual bool}{Enable}{\param{bool}{ enable = {\tt TRUE}}}
 
 Enable or disable the window for user input.
 
@@ -422,6 +427,11 @@ Enable or disable the window for user input.
 
 \docparam{enable}{If {\tt TRUE}, enables the window for input. If {\tt FALSE}, disables the window.}
 
+\wxheading{Return value}
+
+Returns {\tt TRUE} if the window has been enabled or disabled, {\tt FALSE} if
+nothing was done, i.e. if the window had already been in the specified state.
+
 \wxheading{See also}
 
 \helpref{wxWindow::IsEnabled}{wxwindowisenabled},\rtfsp
@@ -459,6 +469,49 @@ implements the following methods:\par
 \end{twocollist}}
 }
 
+\membersection{wxWindow::FindWindowById}\label{wxwindowfindwindow}
+
+\func{wxWindow*}{FindWindowById}{\param{long}{ id}}
+
+Find the first window with the given {\it id}.
+
+If {\it parent} is NULL, the search will start from all top-level
+frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
+The search is recursive in both cases.
+
+\wxheading{See also}
+
+\helpref{FindWindowById}{wxwindowfindwindowbyid}
+
+\membersection{wxWindow::FindWindowByName}\label{wxwindowfindwindowbyname}
+
+\func{wxWindow*}{FindWindowByName}{\param{long}{ id}}
+
+Find a window by its name (as given in a window constructor or {\bf Create} function call).
+If {\it parent} is NULL, the search will start from all top-level
+frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
+The search is recursive in both cases.
+
+If no window with such name is found, 
+\helpref{FindWindowByLabel}{wxwindowfindwindowbylabel} is called.
+
+\wxheading{See also}
+
+\helpref{FindWindowById}{wxwindowfindwindowbyid}
+
+\membersection{wxWindow::FindWindowByLabel}\label{wxwindowfindwindowbylabel}
+
+\func{wxWindow*}{FindWindowByLabel}{\param{long}{ id}}
+
+Find a window by its label. Depending on the type of window, the label may be a window title
+or panel item label. If {\it parent} is NULL, the search will start from all top-level
+frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
+The search is recursive in both cases.
+
+\wxheading{See also}
+
+\helpref{FindWindowById}{wxwindowfindwindowbyid}
+
 \membersection{wxWindow::Fit}\label{wxwindowfit}
 
 \func{virtual void}{Fit}{\void}
@@ -1725,7 +1778,7 @@ functions so should not be required by the application programmer.
 
 \docparam{child}{Child window to remove.}
 
-\membersection{wxWindow::RemoveEventHandler}{wxwindowremoveeventhandler}
+\membersection{wxWindow::RemoveEventHandler}\label{wxwindowremoveeventhandler}
 
 \func{bool}{RemoveEventHandler}{\param{wxEvtHandler *}{handler}}