X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9866d9c2997e20ad12b4f5dd01a46137a74bdeb8..afbe906abdf9aa69a56571b8b20b095351dd8f34:/docs/latex/wx/window.tex

diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex
index 4203a4bf6a..2eefeb2c3c 100644
--- a/docs/latex/wx/window.tex
+++ b/docs/latex/wx/window.tex
@@ -254,15 +254,15 @@ implements the following methods:\par
 
 \membersection{wxWindow::Close}\label{wxwindowclose}
 
-\func{virtual bool}{Close}{\param{bool}{ force = FALSE}}
+\func{virtual bool}{Close}{\param{bool}{ force = {\tt FALSE}}}
 
 The purpose of this call is to provide a safer way of destroying a window than using
 the {\it delete} operator.
 
 \wxheading{Parameters}
 
-\docparam{force}{FALSE if the window's close handler should be able to veto the destruction
-of this window, TRUE if it cannot.}
+\docparam{force}{{\tt FALSE} if the window's close handler should be able to veto the destruction
+of this window, {\tt TRUE} if it cannot.}
 
 \wxheading{Remarks}
 
@@ -382,7 +382,7 @@ windows.
 
 \wxheading{Return value}
 
-TRUE if the window has either been successfully deleted, or it has been added
+{\tt TRUE} if the window has either been successfully deleted, or it has been added
 to the list of windows pending real deletion.
 
 \membersection{wxWindow::DestroyChildren}
@@ -395,7 +395,7 @@ Destroys all children of a window.  Called automatically by the destructor.
 
 \func{void}{Disable}{\void}
 
-Disables the window, same as \helpref{Enable(FALSE)}{wxwindowenable}.
+Disables the window, same as \helpref{Enable({\tt FALSE})}{wxwindowenable}.
 
 \membersection{wxWindow::DragAcceptFiles}\label{wxwindowdragacceptfiles}
 
@@ -405,7 +405,7 @@ Enables or disables elibility for drop file events (OnDropFiles).
 
 \wxheading{Parameters}
 
-\docparam{accept}{If TRUE, the window is eligible for drop file events. If FALSE, the window
+\docparam{accept}{If {\tt TRUE}, the window is eligible for drop file events. If {\tt FALSE}, the window
 will not accept drop file events.}
 
 \wxheading{Remarks}
@@ -414,13 +414,13 @@ Windows only.
 
 \membersection{wxWindow::Enable}\label{wxwindowenable}
 
-\func{virtual void}{Enable}{\param{bool}{ enable = TRUE}}
+\func{virtual void}{Enable}{\param{bool}{ enable = {\tt TRUE}}}
 
 Enable or disable the window for user input.
 
 \wxheading{Parameters}
 
-\docparam{enable}{If TRUE, enables the window for input. If FALSE, disables the window.}
+\docparam{enable}{If {\tt TRUE}, enables the window for input. If {\tt FALSE}, disables the window.}
 
 \wxheading{See also}
 
@@ -536,8 +536,9 @@ a 2-element list {\tt ( width, height )}.}
 
 \constfunc{virtual wxSize}{GetClientSize}{\void}
 
-This gets the size of the window `client area' in pixels.  The client area is the
-area which may be drawn on by the programmer, excluding title bar, border etc.
+This gets the size of the window `client area' in pixels.
+The client area is the area which may be drawn on by the programmer,
+excluding title bar, border, scrollbars, etc.
 
 \wxheading{Parameters}
 
@@ -553,12 +554,23 @@ implements the following methods:\par
 \end{twocollist}}
 }
 
+\wxheading{See also}
+
+\helpref{GetSize}{wxwindowgetsize}
+
 \membersection{wxWindow::GetConstraints}\label{wxwindowgetconstraints}
 
 \constfunc{wxLayoutConstraints*}{GetConstraints}{\void}
 
 Returns a pointer to the window's layout constraints, or NULL if there are none.
 
+\membersection{wxWindow::GetContainingSizer}\label{wxwindowgetcontainingsizer}
+
+\constfunc{const wxSizer *}{GetContainingSizer}{\void}
+
+Return the sizer that this window is a member of, if any, otherwise
+{\tt NULL}.
+
 \membersection{wxWindow::GetDropTarget}\label{wxwindowgetdroptarget}
 
 \constfunc{wxDropTarget*}{GetDropTarget}{\void}
@@ -773,7 +785,8 @@ Returns the built-in scrollbar range.
 
 \constfunc{virtual wxSize}{GetSize}{\void}
 
-This gets the size of the entire window in pixels.
+This gets the size of the entire window in pixels,
+including title bar, border, scrollbars, etc.
 
 \wxheading{Parameters}
 
@@ -798,16 +811,22 @@ method:\par
 \end{twocollist}
 }}
 
+\wxheading{See also}
+
+\helpref{GetClientSize}{wxwindowgetclientsize}
+
 \membersection{wxWindow::GetSizer}\label{wxwindowgetsizer}
 
 \constfunc{const wxSizer *}{GetSizer}{\void}
 
-Return the sizer associated with the window by a previous call to 
+Return the sizer associated with the window by a previous call to
 \helpref{SetSizer()}{wxwindowsetsizer} or {\tt NULL}.
 
+\membersection{wxWindow::GetTextExtent}\label{wxwindowgettextextent}
+
 \constfunc{virtual void}{GetTextExtent}{\param{const wxString\& }{string}, \param{int* }{x}, \param{int* }{y},
  \param{int* }{descent = NULL}, \param{int* }{externalLeading = NULL},
- \param{const wxFont* }{font = NULL}, \param{bool}{ use16 = FALSE}}
+ \param{const wxFont* }{font = NULL}, \param{bool}{ use16 = {\tt FALSE}}}
 
 Gets the dimensions of the string as it would be drawn on the
 window with the currently selected font.
@@ -826,7 +845,7 @@ window with the currently selected font.
 
 \docparam{font}{Font to use instead of the current window font (optional).}
 
-\docparam{use16}{If TRUE, {\it string} contains 16-bit characters. The default is FALSE.}
+\docparam{use16}{If {\tt TRUE}, {\it string} contains 16-bit characters. The default is {\tt FALSE}.}
 
 
 \pythonnote{In place of a single overloaded method name, wxPython
@@ -877,6 +896,12 @@ Returns a pointer to the current validator for the window, or NULL if there is n
 Gets the window style that was passed to the constructor or {\bf Create}
 method. {\bf GetWindowStyle()} is another name for the same function.
 
+\membersection{wxWindow::Hide}\label{wxwindowhide}
+
+\func{bool}{Hide}{\void}
+
+Equivalent to calling \helpref{Show}{wxwindowshow}({\tt FALSE}).
+
 \membersection{wxWindow::InitDialog}\label{wxwindowinitdialog}
 
 \func{void}{InitDialog}{\void}
@@ -888,7 +913,7 @@ to the dialog via validators.
 
 \constfunc{virtual bool}{IsEnabled}{\void}
 
-Returns TRUE if the window is enabled for input, FALSE otherwise.
+Returns {\tt TRUE} if the window is enabled for input, {\tt FALSE} otherwise.
 
 \wxheading{See also}
 
@@ -904,7 +929,7 @@ Returns TRUE if the window is enabled for input, FALSE otherwise.
 
 \constfunc{bool}{IsExposed}{\param{wxRect }{\&rect}}
 
-Returns TRUE if the given point or rectange area has been exposed since the
+Returns {\tt TRUE} if the given point or rectange 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.
 
@@ -920,7 +945,7 @@ implements the following methods:\par
 
 \constfunc{virtual bool}{IsRetained}{\void}
 
-Returns TRUE if the window is retained, FALSE otherwise.
+Returns {\tt TRUE} if the window is retained, {\tt FALSE} otherwise.
 
 \wxheading{Remarks}
 
@@ -930,13 +955,13 @@ Retained windows are only available on X platforms.
 
 \constfunc{virtual bool}{IsShown}{\void}
 
-Returns TRUE if the window is shown, FALSE if it has been hidden.
+Returns {\tt TRUE} if the window is shown, {\tt FALSE} if it has been hidden.
 
 \membersection{wxWindow::IsTopLevel}\label{wxwindowistoplevel}
 
 \constfunc{bool}{IsTopLevel}{\void}
 
-Returns TRUE if the given window is a top-level one. Currently all frames and
+Returns {\tt TRUE} if the given window is a top-level one. Currently all frames and
 dialogs are considered to be top-level windows (even if they have a parent
 window).
 
@@ -968,7 +993,7 @@ default resource table will be used.}
 
 \wxheading{Return value}
 
-TRUE if the operation succeeded, otherwise FALSE.
+{\tt TRUE} if the operation succeeded, otherwise {\tt FALSE}.
 
 \membersection{wxWindow::Lower}\label{wxwindowlower}
 
@@ -987,8 +1012,8 @@ is not implemented anywhere).
 
 \wxheading{Parameters}
 
-\docparam{flag}{If TRUE, this call disables all other windows in the application so that
-the user can only interact with this window. If FALSE, the effect is reversed.}
+\docparam{flag}{If {\tt TRUE}, this call disables all other windows in the application so that
+the user can only interact with this window. If {\tt FALSE}, the effect is reversed.}
 
 \membersection{wxWindow::Move}\label{wxwindowmove}
 
@@ -1044,8 +1069,8 @@ implements the following methods:\par
 %%
 %% \wxheading{Remarks}
 %%
-%% If the window is being activated, \helpref{wxActivateEvent::GetActive}{wxactivateeventgetactive} returns TRUE,
-%% otherwise it returns FALSE (it is being deactivated).
+%% If the window is being activated, \helpref{wxActivateEvent::GetActive}{wxactivateeventgetactive} returns {\tt TRUE},
+%% otherwise it returns {\tt FALSE} (it is being deactivated).
 %%
 %% \wxheading{See also}
 %%
@@ -1160,7 +1185,7 @@ implements the following methods:\par
 %%
 %% \wxheading{Return value}
 %%
-%% If TRUE is returned by OnClose, the window will be deleted by the system, otherwise the
+%% If {\tt TRUE} is returned by OnClose, the window will be deleted by the system, otherwise the
 %% attempt will be ignored. Do not delete the window from within this handler, although
 %% you may delete other windows.
 %%
@@ -1183,24 +1208,24 @@ implements the following methods:\par
 %% Use the EVT\_CLOSE event table macro to handle close events.
 %%
 %% You should check whether the application is forcing the deletion of the window
-%% using \helpref{wxCloseEvent::GetForce}{wxcloseeventgetforce}. If this is TRUE,
+%% using \helpref{wxCloseEvent::GetForce}{wxcloseeventgetforce}. If this is {\tt TRUE},
 %% destroy the window using \helpref{wxWindow::Destroy}{wxwindowdestroy}.
 %% If not, it is up to you whether you respond by destroying the window.
 %%
 %% (Note: GetForce is now superceded by CanVeto. So to test whether forced destruction of
-%% the window is required, test for the negative of CanVeto. If CanVeto returns FALSE,
+%% the window is required, test for the negative of CanVeto. If CanVeto returns {\tt FALSE},
 %% it is not possible to skip window deletion.)
 %%
 %% If you don't destroy the window, you should call \helpref{wxCloseEvent::Veto}{wxcloseeventveto} to
 %% let the calling code know that you did not destroy the window. This allows the \helpref{wxWindow::Close}{wxwindowclose} function
-%% to return TRUE or FALSE depending on whether the close instruction was honoured or not.
+%% to return {\tt TRUE} or {\tt FALSE} depending on whether the close instruction was honoured or not.
 %%
 %% \wxheading{Remarks}
 %%
 %% The \helpref{wxWindow::OnClose}{wxwindowonclose} virtual function remains
 %% for backward compatibility with earlier versions of wxWindows. The
 %% default {\bf OnCloseWindow} handler for wxFrame and wxDialog will call {\bf OnClose},
-%% destroying the window if it returns TRUE or if the close is being forced.
+%% destroying the window if it returns {\tt TRUE} or if the close is being forced.
 %%
 %% \wxheading{See also}
 %%
@@ -1645,14 +1670,14 @@ implements the following methods:\par
 
 \membersection{wxWindow::PopEventHandler}\label{wxwindowpopeventhandler}
 
-\constfunc{wxEvtHandler*}{PopEventHandler}{\param{bool }{deleteHandler = FALSE}}
+\constfunc{wxEvtHandler*}{PopEventHandler}{\param{bool }{deleteHandler = {\tt FALSE}}}
 
 Removes and returns the top-most event handler on the event handler stack.
 
 \wxheading{Parameters}
 
-\docparam{deleteHandler}{If this is TRUE, the handler will be deleted after it is removed. The
-default value is FALSE.}
+\docparam{deleteHandler}{If this is {\tt TRUE}, the handler will be deleted after it is removed. The
+default value is {\tt FALSE}.}
 
 \wxheading{See also}
 
@@ -1741,7 +1766,7 @@ or frame).
 
 \membersection{wxWindow::Refresh}\label{wxwindowrefresh}
 
-\func{virtual void}{Refresh}{\param{bool}{ eraseBackground = TRUE}, \param{const wxRect* }{rect
+\func{virtual void}{Refresh}{\param{bool}{ eraseBackground = {\tt TRUE}}, \param{const wxRect* }{rect
 = NULL}}
 
 Causes a message or event to be generated to repaint the
@@ -1749,7 +1774,7 @@ window.
 
 \wxheading{Parameters}
 
-\docparam{eraseBackground}{If TRUE, the background will be
+\docparam{eraseBackground}{If {\tt TRUE}, the background will be
 erased.}
 
 \docparam{rect}{If non-NULL, only the given rectangle will
@@ -1776,6 +1801,29 @@ functions so should not be required by the application programmer.
 
 \docparam{child}{Child window to remove.}
 
+\membersection{wxWindow::RemoveEventHandler}{wxwindowremoveeventhandler}
+
+\func{bool}{RemoveEventHandler}{\param{wxEvtHandler *}{handler}}
+
+Find the given {\it handler} in the windows event handler chain and remove (but
+not delete) it from it.
+
+\wxheading{Parameters}
+
+\docparam{handler}{The event handler to remove, must be non {\tt NULL} and
+must be present in this windows event handlers chain}
+
+\wxheading{Return value}
+
+Returns {\tt TRUE} if it was found and {\tt FALSE} otherwise (this also results
+in an assert failure so this function should only be called when the
+handler is supposed to be there).
+
+\wxheading{See also}
+
+\helpref{PushEventHandler}{wxwindowpusheventhandler},\rtfsp
+\helpref{PopEventHandler}{wxwindowpopeventhandler}
+
 \membersection{wxWindow::Reparent}\label{wxwindowreparent}
 
 \func{virtual bool}{Reparent}{\param{wxWindow* }{newParent}}
@@ -1888,14 +1936,14 @@ 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 
+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.
 
 \wxheading{Parameters}
 
-\docparam{autoLayout}{Set this to TRUE if you wish the Layout function to be called
+\docparam{autoLayout}{Set this to {\tt TRUE} if you wish the Layout function to be called
 from within wxWindow::OnSize functions.}
 
 \wxheading{See also}
@@ -1968,6 +2016,14 @@ implements the following methods:\par
 \end{twocollist}}
 }
 
+\membersection{wxWindow::SetContainingSizer}\label{wxwindowsetcontainingsizer}
+
+\func{void}{SetContainingSizer}{\param{wxSizer* }{sizer}}
+
+This normally does not need to be called by user code.  It is called
+when a window is added to a sizer, and is used so the window can
+remove itself from the sizer when it is destroyed.
+
 \membersection{wxWindow::SetCursor}\label{wxwindowsetcursor}
 
 \func{virtual void}{SetCursor}{\param{const wxCursor\&}{cursor}}
@@ -2068,7 +2124,7 @@ window if it has this style flag set.}
 events are propagared 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 
+default for the reasons explained in the
 \helpref{event processing overview}{eventprocessing}.}
 \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
@@ -2078,7 +2134,7 @@ any moment as creating childs of such windows results in fatal problems.}
 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.
 This style cannot be used together with wxMAXIMIZE\_BOX or wxMINIMIZE\_BOX, so
-you should use the style of 
+you should use the style of
 {\tt wxDEFAULT\_FRAME\_STYLE & ~(wxMINIMIZE\_BOX | wxMAXIMIZE\_BOX)} for the
 frames having this style (the dialogs don't have minimize nor maximize box by
 default)}
@@ -2184,7 +2240,7 @@ Obsolete - use \helpref{wxDC::SetPalette}{wxdcsetpalette} instead.
 
 \func{virtual void}{SetScrollbar}{\param{int }{orientation}, \param{int }{position},\rtfsp
 \param{int }{thumbSize}, \param{int }{range},\rtfsp
-\param{bool }{refresh = TRUE}}
+\param{bool }{refresh = {\tt TRUE}}}
 
 Sets the scrollbar properties of a built-in scrollbar.
 
@@ -2198,7 +2254,7 @@ Sets the scrollbar properties of a built-in scrollbar.
 
 \docparam{range}{The maximum position of the scrollbar.}
 
-\docparam{refresh}{TRUE to redraw the scrollbar, FALSE otherwise.}
+\docparam{refresh}{{\tt TRUE} to redraw the scrollbar, {\tt FALSE} otherwise.}
 
 \wxheading{Remarks}
 
@@ -2233,7 +2289,7 @@ from your \helpref{wxWindow::OnSize}{wxwindowonsize} event handler function.
 \begin{comment}
 \membersection{wxWindow::SetScrollPage}\label{wxwindowsetscrollpage}
 
-\func{virtual void}{SetScrollPage}{\param{int }{orientation}, \param{int }{pageSize}, \param{bool }{refresh = TRUE}}
+\func{virtual void}{SetScrollPage}{\param{int }{orientation}, \param{int }{pageSize}, \param{bool }{refresh = {\tt TRUE}}}
 
 Sets the page size of one of the built-in scrollbars.
 
@@ -2243,7 +2299,7 @@ Sets the page size of one of the built-in scrollbars.
 
 \docparam{pageSize}{Page size in scroll units.}
 
-\docparam{refresh}{TRUE to redraw the scrollbar, FALSE otherwise.}
+\docparam{refresh}{{\tt TRUE} to redraw the scrollbar, {\tt FALSE} otherwise.}
 
 \wxheading{Remarks}
 
@@ -2271,7 +2327,7 @@ handling of pages and ranges.
 
 \membersection{wxWindow::SetScrollPos}\label{wxwindowsetscrollpos}
 
-\func{virtual void}{SetScrollPos}{\param{int }{orientation}, \param{int }{pos}, \param{bool }{refresh = TRUE}}
+\func{virtual void}{SetScrollPos}{\param{int }{orientation}, \param{int }{pos}, \param{bool }{refresh = {\tt TRUE}}}
 
 Sets the position of one of the built-in scrollbars.
 
@@ -2281,7 +2337,7 @@ Sets the position of one of the built-in scrollbars.
 
 \docparam{pos}{Position in scroll units.}
 
-\docparam{refresh}{TRUE to redraw the scrollbar, FALSE otherwise.}
+\docparam{refresh}{{\tt TRUE} to redraw the scrollbar, {\tt FALSE} otherwise.}
 
 \wxheading{Remarks}
 
@@ -2298,7 +2354,7 @@ application to take note of scrollbar attributes and redraw contents accordingly
 \begin{comment}
 \membersection{wxWindow::SetScrollRange}\label{wxwindowsetscrollrange}
 
-\func{virtual void}{SetScrollRange}{\param{int }{orientation}, \param{int }{range}, \param{bool }{refresh = TRUE}}
+\func{virtual void}{SetScrollRange}{\param{int }{orientation}, \param{int }{range}, \param{bool }{refresh = {\tt TRUE}}}
 
 Sets the range of one of the built-in scrollbars.
 
@@ -2308,7 +2364,7 @@ Sets the range of one of the built-in scrollbars.
 
 \docparam{range}{Scroll range.}
 
-\docparam{refresh}{TRUE to redraw the scrollbar, FALSE otherwise.}
+\docparam{refresh}{{\tt TRUE} to redraw the scrollbar, {\tt FALSE} otherwise.}
 
 \wxheading{Remarks}
 
@@ -2509,15 +2565,20 @@ See \helpref{Window styles}{windowstyles} for more information about flags.
 
 \membersection{wxWindow::Show}\label{wxwindowshow}
 
-\func{virtual bool}{Show}{\param{bool}{ show}}
+\func{virtual bool}{Show}{\param{bool}{ show = {\tt TRUE}}}
 
-Shows or hides the window. You may need to call \helpref{Raise}{wxwindowraise} 
+Shows or hides the window. You may need to call \helpref{Raise}{wxwindowraise}
 for a top level window if you want to bring it to top, although this is not
 needed if Show() is called immediately after the frame creation.
 
 \wxheading{Parameters}
 
-\docparam{show}{If TRUE displays the window. Otherwise, hides it.}
+\docparam{show}{If {\tt TRUE} displays the window. Otherwise, hides it.}
+
+\wxheading{Return value}
+
+{\tt TRUE} if the window has been shown or hidden or {\tt FALSE} if nothing was
+done because it already was in the requested state.
 
 \wxheading{See also}
 
@@ -2527,7 +2588,7 @@ needed if Show() is called immediately after the frame creation.
 
 \func{virtual void}{Thaw}{\void}
 
-Reenables window updating after a previous call to 
+Reenables window updating after a previous call to
 \helpref{Freeze}{wxwindowfreeze}.
 
 \membersection{wxWindow::TransferDataFromWindow}\label{wxwindowtransferdatafromwindow}
@@ -2535,7 +2596,7 @@ Reenables window updating after a previous call to
 \func{virtual bool}{TransferDataFromWindow}{\void}
 
 Transfers values from child controls to data areas specified by their validators. Returns
-FALSE if a transfer failed.
+{\tt FALSE} if a transfer failed.
 
 If the window has {\tt wxWS\_EX\_VALIDATE\_RECURSIVELY} extra style flag set,
 the method will also call TransferDataFromWindow() of all child windows.
@@ -2556,7 +2617,7 @@ the method will also call TransferDataToWindow() of all child windows.
 
 \wxheading{Return value}
 
-Returns FALSE if a transfer failed.
+Returns {\tt FALSE} if a transfer failed.
 
 \wxheading{See also}
 
@@ -2574,7 +2635,7 @@ the method will also call Validate() of all child windows.
 
 \wxheading{Return value}
 
-Returns FALSE if any of the validations failed.
+Returns {\tt FALSE} if any of the validations failed.
 
 \wxheading{See also}