X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/566d84a7c3c06956562b9f8ac364aa3bad760c10..fa10c70ceb3a08a11302c00c9f0e29941174a21b:/docs/latex/wx/window.tex diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index 4294d874f6..4ae3e95a97 100644 --- a/docs/latex/wx/window.tex +++ b/docs/latex/wx/window.tex @@ -3,13 +3,13 @@ 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} @@ -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.} -\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} @@ -229,7 +229,7 @@ cause an erase background event to be generated. \constfunc{virtual void}{ClientToScreen}{\param{int* }{x}, \param{int* }{y}} -\perlnote{In wxPerl this method returns a 2-element list intead of +\perlnote{In wxPerl this method returns a 2-element list instead of modifying its parameters.} \constfunc{virtual wxPoint}{ClientToScreen}{\param{const wxPoint\&}{ pt}} @@ -254,34 +254,37 @@ implements the following methods:\par \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} @@ -348,7 +351,7 @@ Converts a point or size from pixels to dialog units. For the x dimension, the pixels are multiplied by 4 and then divided by the average character width. -For the y dimension, the pixels are multipled by 8 and then divided by the average +For the y dimension, the pixels are multiplied by 8 and then divided by the average character height. \wxheading{Remarks} @@ -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 -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-existant +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} @@ -395,17 +398,22 @@ Destroys all children of a window. Called automatically by the destructor. \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 +already disabled before the call to this function. \membersection{wxWindow::DragAcceptFiles}\label{wxwindowdragacceptfiles} \func{virtual void}{DragAcceptFiles}{\param{bool}{ accept}} -Enables or disables elibility for drop file events (OnDropFiles). +Enables or disables eligibility for drop file events (OnDropFiles). \wxheading{Parameters} -\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} @@ -414,13 +422,20 @@ Windows only. \membersection{wxWindow::Enable}\label{wxwindowenable} -\func{virtual void}{Enable}{\param{bool}{ enable = {\tt TRUE}}} +\func{virtual bool}{Enable}{\param{bool}{ enable = {\tt true}}} -Enable or disable the window for user input. +Enable or disable the window for user input. Note that when a parent window is +disabled, all of its children are disabled as well and they are reenabled again +when the parent is. \wxheading{Parameters} -\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 +nothing was done, i.e. if the window had already been in the specified state. \wxheading{See also} @@ -459,6 +474,49 @@ implements the following methods:\par \end{twocollist}} } +\membersection{wxWindow::FindWindowById}\label{wxwindowfindwindowbyid} + +\func{static wxWindow*}{FindWindowById}{\param{long}{ id}, \param{wxWindow*}{ parent = NULL}} + +Find the first window with the given {\it id}. + +If {\it parent} is NULL, the search will start from all top-level +frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy. +The search is recursive in both cases. + +\wxheading{See also} + +\helpref{FindWindow}{wxwindowfindwindow} + +\membersection{wxWindow::FindWindowByName}\label{wxwindowfindwindowbyname} + +\func{static wxWindow*}{FindWindowByName}{\param{const wxString\&}{ name}, \param{wxWindow*}{ parent = NULL}} + +Find a window by its name (as given in a window constructor or {\bf Create} function call). +If {\it parent} is NULL, the search will start from all top-level +frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy. +The search is recursive in both cases. + +If no window with such name is found, +\helpref{FindWindowByLabel}{wxwindowfindwindowbylabel} is called. + +\wxheading{See also} + +\helpref{FindWindow}{wxwindowfindwindow} + +\membersection{wxWindow::FindWindowByLabel}\label{wxwindowfindwindowbylabel} + +\func{static wxWindow*}{FindWindowByLabel}{\param{const wxString\&}{ label}, \param{wxWindow*}{ parent = NULL}} + +Find a window by its label. Depending on the type of window, the label may be a window title +or panel item label. If {\it parent} is NULL, the search will start from all top-level +frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy. +The search is recursive in both cases. + +\wxheading{See also} + +\helpref{FindWindow}{wxwindowfindwindow} + \membersection{wxWindow::Fit}\label{wxwindowfit} \func{virtual void}{Fit}{\void} @@ -466,6 +524,16 @@ implements the following methods:\par 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} @@ -480,6 +548,24 @@ 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. +\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} @@ -660,6 +746,8 @@ handle, such as {\bf HWND} for Windows, {\bf Widget} for Motif or {\bf GtkWidget \pythonnote{This method will return an integer in wxPython.} +\perlnote{This method will return an integer in wxPerl.} + \membersection{wxWindow::GetHelpText}\label{wxwindowgethelptext} \constfunc{virtual wxString}{GetHelpText}{\void} @@ -731,8 +819,9 @@ Returns the parent of the window, or NULL if there is no parent. \constfunc{wxPoint}{GetPosition}{\void} -This gets the position of the window in pixels, relative to the parent window or -if no parent, relative to the whole display. +This gets the position of the window in pixels, relative to the parent window +for the child windows or relative to the display origin for the top level +windows. \wxheading{Parameters} @@ -841,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}, - \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. @@ -860,7 +949,7 @@ 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 @@ -886,6 +975,12 @@ Gets the window's title. Applicable only to frames and dialogs. \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} @@ -932,7 +1027,7 @@ method. {\bf GetWindowStyle()} is another name for the same function. \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} @@ -944,7 +1039,7 @@ Returns TRUE if this window has the current mouse capture. \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} @@ -957,13 +1052,13 @@ to the dialog via validators. \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} -\membersection{wxWindow:IsExposed}\label{wxwindowisexposed} +\membersection{wxWindow::IsExposed}\label{wxwindowisexposed} \constfunc{bool}{IsExposed}{\param{int }{x}, \param{int }{y}} @@ -973,7 +1068,7 @@ Returns {\tt TRUE} if the window is enabled for input, {\tt FALSE} otherwise. \constfunc{bool}{IsExposed}{\param{wxRect }{\&rect}} -Returns {\tt TRUE} if the given point or rectange area has been exposed since the +Returns {\tt true} if the given point or rectangle area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed. @@ -989,7 +1084,7 @@ implements the following methods:\par \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} @@ -999,13 +1094,13 @@ Retained windows are only available on X platforms. \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). @@ -1016,28 +1111,16 @@ 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. - -\membersection{wxWindow::LoadFromResource}\label{wxwindowloadfromresource} +See \helpref{wxWindow::SetAutoLayout}{wxwindowsetautolayout}: when auto +layout is on, this function gets called automatically when the window is resized. -\func{virtual bool}{LoadFromResource}{\param{wxWindow* }{parent},\rtfsp -\param{const wxString\& }{resourceName}, \param{const wxResourceTable* }{resourceTable = NULL}} +\membersection{wxWindow::LineDown}\label{wxwindowlinedown} -Loads a panel or dialog from a resource file. +This is just a wrapper for \helpref{ScrollLines()}{wxwindowscrolllines}$(1)$. -\wxheading{Parameters} +\membersection{wxWindow::LineUp}\label{wxwindowlineup} -\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} @@ -1056,8 +1139,8 @@ is not implemented anywhere). \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} @@ -1113,8 +1196,8 @@ implements the following methods:\par %% %% \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} %% @@ -1224,12 +1307,12 @@ implements the following methods:\par %% or dialog box using the window manager (X) or system menu (Windows). %% %% {\bf Note:} This is an obsolete function. -%% It is superceded by the \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} event +%% It is superseded by the \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} event %% handler. %% %% \wxheading{Return value} %% -%% 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. %% @@ -1589,16 +1672,24 @@ implements the following methods:\par %% \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} @@ -1687,7 +1778,7 @@ or frame). \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 @@ -1695,12 +1786,25 @@ window. \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} @@ -1725,7 +1829,7 @@ functions so should not be required by the application programmer. \docparam{child}{Child window to remove.} -\membersection{wxWindow::RemoveEventHandler}{wxwindowremoveeventhandler} +\membersection{wxWindow::RemoveEventHandler}\label{wxwindowremoveeventhandler} \func{bool}{RemoveEventHandler}{\param{wxEvtHandler *}{handler}} @@ -1739,7 +1843,7 @@ 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 +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). @@ -1793,7 +1897,7 @@ positive) or up. \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} @@ -1815,7 +1919,7 @@ positive) or up. \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} @@ -1855,19 +1959,29 @@ 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}. +\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}} Determines whether the \helpref{wxWindow::Layout}{wxwindowlayout} function will -be called automatically when the window is resized. Use in connection with -\helpref{wxWindow::SetSizer}{wxwindowsetsizer} and -\helpref{wxWindow::SetConstraints}{wxwindowsetconstraints} for laying out -subwindows. +be called automatically when the window is resized. It is called implicitly by +\helpref{wxWindow::SetSizer}{wxwindowsetsizer} but if you use +\helpref{wxWindow::SetConstraints}{wxwindowsetconstraints} you should call it +manually or otherwise the window layout won't be correctly updated when its +size changes. \wxheading{Parameters} -\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} @@ -2045,7 +2159,7 @@ bits are: and Validate() methods will recursively descend into all children of the window if it has this style flag set.} \twocolitem{\windowstyle{wxWS\_EX\_BLOCK\_EVENTS}}{Normally, the command -events are propagared upwards to the window parent recursively until a handler +events are propagated upwards to the window parent recursively until a handler for them is found. Using this style allows to prevent them from being propagated beyond this window. Notice that wxDialog has this style on by default for the reasons explained in the @@ -2053,13 +2167,13 @@ default for the reasons explained in the \twocolitem{\windowstyle{wxWS\_EX\_TRANSIENT}}{This can be used to prevent a window from being used as an implicit parent for the dialogs which were created without a parent. It is useful for the windows which can disappear at -any moment as creating childs of such windows results in fatal problems.} +any moment as creating children of such windows results in fatal problems.} \twocolitem{\windowstyle{wxFRAME\_EX\_CONTEXTHELP}}{Under Windows, puts a query button on the caption. When pressed, Windows will go into a context-sensitive help mode and wxWindows will send a wxEVT\_HELP event if the user clicked on an application window. This style cannot be used together with wxMAXIMIZE\_BOX or wxMINIMIZE\_BOX, so you should use the style of -{\tt wxDEFAULT\_FRAME\_STYLE & ~(wxMINIMIZE\_BOX | wxMAXIMIZE\_BOX)} for the +{\tt wxDEFAULT\_FRAME\_STYLE \& \textasciitilde(wxMINIMIZE\_BOX | wxMAXIMIZE\_BOX)} for the frames having this style (the dialogs don't have minimize nor maximize box by default)} \end{twocollist} @@ -2070,6 +2184,19 @@ default)} This sets the window to receive keyboard input. +\wxheading{See also} + +\helpref{wxFocusEvent}{wxfocusevent} + +\membersection{wxWindow::SetFocusFromKbd}\label{wxwindowsetfocusfromkbd} + +\func{virtual void}{SetFocusFromKbd}{\void} + +This function is called by wxWindows keyboard navigation code when the user +gives the focus to this window from keyboard (e.g. using {\tt TAB} key). +By default this method simply calls \helpref{SetFocus}{wxwindowsetfocus} but +can be overridden to do something in addition to this in the derived classes. + \membersection{wxWindow::SetFont}\label{wxwindowsetfont} \func{void}{SetFont}{\param{const wxFont\& }{font}} @@ -2101,7 +2228,7 @@ to the window class; it may be the text colour or other colour, or it may not be used at all. Note that when using this functions under GTK, you will disable the so called "themes", -i.e. the user chosen apperance of windows and controls, including the themes of +i.e. the user chosen appearance of windows and controls, including the themes of their parent windows. \wxheading{See also} @@ -2164,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 -\param{bool }{refresh = {\tt TRUE}}} +\param{bool }{refresh = {\tt true}}} Sets the scrollbar properties of a built-in scrollbar. @@ -2178,7 +2305,7 @@ 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} @@ -2213,7 +2340,7 @@ from your \helpref{wxSizeEvent}{wxsizeevent} handler function. \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. @@ -2223,7 +2350,7 @@ 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} @@ -2251,7 +2378,7 @@ handling of pages and ranges. \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. @@ -2261,7 +2388,7 @@ 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} @@ -2278,7 +2405,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 = {\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. @@ -2288,7 +2415,7 @@ 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} @@ -2407,20 +2534,24 @@ The resizing increments are only significant under Motif or Xt. \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. \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} @@ -2434,7 +2565,7 @@ only the sizer will have effect. \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. @@ -2453,12 +2584,19 @@ Sets the window's title. Applicable only to frames and dialogs. \helpref{wxWindow::GetTitle}{wxwindowgettitle} -\membersection{wxWindow::SetValidator}\label{wxwindowsetvalidator} +\membersection{wxWindow::SetThemeEnabled}\label{wxwindowsetthemeenabled} -\func{virtual void}{SetValidator}{\param{const wxValidator\&}{ validator}} +\func{virtual void}{SetThemeEnabled}{\param{bool }{enable}} -Deletes the current validator (if any) and sets the window validator, having called wxValidator::Clone to -create a new validator of this type. +This function tells a window if it should use the system's "theme" code +to draw the windows' background instead if its own background drawing +code. This does not always have any effect since the underlying platform +obviously needs to support the notion of themes in user defined windows. +One such platform is GTK+ where windows can have (very colourful) backgrounds +defined by a user's selected theme. + +Dialogs, notebook pages and the status bar have this flag set to true +by default so that the default look and feel is simulated best. \membersection{wxWindow::SetToolTip}\label{wxwindowsettooltip} @@ -2469,15 +2607,14 @@ create a new validator of this type. Attach a tooltip to the window. See also: \helpref{GetToolTip}{wxwindowgettooltip}, - \helpref{wxToolTip}{wxtooltip} - - -\membersection{wxWindow::GetToolTip}\label{wxwindowgettooltip} + \helpref{wxToolTip}{wxtooltip} -\constfunc{wxToolTip*}{GetToolTip}{\void} +\membersection{wxWindow::SetValidator}\label{wxwindowsetvalidator} -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} @@ -2487,7 +2624,6 @@ Get the associated tooltip or NULL if none. 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}} @@ -2533,7 +2669,7 @@ See \helpref{Window styles}{windowstyles} for more information about flags. \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 @@ -2541,11 +2677,11 @@ needed if Show() is called immediately after the frame creation. \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} @@ -2564,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 -{\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. @@ -2585,13 +2721,24 @@ the method will also call TransferDataToWindow() 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} @@ -2603,7 +2750,7 @@ the method will also call Validate() of all child windows. \wxheading{Return value} -Returns {\tt FALSE} if any of the validations failed. +Returns {\tt false} if any of the validations failed. \wxheading{See also} @@ -2617,6 +2764,9 @@ Returns {\tt FALSE} if any of the validations failed. 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.}