wxWindow is the base class for all windows. Any children of the window will be deleted
automatically by the destructor before the window itself is deleted.
-Please note that we documented a number of handler functions (OnChar(), OnMouse() etc.) in this
-help text. These must not be called by a user program and are documented only for illustration.
-On several platforms, only a few of these handlers are actually written (they are not always
-needed) and if you are uncertain on how to add a certain behaviour to a window class, intercept
-the respective event as usual and call \helpref{wxEvent::Skip}{wxeventskip} so that the native
-platform can implement its native behaviour or just ignore the event if nothing needs to be
-done.
+%Please note that we documented a number of handler functions (OnChar(), OnMouse() etc.) in this
+%help text. These must not be called by a user program and are documented only for illustration.
+%On several platforms, only a few of these handlers are actually written (they are not always
+%needed) and if you are uncertain on how to add a certain behaviour to a window class, intercept
+%the respective event as usual and call \helpref{wxEvent::Skip}{wxeventskip} so that the native
+%platform can implement its native behaviour or just ignore the event if nothing needs to be
+%done.
\wxheading{Derived from}
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}
\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}
-\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}
-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,
-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}
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}
-{\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}
\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}
-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}
\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}
\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
\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}
-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}
Sizes the window so that it fits around its subwindows. This function won't do
anything if there are no subwindows.
+\membersection{wxWindow::FitInside}\label{wxwindowfitinside}
+
+\func{virtual void}{FitInside}{\void}
+
+Similar to \helpref{Fit}{wxwindowfit}, but sizes the interior (virtual) size
+of a window. Mainly useful with scrolled windows to reset scrollbars after
+sizing changes that do not trigger a size event, and/or scrolled windows without
+an interior sizer. This function similarly won't do anything if there are no
+subwindows.
+
\membersection{wxWindow::Freeze}\label{wxwindowfreeze}
\func{virtual void}{Freeze}{\void}
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}
+
+This method is similar to \helpref{GetBestSize}{wxwindowgetbestsize}, except
+in one thing. GetBestSize should return the minimum untruncated size of the
+window, while this method will return the largest of BestSize and any user
+specified minimum size. ie. it is the minimum size the window should currently
+be drawn at, not the minimal size it can possibly tolerate.
+
\membersection{wxWindow::GetBackgroundColour}\label{wxwindowgetbackgroundcolour}
\constfunc{virtual wxColour}{GetBackgroundColour}{\void}
\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.
\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
\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}
\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}
\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}
\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}
\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.
\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}
\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}
-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).
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}}
-
-Loads a panel or dialog from a resource file.
-
-\wxheading{Parameters}
+This is just a wrapper for \helpref{ScrollLines()}{wxwindowscrolllines}$(1)$.
-\docparam{parent}{Parent window.}
+\membersection{wxWindow::LineUp}\label{wxwindowlineup}
-\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}
\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}
%%
%% \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{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.
%%
%% \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}
-\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}
-\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}
\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
\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
be treated as damaged.}
+\wxheading{See also}
+
+\helpref{wxWindow::RefreshRect}{wxwindowrefreshrect}
+
+\membersection{wxWindow::RefreshRect}\label{wxwindowrefreshrect}
+
+\func{virtual void}{Refresh}{\param{const wxRect\& }{rect}}
+
+Redraws the contents of the given rectangle: the area inside it will be
+repainted.
+
+This is the same as \helpref{Refresh}{wxwindowrefresh} but has a nicer syntax.
+
\membersection{wxWindow::ReleaseMouse}\label{wxwindowreleasemouse}
\func{virtual void}{ReleaseMouse}{\void}
\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).
\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}
\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}
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}}
\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}
\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.
\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}
\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.
\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}
\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.
\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}
\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.
\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}
\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
-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
-\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.}
-\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}
\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.
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.
\membersection{wxWindow::SetValidator}\label{wxwindowsetvalidator}
Attach a tooltip to the window.
See also: \helpref{GetToolTip}{wxwindowgettooltip},
- \helpref{wxToolTip}{wxtooltip}
-
-
-\membersection{wxWindow::GetToolTip}\label{wxwindowgettooltip}
-
-\constfunc{wxToolTip*}{GetToolTip}{\void}
-
-Get the associated tooltip or NULL if none.
-
+ \helpref{wxToolTip}{wxtooltip}
\membersection{wxWindow::SetVirtualSize}\label{wxwindowsetvirtualsize}
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::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
\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}
-{\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}
\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.
\wxheading{Return value}
-Returns {\tt FALSE} if a transfer failed.
+Returns {\tt false} if a transfer failed.
\wxheading{See also}
\helpref{wxWindow::TransferDataFromWindow}{wxwindowtransferdatafromwindow},\rtfsp
\helpref{wxValidator}{wxvalidator}, \helpref{wxWindow::Validate}{wxwindowvalidate}
+\membersection{wxWindow::Update}\label{wxwindowupdate}
+
+\func{virtual void}{Update}{\void}
+
+Calling this method immediately repaints the invalidated area of the window
+while this would usually only happen when the flow of control returns to the
+event loop. Notice that this function doesn't refresh the window and does
+nothing if the window hadn't been already repainted. Use
+\helpref{Refresh}{wxwindowrefresh} first if you want to immediately redraw the
+window unconditionally.
+
\membersection{wxWindow::Validate}\label{wxwindowvalidate}
\func{virtual bool}{Validate}{\void}
\wxheading{Return value}
-Returns {\tt FALSE} if any of the validations failed.
+Returns {\tt false} if any of the validations failed.
\wxheading{See also}
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.}
projects / wxWidgets.git / blobdiff