X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/df001660977c76bad66b587b3839afc67105186c..14f8fa9d7fa07b02c276981d135ce73cf6818879:/docs/latex/wx/window.tex

diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex
index ac4fba3bba..a885f34a52 100644
--- a/docs/latex/wx/window.tex
+++ b/docs/latex/wx/window.tex
@@ -229,7 +229,7 @@ cause an erase background event to be generated.
 
 \constfunc{virtual void}{ClientToScreen}{\param{int* }{x}, \param{int* }{y}}
 
-\perlnote{In wxPerl this method returns a 2-element list intead of
+\perlnote{In wxPerl this method returns a 2-element list instead of
 modifying its parameters.}
 
 \constfunc{virtual wxPoint}{ClientToScreen}{\param{const wxPoint\&}{ pt}}
@@ -348,7 +348,7 @@ Converts a point or size from pixels to dialog units.
 For the x dimension, the pixels are multiplied by 4 and then divided by the average
 character width.
 
-For the y dimension, the pixels are multipled by 8 and then divided by the average
+For the y dimension, the pixels are multiplied by 8 and then divided by the average
 character height.
 
 \wxheading{Remarks}
@@ -377,7 +377,7 @@ Destroys the window safely. Use this function instead of the delete operator, si
 different window classes can be destroyed differently. Frames and dialogs
 are not destroyed immediately when this function is called - they are added
 to a list of windows to be deleted on idle time, when all the window's events
-have been processed. This prevents problems with events being sent to non-existant
+have been processed. This prevents problems with events being sent to non-existent
 windows.
 
 \wxheading{Return value}
@@ -406,7 +406,7 @@ already disabled before the call to this function.
 
 \func{virtual void}{DragAcceptFiles}{\param{bool}{ accept}}
 
-Enables or disables elibility for drop file events (OnDropFiles).
+Enables or disables eligibility for drop file events (OnDropFiles).
 
 \wxheading{Parameters}
 
@@ -421,7 +421,9 @@ Windows only.
 
 \func{virtual bool}{Enable}{\param{bool}{ enable = {\tt TRUE}}}
 
-Enable or disable the window for user input.
+Enable or disable the window for user input. Note that when a parent window is
+disabled, all of its children are disabled as well and they are reenabled again
+when the parent is.
 
 \wxheading{Parameters}
 
@@ -469,6 +471,49 @@ implements the following methods:\par
 \end{twocollist}}
 }
 
+\membersection{wxWindow::FindWindowById}\label{wxwindowfindwindowbyid}
+
+\func{static wxWindow*}{FindWindowById}{\param{long}{ id}, \param{wxWindow*}{ parent = NULL}}
+
+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{FindWindow}{wxwindowfindwindow}
+
+\membersection{wxWindow::FindWindowByName}\label{wxwindowfindwindowbyname}
+
+\func{static wxWindow*}{FindWindowByName}{\param{const wxString\&}{ name}, \param{wxWindow*}{ parent = NULL}}
+
+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{FindWindow}{wxwindowfindwindow}
+
+\membersection{wxWindow::FindWindowByLabel}\label{wxwindowfindwindowbylabel}
+
+\func{static wxWindow*}{FindWindowByLabel}{\param{const wxString\&}{ label}, \param{wxWindow*}{ parent = NULL}}
+
+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{FindWindow}{wxwindowfindwindow}
+
 \membersection{wxWindow::Fit}\label{wxwindowfit}
 
 \func{virtual void}{Fit}{\void}
@@ -670,6 +715,8 @@ handle, such as {\bf HWND} for Windows, {\bf Widget} for Motif or {\bf GtkWidget
 
 \pythonnote{This method will return an integer in wxPython.}
 
+\perlnote{This method will return an integer in wxPerl.}
+
 \membersection{wxWindow::GetHelpText}\label{wxwindowgethelptext}
 
 \constfunc{virtual wxString}{GetHelpText}{\void}
@@ -741,8 +788,9 @@ Returns the parent of the window, or NULL if there is no parent.
 
 \constfunc{wxPoint}{GetPosition}{\void}
 
-This gets the position of the window in pixels, relative to the parent window or
-if no parent, relative to the whole display.
+This gets the position of the window in pixels, relative to the parent window
+for the child windows or relative to the display origin for the top level
+windows.
 
 \wxheading{Parameters}
 
@@ -983,7 +1031,7 @@ Returns {\tt TRUE} if the window is enabled for input, {\tt FALSE} otherwise.
 
 \constfunc{bool}{IsExposed}{\param{wxRect }{\&rect}}
 
-Returns {\tt TRUE} if the given point or rectange area has been exposed since the
+Returns {\tt TRUE} if the given point or rectangle area has been exposed since the
 last repaint. Call this in an paint event handler to optimize redrawing by
 only redrawing those areas, which have been exposed.
 
@@ -1234,7 +1282,7 @@ implements the following methods:\par
 %% or dialog box using the window manager (X) or system menu (Windows).
 %%
 %% {\bf Note:} This is an obsolete function.
-%% It is superceded by the \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} event
+%% It is superseded by the \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} event
 %% handler.
 %%
 %% \wxheading{Return value}
@@ -1870,10 +1918,11 @@ Sets the accelerator table for this window. See \helpref{wxAcceleratorTable}{wxa
 \func{void}{SetAutoLayout}{\param{bool}{ autoLayout}}
 
 Determines whether the \helpref{wxWindow::Layout}{wxwindowlayout} function will
-be called automatically when the window is resized. Use in connection with
-\helpref{wxWindow::SetSizer}{wxwindowsetsizer} and
-\helpref{wxWindow::SetConstraints}{wxwindowsetconstraints} for laying out
-subwindows.
+be called automatically when the window is resized. It is called implicitly by 
+\helpref{wxWindow::SetSizer}{wxwindowsetsizer} but if you use 
+\helpref{wxWindow::SetConstraints}{wxwindowsetconstraints} you should call it
+manually or otherwise the window layout won't be correctly updated when its
+size changes.
 
 \wxheading{Parameters}
 
@@ -2055,7 +2104,7 @@ bits are:
 and Validate() methods will recursively descend into all children of the
 window if it has this style flag set.}
 \twocolitem{\windowstyle{wxWS\_EX\_BLOCK\_EVENTS}}{Normally, the command
-events are propagared upwards to the window parent recursively until a handler
+events are propagated upwards to the window parent recursively until a handler
 for them is found. Using this style allows to prevent them from being
 propagated beyond this window. Notice that wxDialog has this style on by
 default for the reasons explained in the
@@ -2063,7 +2112,7 @@ default for the reasons explained in the
 \twocolitem{\windowstyle{wxWS\_EX\_TRANSIENT}}{This can be used to prevent a
 window from being used as an implicit parent for the dialogs which were
 created without a parent. It is useful for the windows which can disappear at
-any moment as creating childs of such windows results in fatal problems.}
+any moment as creating children of such windows results in fatal problems.}
 \twocolitem{\windowstyle{wxFRAME\_EX\_CONTEXTHELP}}{Under Windows, puts a query button on the
 caption. When pressed, Windows will go into a context-sensitive help mode and wxWindows will send
 a wxEVT\_HELP event if the user clicked on an application window.
@@ -2124,7 +2173,7 @@ to the window class; it may be the text colour or other colour, or it may not
 be used at all.
 
 Note that when using this functions under GTK, you will disable the so called "themes",
-i.e. the user chosen apperance of windows and controls, including the themes of
+i.e. the user chosen appearance of windows and controls, including the themes of
 their parent windows.
 
 \wxheading{See also}
@@ -2437,6 +2486,10 @@ will then own the object, and will take care of its deletion.
 If an existing layout constraints object is already owned by the
 window, it will be deleted if the deleteOld parameter is TRUE.
 
+Note that this function will also call 
+\helpref{SetAutoLayout}{wxwindowsetautolayout} implicitly with {\tt TRUE}
+parameter if the {\it sizer}\/ is non-NULL and {\tt FALSE} otherwise.
+
 \wxheading{Parameters}
 
 \docparam{sizer}{The sizer to set. Pass NULL to disassociate and conditionally delete
@@ -2476,6 +2529,20 @@ Sets the window's title. Applicable only to frames and dialogs.
 
 \helpref{wxWindow::GetTitle}{wxwindowgettitle}
 
+\membersection{wxWindow::SetThemeEnabled}\label{wxwindowsetthemeenabled}
+
+\func{virtual void}{SetThemeEnabled}{\param{bool }{enable}}
+
+This function tells a window if it should use the system's "theme" code
+to draw the windows' background instead if its own background drawing
+code. This does not always have any effect since the underlying platform
+obviously needs to support the notion of themes in user defined windows.
+One such platform is GTK+ where windows can have (very colourful) backgrounds
+defined by a user's selected theme.
+
+Dialogs, notebook pages and the status bar have this flag set to TRUE
+by default so that the default look and feel is simulated best.
+
 \membersection{wxWindow::SetValidator}\label{wxwindowsetvalidator}
 
 \func{virtual void}{SetValidator}{\param{const wxValidator\&}{ validator}}
