X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2e36d5cf818d64c8abdb3da1861d233d774be139..a84ece11fffdde5d1bbd254ba58ac3cee79c2e77:/docs/latex/wx/window.tex diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index 0ea0bac987..c5846f1cd0 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} @@ -509,6 +509,19 @@ same as the size the window would have had after calling Returns the \helpref{caret}{wxcaret} associated with the window. +\membersection{wxWindow::GetCapture}\label{wxwindowgetcapture} + +\func{static wxWindow *}{GetCapture}{\void} + +Returns the currently captured window. + +\wxheading{See also} + +\helpref{wxWindow::HasCapture}{wxwindowhascapture}, +\helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse}, +\helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse}, +\helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent} + \membersection{wxWindow::GetCharHeight} \constfunc{virtual int}{GetCharHeight}{\void} @@ -536,8 +549,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 +567,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 +798,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 +824,22 @@ method:\par \end{twocollist} }} +\wxheading{See also} + +\helpref{GetClientSize}{wxwindowgetclientsize} + \membersection{wxWindow::GetSizer}\label{wxwindowgetsizer} -\constfunc{const wxSizer *}{GetSizer}{\void} +\constfunc{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 +858,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 @@ -857,7 +889,7 @@ Gets the window's title. Applicable only to frames and dialogs. \constfunc{virtual wxRegion}{GetUpdateRegion}{\void} Returns the region specifying which parts of the window have been damaged. Should -only be called within an \helpref{OnPaint}{wxwindowonpaint} event handler. +only be called within an \helpref{wxPaintEvent}{wxpaintevent} handler. \wxheading{See also} @@ -877,6 +909,24 @@ 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::HasCapture}\label{wxwindowhascapture} + +\constfunc{virtual bool}{HasCapture}{\void} + +Returns TRUE if this window has the current mouse capture. + +\wxheading{See also} + +\helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse}, +\helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse}, +\helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent} + +\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 +938,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 +954,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 +970,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 +980,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 +1018,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 +1037,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 +1094,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 +1210,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. %% @@ -1171,95 +1221,6 @@ implements the following methods:\par %% \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow},\rtfsp %% \helpref{wxCloseEvent}{wxcloseevent} %% -%% \membersection{wxWindow::OnCloseWindow}\label{wxwindowonclosewindow} -%% -%% \func{void}{OnCloseWindow}{\param{wxCloseEvent\& }{event}} -%% -%% This is an event handler function called when the user has tried to close a a frame -%% or dialog box using the window manager (X) or system menu (Windows). It is -%% called via the \helpref{wxWindow::Close}{wxwindowclose} function, so -%% that the application can also invoke the handler programmatically. -%% -%% 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, -%% 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, -%% 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. -%% -%% \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. -%% -%% \wxheading{See also} -%% -%% \helpref{Window deletion overview}{windowdeletionoverview},\rtfsp -%% \helpref{wxWindow::Close}{wxwindowclose},\rtfsp -%% \helpref{wxWindow::OnClose}{wxwindowonclose},\rtfsp -%% \helpref{wxWindow::Destroy}{wxwindowdestroy},\rtfsp -%% \helpref{wxCloseEvent}{wxcloseevent},\rtfsp -%% \helpref{wxApp::OnQueryEndSession}{wxapponqueryendsession} -%% %% GD: OnXXX functions are not documented -%% %%\helpref{wxApp::OnEndSession}{wxapponendsession} -%% -%% \membersection{wxWindow::OnDropFiles}\label{wxwindowondropfiles} -%% -%% \func{void}{OnDropFiles}{\param{wxDropFilesEvent\&}{ event}} -%% -%% Called when files have been dragged from the file manager to the window. -%% -%% \wxheading{Parameters} -%% -%% \docparam{event}{Drop files event. For more information, see \helpref{wxDropFilesEvent}{wxdropfilesevent}.} -%% -%% \wxheading{Remarks} -%% -%% The window must have previously been enabled for dropping by calling -%% \rtfsp\helpref{wxWindow::DragAcceptFiles}{wxwindowdragacceptfiles}. -%% -%% This event is only generated under Windows. -%% -%% To intercept this event, use the EVT\_DROP\_FILES macro in an event table definition. -%% -%% \wxheading{See also} -%% -%% \helpref{wxDropFilesEvent}{wxdropfilesevent}, \helpref{wxWindow::DragAcceptFiles}{wxwindowdragacceptfiles},\rtfsp -%% \helpref{Event handling overview}{eventhandlingoverview} -%% -%% \membersection{wxWindow::OnEraseBackground}\label{wxwindowonerasebackground} -%% -%% \func{void}{OnEraseBackground}{\param{wxEraseEvent\&}{ event}} -%% -%% Called when the background of the window needs to be erased. -%% -%% \wxheading{Parameters} -%% -%% \docparam{event}{Erase background event. For more information, see \helpref{wxEraseEvent}{wxeraseevent}.} -%% -%% \wxheading{Remarks} -%% -%% Under non-Windows platforms, this event is simulated (simply generated just before the -%% paint event) and may cause flicker. It is therefore recommended that -%% you set the text background colour explicitly in order to prevent flicker. -%% The default background colour under GTK is grey. -%% -%% To intercept this event, use the EVT\_ERASE\_BACKGROUND macro in an event table definition. -%% -%% \wxheading{See also} -%% -%% \helpref{wxEraseEvent}{wxeraseevent}, \helpref{Event handling overview}{eventhandlingoverview} -%% %% \membersection{wxWindow::OnKeyDown}\label{wxwindowonkeydown} %% %% \func{void}{OnKeyDown}{\param{wxKeyEvent\&}{ event}} @@ -1322,40 +1283,6 @@ implements the following methods:\par %% \helpref{wxKeyEvent}{wxkeyevent}, \helpref{wxWindow::OnCharHook}{wxwindowoncharhook},\rtfsp %% \helpref{Event handling overview}{eventhandlingoverview} %% -%% \membersection{wxWindow::OnKillFocus}\label{wxwindowonkillfocus} -%% -%% \func{void}{OnKillFocus}{\param{wxFocusEvent\& }{event}} -%% -%% Called when a window's focus is being killed. -%% -%% \wxheading{Parameters} -%% -%% \docparam{event}{The focus event. For more information, see \helpref{wxFocusEvent}{wxfocusevent}.} -%% -%% \wxheading{Remarks} -%% -%% To intercept this event, use the macro EVT\_KILL\_FOCUS in an event table definition. -%% -%% Most, but not all, windows respond to this event. -%% -%% \wxheading{See also} -%% -%% \helpref{wxFocusEvent}{wxfocusevent}, \helpref{wxWindow::OnSetFocus}{wxwindowonsetfocus},\rtfsp -%% \helpref{Event handling overview}{eventhandlingoverview} -%% -%% \membersection{wxWindow::OnIdle}\label{wxwindowonidle} -%% -%% \func{void}{OnIdle}{\param{wxIdleEvent\& }{event}} -%% -%% Provide this member function for any processing which needs to be done -%% when the application is idle. -%% -%% \wxheading{See also} -%% -%% %% GD: OnXXX functions are not documented -%% %%\helpref{wxApp::OnIdle}{wxapponidle} -%% \helpref{wxIdleEvent}{wxidleevent} -%% %% \membersection{wxWindow::OnInitDialog}\label{wxwindowoninitdialog} %% %% \func{void}{OnInitDialog}{\param{wxInitDialogEvent\&}{ event}} @@ -1645,14 +1572,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 +1668,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 +1676,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 @@ -1763,7 +1690,10 @@ Releases mouse input captured with \helpref{wxWindow::CaptureMouse}{wxwindowcapt \wxheading{See also} -\helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse} +\helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse}, +\helpref{wxWindow::HasCapture}{wxwindowhascapture}, +\helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse}, +\helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent} \membersection{wxWindow::RemoveChild}\label{wxwindowremovechild} @@ -1911,14 +1841,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} @@ -1938,7 +1868,7 @@ Sets the background colour of the window. \wxheading{Remarks} The background colour is usually painted by the default\rtfsp -\helpref{wxWindow::OnEraseBackground}{wxwindowonerasebackground} event handler function +\helpref{wxEraseEvent}{wxeraseevent} event handler function under Windows and automatically under GTK. Note that setting the background colour does not cause an immediate refresh, so you @@ -1956,7 +1886,7 @@ look as the user wishes with run-time loadable modules. \helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour},\rtfsp \helpref{wxWindow::Clear}{wxwindowclear},\rtfsp \helpref{wxWindow::Refresh}{wxwindowrefresh},\rtfsp -\helpref{wxWindow::OnEraseBackground}{wxwindowonerasebackground} +\helpref{wxEraseEvent}{wxeraseevent} \membersection{wxWindow::SetCaret}\label{wxwindowsetcaret} @@ -1991,6 +1921,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}} @@ -2091,7 +2029,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 @@ -2101,7 +2039,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)} @@ -2207,7 +2145,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. @@ -2221,7 +2159,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} @@ -2246,7 +2184,7 @@ When defining your own scrollbar behaviour, you will always need to recalculate the scrollbar settings when the window size changes. You could therefore put your scrollbar calculations and SetScrollbar call into a function named AdjustScrollbars, which can be called initially and also -from your \helpref{wxWindow::OnSize}{wxwindowonsize} event handler function. +from your \helpref{wxSizeEvent}{wxsizeevent} handler function. \wxheading{See also} @@ -2256,7 +2194,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. @@ -2266,7 +2204,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} @@ -2294,7 +2232,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. @@ -2304,7 +2242,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} @@ -2321,7 +2259,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. @@ -2331,7 +2269,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} @@ -2450,17 +2388,20 @@ The resizing increments are only significant under Motif or Xt. \membersection{wxWindow::SetSizer}\label{wxwindowsetsizer} -\func{void}{SetSizer}{\param{wxSizer* }{sizer}} +\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. +window, it will be deleted if the deleteOld parameter is TRUE. \wxheading{Parameters} -\docparam{sizer}{The sizer to set. Pass NULL to disassociate and delete the window's -sizer.} +\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.} \wxheading{Remarks} @@ -2532,15 +2473,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} @@ -2550,7 +2496,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} @@ -2558,7 +2504,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. @@ -2579,7 +2525,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} @@ -2597,7 +2543,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}