X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/85b38e0bd12e376b5ecebac69de539dea5232332..32485259c1342115488d219776dfebeb3d4d81b1:/docs/latex/wx/window.tex diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index 236aa313eb..7fdb71cc7f 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}. @@ -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} @@ -611,7 +624,7 @@ 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, +If no window with such name is found, \helpref{FindWindowByLabel}{wxwindowfindwindowbylabel} is called. \wxheading{See also} @@ -774,9 +787,9 @@ 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} @@ -813,7 +826,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 +834,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 +909,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 +1001,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.} @@ -1112,18 +1125,6 @@ method:\par }} -\membersection{wxWindow::GetPureVirtualSize}\label{wxwindowgetpurevirtualsize} - -\constfunc{wxSize}{GetPureVirtualSize}{\void} - -This gets the virtual size of the window in pixels as it has been set -by \helpref{SetVirtualSize}{wxwindowsetvirtualsize}. - -\helpref{GetSize}{wxwindowgetsize},\rtfsp -\helpref{GetClientSize}{wxwindowgetclientsize},\rtfsp -\helpref{GetVirtualSize}{wxwindowgetvirtualsize} - - \membersection{wxWindow::GetRect}\label{wxwindowgetrect} \constfunc{virtual wxRect}{GetRect}{\void} @@ -1293,11 +1294,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 as it has been set -by \helpref{SetVirtualSize}{wxwindowsetvirtualsize} or the size of the -client area, if it is larger. Use -\helpref{GetPureVirtualSize}{wxwindowgetpurevirtualsize} if you want -to get the actual virtual height independent of the client size. +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} @@ -1321,7 +1321,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}. @@ -1333,8 +1333,8 @@ 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} @@ -1378,12 +1378,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. @@ -1486,12 +1486,12 @@ 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} @@ -1562,7 +1562,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. @@ -2102,7 +2102,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. @@ -2223,11 +2223,13 @@ or frame). \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} @@ -2250,7 +2252,7 @@ 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 -as it can be called with a temporary wxRect object as argument like this +as it can be called with a temporary wxRect object as argument like this \texttt{RefreshRect(wxRect(x, y, w, h))}. @@ -2281,7 +2283,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} @@ -2296,9 +2299,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} @@ -2469,8 +2472,8 @@ 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 -\helpref{wxWindow::SetSizer}{wxwindowsetsizer} but if you use +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. @@ -2492,7 +2495,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} @@ -2845,7 +2848,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} @@ -3167,7 +3170,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}, @@ -3214,7 +3217,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. @@ -3308,7 +3311,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}} @@ -3384,11 +3387,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. @@ -3411,15 +3414,16 @@ 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}. @@ -3486,12 +3490,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} @@ -3504,8 +3508,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. @@ -3538,8 +3542,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}