mention also the contrib libraries removal/movements

[wxWidgets.git] / docs / latex / wx / window.tex

diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex
index 5fd8e56ab22dda0ad20eab7d439e01698fd9ddd4..d7796285d0d31981cf0c7ddf16a35f82868b424a 100644 (file)
--- 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
 \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.
 
 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
 \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


@@ -30,6 +41,10 @@ changes the behaviour of the latter.
 
 <wx/window.h>
 
 
 <wx/window.h>
 

+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+

 \wxheading{Window styles}
 
 The following styles can apply to all windows, although they will not always make sense for a particular
 \wxheading{Window styles}
 
 The following styles can apply to all windows, although they will not always make sense for a particular


@@ -37,13 +52,16 @@ window class or on all platforms.
 
 \twocolwidtha{5cm}%
 \begin{twocollist}\itemsep=0pt
 
 \twocolwidtha{5cm}%
 \begin{twocollist}\itemsep=0pt

-\twocolitem{\windowstyle{wxSIMPLE\_BORDER}}{Displays a thin border around the window. wxBORDER is the old name
+\twocolitem{\windowstyle{wxBORDER\_DEFAULT}}{The window class will decide the kind of border to show, if any.}
+\twocolitem{\windowstyle{wxBORDER\_SIMPLE}}{Displays a thin border around the window. wxSIMPLE\_BORDER is the old name

 for this style. }
 for this style. }

-\twocolitem{\windowstyle{wxDOUBLE\_BORDER}}{Displays a double border. Windows and Mac only.}
-\twocolitem{\windowstyle{wxSUNKEN\_BORDER}}{Displays a sunken border.}
-\twocolitem{\windowstyle{wxRAISED\_BORDER}}{Displays a raised border.}
-\twocolitem{\windowstyle{wxSTATIC\_BORDER}}{Displays a border suitable for a static control. Windows only. }
-\twocolitem{\windowstyle{wxNO\_BORDER}}{Displays no border, overriding the default border style for the window.}
+\twocolitem{\windowstyle{wxBORDER\_SUNKEN}}{Displays a sunken border. wxSUNKEN\_BORDER is the old name for this style.}
+\twocolitem{\windowstyle{wxBORDER\_RAISED}}{Displays a raised border. wxRAISED\_BORDER is the old name for this style. }
+\twocolitem{\windowstyle{wxBORDER\_STATIC}}{Displays a border suitable for a static control.  wxSTATIC\_BORDER is the old name for this style. Windows only. }
+\twocolitem{\windowstyle{wxBORDER\_THEME}}{Displays a native border suitable for a control, on the current platform. On Windows XP or Vista, this will be a themed border; on most other platforms
+a sunken border will be used. For more information for themed borders on Windows, please see \helpref{Themed borders on Windows}{wxmswthemedborders}.}
+\twocolitem{\windowstyle{wxBORDER\_NONE}}{Displays no border, overriding the default border style for the window. wxNO\_BORDER is the old name for this style.}
+\twocolitem{\windowstyle{wxBORDER\_DOUBLE}}{This style is obsolete and should not be used.}

 \twocolitem{\windowstyle{wxTRANSPARENT\_WINDOW}}{The window is transparent, that is, it will not receive paint
 events. Windows only.}
 \twocolitem{\windowstyle{wxTAB\_TRAVERSAL}}{Use this to enable tab traversal for non-dialog windows.}
 \twocolitem{\windowstyle{wxTRANSPARENT\_WINDOW}}{The window is transparent, that is, it will not receive paint
 events. Windows only.}
 \twocolitem{\windowstyle{wxTAB\_TRAVERSAL}}{Use this to enable tab traversal for non-dialog windows.}


@@ -51,20 +69,22 @@ events. Windows only.}
 the window wants to get all char/key events for all keys - even for
 keys like TAB or ENTER which are usually used for dialog navigation
 and which wouldn't be generated without this style.  If you need to
 the window wants to get all char/key events for all keys - even for
 keys like TAB or ENTER which are usually used for dialog navigation
 and which wouldn't be generated without this style.  If you need to

-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{wxVSCROLL}}{Use this style to enable a vertical scrollbar.}
-\twocolitem{\windowstyle{wxHSCROLL}}{Use this style to enable a horizontal scrollbar.}
+use this style in order to get the arrows or etc., but would still like
+to have normal keyboard navigation take place, you should call
+\helpref{Navigate}{wxwindownavigate} in response to the key events for
+Tab and Shift-Tab.}
+\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. Notice that this style cannot be used with native controls
+which don't support scrollbars nor with top-level windows in most ports.}
+\twocolitem{\windowstyle{wxHSCROLL}}{Use this style to enable a horizontal
+scrollbar. The same limitations as for wxVSCROLL apply to this style.}

 \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).
 \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.}
 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.}


@@ -72,7 +92,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
 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}.
 \end{twocollist}
 
 See also \helpref{window styles overview}{windowstyles}.


@@ -103,7 +125,8 @@ even if the mode set by \helpref{wxUpdateUIEvent::SetMode}{wxupdateuieventsetmod
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{Event handling overview}{eventhandlingoverview}
+\helpref{Event handling overview}{eventhandlingoverview}\\
+\helpref{Window sizing overview}{windowsizingoverview}

 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 


@@ -126,13 +149,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{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.}
 
 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. }
 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. }


@@ -158,6 +181,29 @@ can delete a window only when it is safe to do so, in idle time.
 \helpref{wxCloseEvent}{wxcloseevent}
 
 
 \helpref{wxCloseEvent}{wxcloseevent}
 
 

+\membersection{wxWindow::AcceptsFocus}\label{wxwindowacceptsfocus}
+
+\constfunc{bool}{AcceptsFocus}{\void}
+
+This method may be overridden in the derived classes to return \false to
+indicate that this control doesn't accept input at all (i.e. behaves like e.g.
+\helpref{wxStaticText}{wxstatictext}) and so doesn't need focus.
+
+\wxheading{See also}
+
+\helpref{AcceptsFocusFromKeyboard}{wxwindowacceptsfocusfromkeyboard}
+
+
+\membersection{wxWindow::AcceptsFocusFromKeyboard}\label{wxwindowacceptsfocusfromkeyboard}
+
+\constfunc{bool}{AcceptsFocusFromKeyboard}{\void}
+
+This method may be overridden in the derived classes to return \false to
+indicate that while this control can, in principle, have focus if the user
+clicks it with the mouse, it shouldn't be included in the TAB traversal chain
+when using the keyboard.
+
+

 \membersection{wxWindow::AddChild}\label{wxwindowaddchild}
 
 \func{virtual void}{AddChild}{\param{wxWindow* }{child}}
 \membersection{wxWindow::AddChild}\label{wxwindowaddchild}
 
 \func{virtual void}{AddChild}{\param{wxWindow* }{child}}


@@ -173,6 +219,26 @@ called by the user code.
 \docparam{child}{Child window to add.}
 
 
 \docparam{child}{Child window to add.}
 
 

+\membersection{wxWindow::AlwaysShowScrollbars}\label{wxwindowalwaysshowscrollbars}
+
+\func{void}{AlwaysShowScrollbars}{\param{bool}{ hflag}, \param{bool}{ vflag}}
+
+Call this function to force one or both scrollbars to be always shown, even if
+the window is big enough to show its entire contents without scrolling.
+
+\newsince{2.9.0}
+
+\wxheading{Parameters}
+
+\docparam{hflag}{Whether the horizontal scroll bar should always be visible.}
+
+\docparam{vflag}{Whether the vertical scroll bar should always be visible.}
+
+\wxheading{Remarks}
+
+This function is currently only implemented under Mac/Carbon.
+
+

 \membersection{wxWindow::CacheBestSize}\label{wxwindowcachebestsize}
 
 \constfunc{void}{CacheBestSize}{\param{const wxSize\& }{size}}
 \membersection{wxWindow::CacheBestSize}\label{wxwindowcachebestsize}
 
 \constfunc{void}{CacheBestSize}{\param{const wxSize\& }{size}}


@@ -180,6 +246,16 @@ called by the user code.
 Sets the cached best size value.
 
 
 Sets the cached best size value.
 
 

+\membersection{wxWindow::CanSetTransparent}\label{wxwindowcansettransparent}
+
+\func{bool}{CanSetTransparent}{\void}
+
+Returns \true if the system supports transparent windows and calling 
+\helpref{SetTransparent}{wxwindowsettransparent} may succeed. If this function
+returns \false, transparent windows are definitely not supported by the current
+system.
+
+

 \membersection{wxWindow::CaptureMouse}\label{wxwindowcapturemouse}
 
 \func{virtual void}{CaptureMouse}{\void}
 \membersection{wxWindow::CaptureMouse}\label{wxwindowcapturemouse}
 
 \func{virtual void}{CaptureMouse}{\void}


@@ -191,11 +267,18 @@ Note that wxWidgets maintains the stack of windows having captured the mouse
 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
 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}
 
 \wxheading{See also}
 
 \helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse}

+\helpref{wxMouseCaptureLostEvent}{wxmousecapturelostevent}

 
 
 \membersection{wxWindow::Center}\label{wxwindowcenter}
 
 
 \membersection{wxWindow::Center}\label{wxwindowcenter}


@@ -212,13 +295,6 @@ A synonym for \helpref{Centre}{wxwindowcentre}.
 A synonym for \helpref{CentreOnParent}{wxwindowcentreonparent}.
 
 
 A synonym for \helpref{CentreOnParent}{wxwindowcentreonparent}.
 
 

-\membersection{wxWindow::CenterOnScreen}\label{wxwindowcenteronscreen}
-
-\func{void}{CenterOnScreen}{\param{int}{ direction}}
-
-A synonym for \helpref{CentreOnScreen}{wxwindowcentreonscreen}.
-
-

 \membersection{wxWindow::Centre}\label{wxwindowcentre}
 
 \func{void}{Centre}{\param{int}{ direction = wxBOTH}}
 \membersection{wxWindow::Centre}\label{wxwindowcentre}
 
 \func{void}{Centre}{\param{int}{ direction = wxBOTH}}


@@ -266,24 +342,7 @@ window is not a top level window, then behaviour is the same as
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxWindow::CentreOnScreen}{wxwindowcenteronscreen}
-
-
-\membersection{wxWindow::CentreOnScreen}\label{wxwindowcentreonscreen}
-
-\func{void}{CentreOnScreen}{\param{int}{ direction = wxBOTH}}
-
-Centres the window on screen. This only works for top level windows -
-otherwise, the window will still be centered on its parent.
-
-\wxheading{Parameters}
-
-\docparam{direction}{Specifies the direction for the centering. May be {\tt wxHORIZONTAL}, {\tt wxVERTICAL}\rtfsp
-or {\tt wxBOTH}.}
-
-\wxheading{See also}
-
-\helpref{wxWindow::CentreOnParent}{wxwindowcenteronparent}
+\helpref{wxTopLevelWindow::CentreOnScreen}{wxtoplevelwindowcenteronscreen}

 
 
 \membersection{wxWindow::ClearBackground}\label{wxwindowclearbackground}
 
 
 \membersection{wxWindow::ClearBackground}\label{wxwindowclearbackground}


@@ -343,7 +402,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,
 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
 should destroy the window using \helpref{wxWindow::Destroy}{wxwindowdestroy}.
 
 {\it Note} that calling Close does not guarantee that the window will be


@@ -353,7 +412,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.
 
 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::Destroy}{wxwindowdestroy} instead
 
 \wxheading{See also}


@@ -491,7 +550,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.
 \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:
 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 +561,7 @@ void wxTopLevelWindowBase::DoUpdateWindowUI(wxUpdateUIEvent& event)
 {
     if ( event.GetSetEnabled() )
         Enable(event.GetEnabled());
 {
     if ( event.GetSetEnabled() )
         Enable(event.GetEnabled());

-    
+

     if ( event.GetSetText() )
     {
         if ( event.GetText() != GetTitle() )
     if ( event.GetSetText() )
     {
         if ( event.GetText() != GetTitle() )


@@ -549,7 +608,8 @@ nothing was done, i.e. if the window had already been in the specified state.
 \wxheading{See also}
 
 \helpref{wxWindow::IsEnabled}{wxwindowisenabled},\rtfsp
 \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::FindFocus}\label{wxwindowfindfocus}


@@ -602,32 +662,32 @@ The search is recursive in both cases.
 \helpref{FindWindow}{wxwindowfindwindow}
 
 
 \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.
 
 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}
 
 
 \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.
 
 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}
 \wxheading{See also}
 
 \helpref{FindWindow}{wxwindowfindwindow}


@@ -638,7 +698,7 @@ The search is recursive in both cases.
 \func{virtual void}{Fit}{\void}
 
 Sizes the window so that it fits around its subwindows. This function won't do
 \func{virtual void}{Fit}{\void}
 
 Sizes the window so that it fits around its subwindows. This function won't do

-anything if there are no subwindows and will only really work correctly if the
+anything if there are no subwindows and will only really work correctly if

 sizers are used for the subwindows layout. Also, if the window has exactly one
 subwindow it is better (faster and the result is more precise as Fit adds some
 margin to account for fuzziness of its calculations) to call
 sizers are used for the subwindows layout. Also, if the window has exactly one
 subwindow it is better (faster and the result is more precise as Fit adds some
 margin to account for fuzziness of its calculations) to call


@@ -668,7 +728,8 @@ subwindows.
 Freezes the window or, in other words, prevents any updates from taking place
 on screen, the window is not redrawn at all. \helpref{Thaw}{wxwindowthaw} must
 be called to reenable window redrawing. Calls to these two functions may be
 Freezes the window or, in other words, prevents any updates from taking place
 on screen, the window is not redrawn at all. \helpref{Thaw}{wxwindowthaw} must
 be called to reenable window redrawing. Calls to these two functions may be

-nested.
+nested but to ensure that the window is properly repainted again, you must thaw
+it exactly as many times as you froze it.

 
 This method is useful for visual appearance optimization (for example, it
 is a good idea to use it before doing many large text insertions in a row into
 
 This method is useful for visual appearance optimization (for example, it
 is a good idea to use it before doing many large text insertions in a row into


@@ -676,6 +737,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.
 
 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::GetAcceleratorTable}\label{wxwindowgetacceleratortable}
 


@@ -697,11 +762,8 @@ See also \helpref{wxAccessible}{wxaccessible}.
 
 \constfunc{wxSize}{GetAdjustedBestSize}{\void}
 
 
 \constfunc{wxSize}{GetAdjustedBestSize}{\void}
 

-This method is similar to \helpref{GetBestSize}{wxwindowgetbestsize}, except
-in one thing.  GetBestSize should return the minimum untruncated size of the
-window, while this method will return the largest of BestSize and any user
-specified minimum size.  ie. it is the minimum size the window should currently
-be drawn at, not the minimal size it can possibly tolerate.
+This method is deprecated, use \helpref{GetEffectiveMinSize}{wxwindowgeteffectiveminsize}
+instead.

 
 
 \membersection{wxWindow::GetBackgroundColour}\label{wxwindowgetbackgroundcolour}
 
 
 \membersection{wxWindow::GetBackgroundColour}\label{wxwindowgetbackgroundcolour}


@@ -720,31 +782,45 @@ Returns the background colour of the window.
 
 \constfunc{virtual wxBackgroundStyle}{GetBackgroundStyle}{\void}
 
 
 \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.
+Returns the background style of the window. The background style can be one of:
+\begin{twocollist}\itemsep=0pt
+\twocolitem{wxBG\_STYLE\_SYSTEM}{Use the default background, as determined by
+the system or the current theme.}
+\twocolitem{wxBG\_STYLE\_COLOUR}{Use a solid colour for the background, this
+style is set automatically if you call 
+\helpref{SetBackgroundColour}{wxwindowsetbackgroundcolour} so you only need to
+set it explicitly if you had changed the background style to something else
+before.}
+\twocolitem{wxBG\_STYLE\_CUSTOM}{Don't draw the background at all, it's
+supposed that it is drawn by the user-defined erase background event handler.
+This style should be used to avoid flicker when the background is entirely
+custom-drawn.}
+\twocolitem{wxBG\_STYLE\_TRANSPARET}{The background is (partially) transparent,
+this style is automatically set if you call 
+\helpref{SetTransparent}{wxwindowsettransparent} which is used to set the
+transparency level.}
+\end{twocollist}

 
 \wxheading{See also}
 
 \helpref{wxWindow::SetBackgroundColour}{wxwindowsetbackgroundcolour},\rtfsp
 \helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour},\rtfsp
 
 \wxheading{See also}
 
 \helpref{wxWindow::SetBackgroundColour}{wxwindowsetbackgroundcolour},\rtfsp
 \helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour},\rtfsp

-\helpref{wxWindow::SetBackgroundStyle}{wxwindowsetbackgroundstyle}
+\helpref{wxWindow::SetBackgroundStyle}{wxwindowsetbackgroundstyle},\rtfsp
+\helpref{wxWindow::SetTransparent}{wxwindowsettransparent}

 
 

-\membersection{wxWindow::GetBestFittingSize}\label{wxwindowgetbestfittingsize}

 
 

-\constfunc{wxSize}{GetBestFittingSize}{\void}
+\membersection{wxWindow::GetEffectiveMinSize}\label{wxwindowgeteffectiveminsize}

 
 

-Merges the window's best size into the min size and returns the result.
+\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
 
 \wxheading{See also}
 
 \helpref{wxWindow::GetBestSize}{wxwindowgetbestsize},\rtfsp

-\helpref{wxWindow::SetBestFittingSize}{wxwindowsetbestfittingsize},\rtfsp
-\helpref{wxWindow::SetSizeHints}{wxwindowsetsizehints}
+\helpref{wxWindow::SetInitialSize}{wxwindowsetinitialsize}

 
 
 \membersection{wxWindow::GetBestSize}\label{wxwindowgetbestsize}
 
 
 \membersection{wxWindow::GetBestSize}\label{wxwindowgetbestsize}


@@ -759,13 +835,6 @@ same as the size the window would have had after calling
 \helpref{Fit}{wxwindowfit}.
 
 
 \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}
 \membersection{wxWindow::GetCapture}\label{wxwindowgetcapture}
 
 \func{static wxWindow *}{GetCapture}{\void}


@@ -774,12 +843,20 @@ Returns the currently captured window.
 
 \wxheading{See also}
 
 
 \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}
 
 
 \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}
 \membersection{wxWindow::GetCharHeight}\label{wxwindowgetcharheight}
 
 \constfunc{virtual int}{GetCharHeight}{\void}


@@ -796,9 +873,13 @@ Returns the average character width for this window.
 
 \membersection{wxWindow::GetChildren}\label{wxwindowgetchildren}
 
 
 \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}
 
 
 \membersection{wxWindow::GetClassDefaultAttributes}\label{wxwindowgetclassdefaultattributes}


@@ -813,7 +894,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
 
 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,
 for more about this.
 
 This static method is ``overridden'' in many derived classes and so calling,


@@ -821,7 +902,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().
 
 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
 \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


@@ -841,9 +922,12 @@ a 2-element list {\tt (width, height)}.}
 
 \constfunc{wxSize}{GetClientSize}{\void}
 
 
 \constfunc{wxSize}{GetClientSize}{\void}
 

-This gets the size of the window `client area' in pixels.
-The client area is the area which may be drawn on by the programmer,
-excluding title bar, border, scrollbars, etc.
+Returns the size of the window `client area' in pixels. The client area is the
+area which may be drawn on by the programmer, excluding title bar, border,
+scrollbars, etc.
+
+Note that if this window is a top-level one and it is currently minimized, the
+return size is empty (both width and height are $0$).

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -896,7 +980,7 @@ Return the cursor associated with this window.
 
 \constfunc{virtual wxVisualAttributes}{GetDefaultAttributes}{\void}
 
 
 \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
 \helpref{GetClassDefaultAttributes}{wxwindowgetclassdefaultattributes}(\helpref{GetWindowVariant}{wxwindowgetwindowvariant}()).
 
 One advantage of using this function compared to the static version is that


@@ -988,13 +1072,30 @@ 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
 \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.}
 
 
 
 \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}
 \membersection{wxWindow::GetHelpText}\label{wxwindowgethelptext}
 
 \constfunc{virtual wxString}{GetHelpText}{\void}


@@ -1006,7 +1107,7 @@ and not in the window object itself.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{SetHelpText}{wxwindowsethelptext}, \helpref{wxHelpProvider}{wxhelpprovider}
+\helpref{SetHelpText}{wxwindowsethelptext}, \helpref{GetHelpTextAtPoint}{wxwindowgethelptextatpoint}, \helpref{wxHelpProvider}{wxhelpprovider}

 
 
 \membersection{wxWindow::GetId}\label{wxwindowgetid}
 
 
 \membersection{wxWindow::GetId}\label{wxwindowgetid}


@@ -1018,7 +1119,7 @@ Returns the identifier of the window.
 \wxheading{Remarks}
 
 Each window has an integer identifier. If the application has not provided one
 \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}
 
 
 \wxheading{See also}
 


@@ -1046,14 +1147,16 @@ by name.
 \constfunc{wxSize}{GetMaxSize}{\void}
 
 Returns the maximum size of the window, an indication to the sizer layout mechanism
 \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.
+that this is the maximum possible size. 

 
 \membersection{wxWindow::GetMinSize}\label{wxwindowgetminsize}
 
 
 \membersection{wxWindow::GetMinSize}\label{wxwindowgetminsize}
 

-\constfunc{wxSize}{GetMinSize}{\void}
+\constfunc{virtual wxSize}{GetMinSize}{\void}

 
 Returns the minimum size of the window, an indication to the sizer layout mechanism
 
 Returns the minimum size of the window, an indication to the sizer layout mechanism

-that this is the minimum required size.
+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}
 
 
 \membersection{wxWindow::GetName}\label{wxwindowgetname}
 


@@ -1071,6 +1174,20 @@ name in the window constructor or via \helpref{wxWindow::SetName}{wxwindowsetnam
 \helpref{wxWindow::SetName}{wxwindowsetname}
 
 
 \helpref{wxWindow::SetName}{wxwindowsetname}
 
 

+\membersection{wxWindow::GetNextSibling}\label{wxwindowgetnextsibling}
+
+\constfunc{wxWindow *}{GetNextSibling}{\void}
+
+Returns the next window after this one among the parent children or \NULL if
+this window is the last child.
+
+\newsince{2.8.8}
+
+\wxheading{See also}
+
+\helpref{GetPrevSibling}{wxwindowgetprevsibling}
+
+

 \membersection{wxWindow::GetParent}\label{wxwindowgetparent}
 
 \constfunc{virtual wxWindow*}{GetParent}{\void}
 \membersection{wxWindow::GetParent}\label{wxwindowgetparent}
 
 \constfunc{virtual wxWindow*}{GetParent}{\void}


@@ -1078,6 +1195,33 @@ name in the window constructor or via \helpref{wxWindow::SetName}{wxwindowsetnam
 Returns the parent of the window, or NULL if there is no parent.
 
 
 Returns the parent of the window, or NULL if there is no parent.
 
 

+\membersection{wxWindow::GetPopupMenuSelectionFromUser}\label{wxwindowgetpopupmenuselectionfromuser}
+
+\func{int}{GetPopupMenuSelectionFromUser}{\param{wxMenu\&}{ menu}, \param{const wxPoint\&}{ pos}}
+
+\func{int}{GetPopupMenuSelectionFromUser}{\param{wxMenu\&}{ menu}, \param{int}{ x}, \param{int}{ y}}
+
+This function shows a popup menu at the given position in this window and
+returns the selected id. It can be more convenient than the general purpose
+\helpref{PopupMenu}{wxwindowpopupmenu} function for simple menus proposing a
+choice in a list of strings to the user.
+
+\wxheading{Parameters}
+
+\docparam{menu}{The menu to show}
+
+\docparam{pos}{The position at which to show the menu in client coordinates}
+
+\docparam{x}{The horizontal position of the menu}
+
+\docparam{y}{The vertical position of the menu}
+
+\wxheading{Return value}
+
+The selected menu item id or \texttt{wxID\_NONE} if none selected or an error
+occurred.
+
+

 \membersection{wxWindow::GetPosition}\label{wxwindowgetposition}
 
 \constfunc{virtual void}{GetPosition}{\param{int* }{x}, \param{int* }{y}}
 \membersection{wxWindow::GetPosition}\label{wxwindowgetposition}
 
 \constfunc{virtual void}{GetPosition}{\param{int* }{x}, \param{int* }{y}}


@@ -1090,9 +1234,9 @@ windows.
 
 \wxheading{Parameters}
 
 
 \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
 
 \pythonnote{In place of a single overloaded method name, wxPython
 implements the following methods:\par


@@ -1112,11 +1256,66 @@ method:\par
 }}
 
 
 }}
 
 

+\wxheading{See also}
+
+\helpref{GetScreenPosition}{wxwindowgetscreenposition}
+
+
+\membersection{wxWindow::GetPrevSibling}\label{wxwindowgetprevsibling}
+
+\constfunc{wxWindow *}{GetPrevSibling}{\void}
+
+Returns the previous window before this one among the parent children or \NULL if
+this window is the first child.
+
+\newsince{2.8.8}
+
+\wxheading{See also}
+
+\helpref{GetNextSibling}{wxwindowgetnextsibling}
+
+

 \membersection{wxWindow::GetRect}\label{wxwindowgetrect}
 
 \constfunc{virtual wxRect}{GetRect}{\void}
 
 \membersection{wxWindow::GetRect}\label{wxwindowgetrect}
 
 \constfunc{virtual wxRect}{GetRect}{\void}
 

-Returns the size and position of the window as a \helpref{wxRect}{wxrect} object.
+Returns the position and size 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 position and size of the window on the screen as a 
+\helpref{wxRect}{wxrect} object.
+
+\wxheading{See also}
+
+\helpref{GetRect}{wxwindowgetrect}

 
 
 \membersection{wxWindow::GetScrollPos}\label{wxwindowgetscrollpos}
 
 
 \membersection{wxWindow::GetScrollPos}\label{wxwindowgetscrollpos}


@@ -1158,8 +1357,11 @@ Returns the built-in scrollbar thumb size.
 
 \constfunc{wxSize}{GetSize}{\void}
 
 
 \constfunc{wxSize}{GetSize}{\void}
 

-This gets the size of the entire window in pixels,
-including title bar, border, scrollbars, etc.
+Returns the size of the entire window in pixels, including title bar, border,
+scrollbars, etc.
+
+Note that if this window is a top-level one and it is currently minimized, the
+returned size is the restored window size, not the size of the window icon.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -1200,20 +1402,25 @@ Return the sizer associated with the window by a previous call to
 
 \membersection{wxWindow::GetTextExtent}\label{wxwindowgettextextent}
 
 
 \membersection{wxWindow::GetTextExtent}\label{wxwindowgettextextent}
 

-\constfunc{virtual void}{GetTextExtent}{\param{const wxString\& }{string}, \param{int* }{x}, \param{int* }{y},
+\constfunc{virtual void}{GetTextExtent}{\param{const wxString\& }{string}, \param{int* }{w}, \param{int* }{h},

  \param{int* }{descent = NULL}, \param{int* }{externalLeading = NULL},
  \param{const wxFont* }{font = NULL}, \param{bool}{ use16 = {\tt false}}}
 
  \param{int* }{descent = NULL}, \param{int* }{externalLeading = NULL},
  \param{const wxFont* }{font = NULL}, \param{bool}{ use16 = {\tt false}}}
 

+\constfunc{wxSize}{GetTextExtent}{\param{const wxString\& }{string}}
+

 Gets the dimensions of the string as it would be drawn on the
 window with the currently selected font.
 
 Gets the dimensions of the string as it would be drawn on the
 window with the currently selected font.
 

+The text extent is returned in \arg{w} and \arg{h} pointers (first form) or as a 
+\helpref{wxSize}{wxsize} object (second form).
+

 \wxheading{Parameters}
 
 \docparam{string}{String whose extent is to be measured.}
 
 \wxheading{Parameters}
 
 \docparam{string}{String whose extent is to be measured.}
 

-\docparam{x}{Return value for width.}
+\docparam{w}{Return value for width.}

 
 

-\docparam{y}{Return value for height.}
+\docparam{h}{Return value for height.}

 
 \docparam{descent}{Return value for descent (optional).}
 
 
 \docparam{descent}{Return value for descent (optional).}
 


@@ -1237,17 +1444,6 @@ implements the following methods:\par
  {\tt ( x, y, descent, externalLeading )}.}
 
 
  {\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}
 \membersection{wxWindow::GetToolTip}\label{wxwindowgettooltip}
 
 \constfunc{wxToolTip*}{GetToolTip}{\void}


@@ -1281,7 +1477,10 @@ Returns a pointer to the current validator for the window, or NULL if there is n
 
 \constfunc{wxSize}{GetVirtualSize}{\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}
 
 
 \wxheading{Parameters}
 


@@ -1293,6 +1492,14 @@ This gets the virtual size of the window in pixels.
 \helpref{GetClientSize}{wxwindowgetclientsize}
 
 
 \helpref{GetClientSize}{wxwindowgetclientsize}
 
 

+\membersection{wxWindow::GetWindowBorderSize}\label{wxwindowgetwindowbordersize}
+
+\constfunc{wxSize}{GetWindowBorderSize}{\void}
+
+Returns the size of the left/right and top/bottom borders of this window in x
+and y components of the result respectively.
+
+

 \membersection{wxWindow::GetWindowStyleFlag}\label{wxwindowgetwindowstyleflag}
 
 \constfunc{long}{GetWindowStyleFlag}{\void}
 \membersection{wxWindow::GetWindowStyleFlag}\label{wxwindowgetwindowstyleflag}
 
 \constfunc{long}{GetWindowStyleFlag}{\void}


@@ -1305,10 +1512,17 @@ method. {\bf GetWindowStyle()} is another name for the same function.
 
 \constfunc{wxWindowVariant}{GetWindowVariant}{\void}
 
 
 \constfunc{wxWindowVariant}{GetWindowVariant}{\void}
 

-Returns the value previous passed to 
+Returns the value previously passed to

 \helpref{wxWindow::SetWindowVariant}{wxwindowsetwindowvariant}.
 
 
 \helpref{wxWindow::SetWindowVariant}{wxwindowsetwindowvariant}.
 
 

+\membersection{wxWindow::HandleWindowEvent}\label{wxwindowhandlewindowevent}
+
+\func{bool}{HandleWindowEvent}{\param{wxEvent\& }{event}}
+
+Shorthand for \texttt{\helpref{GetEventHandler}{wxwindowgeteventhandler}()->\helpref{SafelyProcessEvent}{wxevthandlersafelyprocessevent}(event)}.
+
+

 \membersection{wxWindow::HasCapture}\label{wxwindowhascapture}
 
 \constfunc{virtual bool}{HasCapture}{\void}
 \membersection{wxWindow::HasCapture}\label{wxwindowhascapture}
 
 \constfunc{virtual bool}{HasCapture}{\void}


@@ -1317,11 +1531,43 @@ Returns {\tt true} if this window has the current mouse capture.
 
 \wxheading{See also}
 
 
 \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}
 
 
 \helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}
 
 

+\membersection{wxWindow::HasExtraStyle}\label{wxwindowhasextrastyle}
+
+\constfunc{bool}{HasExtraStyle}{\param{int }{exFlag}}
+
+Returns \texttt{true} if the window has the given \arg{exFlag} bit set in its
+extra styles.
+
+\wxheading{See also}
+
+\helpref{SetExtraStyle}{wxwindowsetextrastyle}
+
+
+\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}}
 \membersection{wxWindow::HasScrollbar}\label{wxwindowhasscrollbar}
 
 \constfunc{virtual bool}{HasScrollbar}{\param{int }{orient}}


@@ -1352,6 +1598,20 @@ wxWindow-derived class to ensure that background is painted correctly.
 Equivalent to calling \helpref{Show}{wxwindowshow}({\tt false}).
 
 
 Equivalent to calling \helpref{Show}{wxwindowshow}({\tt false}).
 
 

+\membersection{wxWindow::HideWithEffect}\label{wxwindowhidewitheffect}
+
+\func{virtual bool}{HideWithEffect}{\param{wxShowEffect }{effect}, \param{unsigned }{timeout = $0$}, \param{wxDirection }{dir = wxBOTTOM}}
+
+This function hides a window, like \helpref{Hide()}{wxwindowhide}, but using a
+special visual effect if possible.
+
+The parameters of this function are the same as for 
+\helpref{ShowWithEffect()}{wxwindowshowwitheffect}, please see their
+description there.
+
+\newsince{2.9.0}
+
+

 \membersection{wxWindow::InheritAttributes}\label{wxwindowinheritattributes}
 
 \func{void}{InheritAttributes}{\void}
 \membersection{wxWindow::InheritAttributes}\label{wxwindowinheritattributes}
 
 \func{void}{InheritAttributes}{\void}


@@ -1362,12 +1622,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
 
 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
 \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.
 
 to return \false, the colours will not be changed no matter what and only the
 font might.
 


@@ -1396,11 +1656,30 @@ to the dialog via validators.
 Resets the cached best size value so it will be recalculated the next time it is needed.
 
 
 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}
 
 \membersection{wxWindow::IsEnabled}\label{wxwindowisenabled}
 
 \constfunc{virtual bool}{IsEnabled}{\void}
 

-Returns {\tt true} if the window is enabled for input, {\tt false} otherwise.
+Returns \true if the window is enabled, i.e. if it accepts user input, \false 
+otherwise.
+
+Notice that this method can return \false even if this window itself hadn't
+been explicitly disabled when one of its parent windows is disabled. To get the
+intrinsic status of this window, use 
+\helpref{IsThisEnabled}{wxwindowisthisenabled}

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -1430,6 +1709,18 @@ implements the following methods:\par
 \end{twocollist}}}
 
 
 \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}
 \membersection{wxWindow::IsRetained}\label{wxwindowisretained}
 
 \constfunc{virtual bool}{IsRetained}{\void}


@@ -1441,12 +1732,53 @@ Returns {\tt true} if the window is retained, {\tt false} otherwise.
 Retained windows are only available on X platforms.
 
 
 Retained windows are only available on X platforms.
 
 

+\membersection{wxWindow::IsScrollbarAlwaysShown}\label{wxwindowisscrollbaralwaysshown}
+
+\func{bool}{IsScrollbarAlwaysShown}{\param{int}{ orient}}
+
+Return whether a scrollbar is always shown.
+
+\wxheading{Parameters}
+
+\docparam{orient}{Orientation to check, either {\tt wxHORIZONTAL} or {\tt wxVERTICAL}.}
+
+\wxheading{See also}
+
+\helpref{wxWindow::AlwaysShowScrollbars}{wxwindowalwaysshowscrollbars}
+
+

 \membersection{wxWindow::IsShown}\label{wxwindowisshown}
 
 \constfunc{virtual bool}{IsShown}{\void}
 
 Returns {\tt true} if the window is shown, {\tt false} if it has been hidden.
 
 \membersection{wxWindow::IsShown}\label{wxwindowisshown}
 
 \constfunc{virtual bool}{IsShown}{\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::IsThisEnabled}\label{wxwindowisthisenabled}
+
+\constfunc{bool}{IsThisEnabled}{\void}
+
+Returns \true if this window is intrinsically enabled, \false otherwise, i.e.
+if \helpref{Enable(false)}{wxwindowenable} had been called. This method is
+mostly used for wxWidgets itself, user code should normally use 
+\helpref{IsEnabled}{wxwindowisenabled} instead.
+

 
 \membersection{wxWindow::IsTopLevel}\label{wxwindowistoplevel}
 
 
 \membersection{wxWindow::IsTopLevel}\label{wxwindowistoplevel}
 


@@ -1470,20 +1802,23 @@ layout is on, this function gets called automatically when the window is resized
 
 \membersection{wxWindow::LineDown}\label{wxwindowlinedown}
 
 
 \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}
 
 
 
 \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}
 
 
 
 \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}
 
 
 \membersection{wxWindow::MakeModal}\label{wxwindowmakemodal}


@@ -1522,7 +1857,7 @@ wxWindow::Move function, which is defined in the base wxWindow class
 as the call:
 
 \begin{verbatim}
 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{verbatim}
 
 \wxheading{See also}


@@ -1546,7 +1881,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.
 
 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.
 
 \helpref{MoveBeforeInTabOrder()}{wxwindowmovebeforeintaborder} allow to change
 it after creating all the windows.
 


@@ -1569,33 +1904,75 @@ it.
 
 \func{bool}{Navigate}{\param{int}{ flags = wxNavigationKeyEvent::IsForward}}
 
 
 \func{bool}{Navigate}{\param{int}{ flags = wxNavigationKeyEvent::IsForward}}
 

-Does keyboard navigation from this window to another, by sending
-a wxNavigationKeyEvent.
+Performs a keyboard navigation action starting from this window. This method is
+equivalent to calling \helpref{NavigateIn()}{wxwindownavigatein} method on the
+parent window.

 
 \wxheading{Parameters}
 
 \docparam{flags}{A combination of wxNavigationKeyEvent::IsForward and wxNavigationKeyEvent::WinChange.}
 
 
 \wxheading{Parameters}
 
 \docparam{flags}{A combination of wxNavigationKeyEvent::IsForward and wxNavigationKeyEvent::WinChange.}
 

+\wxheading{Return value}
+
+Returns \true if the focus was moved to another window or \false if nothing
+changed.
+

 \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
 \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.
+and not navigate to the next control. See also \helpref{wxNavigationKeyEvent}{wxnavigationkeyevent}.

 
 

-%% 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)
-%%
-%% \membersection{wxWindow::OnActivate}\label{wxwindowonactivate}
-%%
-%% \func{void}{OnActivate}{\param{wxActivateEvent\&}{ event}}
-%%
-%% Called when a window is activated or deactivated.
-%%
-%% \wxheading{Parameters}
-%%
-%% \docparam{event}{Object containing activation information.}
+
+\membersection{wxWindow::NavigateIn}\label{wxwindownavigatein}
+
+\func{bool}{NavigateIn}{\param{int}{ flags = wxNavigationKeyEvent::IsForward}}
+
+Performs a keyboard navigation action inside this window.
+
+See \helpref{Navigate}{wxwindownavigate} for more information.
+
+
+\membersection{wxWindow::NewControlId}\label{wxwindownewcontrolid}
+
+\func{static wxWindowID}{NewControlId}{\param{int}{ count = 1}}
+
+Create a new ID or range of IDs that are not currently in use.  The
+IDs will be reserved until assigned to a \helpref{wxWindowIDRef}{windowidsoverview}
+or unreserved with \helpref{UnreserveControlId}{wxwindowunreservecontrolid}.
+
+See \helpref{Window IDs overview}{windowidsoverview} for more information.
+
+\wxheading{Parameters}
+
+\docparam{count}{The number of sequential IDs to reserve.}
+
+\wxheading{Return value}
+
+Returns the ID or the first ID of the range, or \texttt{wxID\_NONE} if the
+specified number of identifiers couldn't be allocated.
+
+\wxheading{See also}
+
+\helpref{UnreserveControlId}{wxwindowunreservecontrolid}
+\helpref{wxIdManager}{wxidmanager}
+\helpref{Window IDs overview}{windowidsoverview}
+
+
+%% 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)
+%%
+%% \membersection{wxWindow::OnActivate}\label{wxwindowonactivate}
+%%
+%% \func{void}{OnActivate}{\param{wxActivateEvent\&}{ event}}
+%%
+%% Called when a window is activated or deactivated.
+%%
+%% \wxheading{Parameters}
+%%
+%% \docparam{event}{Object containing activation information.}

 %%
 %% \wxheading{Remarks}
 %%
 %%
 %% \wxheading{Remarks}
 %%


@@ -1807,28 +2184,6 @@ and not navigate to the next control.
 %%
 %% \helpref{wxValidator}{wxvalidator}, \helpref{wxWindow::TransferDataToWindow}{wxwindowtransferdatatowindow}
 %%
 %%
 %% \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}}
 %% \membersection{wxWindow::OnMenuHighlight}\label{wxwindowonmenuhighlight}
 %%
 %% \func{void}{OnMenuHighlight}{\param{wxMenuEvent\& }{event}}


@@ -1856,7 +2211,6 @@ and not navigate to the next control.
 %% \wxheading{See also}
 %%
 %% \helpref{wxMenuEvent}{wxmenuevent},\rtfsp
 %% \wxheading{See also}
 %%
 %% \helpref{wxMenuEvent}{wxmenuevent},\rtfsp

-%% \helpref{wxWindow::OnMenuCommand}{wxwindowonmenucommand},\rtfsp

 %% \helpref{Event handling overview}{eventhandlingoverview}
 %%
 %%
 %% \helpref{Event handling overview}{eventhandlingoverview}
 %%
 %%


@@ -2086,7 +2440,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,
 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.
 
 
 in order to send update events to the window in idle time.
 
 


@@ -2164,7 +2518,6 @@ implements the following methods:\par
 \end{twocollist}}
 }
 
 \end{twocollist}}
 }
 

-

 \membersection{wxWindow::PushEventHandler}\label{wxwindowpusheventhandler}
 
 \func{void}{PushEventHandler}{\param{wxEvtHandler* }{handler}}
 \membersection{wxWindow::PushEventHandler}\label{wxwindowpusheventhandler}
 
 \func{void}{PushEventHandler}{\param{wxEvtHandler* }{handler}}


@@ -2201,17 +2554,24 @@ remove the event handler.
 
 \func{void}{Raise}{\void}
 
 
 \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}
 
 
 
 \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}
 
 
 \wxheading{Parameters}
 


@@ -2228,12 +2588,14 @@ be treated as damaged.}
 
 \membersection{wxWindow::RefreshRect}\label{wxwindowrefreshrect}
 
 
 \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.
 
 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}
 
 
 \membersection{wxWindow::RegisterHotKey}\label{wxwindowregisterhotkey}


@@ -2263,7 +2625,8 @@ hotkey with this modifier/virtualKeyCode combination.
 \wxheading{Remarks}
 
 Use EVT\_HOTKEY(hotkeyId, fnc) in the event table to capture the event.
 \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}
 


@@ -2278,9 +2641,10 @@ Releases mouse input captured with \helpref{wxWindow::CaptureMouse}{wxwindowcapt
 
 \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}
 
 
 \helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}
 
 


@@ -2308,7 +2672,7 @@ not delete) it from it.
 
 \wxheading{Parameters}
 
 
 \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}
 must be present in this windows event handlers chain}
 
 \wxheading{Return value}


@@ -2329,7 +2693,7 @@ handler is supposed to be there).
 
 Reparents the window, i.e the window will be removed from its
 current parent window (e.g. a non-standard toolbar in a wxFrame)
 
 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{Parameters}
 


@@ -2398,9 +2762,7 @@ on top/bottom and nothing was done.
 
 \wxheading{Remarks}
 
 
 \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}
 
 
 \wxheading{See also}
 


@@ -2419,14 +2781,14 @@ Physically scrolls the pixels in the window and move child windows accordingly.
 
 \docparam{dy}{Amount to scroll vertically.}
 
 
 \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}
 
 
 \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::SetAcceleratorTable}\label{wxwindowsetacceleratortable}


@@ -2451,7 +2813,12 @@ See also \helpref{wxAccessible}{wxaccessible}.
 \func{void}{SetAutoLayout}{\param{bool}{ autoLayout}}
 
 Determines whether the \helpref{wxWindow::Layout}{wxwindowlayout} function will
 \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
 \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 +2826,8 @@ size changes.
 
 \wxheading{Parameters}
 
 
 \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}
 
 
 \wxheading{See also}
 


@@ -2474,7 +2841,7 @@ from within wxWindow::OnSize functions.}
 Sets the background colour of the window.
 
 Please see \helpref{InheritAttributes}{wxwindowinheritattributes} for
 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}
 \helpref{SetOwnBackgroundColour}{wxwindowsetownbackgroundcolour}.
 
 \wxheading{Parameters}


@@ -2511,38 +2878,34 @@ applications on the system.
 
 \func{virtual void}{SetBackgroundStyle}{\param{wxBackgroundStyle}{ style}}
 
 
 \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.
+Sets the background style of the window. see 
+\helpref{GetBackgroundStyle()}{wxwindowgetbackgroundstyle} for the description
+of the possible style values.

 
 \wxheading{See also}
 
 \helpref{wxWindow::SetBackgroundColour}{wxwindowsetbackgroundcolour},\rtfsp
 \helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour},\rtfsp
 
 \wxheading{See also}
 
 \helpref{wxWindow::SetBackgroundColour}{wxwindowsetbackgroundcolour},\rtfsp
 \helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour},\rtfsp

-\helpref{wxWindow::GetBackgroundStyle}{wxwindowgetbackgroundstyle}
+\helpref{wxWindow::SetTransparent}{wxwindowsettransparent}

 
 
 
 

-\membersection{wxWindow::SetBestFittingSize}\label{wxwindowsetbestfittingsize}

 
 

-\func{void}{SetBestFittingSize}{\param{const wxSize\& }{size = wxDefaultSize}}
+\membersection{wxWindow::SetCanFocus}\label{wxwindowsetcanfocus}

 
 

-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.
+\func{virtual void}{SetCanFocus}{\param{bool}{ canFocus}}
+
+This method is only implemented by ports which have support for
+native TAB traversal (such as GTK+ 2.0). It is called by wxWidgets'
+container control code to give the native system a hint when
+doing TAB traversal. A call to this does not disable or change
+the effect of programmatically calling 
+\helpref{wxWindow::SetFocus}{wxwindowsetfocus}.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxWindow::SetSize}{wxwindowsetsize},\rtfsp
-\helpref{wxWindow::GetBestSize}{wxwindowgetbestsize},\rtfsp
-\helpref{wxWindow::GetBestFittingSize}{wxwindowgetbestfittingsize},\rtfsp
-\helpref{wxWindow::SetSizeHints}{wxwindowsetsizehints}
+\helpref{wxFocusEvent}{wxfocusevent}
+\helpref{wxPanel::SetFocus}{wxpanelsetfocus}
+\helpref{wxPanel::SetFocusIgnoringChildren}{wxpanelsetfocusignoringchildren}

 
 
 \membersection{wxWindow::SetCaret}\label{wxwindowsetcaret}
 
 
 \membersection{wxWindow::SetCaret}\label{wxwindowsetcaret}


@@ -2580,36 +2943,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}}
 \membersection{wxWindow::SetConstraints}\label{wxwindowsetconstraints}
 
 \func{void}{SetConstraints}{\param{wxLayoutConstraints* }{constraints}}


@@ -2631,66 +2964,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.
 
 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}
 
 
 \wxheading{See also}
 

-\helpref{SetForegroundColour}{wxwindowsetforegroundcolour},\rtfsp
-\helpref{InheritAttributes}{wxwindowinheritattributes}
+\helpref{::wxSetCursor}{wxsetcursor}, \helpref{wxCursor}{wxcursor}

 
 
 \membersection{wxWindow::SetDropTarget}\label{wxwindowsetdroptarget}
 
 
 \membersection{wxWindow::SetDropTarget}\label{wxwindowsetdroptarget}


@@ -2726,9 +3027,9 @@ an application may wish to substitute another, for example to allow
 central implementation of event-handling for a variety of different
 window classes.
 
 central implementation of event-handling for a variety of different
 window classes.
 

-It is usually better to use \helpref{wxWindow::PushEventHandler}{wxwindowpusheventhandler} since
-this sets up a chain of event handlers, where an event not handled by one event handler is
-handed to the next one in the chain.
+It is usually better to use \helpref{wxWindow::PushEventHandler}{wxwindowpusheventhandler}
+since this sets up a chain of event handlers, where an event not handled by
+one event handler is handed to the next one in the chain.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -2761,14 +3062,12 @@ default for the reasons explained in the
 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.}
 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
 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,
 \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,


@@ -2801,7 +3100,7 @@ can be overridden to do something in addition to this in the derived classes.
 
 \membersection{wxWindow::SetFont}\label{wxwindowsetfont}
 
 
 \membersection{wxWindow::SetFont}\label{wxwindowsetfont}
 

-\func{void}{SetFont}{\param{const wxFont\& }{font}}
+\func{bool}{SetFont}{\param{const wxFont\& }{font}}

 
 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,
 
 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,


@@ -2809,11 +3108,22 @@ use \helpref{SetOwnFont}{wxwindowsetownfont} instead in this case and
 see \helpref{InheritAttributes}{wxwindowinheritattributes} for more
 explanations.
 
 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
 {\tt wxNullFont} to reset to the default font.}
 
 \wxheading{Parameters}
 
 \docparam{font}{Font to associate with this window, pass
 {\tt wxNullFont} to reset to the default font.}
 

+\wxheading{Return value}
+
+\true if the want was really changed, \false if it was already set to this 
+\arg{font} and so nothing was done.
+

 \wxheading{See also}
 
 \helpref{wxWindow::GetFont}{wxwindowgetfont},\\
 \wxheading{See also}
 
 \helpref{wxWindow::GetFont}{wxwindowgetfont},\\


@@ -2827,7 +3137,7 @@ explanations.
 Sets the foreground colour of the window.
 
 Please see \helpref{InheritAttributes}{wxwindowinheritattributes} for
 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}
 \helpref{SetOwnForegroundColour}{wxwindowsetownforegroundcolour}.
 
 \wxheading{Parameters}


@@ -2887,6 +3197,36 @@ on creation and should not be modified subsequently.
 
 
 
 
 
 

+\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::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::SetLabel}\label{wxwindowsetlabel}
 
 \func{virtual void}{SetLabel}{\param{const wxString\& }{label}}
 \membersection{wxWindow::SetLabel}\label{wxwindowsetlabel}
 
 \func{virtual void}{SetLabel}{\param{const wxString\& }{label}}


@@ -2902,6 +3242,22 @@ Sets the window's label.
 \helpref{wxWindow::GetLabel}{wxwindowgetlabel}
 
 
 \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}}
 \membersection{wxWindow::SetName}\label{wxwindowsetname}
 
 \func{virtual void}{SetName}{\param{const wxString\& }{name}}


@@ -2917,6 +3273,45 @@ Sets the window's name.
 \helpref{wxWindow::GetName}{wxwindowgetname}
 
 
 \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}}
 \membersection{wxWindow::SetPalette}\label{wxwindowsetpalette}
 
 \func{virtual void}{SetPalette}{\param{wxPalette* }{palette}}


@@ -2972,7 +3367,8 @@ from your \helpref{wxSizeEvent}{wxsizeevent} handler function.
 \wxheading{See also}
 
 \helpref{Scrolling overview}{scrollingoverview},\rtfsp
 \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}
 
 
 \begin{comment}
 


@@ -3084,7 +3480,7 @@ and usually the scrollbar will be automatically hidden.
 
 \func{virtual void}{SetSize}{\param{const wxRect\&}{ rect}}
 
 
 \func{virtual void}{SetSize}{\param{const wxRect\&}{ rect}}
 

-Sets the size and position of the window in pixels.
+Sets the position and size of the window in pixels.

 
 \func{virtual void}{SetSize}{\param{int}{ width}, \param{int}{ height}}
 
 
 \func{virtual void}{SetSize}{\param{int}{ width}, \param{int}{ height}}
 


@@ -3094,16 +3490,16 @@ Sets the size of the window in pixels.
 
 \wxheading{Parameters}
 
 
 \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.}
 
 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.}
 
 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.}
 
 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.}
 value should be used.}
 
 \docparam{size}{\helpref{wxSize}{wxsize} object for setting the size.}


@@ -3112,16 +3508,20 @@ value should be used.}
 
 \docparam{sizeFlags}{Indicates the interpretation of other parameters. It is a bit list of the following:
 
 
 \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.\\
 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
 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.
 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}
 }
 
 \wxheading{Remarks}


@@ -3130,7 +3530,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.
 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}
 by wxWidgets, or that the current value of the dimension should be used.
 
 \wxheading{See also}


@@ -3149,42 +3549,14 @@ implements the following methods:\par
 
 \membersection{wxWindow::SetSizeHints}\label{wxwindowsetsizehints}
 
 
 \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}}
+Use of this function for windows which are not toplevel windows
+(such as wxDialog or wxFrame) is discouraged. Please use 
+\helpref{SetMinSize}{wxwindowsetminsize} and \helpref{SetMaxSize}{wxwindowsetmaxsize}
+instead.

 
 

+\wxheading{See also}

 
 

-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.
+\helpref{wxTopLevelWindow::SetSizeHints}{wxtoplevelwindowsetsizehints}.

 
 
 \membersection{wxWindow::SetSizer}\label{wxwindowsetsizer}
 
 
 \membersection{wxWindow::SetSizer}\label{wxwindowsetsizer}


@@ -3196,7 +3568,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.
 
 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.
 
 \helpref{SetAutoLayout}{wxwindowsetautolayout} implicitly with {\tt true}
 parameter if the {\it sizer}\/ is non-NULL and {\tt false} otherwise.
 


@@ -3205,7 +3577,7 @@ parameter if the {\it sizer}\/ is non-NULL and {\tt false} otherwise.
 \docparam{sizer}{The sizer to set. Pass NULL to disassociate and conditionally delete
 the window's sizer.  See below.}
 
 \docparam{sizer}{The sizer to set. Pass NULL to disassociate and conditionally delete
 the window's sizer.  See below.}
 

-\docparam{deleteOld}{If true (the default), this will delete any prexisting sizer.
+\docparam{deleteOld}{If true (the default), this will delete any pre-existing sizer.

 Pass false if you wish to handle deleting the old sizer yourself.}
 
 \wxheading{Remarks}
 Pass false if you wish to handle deleting the old sizer yourself.}
 
 \wxheading{Remarks}


@@ -3223,23 +3595,11 @@ only the sizer will have effect.
 
 \func{void}{SetSizerAndFit}{\param{wxSizer* }{sizer}, \param{bool }{deleteOld=true}}
 
 
 \func{void}{SetSizerAndFit}{\param{wxSizer* }{sizer}, \param{bool }{deleteOld=true}}
 

-The same as \helpref{SetSizer}{wxwindowsetsizer}, except it also sets the size hints
-for the window based on the sizer's minimum size.
-
-
-\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}
+This method calls \helpref{SetSizer}{wxwindowsetsizer} and then 
+\helpref{wxSizer::SetSizeHints}{wxsizersetsizehints} which sets the initial
+window size to the size needed to accommodate all sizer elements and sets the
+size hints which, if this window is a top level one, prevent the user from
+resizing it to be less than this minimial size.

 
 
 \membersection{wxWindow::SetThemeEnabled}\label{wxwindowsetthemeenabled}
 
 
 \membersection{wxWindow::SetThemeEnabled}\label{wxwindowsetthemeenabled}


@@ -3269,6 +3629,20 @@ See also: \helpref{GetToolTip}{wxwindowgettooltip},
  \helpref{wxToolTip}{wxtooltip}
 
 
  \helpref{wxToolTip}{wxtooltip}
 
 

+\membersection{wxWindow::SetTransparent}\label{wxwindowsettransparent}
+
+\func{bool}{SetTransparent}{\param{wxByte }{alpha}}
+
+Set the transparency of the window. If the system supports transparent windows,
+returns \true, otherwise returns \false and the window remains fully opaque.
+See also \helpref{CanSetTransparent}{wxwindowcansettransparent}.
+
+The parameter \arg{alpha} is in the range $0..255$ where $0$ corresponds to a
+fully transparent window and $255$ to the fully opaque one. The constants
+\texttt{wxIMAGE\_ALPHA\_TRANSPARENT} and \texttt{wxIMAGE\_ALPHA\_OPAQUE} can be
+used.
+
+

 \membersection{wxWindow::SetValidator}\label{wxwindowsetvalidator}
 
 \func{virtual void}{SetValidator}{\param{const wxValidator\&}{ validator}}
 \membersection{wxWindow::SetValidator}\label{wxwindowsetvalidator}
 
 \func{virtual void}{SetValidator}{\param{const wxValidator\&}{ validator}}


@@ -3290,7 +3664,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{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}}
 
 
 \param{const wxSize\&}{ maxSize=wxDefaultSize}}
 
 


@@ -3331,7 +3705,8 @@ Identical to \helpref{SetWindowStyleFlag}{wxwindowsetwindowstyleflag}.
 
 Sets the style of the window. Please note that some styles cannot be changed
 after the window creation and that \helpref{Refresh()}{wxwindowrefresh} might
 
 Sets the style of the window. Please note that some styles cannot be changed
 after the window creation and that \helpref{Refresh()}{wxwindowrefresh} might

-be called after changing the others for the change to take place immediately.
+need to be be called after changing the others for the change to take place
+immediately.

 
 See \helpref{Window styles}{windowstyles} for more information about flags.
 
 
 See \helpref{Window styles}{windowstyles} for more information about flags.
 


@@ -3366,11 +3741,11 @@ be used to change this.
 
 \func{virtual bool}{ShouldInheritColours}{\void}
 
 
 \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.
 
 \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.
 
 
 \helpref{wxControl}{wxcontrol} where it returns \true.
 
 


@@ -3393,18 +3768,78 @@ done because it already was in the requested state.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxWindow::IsShown}{wxwindowisshown}
+\helpref{wxWindow::IsShown}{wxwindowisshown},\rtfsp
+\helpref{wxWindow::Hide}{wxwindowhide},\rtfsp
+\helpref{wxRadioBox::Show}{wxradioboxshow}
+
+
+\membersection{wxWindow::ShowWithEffect}\label{wxwindowshowwitheffect}
+
+\func{virtual bool}{ShowWithEffect}{\param{wxShowEffect }{effect}, \param{unsigned }{timeout = $0$}, \param{wxDirection }{dir = wxBOTTOM}}
+
+This function shows a window, like \helpref{Show()}{wxwindowshow}, but using a
+special visual effect if possible.
+
+Possible values for \arg{effect} are:
+\begin{twocollist}\itemsep=0pt
+\twocolitem{wxSHOW\_EFFECT\_ROLL}{Roll window effect}
+\twocolitem{wxSHOW\_EFFECT\_SLIDE}{Sliding window effect}
+\twocolitem{wxSHOW\_EFFECT\_BLEND}{Fade in or out effect}
+\twocolitem{wxSHOW\_EFFECT\_EXPAND}{Expanding or collapsing effect}
+\end{twocollist}

 
 

+For the roll and slide effects the \arg{dir} parameter specifies the animation
+direction: it can be one of \texttt{wxTOP}, \texttt{wxBOTTOM}, \texttt{wxLEFT} 
+or \texttt{wxRIGHT}. For the other effects, this parameter is unused.
+
+The \arg{timeout} parameter specifies the time of the animation, in
+milliseconds. If the default value of $0$ is used, the default animation time
+for the current platform is used.
+
+Currently this function is only implemented in wxMSW and does the same thing as
+Show() in the other ports.
+
+\newsince{2.9.0}
+
+\wxheading{See also}
+
+\helpref{HideWithEffect}{wxwindowhidewitheffect}

 
 
 \membersection{wxWindow::Thaw}\label{wxwindowthaw}
 
 \func{virtual void}{Thaw}{\void}
 
 
 
 \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}.
 
 \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::ToggleWindowStyle}\label{wxwindowtogglewindowstyle}
+
+\func{bool}{ToggleWindowStyle}{\param{int }{flag}}
+
+Turns the given \arg{flag} on if it's currently turned off and vice versa.
+This function cannot be used if the value of the flag is $0$ (which is often
+the case for default flags).
+
+Also, please notice that not all styles can be changed after the control
+creation.
+
+\wxheading{Return value}
+
+Returns \true if the style was turned on by this function, \false if it was
+switched off.
+
+\wxheading{See also}
+
+\helpref{wxWindow::SetWindowStyleFlag}{wxwindowsetwindowstyleflag},\rtfsp
+\helpref{wxWindow::HasFlag}{wxwindowhasflag}
+

 
 \membersection{wxWindow::TransferDataFromWindow}\label{wxwindowtransferdatafromwindow}
 
 
 \membersection{wxWindow::TransferDataFromWindow}\label{wxwindowtransferdatafromwindow}
 


@@ -3463,17 +3898,37 @@ This function is currently only implemented under MSW.
 
 \helpref{wxWindow::RegisterHotKey}{wxwindowregisterhotkey}
 
 
 \helpref{wxWindow::RegisterHotKey}{wxwindowregisterhotkey}
 

+\membersection{wxWindow::UnreserveControlId}\label{wxwindowunreservecontrolid}
+
+\func{static void}{UnreserveControlId}{\param{wxWindowID}{ id}, \param{int}{ count = 1}}
+
+Unreserve an ID or range of IDs that was reserved by \helpref{NewControlId}{wxwindownewcontrolid}.
+
+See \helpref{Window IDs overview}{windowidsoverview} for more information.
+
+\wxheading{Parameters}
+
+\docparam{id}{The starting ID of the range of IDs to unreserve.}
+
+\docparam{count}{The number of sequential IDs to unreserve.}
+
+\wxheading{See also}
+
+\helpref{NewControlId}{wxwindownewcontrolid}
+\helpref{wxIdManager}{wxidmanager}
+\helpref{Window IDs overview}{windowidsoverview}

 
 \membersection{wxWindow::Update}\label{wxwindowupdate}
 
 \func{virtual void}{Update}{\void}
 
 
 \membersection{wxWindow::Update}\label{wxwindowupdate}
 
 \func{virtual void}{Update}{\void}
 

-Calling this method immediately repaints the invalidated area of the window
-while this would usually only happen when the flow of control returns to the
-event loop. Notice that this function doesn't refresh the window and does
-nothing if the window hadn't been already repainted. Use 
-\helpref{Refresh}{wxwindowrefresh} first if you want to immediately redraw the
-window unconditionally.
+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}
 
 
 \membersection{wxWindow::UpdateWindowUI}\label{wxwindowupdatewindowui}


@@ -3486,8 +3941,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
 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.
 
 \helpref{wxUpdateUIEvent::SetUpdateInterval}{wxupdateuieventsetupdateinterval} to
 limit the overhead that wxWidgets incurs by sending update UI events in idle time.
 


@@ -3520,8 +3975,8 @@ void MyWindow::OnInternalIdle()
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxUpdateUIEvent}{wxupdateuievent}, 
-\helpref{wxWindow::DoUpdateWindowUI}{wxwindowdoupdatewindowui}, 
+\helpref{wxUpdateUIEvent}{wxupdateuievent},
+\helpref{wxWindow::DoUpdateWindowUI}{wxwindowdoupdatewindowui},

 \helpref{wxWindow::OnInternalIdle}{wxwindowoninternalidle}
 
 
 \helpref{wxWindow::OnInternalIdle}{wxwindowoninternalidle}