X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6b73af793f5236c8ad47b8df55166811f4fb042f..852b6c3ce7baa055da25f5254f6ee2eee0cd79b7:/docs/latex/wx/window.tex diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index 8f06ba3033..4c15ed1719 100644 --- a/docs/latex/wx/window.tex +++ b/docs/latex/wx/window.tex @@ -1,3 +1,14 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Name: window.tex +%% Purpose: wxWindow documentation +%% Author: wxWidgets Team +%% Modified by: +%% Created: +%% RCS-ID: $Id$ +%% Copyright: (c) wxWidgets Team +%% License: wxWindows license +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + \section{\class{wxWindow}}\label{wxwindow} wxWindow is the base class for all windows and represents any visible object on @@ -9,9 +20,9 @@ the destructor before the window itself is deleted which means that you don't have to worry about deleting them manually. Please see the \helpref{window deletion overview}{windowdeletionoverview} for more information. -Also note that in this, and many others, wxWidgets classes some -\texttt{GetXXX()} methods may be overloaded (as, for example, -\helpref{GetSize}{wxwindowgetsize} or +Also note that in this, and many others, wxWidgets classes some +\texttt{GetXXX()} methods may be overloaded (as, for example, +\helpref{GetSize}{wxwindowgetsize} or \helpref{GetClientSize}{wxwindowgetclientsize}). In this case, the overloads are non-virtual because having multiple virtual functions with the same name results in a virtual function name hiding at the derived class level (in @@ -55,10 +66,9 @@ use this style in order to get the arrows or etc., but would still like to have normal keyboard navigation take place, you should create and send a wxNavigationKeyEvent in response to the key events for Tab and Shift-Tab.} -\twocolitem{\windowstyle{wxNO\_FULL\_REPAINT\_ON\_RESIZE}}{Disables repainting -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{wxNO\_FULL\_REPAINT\_ON\_RESIZE}}{On Windows, this style used to disable repainting +the window completely when its size is changed. Since this behaviour is now the default, the style is now obsolete +and no longer has an effect.} \twocolitem{\windowstyle{wxVSCROLL}}{Use this style to enable a vertical scrollbar.} \twocolitem{\windowstyle{wxHSCROLL}}{Use this style to enable a horizontal scrollbar.} \twocolitem{\windowstyle{wxALWAYS\_SHOW\_SB}}{If a window has scrollbars, @@ -72,7 +82,9 @@ repainted, then children being painted over them. Windows only.} a complete redraw of the window whenever it is resized instead of redrawing just the part of the window affected by resizing. Note that this was the behaviour by default before 2.5.1 release and that if you experience redraw -problems with the code which previously used to work you may want to try this.} +problems with code which previously used to work you may want to try this. +Currently this style applies on GTK+ 2 and Windows only, and full repainting is always +done on other platforms.} \end{twocollist} See also \helpref{window styles overview}{windowstyles}. @@ -126,13 +138,13 @@ Constructs a window, which can be a child of a frame, dialog or any other non-co \docparam{parent}{Pointer to a parent window.} -\docparam{id}{Window identifier. If -1, will automatically create an identifier.} +\docparam{id}{Window identifier. If wxID\_ANY, will automatically create an identifier.} -\docparam{pos}{Window position. wxDefaultPosition is (-1, -1) which indicates that wxWidgets +\docparam{pos}{Window position. wxDefaultPosition indicates that wxWidgets should generate a default position for the window. If using the wxWindow class directly, supply an actual position.} -\docparam{size}{Window size. wxDefaultSize is (-1, -1) which indicates that wxWidgets +\docparam{size}{Window size. wxDefaultSize indicates that wxWidgets should generate a default size for the window. If no suitable size can be found, the window will be sized to 20x20 pixels so that the window is visible but obviously not correctly sized. } @@ -343,7 +355,7 @@ 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 +using \helpref{wxCloseEvent::CanVeto}{wxcloseeventcanveto}, in which case it should destroy the window using \helpref{wxWindow::Destroy}{wxwindowdestroy}. {\it Note} that calling Close does not guarantee that the window will be @@ -353,7 +365,7 @@ 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. -To guarantee that the window will be destroyed, call +To guarantee that the window will be destroyed, call \helpref{wxWindow::Destroy}{wxwindowdestroy} instead \wxheading{See also} @@ -491,7 +503,7 @@ same size as it would have after a call to \helpref{Fit()}{wxwindowfit}. \func{virtual void}{DoUpdateWindowUI}{\param{wxUpdateUIEvent\&}{ event}} Does the window-specific updating after processing the update event. -This function is called by \helpref{wxWindow::UpdateWindowUI}{wxwindowupdatewindowui} +This function is called by \helpref{wxWindow::UpdateWindowUI}{wxwindowupdatewindowui} in order to check return values in the \helpref{wxUpdateUIEvent}{wxupdateuievent} and act appropriately. For example, to allow frame and dialog title updating, wxWidgets implements this function as follows: @@ -502,7 +514,7 @@ void wxTopLevelWindowBase::DoUpdateWindowUI(wxUpdateUIEvent& event) { if ( event.GetSetEnabled() ) Enable(event.GetEnabled()); - + if ( event.GetSetText() ) { if ( event.GetText() != GetTitle() ) @@ -549,7 +561,8 @@ nothing was done, i.e. if the window had already been in the specified state. \wxheading{See also} \helpref{wxWindow::IsEnabled}{wxwindowisenabled},\rtfsp -\helpref{wxWindow::Disable}{wxwindowdisable} +\helpref{wxWindow::Disable}{wxwindowdisable},\rtfsp +\helpref{wxRadioBox::Enable}{wxradioboxenable} \membersection{wxWindow::FindFocus}\label{wxwindowfindfocus} @@ -602,32 +615,32 @@ The search is recursive in both cases. \helpref{FindWindow}{wxwindowfindwindow} -\membersection{wxWindow::FindWindowByName}\label{wxwindowfindwindowbyname} +\membersection{wxWindow::FindWindowByLabel}\label{wxwindowfindwindowbylabel} -\func{static wxWindow*}{FindWindowByName}{\param{const wxString\&}{ name}, \param{wxWindow*}{ parent = NULL}} +\func{static wxWindow*}{FindWindowByLabel}{\param{const wxString\&}{ label}, \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 +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. -If no window with such name is found, -\helpref{FindWindowByLabel}{wxwindowfindwindowbylabel} is called. - \wxheading{See also} \helpref{FindWindow}{wxwindowfindwindow} -\membersection{wxWindow::FindWindowByLabel}\label{wxwindowfindwindowbylabel} +\membersection{wxWindow::FindWindowByName}\label{wxwindowfindwindowbyname} -\func{static wxWindow*}{FindWindowByLabel}{\param{const wxString\&}{ label}, \param{wxWindow*}{ parent = NULL}} +\func{static wxWindow*}{FindWindowByName}{\param{const wxString\&}{ name}, \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 +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} @@ -676,6 +689,10 @@ a wxTextCtrl under wxGTK) but is not implemented on all platforms nor for all controls so it is mostly just a hint to wxWidgets and not a mandatory directive. +\wxheading{See also} + +\helpref{wxWindowUpdateLocker}{wxwindowupdatelocker} + \membersection{wxWindow::GetAcceleratorTable}\label{wxwindowgetacceleratortable} @@ -759,13 +776,6 @@ same as the size the window would have had after calling \helpref{Fit}{wxwindowfit}. -\membersection{wxWindow::GetCaret}\label{wxwindowgetcaret} - -\constfunc{wxCaret *}{GetCaret}{\void} - -Returns the \helpref{caret}{wxcaret} associated with the window. - - \membersection{wxWindow::GetCapture}\label{wxwindowgetcapture} \func{static wxWindow *}{GetCapture}{\void} @@ -774,12 +784,19 @@ Returns the currently captured window. \wxheading{See also} -\helpref{wxWindow::HasCapture}{wxwindowhascapture}, -\helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse}, -\helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse}, +\helpref{wxWindow::HasCapture}{wxwindowhascapture}, +\helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse}, +\helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse}, \helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent} +\membersection{wxWindow::GetCaret}\label{wxwindowgetcaret} + +\constfunc{wxCaret *}{GetCaret}{\void} + +Returns the \helpref{caret}{wxcaret} associated with the window. + + \membersection{wxWindow::GetCharHeight}\label{wxwindowgetcharheight} \constfunc{virtual int}{GetCharHeight}{\void} @@ -796,9 +813,13 @@ Returns the average character width for this window. \membersection{wxWindow::GetChildren}\label{wxwindowgetchildren} -\func{wxList\&}{GetChildren}{\void} +\func{wxWindowList\&}{GetChildren}{\void} + +\constfunc{const wxWindowList\&}{GetChildren}{\void} -Returns a reference to the list of the window's children. +Returns a reference to the list of the window's children. \texttt{wxWindowList} +is a type-safe \helpref{wxList}{wxlist}-like class whose elements are of type +\texttt{wxWindow *}. \membersection{wxWindow::GetClassDefaultAttributes}\label{wxwindowgetclassdefaultattributes} @@ -813,7 +834,7 @@ system, especially if it uses themes. The \arg{variant} parameter is only relevant under Mac currently and is ignore under other platforms. Under Mac, it will change the size of the -returned font. See \helpref{wxWindow::SetWindowVariant}{wxwindowsetwindowvariant} +returned font. See \helpref{wxWindow::SetWindowVariant}{wxwindowsetwindowvariant} for more about this. This static method is ``overridden'' in many derived classes and so calling, @@ -821,7 +842,7 @@ for example, \helpref{wxButton}{wxbutton}::GetClassDefaultAttributes() will typi return the values appropriate for a button which will be normally different from those returned by, say, \helpref{wxListCtrl}{wxlistctrl}::GetClassDefaultAttributes(). -The \texttt{wxVisualAttributes} structure has at least the fields +The \texttt{wxVisualAttributes} structure has at least the fields \texttt{font}, \texttt{colFg} and \texttt{colBg}. All of them may be invalid if it was not possible to determine the default control appearance or, especially for the background colour, if the field doesn't make sense as is @@ -896,7 +917,7 @@ Return the cursor associated with this window. \constfunc{virtual wxVisualAttributes}{GetDefaultAttributes}{\void} -Currently this is the same as calling +Currently this is the same as calling \helpref{GetClassDefaultAttributes}{wxwindowgetclassdefaultattributes}(\helpref{GetWindowVariant}{wxwindowgetwindowvariant}()). One advantage of using this function compared to the static version is that @@ -988,7 +1009,7 @@ Returns the grandparent of a window, or NULL if there isn't one. \constfunc{void*}{GetHandle}{\void} Returns the platform-specific handle of the physical window. Cast it to an appropriate -handle, such as {\bf HWND} for Windows, {\bf Widget} for Motif or {\bf GtkWidget} for GTK. +handle, such as {\bf HWND} for Windows, {\bf Widget} for Motif, {\bf GtkWidget} for GTK or {\bf WinHandle} for PalmOS. \pythonnote{This method will return an integer in wxPython.} @@ -1018,7 +1039,7 @@ Returns the identifier of the window. \wxheading{Remarks} Each window has an integer identifier. If the application has not provided one -(or the default Id -1) an unique identifier with a negative value will be generated. +(or the default wxID\_ANY) an unique identifier with a negative value will be generated. \wxheading{See also} @@ -1090,9 +1111,9 @@ windows. \wxheading{Parameters} -\docparam{x}{Receives the x position of the window.} +\docparam{x}{Receives the x position of the window if non-\NULL.} -\docparam{y}{Receives the y position of the window.} +\docparam{y}{Receives the y position of the window if non-\NULL.} \pythonnote{In place of a single overloaded method name, wxPython implements the following methods:\par @@ -1112,12 +1133,53 @@ method:\par }} +\wxheading{See also} + +\helpref{GetScreenPosition}{wxwindowgetscreenposition} + + \membersection{wxWindow::GetRect}\label{wxwindowgetrect} \constfunc{virtual wxRect}{GetRect}{\void} Returns the size and position of the window as a \helpref{wxRect}{wxrect} object. +\wxheading{See also} + +\helpref{GetScreenRect}{wxwindowgetscreenrect} + + +\membersection{wxWindow::GetScreenPosition}\label{wxwindowgetscreenposition} + +\constfunc{virtual void}{GetScreenPosition}{\param{int* }{x}, \param{int* }{y}} + +\constfunc{wxPoint}{GetScreenPosition}{\void} + +Returns the window position in screen coordinates, whether the window is a +child window or a top level one. + +\wxheading{Parameters} + +\docparam{x}{Receives the x position of the window on the screen if non-\NULL.} + +\docparam{y}{Receives the y position of the window on the screen if non-\NULL.} + +\wxheading{See also} + +\helpref{GetPosition}{wxwindowgetposition} + + +\membersection{wxWindow::GetScreenRect}\label{wxwindowgetscreenrect} + +\constfunc{virtual wxRect}{GetScreenRect}{\void} + +Returns the size and position of the window on the screen as a +\helpref{wxRect}{wxrect} object. + +\wxheading{See also} + +\helpref{GetRect}{wxwindowgetrect} + \membersection{wxWindow::GetScrollPos}\label{wxwindowgetscrollpos} @@ -1237,17 +1299,6 @@ implements the following methods:\par {\tt ( x, y, descent, externalLeading )}.} -\membersection{wxWindow::GetTitle}\label{wxwindowgettitle} - -\func{virtual wxString}{GetTitle}{\void} - -Gets the window's title. Applicable only to frames and dialogs. - -\wxheading{See also} - -\helpref{wxWindow::SetTitle}{wxwindowsettitle} - - \membersection{wxWindow::GetToolTip}\label{wxwindowgettooltip} \constfunc{wxToolTip*}{GetToolTip}{\void} @@ -1281,7 +1332,10 @@ Returns a pointer to the current validator for the window, or NULL if there is n \constfunc{wxSize}{GetVirtualSize}{\void} -This gets the virtual size of the window in pixels. +This gets the virtual size of the window in pixels. By default it +returns the client size of the window, but after a call to +\helpref{SetVirtualSize}{wxwindowsetvirtualsize} it will return +that size. \wxheading{Parameters} @@ -1305,7 +1359,7 @@ method. {\bf GetWindowStyle()} is another name for the same function. \constfunc{wxWindowVariant}{GetWindowVariant}{\void} -Returns the value previous passed to +Returns the value previously passed to \helpref{wxWindow::SetWindowVariant}{wxwindowsetwindowvariant}. @@ -1317,11 +1371,18 @@ Returns {\tt true} if this window has the current mouse capture. \wxheading{See also} -\helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse}, -\helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse}, +\helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse}, +\helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse}, \helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent} +\membersection{wxWindow::HasFlag}\label{wxwindowhasflag} + +\constfunc{bool}{HasFlag}{\param{int }{flag}} + +Returns \texttt{true} if the window has the given \arg{flag} bit set. + + \membersection{wxWindow::HasScrollbar}\label{wxwindowhasscrollbar} \constfunc{virtual bool}{HasScrollbar}{\param{int }{orient}} @@ -1362,12 +1423,12 @@ the font and the foreground and background colours. By ``intelligently'' the following is meant: by default, all windows use their own \helpref{default}{wxwindowgetclassdefaultattributes} attributes. However -if some of the parents attributes are explicitly (that is, using -\helpref{SetFont}{wxwindowsetfont} and not +if some of the parents attributes are explicitly (that is, using +\helpref{SetFont}{wxwindowsetfont} and not \helpref{SetOwnFont}{wxwindowsetownfont}) changed \emph{and} if the corresponding attribute hadn't been explicitly set for this window itself, then this window takes the same value as used by the parent. In addition, if -the window overrides \helpref{ShouldInheritColours}{wxwindowshouldinheritcolours} +the window overrides \helpref{ShouldInheritColours}{wxwindowshouldinheritcolours} to return \false, the colours will not be changed no matter what and only the font might. @@ -1470,20 +1531,23 @@ layout is on, this function gets called automatically when the window is resized \membersection{wxWindow::LineDown}\label{wxwindowlinedown} -This is just a wrapper for \helpref{ScrollLines()}{wxwindowscrolllines}$(1)$. +This is just a wrapper for \helpref{ScrollLines}{wxwindowscrolllines}$(1)$. \membersection{wxWindow::LineUp}\label{wxwindowlineup} -This is just a wrapper for \helpref{ScrollLines()}{wxwindowscrolllines}$(-1)$. +This is just a wrapper for \helpref{ScrollLines}{wxwindowscrolllines}$(-1)$. \membersection{wxWindow::Lower}\label{wxwindowlower} \func{void}{Lower}{\void} -Lowers the window to the bottom of the window hierarchy if it is a managed window (dialog -or frame). +Lowers the window to the bottom of the window hierarchy (z-order). + +\wxheading{See also} + +\helpref{Raise}{wxwindowraise} \membersection{wxWindow::MakeModal}\label{wxwindowmakemodal} @@ -1522,7 +1586,7 @@ wxWindow::Move function, which is defined in the base wxWindow class as the call: \begin{verbatim} - SetSize(x, y, -1, -1, wxSIZE_USE_EXISTING); + SetSize(x, y, wxDefaultCoord, wxDefaultCoord, wxSIZE_USE_EXISTING); \end{verbatim} \wxheading{See also} @@ -1546,7 +1610,7 @@ Moves this window in the tab navigation order after the specified \arg{win}. This means that when the user presses \texttt{TAB} key on that other window, the focus switches to this window. -Default tab order is the same as creation order, this function and +Default tab order is the same as creation order, this function and \helpref{MoveBeforeInTabOrder()}{wxwindowmovebeforeintaborder} allow to change it after creating all the windows. @@ -1807,28 +1871,6 @@ and not navigate to the next control. %% %% \helpref{wxValidator}{wxvalidator}, \helpref{wxWindow::TransferDataToWindow}{wxwindowtransferdatatowindow} %% -%% \membersection{wxWindow::OnMenuCommand}\label{wxwindowonmenucommand} -%% -%% \func{void}{OnMenuCommand}{\param{wxCommandEvent\& }{event}} -%% -%% Called when a menu command is received from a menu bar. -%% -%% \wxheading{Parameters} -%% -%% \docparam{event}{The menu command event. For more information, see \helpref{wxCommandEvent}{wxcommandevent}.} -%% -%% \wxheading{Remarks} -%% -%% A function with this name doesn't actually exist; you can choose any member function to receive -%% menu command events, using the EVT\_COMMAND macro for individual commands or EVT\_COMMAND\_RANGE for -%% a range of commands. -%% -%% \wxheading{See also} -%% -%% \helpref{wxCommandEvent}{wxcommandevent},\rtfsp -%% \helpref{wxWindow::OnMenuHighlight}{wxwindowonmenuhighlight},\rtfsp -%% \helpref{Event handling overview}{eventhandlingoverview} -%% %% \membersection{wxWindow::OnMenuHighlight}\label{wxwindowonmenuhighlight} %% %% \func{void}{OnMenuHighlight}{\param{wxMenuEvent\& }{event}} @@ -1856,7 +1898,6 @@ and not navigate to the next control. %% \wxheading{See also} %% %% \helpref{wxMenuEvent}{wxmenuevent},\rtfsp -%% \helpref{wxWindow::OnMenuCommand}{wxwindowonmenucommand},\rtfsp %% \helpref{Event handling overview}{eventhandlingoverview} %% %% @@ -2086,7 +2127,7 @@ that should not be disabled by an application defining an OnIdle handler in a derived class. This function may be used to do delayed painting, for example, -and most implementations call \helpref{wxWindow::UpdateWindowUI}{wxwindowupdatewindowui} +and most implementations call \helpref{wxWindow::UpdateWindowUI}{wxwindowupdatewindowui} in order to send update events to the window in idle time. @@ -2201,17 +2242,24 @@ remove the event handler. \func{void}{Raise}{\void} -Raises the window to the top of the window hierarchy if it is a managed window (dialog -or frame). +Raises the window to the top of the window hierarchy (z-order). + +In current version of wxWidgets this works both for managed and child windows. + +\wxheading{See also} + +\helpref{Lower}{wxwindowlower} \membersection{wxWindow::Refresh}\label{wxwindowrefresh} -\func{virtual void}{Refresh}{\param{bool}{ eraseBackground = {\tt true}}, \param{const wxRect* }{rect -= NULL}} +\func{virtual void}{Refresh}{\param{bool}{ eraseBackground = {\tt true}}, \param{const wxRect* }{rect = NULL}} -Causes an event to be generated to repaint the -window. +Causes this window, and all of its children recursively (except under wxGTK1 +where this is not implemented), to be repainted. Note that repainting doesn't +happen immediately but only during the next event loop iteration, if you need +to update the window immediately you should use \helpref{Update}{wxwindowupdate} +instead. \wxheading{Parameters} @@ -2228,12 +2276,14 @@ be treated as damaged.} \membersection{wxWindow::RefreshRect}\label{wxwindowrefreshrect} -\func{void}{RefreshRect}{\param{const wxRect\& }{rect}} +\func{void}{RefreshRect}{\param{const wxRect\& }{rect}, \param{bool }{eraseBackground = \true}} -Redraws the contents of the given rectangle: the area inside it will be +Redraws the contents of the given rectangle: only the area inside it will be repainted. -This is the same as \helpref{Refresh}{wxwindowrefresh} but has a nicer syntax. +This is the same as \helpref{Refresh}{wxwindowrefresh} but has a nicer syntax +as it can be called with a temporary wxRect object as argument like this +\texttt{RefreshRect(wxRect(x, y, w, h))}. \membersection{wxWindow::RegisterHotKey}\label{wxwindowregisterhotkey} @@ -2263,7 +2313,8 @@ hotkey with this modifier/virtualKeyCode combination. \wxheading{Remarks} Use EVT\_HOTKEY(hotkeyId, fnc) in the event table to capture the event. -This function is currently only implemented under MSW. +This function is currently only implemented under Windows. It is used +in the \helpref{Windows CE port}{wxwince} for detecting hardware button presses. \wxheading{See also} @@ -2278,9 +2329,9 @@ Releases mouse input captured with \helpref{wxWindow::CaptureMouse}{wxwindowcapt \wxheading{See also} -\helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse}, -\helpref{wxWindow::HasCapture}{wxwindowhascapture}, -\helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse}, +\helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse}, +\helpref{wxWindow::HasCapture}{wxwindowhascapture}, +\helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse}, \helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent} @@ -2308,7 +2359,7 @@ not delete) it from it. \wxheading{Parameters} -\docparam{handler}{The event handler to remove, must be non {\tt NULL} and +\docparam{handler}{The event handler to remove, must be non-{\tt NULL} and must be present in this windows event handlers chain} \wxheading{Return value} @@ -2398,9 +2449,7 @@ on top/bottom and nothing was done. \wxheading{Remarks} -This function is currently only implemented under MSW and wxTextCtrl under -wxGTK (it also works for wxScrolledWindow derived classes under all -platforms). +This function is currently only implemented under MSW and wxGTK. \wxheading{See also} @@ -2419,14 +2468,14 @@ Physically scrolls the pixels in the window and move child windows accordingly. \docparam{dy}{Amount to scroll vertically.} -\docparam{rect}{Rectangle to invalidate. If this is NULL, the whole window is invalidated. If you -pass a rectangle corresponding to the area of the window exposed by the scroll, your painting handler -can optimize painting by checking for the invalidated region. This parameter is ignored under GTK.} +\docparam{rect}{Rectangle to scroll, if it is \NULL, the whole window is +scrolled (this is always the case under wxGTK which doesn't support this +parameter)} \wxheading{Remarks} -Use this function to optimise your scrolling implementations, to minimise the area that must be -redrawn. Note that it is rarely required to call this function from a user program. +Note that you can often use \helpref{wxScrolledWindow}{wxscrolledwindow} +instead of using this function directly. \membersection{wxWindow::SetAcceleratorTable}\label{wxwindowsetacceleratortable} @@ -2451,7 +2500,12 @@ See also \helpref{wxAccessible}{wxaccessible}. \func{void}{SetAutoLayout}{\param{bool}{ autoLayout}} Determines whether the \helpref{wxWindow::Layout}{wxwindowlayout} function will -be called automatically when the window is resized. It is called implicitly by +be called automatically when the window is resized. Please note that this only +happens for the windows usually used to contain children, namely +\helpref{wxPanel}{wxpanel} and \helpref{wxTopLevelWindow}{wxtoplevelwindow} +(and the classes deriving from them). + +This method 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 @@ -2459,8 +2513,8 @@ size changes. \wxheading{Parameters} -\docparam{autoLayout}{Set this to {\tt true} if you wish the Layout function to be called -from within wxWindow::OnSize functions.} +\docparam{autoLayout}{Set this to \true if you wish the Layout function to be +called automatically when the window is resized.} \wxheading{See also} @@ -2474,7 +2528,7 @@ from within wxWindow::OnSize functions.} Sets the background colour of the window. Please see \helpref{InheritAttributes}{wxwindowinheritattributes} for -explanation of the difference between this method and +explanation of the difference between this method and \helpref{SetOwnBackgroundColour}{wxwindowsetownbackgroundcolour}. \wxheading{Parameters} @@ -2580,36 +2634,6 @@ implements the following methods:\par } -\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}} - -% VZ: the docs are correct, if the code doesn't behave like this, it must be -% changed -Sets the window's cursor. Notice that the window cursor also sets it for the -children of the window implicitly. - -The {\it cursor} may be {\tt wxNullCursor} in which case the window cursor will -be reset back to default. - -\wxheading{Parameters} - -\docparam{cursor}{Specifies the cursor that the window should normally display.} - -\wxheading{See also} - -\helpref{::wxSetCursor}{wxsetcursor}, \helpref{wxCursor}{wxcursor} - - \membersection{wxWindow::SetConstraints}\label{wxwindowsetconstraints} \func{void}{SetConstraints}{\param{wxLayoutConstraints* }{constraints}} @@ -2631,66 +2655,34 @@ the constraints automatically in OnSize; otherwise, you must override OnSize and explicitly. When setting both a wxLayoutConstraints and a \helpref{wxSizer}{wxsizer}, only the sizer will have effect. -\membersection{wxWindow::SetInitialBestSize}\label{wxwindowsetinitialbestsize} - -\func{virtual void}{SetInitialBestSize}{\param{const wxSize\& }{size}} - -Sets the initial window size if none is given (i.e. at least one of the -components of the size passed to ctor/Create() is wxDefaultCoord). - -\membersection{wxWindow::SetMaxSize}\label{wxwindowsetmaxsize} - -\func{void}{SetMaxSize}{\param{const wxSize\& }{size}} - -Sets the maximum size of the window, to indicate to the sizer layout mechanism -that this is the maximum possible size. - -\membersection{wxWindow::SetMinSize}\label{wxwindowsetminsize} - -\func{void}{SetMinSize}{\param{const wxSize\& }{size}} - -Sets the minimum size of the window, to indicate to the sizer layout mechanism -that this is the minimum required size. You may need to call this -if you change the window size after construction and before adding -to its parent sizer. - -\membersection{wxWindow::SetOwnBackgroundColour}\label{wxwindowsetownbackgroundcolour} - -\func{void}{SetOwnBackgroundColour}{\param{const wxColour\& }{colour}} - -Sets the background colour of the window but prevents it from being inherited -by the children of this window. - -\wxheading{See also} - -\helpref{SetBackgroundColour}{wxwindowsetbackgroundcolour},\rtfsp -\helpref{InheritAttributes}{wxwindowinheritattributes} - +\membersection{wxWindow::SetContainingSizer}\label{wxwindowsetcontainingsizer} -\membersection{wxWindow::SetOwnFont}\label{wxwindowsetownfont} +\func{void}{SetContainingSizer}{\param{wxSizer* }{sizer}} -\func{void}{SetOwnBackgroundColour}{\param{const wxColour\& }{colour}} +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. -Sets the font of the window but prevents it from being inherited by the -children of this window. -\wxheading{See also} +\membersection{wxWindow::SetCursor}\label{wxwindowsetcursor} -\helpref{SetFont}{wxwindowsetfont},\rtfsp -\helpref{InheritAttributes}{wxwindowinheritattributes} +\func{virtual void}{SetCursor}{\param{const wxCursor\&}{cursor}} +% VZ: the docs are correct, if the code doesn't behave like this, it must be +% changed +Sets the window's cursor. Notice that the window cursor also sets it for the +children of the window implicitly. -\membersection{wxWindow::SetOwnForegroundColour}\label{wxwindowsetownforegroundcolour} +The {\it cursor} may be {\tt wxNullCursor} in which case the window cursor will +be reset back to default. -\func{void}{SetOwnForegroundColour}{\param{const wxColour\& }{colour}} +\wxheading{Parameters} -Sets the foreground colour of the window but prevents it from being inherited -by the children of this window. +\docparam{cursor}{Specifies the cursor that the window should normally display.} \wxheading{See also} -\helpref{SetForegroundColour}{wxwindowsetforegroundcolour},\rtfsp -\helpref{InheritAttributes}{wxwindowinheritattributes} +\helpref{::wxSetCursor}{wxsetcursor}, \helpref{wxCursor}{wxcursor} \membersection{wxWindow::SetDropTarget}\label{wxwindowsetdroptarget} @@ -2708,6 +2700,13 @@ If the window already has a drop target, it is deleted. +\membersection{wxWindow::SetInitialBestSize}\label{wxwindowsetinitialbestsize} + +\func{virtual void}{SetInitialBestSize}{\param{const wxSize\& }{size}} + +Sets the initial window size if none is given (i.e. at least one of the +components of the size passed to ctor/Create() is wxDefaultCoord). + \membersection{wxWindow::SetEventHandler}\label{wxwindowseteventhandler} \func{void}{SetEventHandler}{\param{wxEvtHandler* }{handler}} @@ -2809,6 +2808,12 @@ use \helpref{SetOwnFont}{wxwindowsetownfont} instead in this case and see \helpref{InheritAttributes}{wxwindowinheritattributes} for more explanations. +Please notice that the given font is \emph{not} automatically used for +\helpref{wxPaintDC}{wxpaintdc} objects associated with this window, you need to +call \helpref{wxDC::SetFont()}{wxdcsetfont} too. However this font is used by +any standard controls for drawing their text as well as by +\helpref{wxWindow::GetTextExtent()}{wxwindowgettextextent}. + \wxheading{Parameters} \docparam{font}{Font to associate with this window, pass @@ -2827,7 +2832,7 @@ explanations. Sets the foreground colour of the window. Please see \helpref{InheritAttributes}{wxwindowinheritattributes} for -explanation of the difference between this method and +explanation of the difference between this method and \helpref{SetOwnForegroundColour}{wxwindowsetownforegroundcolour}. \wxheading{Parameters} @@ -2902,6 +2907,22 @@ Sets the window's label. \helpref{wxWindow::GetLabel}{wxwindowgetlabel} +\membersection{wxWindow::SetMaxSize}\label{wxwindowsetmaxsize} + +\func{void}{SetMaxSize}{\param{const wxSize\& }{size}} + +Sets the maximum size of the window, to indicate to the sizer layout mechanism +that this is the maximum possible size. + +\membersection{wxWindow::SetMinSize}\label{wxwindowsetminsize} + +\func{void}{SetMinSize}{\param{const wxSize\& }{size}} + +Sets the minimum size of the window, to indicate to the sizer layout mechanism +that this is the minimum required size. You may need to call this +if you change the window size after construction and before adding +to its parent sizer. + \membersection{wxWindow::SetName}\label{wxwindowsetname} \func{virtual void}{SetName}{\param{const wxString\& }{name}} @@ -2917,6 +2938,45 @@ Sets the window's name. \helpref{wxWindow::GetName}{wxwindowgetname} +\membersection{wxWindow::SetOwnBackgroundColour}\label{wxwindowsetownbackgroundcolour} + +\func{void}{SetOwnBackgroundColour}{\param{const wxColour\& }{colour}} + +Sets the background colour of the window but prevents it from being inherited +by the children of this window. + +\wxheading{See also} + +\helpref{SetBackgroundColour}{wxwindowsetbackgroundcolour},\rtfsp +\helpref{InheritAttributes}{wxwindowinheritattributes} + + +\membersection{wxWindow::SetOwnFont}\label{wxwindowsetownfont} + +\func{void}{SetOwnFont}{\param{const wxFont\& }{font}} + +Sets the font of the window but prevents it from being inherited by the +children of this window. + +\wxheading{See also} + +\helpref{SetFont}{wxwindowsetfont},\rtfsp +\helpref{InheritAttributes}{wxwindowinheritattributes} + + +\membersection{wxWindow::SetOwnForegroundColour}\label{wxwindowsetownforegroundcolour} + +\func{void}{SetOwnForegroundColour}{\param{const wxColour\& }{colour}} + +Sets the foreground colour of the window but prevents it from being inherited +by the children of this window. + +\wxheading{See also} + +\helpref{SetForegroundColour}{wxwindowsetforegroundcolour},\rtfsp +\helpref{InheritAttributes}{wxwindowinheritattributes} + + \membersection{wxWindow::SetPalette}\label{wxwindowsetpalette} \func{virtual void}{SetPalette}{\param{wxPalette* }{palette}} @@ -2972,7 +3032,8 @@ from your \helpref{wxSizeEvent}{wxsizeevent} handler function. \wxheading{See also} \helpref{Scrolling overview}{scrollingoverview},\rtfsp -\helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow} +\helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow},\rtfsp +\helpref{wxScrollWinEvent}{wxscrollwinevent} \begin{comment} @@ -3010,8 +3071,8 @@ handling of pages and ranges. \wxheading{See also} \helpref{wxWindow::SetScrollPos}{wxwindowsetscrollpos},\rtfsp -\helpref{wxWindow::GetScrollPos}{wxwindowsetscrollpos},\rtfsp -\helpref{wxWindow::GetScrollPage}{wxwindowsetscrollpage},\rtfsp +\helpref{wxWindow::GetScrollPos}{wxwindowgetscrollpos},\rtfsp +\helpref{wxWindow::GetScrollPage}{wxwindowgetscrollpage},\rtfsp \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow} \end{comment} @@ -3038,7 +3099,7 @@ application to take note of scrollbar attributes and redraw contents accordingly \wxheading{See also} \helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar},\rtfsp -\helpref{wxWindow::GetScrollPos}{wxwindowsetscrollpos},\rtfsp +\helpref{wxWindow::GetScrollPos}{wxwindowgetscrollpos},\rtfsp \helpref{wxWindow::GetScrollThumb}{wxwindowgetscrollthumb},\rtfsp \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow} @@ -3071,8 +3132,8 @@ and usually the scrollbar will be automatically hidden. \helpref{wxWindow::SetScrollPos}{wxwindowsetscrollpos},\rtfsp \helpref{wxWindow::SetScrollPage}{wxwindowsetscrollpage},\rtfsp -\helpref{wxWindow::GetScrollPos}{wxwindowsetscrollpos},\rtfsp -\helpref{wxWindow::GetScrollPage}{wxwindowsetscrollpage},\rtfsp +\helpref{wxWindow::GetScrollPos}{wxwindowgetscrollpos},\rtfsp +\helpref{wxWindow::GetScrollPage}{wxwindowgetscrollpage},\rtfsp \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow} \end{comment} @@ -3094,16 +3155,16 @@ Sets the size of the window in pixels. \wxheading{Parameters} -\docparam{x}{Required x position in pixels, or -1 to indicate that the existing +\docparam{x}{Required x position in pixels, or wxDefaultCoord to indicate that the existing value should be used.} -\docparam{y}{Required y position in pixels, or -1 to indicate that the existing +\docparam{y}{Required y position in pixels, or wxDefaultCoord to indicate that the existing value should be used.} -\docparam{width}{Required width in pixels, or -1 to indicate that the existing +\docparam{width}{Required width in pixels, or wxDefaultCoord to indicate that the existing value should be used.} -\docparam{height}{Required height position in pixels, or -1 to indicate that the existing +\docparam{height}{Required height position in pixels, or wxDefaultCoord to indicate that the existing value should be used.} \docparam{size}{\helpref{wxSize}{wxsize} object for setting the size.} @@ -3112,16 +3173,20 @@ value should be used.} \docparam{sizeFlags}{Indicates the interpretation of other parameters. It is a bit list of the following: -{\bf wxSIZE\_AUTO\_WIDTH}: a -1 width value is taken to indicate -a wxWidgets-supplied default width.\\ -{\bf wxSIZE\_AUTO\_HEIGHT}: a -1 height value is taken to indicate +{\bf wxSIZE\_AUTO\_WIDTH}: a $wxDefaultCoord$ width value is taken to indicate a wxWidgets-supplied default width.\\ -{\bf wxSIZE\_AUTO}: -1 size values are taken to indicate +{\bf wxSIZE\_AUTO\_HEIGHT}: a $wxDefaultCoord$ height value is taken to indicate +a wxWidgets-supplied default height.\\ +{\bf wxSIZE\_AUTO}: $wxDefaultCoord$ size values are taken to indicate a wxWidgets-supplied default size.\\ {\bf wxSIZE\_USE\_EXISTING}: existing dimensions should be used -if -1 values are supplied.\\ -{\bf wxSIZE\_ALLOW\_MINUS\_ONE}: allow dimensions of -1 and less to be interpreted +if $wxDefaultCoord$ values are supplied.\\ +{\bf wxSIZE\_ALLOW\_MINUS\_ONE}: allow negative dimensions (ie. value of $wxDefaultCoord$) to be interpreted as real dimensions, not default values. +{\bf wxSIZE\_FORCE}: normally, if the position and the size of the window are +already the same as the parameters of this function, nothing is done. but with +this flag a window resize may be forced even in this case (supported in wx +2.6.2 and later and only implemented for MSW and ignored elsewhere currently) } \wxheading{Remarks} @@ -3130,7 +3195,7 @@ The second form is a convenience for calling the first form with default x and y parameters, and must be used with non-default width and height values. The first form sets the position and optionally size, of the window. -Parameters may be -1 to indicate either that a default should be supplied +Parameters may be $wxDefaultCoord$ to indicate either that a default should be supplied by wxWidgets, or that the current value of the dimension should be used. \wxheading{See also} @@ -3149,7 +3214,7 @@ implements the following methods:\par \membersection{wxWindow::SetSizeHints}\label{wxwindowsetsizehints} -\func{virtual void}{SetSizeHints}{\param{int}{ minW=-1}, \param{int}{ minH=-1}, \param{int}{ maxW=-1}, \param{int}{ maxH=-1}, +\func{virtual void}{SetSizeHints}{\param{int}{ minW}, \param{int}{ minH}, \param{int}{ maxW=-1}, \param{int}{ maxH=-1}, \param{int}{ incW=-1}, \param{int}{ incH=-1}} \func{void}{SetSizeHints}{\param{const wxSize\&}{ minSize}, @@ -3196,7 +3261,7 @@ 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. -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. @@ -3227,21 +3292,6 @@ The same as \helpref{SetSizer}{wxwindowsetsizer}, except it also sets the size h for the window based on the sizer's minimum size. -\membersection{wxWindow::SetTitle}\label{wxwindowsettitle} - -\func{virtual void}{SetTitle}{\param{const wxString\& }{title}} - -Sets the window's title. Applicable only to frames and dialogs. - -\wxheading{Parameters} - -\docparam{title}{The window's title.} - -\wxheading{See also} - -\helpref{wxWindow::GetTitle}{wxwindowgettitle} - - \membersection{wxWindow::SetThemeEnabled}\label{wxwindowsetthemeenabled} \func{virtual void}{SetThemeEnabled}{\param{bool }{enable}} @@ -3290,7 +3340,7 @@ Sets the virtual size of the window in pixels. \func{virtual void}{SetVirtualSizeHints}{\param{int}{ minW},\param{int}{ minH}, \param{int}{ maxW=-1}, \param{int}{ maxH=-1}} -\func{void}{SetVirtualSizeHints}{\param{const wxSize\&}{ minSize=wxDefaultSize}, +\func{void}{SetVirtualSizeHints}{\param{const wxSize\&}{ minSize=wxDefaultSize}, \param{const wxSize\&}{ maxSize=wxDefaultSize}} @@ -3366,11 +3416,11 @@ be used to change this. \func{virtual bool}{ShouldInheritColours}{\void} -Return \true from here to allow the colours of this window to be changed by +Return \true from here to allow the colours of this window to be changed by \helpref{InheritAttributes}{wxwindowinheritattributes}, returning \false forbids inheriting them from the parent window. -The base class version returns \false, but this method is overridden in +The base class version returns \false, but this method is overridden in \helpref{wxControl}{wxcontrol} where it returns \true. @@ -3393,18 +3443,23 @@ done because it already was in the requested state. \wxheading{See also} -\helpref{wxWindow::IsShown}{wxwindowisshown} - +\helpref{wxWindow::IsShown}{wxwindowisshown},\rtfsp +\helpref{wxWindow::Hide}{wxwindowhide},\rtfsp +\helpref{wxRadioBox::Show}{wxradioboxshow} \membersection{wxWindow::Thaw}\label{wxwindowthaw} \func{virtual void}{Thaw}{\void} -Reenables window updating after a previous call to +Reenables window updating after a previous call to \helpref{Freeze}{wxwindowfreeze}. To really thaw the control, it must be called exactly the same number of times as \helpref{Freeze}{wxwindowfreeze}. +\wxheading{See also} + +\helpref{wxWindowUpdateLocker}{wxwindowupdatelocker} + \membersection{wxWindow::TransferDataFromWindow}\label{wxwindowtransferdatafromwindow} @@ -3468,12 +3523,12 @@ This function is currently only implemented under MSW. \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. +Calling this method immediately repaints the invalidated area of the window and +all of its children recursively 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::UpdateWindowUI}\label{wxwindowupdatewindowui} @@ -3486,8 +3541,8 @@ example a wxToolBar will send an update UI event for each toolbar button, and a wxFrame will send an update UI event for each menubar menu item. You can call this function from your application to ensure that your UI is up-to-date at this point (as far as your wxUpdateUIEvent handlers -are concerned). This may be necessary if you have called -\helpref{wxUpdateUIEvent::SetMode}{wxupdateuieventsetmode} or +are concerned). This may be necessary if you have called +\helpref{wxUpdateUIEvent::SetMode}{wxupdateuieventsetmode} or \helpref{wxUpdateUIEvent::SetUpdateInterval}{wxupdateuieventsetupdateinterval} to limit the overhead that wxWidgets incurs by sending update UI events in idle time. @@ -3520,8 +3575,8 @@ void MyWindow::OnInternalIdle() \wxheading{See also} -\helpref{wxUpdateUIEvent}{wxupdateuievent}, -\helpref{wxWindow::DoUpdateWindowUI}{wxwindowdoupdatewindowui}, +\helpref{wxUpdateUIEvent}{wxupdateuievent}, +\helpref{wxWindow::DoUpdateWindowUI}{wxwindowdoupdatewindowui}, \helpref{wxWindow::OnInternalIdle}{wxwindowoninternalidle} @@ -3559,4 +3614,3 @@ Interface Guidelines forbid moving the mouse cursor programmatically. \docparam{x}{The new x position for the cursor.} \docparam{y}{The new y position for the cursor.} -