Added wxHtmlPrintout::AddFilter so the same filters used for

[wxWidgets.git] / docs / latex / wx / window.tex

diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex
index c784cfbb04dd41fa353faf29f10a4fcd5cf8122a..4ae3e95a979cf2a070849ce2f4af2e5b79f697a9 100644 (file)
--- a/docs/latex/wx/window.tex
+++ b/docs/latex/wx/window.tex
@@ -46,8 +46,8 @@ this style}
 the window completely when its size is changed - you will have to repaint the
 new window area manually if you use this style. Currently only has an effect for
 Windows.}
 the window completely when its size is changed - you will have to repaint the
 new window area manually if you use this style. Currently only has an effect for
 Windows.}

-\twocolitem{\windowstyle{wxVSCROLL}}{Use this style to enable a vertical scrollbar. (Still used?) }
-\twocolitem{\windowstyle{wxHSCROLL}}{Use this style to enable a horizontal scrollbar. (Still used?) }
+\twocolitem{\windowstyle{wxVSCROLL}}{Use this style to enable a vertical scrollbar.}
+\twocolitem{\windowstyle{wxHSCROLL}}{Use this style to enable a horizontal scrollbar.}

 \twocolitem{\windowstyle{wxCLIP\_CHILDREN}}{Use this style to eliminate flicker caused by the background being
 repainted, then children being painted over them. Windows only.}
 \end{twocollist}
 \twocolitem{\windowstyle{wxCLIP\_CHILDREN}}{Use this style to eliminate flicker caused by the background being
 repainted, then children being painted over them. Windows only.}
 \end{twocollist}


@@ -254,34 +254,37 @@ implements the following methods:\par
 
 \membersection{wxWindow::Close}\label{wxwindowclose}
 
 
 \membersection{wxWindow::Close}\label{wxwindowclose}
 

-\func{virtual bool}{Close}{\param{bool}{ force = {\tt FALSE}}}
+\func{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.
+This function simply generates a \helpref{wxCloseEvent}{wxcloseevent} whose
+handler usually tries to close the window. It doesn't close the window itself,
+however.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\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.}
+\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}
 
 
 \wxheading{Remarks}
 

-Close calls the \helpref{close handler}{wxcloseevent} for the window, providing an opportunity for the window to
-choose whether to destroy the window.
+Close calls the \helpref{close handler}{wxcloseevent} for the window, providing
+an opportunity for the window to choose whether to destroy the window.
+Usually it is only used with the top level windows (wxFrame and wxDialog
+classes) as the others are not supposed to have any special OnClose() logic.

 
 The close handler should check whether the window is being deleted forcibly,
 
 The close handler should check whether the window is being deleted forcibly,

-using \helpref{wxCloseEvent::GetForce}{wxcloseeventgetforce}, in which case it should
-destroy the window using \helpref{wxWindow::Destroy}{wxwindowdestroy}.
+using \helpref{wxCloseEvent::GetForce}{wxcloseeventgetforce}, in which case it
+should destroy the window using \helpref{wxWindow::Destroy}{wxwindowdestroy}.

 
 

-Applies to managed windows (wxFrame and wxDialog classes) only.
+{\it Note} that calling Close does not guarantee that the window will be
+destroyed; but it provides a way to simulate a manual close of a window, which
+may or may not be implemented by destroying the window. The default
+implementation of wxDialog::OnCloseWindow does not necessarily delete the
+dialog, since it will simply simulate an wxID\_CANCEL event which is handled by
+the appropriate button event handler and may do anything at all.

 
 

-{\it Note} that calling Close does not guarantee that the window will be destroyed; but it
-provides a way to simulate a manual close of a window, which may or may not be implemented by
-destroying the window. The default implementation of wxDialog::OnCloseWindow does not
-necessarily delete the dialog, since it will simply simulate an wxID\_CANCEL event which
-itself only hides the dialog.
-
-To guarantee that the window will be destroyed, call \helpref{wxWindow::Destroy}{wxwindowdestroy} instead.
+To guarantee that the window will be destroyed, call 
+\helpref{wxWindow::Destroy}{wxwindowdestroy} instead

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -375,14 +378,14 @@ implements the following methods:\par
 
 Destroys the window safely. Use this function instead of the delete operator, since
 different window classes can be destroyed differently. Frames and dialogs
 
 Destroys the window safely. Use this function instead of the delete operator, since
 different window classes can be destroyed differently. Frames and dialogs

-are not destroyed immediately when this function is called - they are added
+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-existent
 windows.
 
 \wxheading{Return value}
 
 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-existent
 windows.
 
 \wxheading{Return value}
 

-{\tt 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}
 to the list of windows pending real deletion.
 
 \membersection{wxWindow::DestroyChildren}


@@ -395,11 +398,11 @@ Destroys all children of a window.  Called automatically by the destructor.
 
 \func{void}{Disable}{\void}
 
 
 \func{void}{Disable}{\void}
 

-Disables the window, same as \helpref{Enable({\tt FALSE})}{wxwindowenable}.
+Disables the window, same as \helpref{Enable({\tt false})}{wxwindowenable}.

 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-Returns {\tt TRUE} if the window has been disabled, {\tt FALSE} if it had been
+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}
 already disabled before the call to this function.
 
 \membersection{wxWindow::DragAcceptFiles}\label{wxwindowdragacceptfiles}


@@ -410,7 +413,7 @@ Enables or disables eligibility for drop file events (OnDropFiles).
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{accept}{If {\tt TRUE}, the window is eligible for drop file events. If {\tt 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}
 will not accept drop file events.}
 
 \wxheading{Remarks}


@@ -419,7 +422,7 @@ Windows only.
 
 \membersection{wxWindow::Enable}\label{wxwindowenable}
 
 
 \membersection{wxWindow::Enable}\label{wxwindowenable}
 

-\func{virtual bool}{Enable}{\param{bool}{ enable = {\tt TRUE}}}
+\func{virtual bool}{Enable}{\param{bool}{ enable = {\tt true}}}

 
 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
 
 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


@@ -427,11 +430,11 @@ when the parent is.
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{enable}{If {\tt TRUE}, enables the window for input. If {\tt FALSE}, disables the window.}
+\docparam{enable}{If {\tt true}, enables the window for input. If {\tt false}, disables the window.}

 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-Returns {\tt TRUE} if the window has been enabled or disabled, {\tt FALSE} if
+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}
 nothing was done, i.e. if the window had already been in the specified state.
 
 \wxheading{See also}


@@ -545,6 +548,14 @@ wxTextCtrl under wxGTK) but is not implemented on all platforms nor for all
 controls so it is mostly just a hint to wxWindows and not a mandatory
 directive.
 
 controls so it is mostly just a hint to wxWindows and not a mandatory
 directive.
 

+\membersection{wxWindow::GetAccessible}\label{wxwindowgetaccessible}
+
+\func{wxAccessibile*}{GetAccessible}{\void}
+
+Returns the accessible object for this window, if any.
+
+See also \helpref{wxAccessible}{wxaccessible}.
+

 \membersection{wxWindow::GetAdjustedBestSize}\label{wxwindowgetadjustedbestsize}
 
 \constfunc{wxSize}{GetAdjustedBestSize}{\void}
 \membersection{wxWindow::GetAdjustedBestSize}\label{wxwindowgetadjustedbestsize}
 
 \constfunc{wxSize}{GetAdjustedBestSize}{\void}


@@ -919,7 +930,7 @@ Return the sizer associated with the window by a previous call to
 
 \constfunc{virtual void}{GetTextExtent}{\param{const wxString\& }{string}, \param{int* }{x}, \param{int* }{y},
  \param{int* }{descent = NULL}, \param{int* }{externalLeading = NULL},
 
 \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 = {\tt 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.
 
 Gets the dimensions of the string as it would be drawn on the
 window with the currently selected font.


@@ -938,7 +949,7 @@ window with the currently selected font.
 
 \docparam{font}{Font to use instead of the current window font (optional).}
 
 
 \docparam{font}{Font to use instead of the current window font (optional).}
 

-\docparam{use16}{If {\tt TRUE}, {\it string} contains 16-bit characters. The default is {\tt 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
 
 
 \pythonnote{In place of a single overloaded method name, wxPython


@@ -964,6 +975,12 @@ Gets the window's title. Applicable only to frames and dialogs.
 
 \helpref{wxWindow::SetTitle}{wxwindowsettitle}
 
 
 \helpref{wxWindow::SetTitle}{wxwindowsettitle}
 

+\membersection{wxWindow::GetToolTip}\label{wxwindowgettooltip}
+
+\constfunc{wxToolTip*}{GetToolTip}{\void}
+
+Get the associated tooltip or NULL if none.
+

 \membersection{wxWindow::GetUpdateRegion}\label{wxwindowgetupdateregion}
 
 \constfunc{virtual wxRegion}{GetUpdateRegion}{\void}
 \membersection{wxWindow::GetUpdateRegion}\label{wxwindowgetupdateregion}
 
 \constfunc{virtual wxRegion}{GetUpdateRegion}{\void}


@@ -1010,7 +1027,7 @@ method. {\bf GetWindowStyle()} is another name for the same function.
 
 \constfunc{virtual bool}{HasCapture}{\void}
 
 
 \constfunc{virtual bool}{HasCapture}{\void}
 

-Returns TRUE if this window has the current mouse capture.
+Returns true if this window has the current mouse capture.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -1022,7 +1039,7 @@ Returns TRUE if this window has the current mouse capture.
 
 \func{bool}{Hide}{\void}
 
 
 \func{bool}{Hide}{\void}
 

-Equivalent to calling \helpref{Show}{wxwindowshow}({\tt FALSE}).
+Equivalent to calling \helpref{Show}{wxwindowshow}({\tt false}).

 
 \membersection{wxWindow::InitDialog}\label{wxwindowinitdialog}
 
 
 \membersection{wxWindow::InitDialog}\label{wxwindowinitdialog}
 


@@ -1035,13 +1052,13 @@ to the dialog via validators.
 
 \constfunc{virtual bool}{IsEnabled}{\void}
 
 
 \constfunc{virtual bool}{IsEnabled}{\void}
 

-Returns {\tt TRUE} if the window is enabled for input, {\tt FALSE} otherwise.
+Returns {\tt true} if the window is enabled for input, {\tt false} otherwise.

 
 \wxheading{See also}
 
 \helpref{wxWindow::Enable}{wxwindowenable}
 
 
 \wxheading{See also}
 
 \helpref{wxWindow::Enable}{wxwindowenable}
 

-\membersection{wxWindow:IsExposed}\label{wxwindowisexposed}
+\membersection{wxWindow::IsExposed}\label{wxwindowisexposed}

 
 \constfunc{bool}{IsExposed}{\param{int }{x}, \param{int }{y}}
 
 
 \constfunc{bool}{IsExposed}{\param{int }{x}, \param{int }{y}}
 


@@ -1051,7 +1068,7 @@ Returns {\tt TRUE} if the window is enabled for input, {\tt FALSE} otherwise.
 
 \constfunc{bool}{IsExposed}{\param{wxRect }{\&rect}}
 
 
 \constfunc{bool}{IsExposed}{\param{wxRect }{\&rect}}
 

-Returns {\tt TRUE} if the given point or rectangle 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.
 
 last repaint. Call this in an paint event handler to optimize redrawing by
 only redrawing those areas, which have been exposed.
 


@@ -1067,7 +1084,7 @@ implements the following methods:\par
 
 \constfunc{virtual bool}{IsRetained}{\void}
 
 
 \constfunc{virtual bool}{IsRetained}{\void}
 

-Returns {\tt TRUE} if the window is retained, {\tt FALSE} otherwise.
+Returns {\tt true} if the window is retained, {\tt false} otherwise.

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -1077,13 +1094,13 @@ Retained windows are only available on X platforms.
 
 \constfunc{virtual bool}{IsShown}{\void}
 
 
 \constfunc{virtual bool}{IsShown}{\void}
 

-Returns {\tt TRUE} if the window is shown, {\tt 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}
 
 
 \membersection{wxWindow::IsTopLevel}\label{wxwindowistoplevel}
 
 \constfunc{bool}{IsTopLevel}{\void}
 

-Returns {\tt 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).
 
 dialogs are considered to be top-level windows (even if they have a parent
 window).
 


@@ -1094,28 +1111,16 @@ window).
 Invokes the constraint-based layout algorithm or the sizer-based algorithm
 for this window.
 
 Invokes the constraint-based layout algorithm or the sizer-based algorithm
 for this window.
 

-See \helpref{wxWindow::SetAutoLayout}{wxwindowsetautolayout} on when
-this function gets called automatically using auto layout.
+See \helpref{wxWindow::SetAutoLayout}{wxwindowsetautolayout}: when auto
+layout is on, this function gets called automatically when the window is resized.

 
 

-\membersection{wxWindow::LoadFromResource}\label{wxwindowloadfromresource}
+\membersection{wxWindow::LineDown}\label{wxwindowlinedown}

 
 

-\func{virtual bool}{LoadFromResource}{\param{wxWindow* }{parent},\rtfsp
-\param{const wxString\& }{resourceName}, \param{const wxResourceTable* }{resourceTable = NULL}}
+This is just a wrapper for \helpref{ScrollLines()}{wxwindowscrolllines}$(1)$.

 
 

-Loads a panel or dialog from a resource file.
+\membersection{wxWindow::LineUp}\label{wxwindowlineup}

 
 

-\wxheading{Parameters}
-
-\docparam{parent}{Parent window.}
-
-\docparam{resourceName}{The name of the resource to load.}
-
-\docparam{resourceTable}{The resource table to load it from. If this is NULL, the
-default resource table will be used.}
-
-\wxheading{Return value}
-
-{\tt TRUE} if the operation succeeded, otherwise {\tt FALSE}.
+This is just a wrapper for \helpref{ScrollLines()}{wxwindowscrolllines}$(-1)$.

 
 \membersection{wxWindow::Lower}\label{wxwindowlower}
 
 
 \membersection{wxWindow::Lower}\label{wxwindowlower}
 


@@ -1134,8 +1139,8 @@ is not implemented anywhere).
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\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.}
+\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}
 
 
 \membersection{wxWindow::Move}\label{wxwindowmove}
 


@@ -1191,8 +1196,8 @@ implements the following methods:\par
 %%
 %% \wxheading{Remarks}
 %%
 %%
 %% \wxheading{Remarks}
 %%

-%% If the window is being activated, \helpref{wxActivateEvent::GetActive}{wxactivateeventgetactive} returns {\tt TRUE},
-%% otherwise it returns {\tt 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}
 %%
 %%
 %% \wxheading{See also}
 %%


@@ -1307,7 +1312,7 @@ implements the following methods:\par
 %%
 %% \wxheading{Return value}
 %%
 %%
 %% \wxheading{Return value}
 %%

-%% If {\tt 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.
 %%
 %% attempt will be ignored. Do not delete the window from within this handler, although
 %% you may delete other windows.
 %%


@@ -1667,16 +1672,24 @@ implements the following methods:\par
 %% \helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent},\rtfsp
 %% \helpref{Event handling overview}{eventhandlingoverview}
 
 %% \helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent},\rtfsp
 %% \helpref{Event handling overview}{eventhandlingoverview}
 

+\membersection{wxWindow::PageDown}\label{wxwindowpagedown}
+
+This is just a wrapper for \helpref{ScrollPages()}{wxwindowscrollpages}$(1)$.
+
+\membersection{wxWindow::PageUp}\label{wxwindowpageup}
+
+This is just a wrapper for \helpref{ScrollPages()}{wxwindowscrollpages}$(-1)$.
+

 \membersection{wxWindow::PopEventHandler}\label{wxwindowpopeventhandler}
 
 \membersection{wxWindow::PopEventHandler}\label{wxwindowpopeventhandler}
 

-\constfunc{wxEvtHandler*}{PopEventHandler}{\param{bool }{deleteHandler = {\tt FALSE}}}
+\constfunc{wxEvtHandler*}{PopEventHandler}{\param{bool }{deleteHandler = {\tt false}}}

 
 Removes and returns the top-most event handler on the event handler stack.
 
 \wxheading{Parameters}
 
 
 Removes and returns the top-most event handler on the event handler stack.
 
 \wxheading{Parameters}
 

-\docparam{deleteHandler}{If this is {\tt TRUE}, the handler will be deleted after it is removed. The
-default value is {\tt 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}
 
 
 \wxheading{See also}
 


@@ -1765,7 +1778,7 @@ or frame).
 
 \membersection{wxWindow::Refresh}\label{wxwindowrefresh}
 
 
 \membersection{wxWindow::Refresh}\label{wxwindowrefresh}
 

-\func{virtual void}{Refresh}{\param{bool}{ eraseBackground = {\tt 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
 = NULL}}
 
 Causes a message or event to be generated to repaint the


@@ -1773,7 +1786,7 @@ window.
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{eraseBackground}{If {\tt 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
 erased.}
 
 \docparam{rect}{If non-NULL, only the given rectangle will


@@ -1830,7 +1843,7 @@ must be present in this windows event handlers chain}
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-Returns {\tt TRUE} if it was found and {\tt FALSE} otherwise (this also results
+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).
 
 in an assert failure so this function should only be called when the
 handler is supposed to be there).
 


@@ -1884,7 +1897,7 @@ positive) or up.
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-Returns {\tt TRUE} if the window was scrolled, {\tt FALSE} if it was already
+Returns {\tt true} if the window was scrolled, {\tt false} if it was already

 on top/bottom and nothing was done.
 
 \wxheading{Remarks}
 on top/bottom and nothing was done.
 
 \wxheading{Remarks}


@@ -1906,7 +1919,7 @@ positive) or up.
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-Returns {\tt TRUE} if the window was scrolled, {\tt FALSE} if it was already
+Returns {\tt true} if the window was scrolled, {\tt false} if it was already

 on top/bottom and nothing was done.
 
 \wxheading{Remarks}
 on top/bottom and nothing was done.
 
 \wxheading{Remarks}


@@ -1946,6 +1959,15 @@ redrawn. Note that it is rarely required to call this function from a user progr
 
 Sets the accelerator table for this window. See \helpref{wxAcceleratorTable}{wxacceleratortable}.
 
 
 Sets the accelerator table for this window. See \helpref{wxAcceleratorTable}{wxacceleratortable}.
 

+\membersection{wxWindow::SetAccessible}\label{wxwindowsetaccessible}
+
+\func{void}{SetAccessible}{\param{wxAccessibile*}{ accessible}}
+
+Sets the accessible for this window. Any existing accessible for this window
+will be deleted first, if not identical to {\it accessible}.
+
+See also \helpref{wxAccessible}{wxaccessible}.
+

 \membersection{wxWindow::SetAutoLayout}\label{wxwindowsetautolayout}
 
 \func{void}{SetAutoLayout}{\param{bool}{ autoLayout}}
 \membersection{wxWindow::SetAutoLayout}\label{wxwindowsetautolayout}
 
 \func{void}{SetAutoLayout}{\param{bool}{ autoLayout}}


@@ -1959,7 +1981,7 @@ size changes.
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{autoLayout}{Set this to {\tt 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}
 from within wxWindow::OnSize functions.}
 
 \wxheading{See also}


@@ -2269,7 +2291,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
 
 \func{virtual void}{SetScrollbar}{\param{int }{orientation}, \param{int }{position},\rtfsp
 \param{int }{thumbSize}, \param{int }{range},\rtfsp

-\param{bool }{refresh = {\tt TRUE}}}
+\param{bool }{refresh = {\tt true}}}

 
 Sets the scrollbar properties of a built-in scrollbar.
 
 
 Sets the scrollbar properties of a built-in scrollbar.
 


@@ -2283,7 +2305,7 @@ Sets the scrollbar properties of a built-in scrollbar.
 
 \docparam{range}{The maximum position of the scrollbar.}
 
 
 \docparam{range}{The maximum position of the scrollbar.}
 

-\docparam{refresh}{{\tt TRUE} to redraw the scrollbar, {\tt FALSE} otherwise.}
+\docparam{refresh}{{\tt true} to redraw the scrollbar, {\tt false} otherwise.}

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -2318,7 +2340,7 @@ from your \helpref{wxSizeEvent}{wxsizeevent} handler function.
 \begin{comment}
 \membersection{wxWindow::SetScrollPage}\label{wxwindowsetscrollpage}
 
 \begin{comment}
 \membersection{wxWindow::SetScrollPage}\label{wxwindowsetscrollpage}
 

-\func{virtual void}{SetScrollPage}{\param{int }{orientation}, \param{int }{pageSize}, \param{bool }{refresh = {\tt 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.
 
 
 Sets the page size of one of the built-in scrollbars.
 


@@ -2328,7 +2350,7 @@ Sets the page size of one of the built-in scrollbars.
 
 \docparam{pageSize}{Page size in scroll units.}
 
 
 \docparam{pageSize}{Page size in scroll units.}
 

-\docparam{refresh}{{\tt TRUE} to redraw the scrollbar, {\tt FALSE} otherwise.}
+\docparam{refresh}{{\tt true} to redraw the scrollbar, {\tt false} otherwise.}

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -2356,7 +2378,7 @@ handling of pages and ranges.
 
 \membersection{wxWindow::SetScrollPos}\label{wxwindowsetscrollpos}
 
 
 \membersection{wxWindow::SetScrollPos}\label{wxwindowsetscrollpos}
 

-\func{virtual void}{SetScrollPos}{\param{int }{orientation}, \param{int }{pos}, \param{bool }{refresh = {\tt 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.
 
 
 Sets the position of one of the built-in scrollbars.
 


@@ -2366,7 +2388,7 @@ Sets the position of one of the built-in scrollbars.
 
 \docparam{pos}{Position in scroll units.}
 
 
 \docparam{pos}{Position in scroll units.}
 

-\docparam{refresh}{{\tt TRUE} to redraw the scrollbar, {\tt FALSE} otherwise.}
+\docparam{refresh}{{\tt true} to redraw the scrollbar, {\tt false} otherwise.}

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -2383,7 +2405,7 @@ application to take note of scrollbar attributes and redraw contents accordingly
 \begin{comment}
 \membersection{wxWindow::SetScrollRange}\label{wxwindowsetscrollrange}
 
 \begin{comment}
 \membersection{wxWindow::SetScrollRange}\label{wxwindowsetscrollrange}
 

-\func{virtual void}{SetScrollRange}{\param{int }{orientation}, \param{int }{range}, \param{bool }{refresh = {\tt 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.
 
 
 Sets the range of one of the built-in scrollbars.
 


@@ -2393,7 +2415,7 @@ Sets the range of one of the built-in scrollbars.
 
 \docparam{range}{Scroll range.}
 
 
 \docparam{range}{Scroll range.}
 

-\docparam{refresh}{{\tt TRUE} to redraw the scrollbar, {\tt FALSE} otherwise.}
+\docparam{refresh}{{\tt true} to redraw the scrollbar, {\tt false} otherwise.}

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -2512,24 +2534,24 @@ The resizing increments are only significant under Motif or Xt.
 
 \membersection{wxWindow::SetSizer}\label{wxwindowsetsizer}
 
 
 \membersection{wxWindow::SetSizer}\label{wxwindowsetsizer}
 

-\func{void}{SetSizer}{\param{wxSizer* }{sizer}, \param{bool }{deleteOld=TRUE}}
+\func{void}{SetSizer}{\param{wxSizer* }{sizer}, \param{bool }{deleteOld=true}}

 
 Sets the window to have the given layout sizer. The window
 will then own the object, and will take care of its deletion.
 If an existing layout constraints object is already owned by the
 
 Sets the window to have the given layout sizer. The window
 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.
+window, it will be deleted if the deleteOld parameter is true.

 
 Note that this function will also call 
 
 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.
+\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
 the window's sizer.  See below.}
 
 
 \wxheading{Parameters}
 
 \docparam{sizer}{The sizer to set. Pass NULL to disassociate and conditionally delete
 the window's sizer.  See below.}
 

-\docparam{deleteOld}{If TRUE (the default), this will delete any prexisting sizer.
-Pass FALSE if you wish to handle deleting the old sizer yourself.}
+\docparam{deleteOld}{If true (the default), this will delete any prexisting sizer.
+Pass false if you wish to handle deleting the old sizer yourself.}

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -2543,7 +2565,7 @@ only the sizer will have effect.
 
 \membersection{wxWindow::SetSizerAndFit}\label{wxwindowsetsizerandfit}
 
 
 \membersection{wxWindow::SetSizerAndFit}\label{wxwindowsetsizerandfit}
 

-\func{void}{SetSizerAndFit}{\param{wxSizer* }{sizer}, \param{bool }{deleteOld=TRUE}}
+\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.
 
 The same as \helpref{SetSizer}{wxwindowsetsizer}, except it also sets the size hints
 for the window based on the sizer's minimum size.


@@ -2573,16 +2595,9 @@ 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.
 
 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
+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.
 
 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}}
-
-Deletes the current validator (if any) and sets the window validator, having called wxValidator::Clone to
-create a new validator of this type.
-

 \membersection{wxWindow::SetToolTip}\label{wxwindowsettooltip}
 
 \func{void}{SetToolTip}{\param{const wxString\& }{tip}}
 \membersection{wxWindow::SetToolTip}\label{wxwindowsettooltip}
 
 \func{void}{SetToolTip}{\param{const wxString\& }{tip}}


@@ -2592,15 +2607,14 @@ create a new validator of this type.
 Attach a tooltip to the window.
 
 See also: \helpref{GetToolTip}{wxwindowgettooltip},
 Attach a tooltip to the window.
 
 See also: \helpref{GetToolTip}{wxwindowgettooltip},

-          \helpref{wxToolTip}{wxtooltip}
+ \helpref{wxToolTip}{wxtooltip}

 
 

+\membersection{wxWindow::SetValidator}\label{wxwindowsetvalidator}

 
 

-\membersection{wxWindow::GetToolTip}\label{wxwindowgettooltip}
-
-\constfunc{wxToolTip*}{GetToolTip}{\void}
-
-Get the associated tooltip or NULL if none.
+\func{virtual void}{SetValidator}{\param{const wxValidator\&}{ validator}}

 
 

+Deletes the current validator (if any) and sets the window validator, having called wxValidator::Clone to
+create a new validator of this type.

 
 \membersection{wxWindow::SetVirtualSize}\label{wxwindowsetvirtualsize}
 
 
 \membersection{wxWindow::SetVirtualSize}\label{wxwindowsetvirtualsize}
 


@@ -2610,7 +2624,6 @@ Get the associated tooltip or NULL if none.
 
 Sets the virtual size of the window in pixels.
 
 
 Sets the virtual size of the window in pixels.
 

-

 \membersection{wxWindow::SetVirtualSizeHints}\label{wxwindowsetvirtualsizehints}
 
 \func{virtual void}{SetVirtualSizeHints}{\param{int}{ minW},\param{int}{ minH}, \param{int}{ maxW=-1}, \param{int}{ maxH=-1}}
 \membersection{wxWindow::SetVirtualSizeHints}\label{wxwindowsetvirtualsizehints}
 
 \func{virtual void}{SetVirtualSizeHints}{\param{int}{ minW},\param{int}{ minH}, \param{int}{ maxW=-1}, \param{int}{ maxH=-1}}


@@ -2656,7 +2669,7 @@ See \helpref{Window styles}{windowstyles} for more information about flags.
 
 \membersection{wxWindow::Show}\label{wxwindowshow}
 
 
 \membersection{wxWindow::Show}\label{wxwindowshow}
 

-\func{virtual bool}{Show}{\param{bool}{ show = {\tt TRUE}}}
+\func{virtual bool}{Show}{\param{bool}{ show = {\tt true}}}

 
 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
 
 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


@@ -2664,11 +2677,11 @@ needed if Show() is called immediately after the frame creation.
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{show}{If {\tt TRUE} displays the window. Otherwise, hides it.}
+\docparam{show}{If {\tt true} displays the window. Otherwise, hides it.}

 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-{\tt TRUE} if the window has been shown or hidden or {\tt FALSE} if nothing was
+{\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}
 done because it already was in the requested state.
 
 \wxheading{See also}


@@ -2687,7 +2700,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
 \func{virtual bool}{TransferDataFromWindow}{\void}
 
 Transfers values from child controls to data areas specified by their validators. Returns

-{\tt 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.
 
 If the window has {\tt wxWS\_EX\_VALIDATE\_RECURSIVELY} extra style flag set,
 the method will also call TransferDataFromWindow() of all child windows.


@@ -2708,7 +2721,7 @@ the method will also call TransferDataToWindow() of all child windows.
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-Returns {\tt FALSE} if a transfer failed.
+Returns {\tt false} if a transfer failed.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -2737,7 +2750,7 @@ the method will also call Validate() of all child windows.
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-Returns {\tt FALSE} if any of the validations failed.
+Returns {\tt false} if any of the validations failed.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -2751,6 +2764,9 @@ Returns {\tt FALSE} if any of the validations failed.
 
 Moves the pointer to the given position on the window.
 
 
 Moves the pointer to the given position on the window.
 

+{\bf NB: } This function is not supported under Mac because Apple Human
+Interface Guidelines forbid moving the mouse cursor programmatically.
+

 \wxheading{Parameters}
 
 \docparam{x}{The new x position for the cursor.}
 \wxheading{Parameters}
 
 \docparam{x}{The new x position for the cursor.}