+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% 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 objecto n
+wxWindow is the base class for all windows and represents any visible object on
screen. All controls, top level windows and so on are windows. Sizers and
device contexts are not, however, as they don't appear on screen themselves.
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
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,
disable them instead of hiding them when they are not needed (i.e. when the
size of the window is big enough to not require the scrollbars to navigate it).
-This style is currently only implemented for wxMSW and wxUniversal and does
+This style is currently implemented for wxMSW, wxGTK and wxUniversal and does
nothing on the other platforms.}
\twocolitem{\windowstyle{wxCLIP\_CHILDREN}}{Use this style to eliminate flicker caused by the background being
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}.
\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. }
\docparam{name}{Window name.}
-\membersection{wxWindow::\destruct{wxWindow}}
+\membersection{wxWindow::\destruct{wxWindow}}\label{wxwindowdtor}
\func{}{\destruct{wxWindow}}{\void}
\helpref{wxCloseEvent}{wxcloseevent}
-\membersection{wxWindow::AddChild}
+\membersection{wxWindow::AddChild}\label{wxwindowaddchild}
\func{virtual void}{AddChild}{\param{wxWindow* }{child}}
\docparam{child}{Child window to add.}
+\membersection{wxWindow::CacheBestSize}\label{wxwindowcachebestsize}
+
+\constfunc{void}{CacheBestSize}{\param{const wxSize\& }{size}}
+
+Sets the cached best size value.
+
+
\membersection{wxWindow::CaptureMouse}\label{wxwindowcapturemouse}
\func{virtual void}{CaptureMouse}{\void}
and when the mouse is released the capture returns to the window which had had
captured it previously and it is only really released if there were no previous
window. In particular, this means that you must release the mouse as many times
-as you capture it.
+as you capture it, unless the window receives
+the \helpref{wxMouseCaptureLostEvent}{wxmousecapturelostevent} event.
+
+Any application which captures the mouse in the beginning of some operation
+{\em must} handle \helpref{wxMouseCaptureLostEvent}{wxmousecapturelostevent}
+and cancel this operation when it receives the event. The event handler must
+not recapture mouse.
\wxheading{See also}
\helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse}
+\helpref{wxMouseCaptureLostEvent}{wxmousecapturelostevent}
\membersection{wxWindow::Center}\label{wxwindowcenter}
cause an erase background event to be generated.
-\membersection{wxWindow::ClientToScreen}
+\membersection{wxWindow::ClientToScreen}\label{wxwindowclienttoscreen}
\constfunc{virtual void}{ClientToScreen}{\param{int* }{x}, \param{int* }{y}}
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
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}
\helpref{wxWindow::ConvertDialogToPixels}{wxwindowconvertdialogtopixels}
-\pythonnote{In place of a single overloaded method name, wxPythonimplements the following methods:\par
+\pythonnote{In place of a single overloaded method name, wxPython implements the following methods:\par
\indented{2cm}{\begin{twocollist}
\twocolitem{{\bf ConvertDialogPointToPixels(point)}}{Accepts and returns a wxPoint}
\twocolitem{{\bf ConvertDialogSizeToPixels(size)}}{Accepts and returns a wxSize}
to the list of windows pending real deletion.
-\membersection{wxWindow::DestroyChildren}
+\membersection{wxWindow::DestroyChildren}\label{wxwindowdestroychildren}
\func{virtual void}{DestroyChildren}{\void}
already disabled before the call to this function.
+\membersection{wxWindow::DoGetBestSize}\label{wxwindowdogetbestsize}
+
+\constfunc{virtual wxSize}{DoGetBestSize}{\void}
+
+Gets the size which best suits the window: for a control, it would be
+the minimal size which doesn't truncate the control, for a panel - the
+same size as it would have after a call to \helpref{Fit()}{wxwindowfit}.
+
+
\membersection{wxWindow::DoUpdateWindowUI}\label{wxwindowdoupdatewindowui}
\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:
{
if ( event.GetSetEnabled() )
Enable(event.GetEnabled());
-
+
if ( event.GetSetText() )
{
if ( event.GetText() != GetTitle() )
\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}
\membersection{wxWindow::FindWindow}\label{wxwindowfindwindow}
-\func{wxWindow*}{FindWindow}{\param{long}{ id}}
+\constfunc{wxWindow*}{FindWindow}{\param{long}{ id}}
Find a child of this window, by identifier.
-\func{wxWindow*}{FindWindow}{\param{const wxString\&}{ name}}
+\constfunc{wxWindow*}{FindWindow}{\param{const wxString\&}{ name}}
Find a child of this window, by name.
\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}
nested.
This method is useful for visual appearance optimization (for example, it
-is a good idea to use it before inserting large amount of text into a
-wxTextCtrl under wxGTK) but is not implemented on all platforms nor for all
+is a good idea to use it before doing many large text insertions in a row into
+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}
\membersection{wxWindow::GetAccessible}\label{wxwindowgetaccessible}
-\func{wxAccessibile*}{GetAccessible}{\void}
+\func{wxAccessible*}{GetAccessible}{\void}
Returns the accessible object for this window, if any.
\helpref{wxWindow::SetForegroundColour}{wxwindowsetforegroundcolour},\rtfsp
\helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour}
+\membersection{wxWindow::GetBackgroundStyle}\label{wxwindowgetbackgroundstyle}
+
+\constfunc{virtual wxBackgroundStyle}{GetBackgroundStyle}{\void}
+
+Returns the background style of the window. The background style indicates
+whether background colour should be determined by the system (wxBG\_STYLE\_SYSTEM),
+be set to a specific colour (wxBG\_STYLE\_COLOUR), or should be left to the
+application to implement (wxBG\_STYLE\_CUSTOM).
+
+On GTK+, use of wxBG\_STYLE\_CUSTOM allows the flicker-free drawing of a custom
+background, such as a tiled bitmap. Currently the style has no effect on other platforms.
+
+\wxheading{See also}
+
+\helpref{wxWindow::SetBackgroundColour}{wxwindowsetbackgroundcolour},\rtfsp
+\helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour},\rtfsp
+\helpref{wxWindow::SetBackgroundStyle}{wxwindowsetbackgroundstyle}
+
+\membersection{wxWindow::GetEffectiveMinSize}\label{wxwindowgeteffectiveminsize}
+
+\constfunc{wxSize}{GetEffectiveMinSize}{\void}
+
+Merges the window's best size into the min size and returns the
+result. This is the value used by sizers to determine the appropriate
+ammount of sapce to allocate for the widget.
+
+\wxheading{See also}
+
+\helpref{wxWindow::GetBestSize}{wxwindowgetbestsize},\rtfsp
+\helpref{wxWindow::SetInitialSize}{wxwindowsetinitialsize}
+
\membersection{wxWindow::GetBestSize}\label{wxwindowgetbestsize}
\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}
\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{wxMouseCaptureLostEvent}{wxmousecapturelostevent}
\helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}
-\membersection{wxWindow::GetCharHeight}
+\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}
Returns the character height for this window.
-\membersection{wxWindow::GetCharWidth}
+\membersection{wxWindow::GetCharWidth}\label{wxwindowgetcharwidth}
\constfunc{virtual int}{GetCharWidth}{\void}
Returns the average character width for this window.
-\membersection{wxWindow::GetChildren}
+\membersection{wxWindow::GetChildren}\label{wxwindowgetchildren}
-\func{wxList\&}{GetChildren}{\void}
+\func{wxWindowList\&}{GetChildren}{\void}
-Returns a reference to the list of the window's children.
+\constfunc{const wxWindowList\&}{GetChildren}{\void}
+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{wxControl::GetClassDefaultAttributes}\label{wxwindowgetclassdefaultattributes}
+
+\membersection{wxWindow::GetClassDefaultAttributes}\label{wxwindowgetclassdefaultattributes}
\func{static wxVisualAttributes}{GetClassDefaultAttributes}{\param{wxWindowVariant}{ variant = \texttt{wxWINDOW\_VARIANT\_NORMAL}}}
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,
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
\helpref{wxWindow::SetCursor}{wxwindowsetcursor}
-\membersection{wxControl::GetDefaultAttributes}\label{wxwindowgetdefaultattributes}
+\membersection{wxWindow::GetDefaultAttributes}\label{wxwindowgetdefaultattributes}
\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
\membersection{wxWindow::GetFont}\label{wxwindowgetfont}
-\constfunc{wxFont\&}{GetFont}{\void}
+\constfunc{wxFont}{GetFont}{\void}
-Returns a reference to the font for this window.
+Returns the font for this window.
\wxheading{See also}
\helpref{wxWindow::GetBackgroundColour}{wxwindowgetbackgroundcolour}
-\membersection{wxWindow::GetGrandParent}
+\membersection{wxWindow::GetGrandParent}\label{wxwindowgetgrandparent}
\constfunc{wxWindow*}{GetGrandParent}{\void}
\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.}
\perlnote{This method will return an integer in wxPerl.}
+\membersection{wxWindow::GetHelpTextAtPoint}\label{wxwindowgethelptextatpoint}
+
+\constfunc{virtual wxString}{GetHelpTextAtPoint}{\param{const wxPoint &}{point}, \param{wxHelpEvent::Origin }{origin}}
+
+Gets the help text to be used as context-sensitive help for this window. This
+method should be overridden if the help message depends on the position inside
+the window, otherwise \helpref{GetHelpText}{wxwindowgethelptext} can be used.
+
+\wxheading{Parameters}
+
+\docparam{point}{Coordinates of the mouse at the moment of help event emission.}
+
+\docparam{origin}{Help event origin, see also \helpref{wxHelpEvent::GetOrigin}{wxhelpeventgetorigin}.}
+
+\newsince{2.7.0}
+
+
\membersection{wxWindow::GetHelpText}\label{wxwindowgethelptext}
\constfunc{virtual wxString}{GetHelpText}{\void}
\wxheading{See also}
-\helpref{SetHelpText}{wxwindowsethelptext}, \helpref{wxHelpProvider}{wxhelpprovider}
+\helpref{SetHelpText}{wxwindowsethelptext}, \helpref{GetHelpTextAtPoint}{wxwindowgethelptextatpoint}, \helpref{wxHelpProvider}{wxhelpprovider}
\membersection{wxWindow::GetId}\label{wxwindowgetid}
\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}
\helpref{Window identifiers}{windowids}
-\membersection{wxWindow::GetLabel}
+\membersection{wxWindow::GetLabel}\label{wxwindowgetlabel}
\constfunc{virtual wxString }{GetLabel}{\void}
tools or special-needs access programs) which need to identify windows
by name.
+\membersection{wxWindow::GetMaxSize}\label{wxwindowgetmaxsize}
+
+\constfunc{wxSize}{GetMaxSize}{\void}
+
+Returns the maximum size of the window, an indication to the sizer layout mechanism
+that this is the maximum possible size.
+
+\membersection{wxWindow::GetMinSize}\label{wxwindowgetminsize}
+
+\constfunc{virtual wxSize}{GetMinSize}{\void}
+
+Returns the minimum size of the window, an indication to the sizer layout mechanism
+that this is the minimum required size. It normally just returns the value set
+by \helpref{SetMinSize}{wxwindowsetminsize}, but it can be overridden to do the
+calculation on demand.
\membersection{wxWindow::GetName}\label{wxwindowgetname}
\helpref{wxWindow::SetName}{wxwindowsetname}
-\membersection{wxWindow::GetParent}
+\membersection{wxWindow::GetParent}\label{wxwindowgetparent}
\constfunc{virtual wxWindow*}{GetParent}{\void}
\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
}}
+\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}
-\membersection{wxWindow::GetScrollThumb}\label{wxwindowgetscrollthumb}
+\helpref{GetScreenRect}{wxwindowgetscreenrect}
-\func{virtual int}{GetScrollThumb}{\param{int }{orientation}}
-Returns the built-in scrollbar thumb size.
+\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{wxWindow::SetScrollbar}{wxwindowsetscrollbar}
+\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}
\helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar}
+\membersection{wxWindow::GetScrollThumb}\label{wxwindowgetscrollthumb}
+
+\func{virtual int}{GetScrollThumb}{\param{int }{orientation}}
+
+Returns the built-in scrollbar thumb size.
+
+\wxheading{See also}
+
+\helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar}
+
+
\membersection{wxWindow::GetSize}\label{wxwindowgetsize}
\constfunc{void}{GetSize}{\param{int* }{width}, \param{int* }{height}}
{\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}
\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}
\constfunc{wxWindowVariant}{GetWindowVariant}{\void}
-Returns the value previous passed to
+Returns the value previously passed to
\helpref{wxWindow::SetWindowVariant}{wxwindowsetwindowvariant}.
\constfunc{virtual bool}{HasCapture}{\void}
-Returns true if this window has the current mouse capture.
+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{wxMouseCaptureLostEvent}{wxmousecapturelostevent}
\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::HasMultiplePages}\label{wxwindowhasmultiplepages}
+
+\constfunc{virtual bool}{HasMultiplePages}{\void}
+
+This method should be overridden to return \texttt{true} if this window has
+multiple pages. All standard class with multiple pages such as
+\helpref{wxNotebook}{wxnotebook}, \helpref{wxListbook}{wxlistbook} and
+\helpref{wxTreebook}{wxtreebook} already override it to return \texttt{true}
+and user-defined classes with similar behaviour should do it as well to allow
+the library to handle such windows appropriately.
+
+
+\membersection{wxWindow::HasScrollbar}\label{wxwindowhasscrollbar}
+
+\constfunc{virtual bool}{HasScrollbar}{\param{int }{orient}}
+
+Returns {\tt true} if this window has a scroll bar for this orientation.
+
+\wxheading{Parameters}
+
+\docparam{orient}{Orientation to check, either {\tt wxHORIZONTAL} or {\tt wxVERTICAL}.}
+
+
+\membersection{wxWindow::HasTransparentBackground}\label{wxwindowhastransparentbackground}
+
+\constfunc{virtual bool}{HasTransparentBackground}{\void}
+
+Returns \true if this window background is transparent (as, for example, for
+wxStaticText) and should show the parent window background.
+
+This method is mostly used internally by the library itself and you normally
+shouldn't have to call it. You may, however, have to override it in your
+wxWindow-derived class to ensure that background is painted correctly.
+
+
\membersection{wxWindow::Hide}\label{wxwindowhide}
\func{bool}{Hide}{\void}
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
-\helpref{SetDefaultFont}{wxwindowsetdefaultfont}) changed \emph{and} if the
+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.
-This rather complicated logic is necessary in order to accomodate the
-different usage scenarius. The most common one is when all default attributes
+This rather complicated logic is necessary in order to accommodate the
+different usage scenarios. The most common one is when all default attributes
are used and in this case, nothing should be inherited as in modern GUIs
different controls use different fonts (and colours) than their siblings so
they can't inherit the same value from the parent. However it was also deemed
to the dialog via validators.
+\membersection{wxWindow::InvalidateBestSize}\label{wxwindowinvalidatebestsize}
+
+\func{void}{InvalidateBestSize}{\void}
+
+Resets the cached best size value so it will be recalculated the next time it is needed.
+
+
+\membersection{wxWindow::IsDoubleBuffered}\label{wxwindowisdoublebuffered}
+
+\constfunc{virtual bool}{IsDoubleBuffered}{\void}
+
+Returns \true if the window contents is double-buffered by the system, i.e. if
+any drawing done on the window is really done on a temporary backing surface
+and transferred to the screen all at once later.
+
+\wxheading{See also}
+
+\helpref{wxBufferedDC}{wxbuffereddc}
+
+
\membersection{wxWindow::IsEnabled}\label{wxwindowisenabled}
\constfunc{virtual bool}{IsEnabled}{\void}
\end{twocollist}}}
+\membersection{wxWindow::IsFrozen}\label{wxwindowisfrozen}
+
+\constfunc{virtual bool}{IsFrozen}{\void}
+
+Returns \true if the window is currently frozen by a call to
+\helpref{Freeze()}{wxwindowfreeze}.
+
+\wxheading{See also}
+
+\helpref{Thaw()}{wxwindowthaw}
+
+
\membersection{wxWindow::IsRetained}\label{wxwindowisretained}
\constfunc{virtual bool}{IsRetained}{\void}
Returns {\tt true} if the window is shown, {\tt false} if it has been hidden.
+\wxheading{See also}
+
+\helpref{wxWindow::IsShownOnScreen}{wxwindowisshownonscreen}
+
+
+\membersection{wxWindow::IsShownOnScreen}\label{wxwindowisshownonscreen}
+
+\constfunc{virtual bool}{IsShownOnScreen}{\void}
+
+Returns {\tt true} if the window is physically visible on the screen, i.e. it
+is shown and all its parents up to the toplevel window are shown as well.
+
+\wxheading{See also}
+
+\helpref{wxWindow::IsShown}{wxwindowisshown}
+
\membersection{wxWindow::IsTopLevel}\label{wxwindowistoplevel}
\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}
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}
\end{twocollist}}
}
+
+\membersection{wxWindow::MoveAfterInTabOrder}\label{wxwindowmoveafterintaborder}
+
+\func{void}{MoveAfterInTabOrder}{\param{wxWindow *}{win}}
+
+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
+\helpref{MoveBeforeInTabOrder()}{wxwindowmovebeforeintaborder} allow to change
+it after creating all the windows.
+
+\wxheading{Parameters}
+
+\docparam{win}{A sibling of this window which should precede it in tab order,
+must not be NULL}
+
+
+\membersection{wxWindow::MoveBeforeInTabOrder}\label{wxwindowmovebeforeintaborder}
+
+\func{void}{MoveBeforeInTabOrder}{\param{wxWindow *}{win}}
+
+Same as \helpref{MoveAfterInTabOrder}{wxwindowmoveafterintaborder} except that
+it inserts this window just before \arg{win} instead of putting it right after
+it.
+
+
+\membersection{wxWindow::Navigate}\label{wxwindownavigate}
+
+\func{bool}{Navigate}{\param{int}{ flags = wxNavigationKeyEvent::IsForward}}
+
+Does keyboard navigation from this window to another, by sending
+a wxNavigationKeyEvent.
+
+\wxheading{Parameters}
+
+\docparam{flags}{A combination of wxNavigationKeyEvent::IsForward and wxNavigationKeyEvent::WinChange.}
+
+\wxheading{Remarks}
+
+You may wish to call this from a text control custom keypress handler to do the default
+navigation behaviour for the tab key, since the standard default behaviour for
+a multiline text control with the wxTE\_PROCESS\_TAB style is to insert a tab
+and not navigate to the next control.
+
%% VZ: wxWindow::OnXXX() functions should not be documented but I'm leaving
%% the old docs here in case we want to move any still needed bits to
%% the right location (i.e. probably the corresponding events docs)
%%
%% This function is only relevant to top-level windows (frames and dialogs), and under
%% Windows only. Under GTK the normal EVT\_CHAR\_ event has the functionality, i.e.
-%% you can intercepts it and if you don't call \helpref{wxEvent::Skip}{wxeventskip}
+%% you can intercept it, and if you don't call \helpref{wxEvent::Skip}{wxeventskip}
%% the window won't get the event.
%%
%% \wxheading{See also}
%%
%% \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}}
%% \wxheading{See also}
%%
%% \helpref{wxMenuEvent}{wxmenuevent},\rtfsp
-%% \helpref{wxWindow::OnMenuCommand}{wxwindowonmenucommand},\rtfsp
%% \helpref{Event handling overview}{eventhandlingoverview}
%%
%%
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.
\membersection{wxWindow::PopupMenu}\label{wxwindowpopupmenu}
-\func{bool}{PopupMenu}{\param{wxMenu* }{menu}, \param{const wxPoint\& }{pos}}
+\func{bool}{PopupMenu}{\param{wxMenu* }{menu}, \param{const wxPoint\& }{pos = wxDefaultPosition}}
\func{bool}{PopupMenu}{\param{wxMenu* }{menu}, \param{int }{x}, \param{int }{y}}
Pops up the given menu at the specified coordinates, relative to this
window, and returns control when the user has dismissed the menu. If a
menu item is selected, the corresponding menu event is generated and will be
-processed as usually.
+processed as usually. If the coordinates are not specified, current mouse
+cursor position is used.
\wxheading{Parameters}
\wxheading{Remarks}
-Just before the menu is popped up, \helpref{wxMenu::UpdateUI}{wxmenuupdateui} is called
-to ensure that the menu items are in the correct state. The menu does not get deleted
-by the window.
+Just before the menu is popped up, \helpref{wxMenu::UpdateUI}{wxmenuupdateui}
+is called to ensure that the menu items are in the correct state. The menu does
+not get deleted by the window.
+
+It is recommended to not explicitly specify coordinates when calling PopupMenu
+in response to mouse click, because some of the ports (namely, wxGTK) can do
+a better job of positioning the menu in that case.
\pythonnote{In place of a single overloaded method name, wxPython
implements the following methods:\par
\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}
\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}
\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}
\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{wxMouseCaptureLostEvent}{wxmousecapturelostevent}
\helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}
\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}
Reparents the window, i.e the window will be removed from its
current parent window (e.g. a non-standard toolbar in a wxFrame)
-and then re-inserted into another. Available on Windows and GTK.
+and then re-inserted into another.
\wxheading{Parameters}
\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}
\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}
\membersection{wxWindow::SetAccessible}\label{wxwindowsetaccessible}
-\func{void}{SetAccessible}{\param{wxAccessibile*}{ accessible}}
+\func{void}{SetAccessible}{\param{wxAccessible*}{ accessible}}
Sets the accessible for this window. Any existing accessible for this window
will be deleted first, if not identical to {\it accessible}.
\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
\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}
\membersection{wxWindow::SetBackgroundColour}\label{wxwindowsetbackgroundcolour}
-\func{virtual void}{SetBackgroundColour}{\param{const wxColour\& }{colour}}
+\func{virtual bool}{SetBackgroundColour}{\param{const wxColour\& }{colour}}
Sets the background colour of the window.
Please see \helpref{InheritAttributes}{wxwindowinheritattributes} for
-explanation of the difference between this method and
-\helpref{SetDefaultBackgroundColour}{wxwindowsetdefaultbackgroundcolour}.
+explanation of the difference between this method and
+\helpref{SetOwnBackgroundColour}{wxwindowsetownbackgroundcolour}.
\wxheading{Parameters}
-\docparam{colour}{The colour to be used as the background colour.}
+\docparam{colour}{The colour to be used as the background colour, pass
+ {\tt wxNullColour} to reset to the default colour.}
\wxheading{Remarks}
may wish to call \helpref{wxWindow::ClearBackground}{wxwindowclearbackground} or \helpref{wxWindow::Refresh}{wxwindowrefresh} after
calling this function.
-Use this function with care under GTK+ as the new appearance of the window might
-not look equally well when used with "Themes", i.e GTK+'s ability to change its
-look as the user wishes with run-time loadable modules.
+Using this function will disable attempts to use themes for this
+window, if the system supports them. Use with care since usually the
+themes represent the appearance chosen by the user to be used for all
+applications on the system.
+
\wxheading{See also}
\helpref{wxWindow::Refresh}{wxwindowrefresh},\rtfsp
\helpref{wxEraseEvent}{wxeraseevent}
+\membersection{wxWindow::SetBackgroundStyle}\label{wxwindowsetbackgroundstyle}
+
+\func{virtual void}{SetBackgroundStyle}{\param{wxBackgroundStyle}{ style}}
+
+Sets the background style of the window. The background style indicates
+whether background colour should be determined by the system (wxBG\_STYLE\_SYSTEM),
+be set to a specific colour (wxBG\_STYLE\_COLOUR), or should be left to the
+application to implement (wxBG\_STYLE\_CUSTOM).
+
+On GTK+, use of wxBG\_STYLE\_CUSTOM allows the flicker-free drawing of a custom
+background, such as a tiled bitmap. Currently the style has no effect on other platforms.
+
+\wxheading{See also}
+
+\helpref{wxWindow::SetBackgroundColour}{wxwindowsetbackgroundcolour},\rtfsp
+\helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour},\rtfsp
+\helpref{wxWindow::GetBackgroundStyle}{wxwindowgetbackgroundstyle}
+
+
+\membersection{wxWindow::SetInitialSize}\label{wxwindowsetinitialsize}
+
+\func{void}{SetInitialSize}{\param{const wxSize\& }{size = wxDefaultSize}}
+
+A {\it smart} SetSize that will fill in default size components with the
+window's {\it best} size values. Also sets the window's minsize to
+the value passed in for use with sizers. This means that if a full or
+partial size is passed to this function then the sizers will use that
+size instead of the results of GetBestSize to determine the minimum
+needs of the window for layout.
+
+Most controls will use this to set their initial size, and their min
+size to the passed in value (if any.)
+
+
+\wxheading{See also}
+
+\helpref{wxWindow::SetSize}{wxwindowsetsize},\rtfsp
+\helpref{wxWindow::GetBestSize}{wxwindowgetbestsize},\rtfsp
+\helpref{wxWindow::GetEffectiveMinSize}{wxwindowgeteffectiveminsize}
+
\membersection{wxWindow::SetCaret}\label{wxwindowsetcaret}
}
-\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}}
explicitly. When setting both a wxLayoutConstraints and a \helpref{wxSizer}{wxsizer}, only the
sizer will have effect.
+\membersection{wxWindow::SetContainingSizer}\label{wxwindowsetcontainingsizer}
-\membersection{wxWindow::SetDefaultBackgroundColour}\label{wxwindowsetdefaultbackgroundcolour}
-
-\func{void}{SetDefaultBackgroundColour}{\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::SetDefaultFont}\label{wxwindowsetdefaultfont}
+\func{void}{SetContainingSizer}{\param{wxSizer* }{sizer}}
-\func{void}{SetDefaultBackgroundColour}{\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::SetDefaultForegroundColour}\label{wxwindowsetdefaultforegroundcolour}
+The {\it cursor} may be {\tt wxNullCursor} in which case the window cursor will
+be reset back to default.
-\func{void}{SetDefaultForegroundColour}{\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}
+\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}}
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 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 wxWidgets will send
-a wxEVT\_HELP event if the user clicked on an application window.
+\twocolitem{\windowstyle{wxWS\_EX\_CONTEXTHELP}}{Under Windows, puts a query
+button on the caption. When pressed, Windows will go into a context-sensitive
+help mode and wxWidgets 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 \& \textasciitilde(wxMINIMIZE\_BOX | wxMAXIMIZE\_BOX)} for the
-frames having this style (the dialogs don't have minimize nor maximize box by
-default)}
+these two styles are automatically turned of if this one is used.}
\twocolitem{\windowstyle{wxWS\_EX\_PROCESS\_IDLE}}{This window should always process idle events, even
if the mode set by \helpref{wxIdleEvent::SetMode}{wxidleeventsetmode} is wxIDLE\_PROCESS\_SPECIFIED.}
\twocolitem{\windowstyle{wxWS\_EX\_PROCESS\_UI\_UPDATES}}{This window should always process UI update events,
\wxheading{See also}
\helpref{wxFocusEvent}{wxfocusevent}
+\helpref{wxPanel::SetFocus}{wxpanelsetfocus}
+\helpref{wxPanel::SetFocusIgnoringChildren}{wxpanelsetfocusignoringchildren}
\membersection{wxWindow::SetFocusFromKbd}\label{wxwindowsetfocusfromkbd}
Sets the font for this window. This function should not be called for the
parent window if you don't want its font to be inherited by its children,
-use \helpref{SetDefaultFont}{wxwindowsetdefaultfont} instead in this case and
+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.}
+\docparam{font}{Font to associate with this window, pass
+{\tt wxNullFont} to reset to the default font.}
\wxheading{See also}
Sets the foreground colour of the window.
Please see \helpref{InheritAttributes}{wxwindowinheritattributes} for
-explanation of the difference between this method and
-\helpref{SetDefaultForegroundColour}{wxwindowsetdefaultforegroundcolour}.
+explanation of the difference between this method and
+\helpref{SetOwnForegroundColour}{wxwindowsetownforegroundcolour}.
\wxheading{Parameters}
-\docparam{colour}{The colour to be used as the foreground colour.}
+\docparam{colour}{The colour to be used as the foreground colour, pass
+ {\tt wxNullColour} to reset to the default colour.}
\wxheading{Remarks}
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 appearance of windows and controls, including the themes of
-their parent windows.
+Using this function will disable attempts to use themes for this
+window, if the system supports them. Use with care since usually the
+themes represent the appearance chosen by the user to be used for all
+applications on the system.
\wxheading{See also}
+\membersection{wxWindow::SetLabel}\label{wxwindowsetlabel}
+
+\func{virtual void}{SetLabel}{\param{const wxString\& }{label}}
+
+Sets the window's label.
+
+\wxheading{Parameters}
+
+\docparam{label}{The window label.}
+
+\wxheading{See also}
+
+\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}}
\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}}
\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}
\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}
\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}
\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}
\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.}
\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
+{\bf wxSIZE\_AUTO\_WIDTH}: a $wxDefaultCoord$ width value is taken to indicate
a wxWidgets-supplied default width.\\
-{\bf wxSIZE\_AUTO\_HEIGHT}: a -1 height 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}
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}
\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},
- \param{int}{ incW=-1}, \param{int}{ incH=-1}}
-
-\func{void}{SetSizeHints}{\param{const wxSize\&}{ minSize},
-\param{const wxSize\&}{ maxSize=wxDefaultSize}, \param{const wxSize\&}{ incSize=wxDefaultSize}}
-
-
-Allows specification of minimum and maximum window sizes, and window size increments.
-If a pair of values is not set (or set to -1), the default values will be used.
-
-\wxheading{Parameters}
-
-\docparam{minW}{Specifies the minimum width allowable.}
-
-\docparam{minH}{Specifies the minimum height allowable.}
-
-\docparam{maxW}{Specifies the maximum width allowable.}
-
-\docparam{maxH}{Specifies the maximum height allowable.}
-
-\docparam{incW}{Specifies the increment for sizing the width (Motif/Xt only).}
-
-\docparam{incH}{Specifies the increment for sizing the height (Motif/Xt only).}
-
-\docparam{minSize}{Minimum size.}
-
-\docparam{maxSize}{Maximum size.}
-
-\docparam{incSize}{Increment size (Motif/Xt only).}
-
-\wxheading{Remarks}
-
-If this function is called, the user will not be able to size the window outside the
-given bounds.
-
-The resizing increments are only significant under Motif or Xt.
+This method does nothing for a normal wxWindow and is only kept
+for backwards compatibility. The actual implementation is in
+\helpref{wxTopLevelWindow::SetSizeHints}{wxtoplevelwindowsetsizehints}.
\membersection{wxWindow::SetSizer}\label{wxwindowsetsizer}
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.
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}}
\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}}
This function can be called under all platforms but only does anything under
Mac OS X 10.3+ currently. Under this system, each of the standard control can
-exist in several sizes which correpond to the elements of wxWindowVariant
+exist in several sizes which correspond to the elements of wxWindowVariant
enum:
\begin{verbatim}
enum wxWindowVariant
\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.
\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}
\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 invalidate any area of the window so
+nothing happens if nothing has been invalidated (i.e. marked as requiring
+a redraw). Use \helpref{Refresh}{wxwindowrefresh} first if you want to
+immediately redraw the window unconditionally.
\membersection{wxWindow::UpdateWindowUI}\label{wxwindowupdatewindowui}
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.
\wxheading{See also}
-\helpref{wxUpdateUIEvent}{wxupdateuievent},
-\helpref{wxWindow::DoUpdateWindowUI}{wxwindowdoupdatewindowui},
+\helpref{wxUpdateUIEvent}{wxupdateuievent},
+\helpref{wxWindow::DoUpdateWindowUI}{wxwindowdoupdatewindowui},
\helpref{wxWindow::OnInternalIdle}{wxwindowoninternalidle}
\wxheading{See also}
\helpref{wxWindow::TransferDataFromWindow}{wxwindowtransferdatafromwindow},\rtfsp
-\helpref{wxWindow::TransferDataFromWindow}{wxwindowtransferdatafromwindow},\rtfsp
+\helpref{wxWindow::TransferDataToWindow}{wxwindowtransferdatatowindow},\rtfsp
\helpref{wxValidator}{wxvalidator}
projects / wxWidgets.git / blobdiff