define _HPUX_SOURCE under HP-UX, otherwise many things are not defined in standard...

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

diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex
index 08564bb8ff268938024ff8b1a4b4d55f153f42e8..322ca2ae90796cdea4f6c9279d9b92d578dfae69 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


@@ -55,10 +66,9 @@ use this style in order to get the arrows or etc., but would still like to have
 normal keyboard navigation take place, you should create and send a
 wxNavigationKeyEvent in response to the key events for Tab and
 Shift-Tab.}
 normal keyboard navigation take place, you should create and send a
 wxNavigationKeyEvent in response to the key events for Tab and
 Shift-Tab.}

-\twocolitem{\windowstyle{wxNO\_FULL\_REPAINT\_ON\_RESIZE}}{Disables repainting
-the window completely when its size is changed - you will have to repaint the
-new window area manually if you use this style. Currently only has an effect for
-Windows.}
+\twocolitem{\windowstyle{wxNO\_FULL\_REPAINT\_ON\_RESIZE}}{On Windows, this style used to disable repainting
+the window completely when its size is changed. Since this behaviour is now the default, the style is now obsolete
+and no longer has an effect.}

 \twocolitem{\windowstyle{wxVSCROLL}}{Use this style to enable a vertical scrollbar.}
 \twocolitem{\windowstyle{wxHSCROLL}}{Use this style to enable a horizontal scrollbar.}
 \twocolitem{\windowstyle{wxALWAYS\_SHOW\_SB}}{If a window has scrollbars,
 \twocolitem{\windowstyle{wxVSCROLL}}{Use this style to enable a vertical scrollbar.}
 \twocolitem{\windowstyle{wxHSCROLL}}{Use this style to enable a horizontal scrollbar.}
 \twocolitem{\windowstyle{wxALWAYS\_SHOW\_SB}}{If a window has scrollbars,


@@ -72,7 +82,9 @@ repainted, then children being painted over them. Windows only.}
 a complete redraw of the window whenever it is resized instead of redrawing
 just the part of the window affected by resizing. Note that this was the
 behaviour by default before 2.5.1 release and that if you experience redraw
 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}.


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

+\membersection{wxWindow::CacheBestSize}\label{wxwindowcachebestsize}
+
+\constfunc{void}{CacheBestSize}{\param{const wxSize\& }{size}}
+
+Sets the cached best size value.
+
+

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


@@ -346,7 +365,7 @@ implementation of wxDialog::OnCloseWindow does not necessarily delete the
 dialog, since it will simply simulate an wxID\_CANCEL event which is handled by
 the appropriate button event handler and may do anything at all.
 
 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}


@@ -470,12 +489,21 @@ Returns {\tt true} if the window has been disabled, {\tt false} if it had been
 already disabled before the call to this function.
 
 
 already disabled before the call to this function.
 
 

+\membersection{wxWindow::DoGetBestSize}\label{wxwindowdogetbestsize}
+
+\constfunc{virtual wxSize}{DoGetBestSize}{\void}
+
+Gets the size which best suits the window: for a control, it would be
+the minimal size which doesn't truncate the control, for a panel - the
+same size as it would have after a call to \helpref{Fit()}{wxwindowfit}.
+
+

 \membersection{wxWindow::DoUpdateWindowUI}\label{wxwindowdoupdatewindowui}
 
 \func{virtual void}{DoUpdateWindowUI}{\param{wxUpdateUIEvent\&}{ event}}
 
 Does the window-specific updating after processing the update event.
 \membersection{wxWindow::DoUpdateWindowUI}\label{wxwindowdoupdatewindowui}
 
 \func{virtual void}{DoUpdateWindowUI}{\param{wxUpdateUIEvent\&}{ event}}
 
 Does the window-specific updating after processing the update event.

-This function is called by \helpref{wxWindow::UpdateWindowUI}{wxwindowupdatewindowui} 
+This function is called by \helpref{wxWindow::UpdateWindowUI}{wxwindowupdatewindowui}

 in order to check return values in the \helpref{wxUpdateUIEvent}{wxupdateuievent} and
 act appropriately. For example, to allow frame and dialog title updating, wxWidgets
 implements this function as follows:
 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:


@@ -486,7 +514,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() )


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


@@ -554,11 +583,11 @@ Note that this is a static function, so it can be called without needing a wxWin
 
 \membersection{wxWindow::FindWindow}\label{wxwindowfindwindow}
 
 
 \membersection{wxWindow::FindWindow}\label{wxwindowfindwindow}
 

-\func{wxWindow*}{FindWindow}{\param{long}{ id}}
+\constfunc{wxWindow*}{FindWindow}{\param{long}{ id}}

 
 Find a child of this window, by identifier.
 
 
 Find a child of this window, by identifier.
 

-\func{wxWindow*}{FindWindow}{\param{const wxString\&}{ name}}
+\constfunc{wxWindow*}{FindWindow}{\param{const wxString\&}{ name}}

 
 Find a child of this window, by name.
 
 
 Find a child of this window, by name.
 


@@ -595,7 +624,7 @@ If {\it parent} is NULL, the search will start from all top-level
 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
 The search is recursive in both cases.
 
 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
 The search is recursive in both cases.
 

-If no window with such name is found, 
+If no window with such name is found,

 \helpref{FindWindowByLabel}{wxwindowfindwindowbylabel} is called.
 
 \wxheading{See also}
 \helpref{FindWindowByLabel}{wxwindowfindwindowbylabel} is called.
 
 \wxheading{See also}


@@ -655,8 +684,8 @@ be called to reenable window redrawing. Calls to these two functions may be
 nested.
 
 This method is useful for visual appearance optimization (for example, it
 nested.
 
 This method is useful for visual appearance optimization (for example, it

-is a good idea to use it before inserting large amount of text into a
-wxTextCtrl under wxGTK) but is not implemented on all platforms nor for all
+is a good idea to use it before doing many large text insertions in a row into
+a wxTextCtrl under wxGTK) but is not implemented on all platforms nor for all

 controls so it is mostly just a hint to wxWidgets and not a mandatory
 directive.
 
 controls so it is mostly just a hint to wxWidgets and not a mandatory
 directive.
 


@@ -758,9 +787,9 @@ 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{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}
 
 
 \helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}
 
 


@@ -797,7 +826,7 @@ system, especially if it uses themes.
 
 The \arg{variant} parameter is only relevant under Mac currently and is
 ignore under other platforms. Under Mac, it will change the size of the
 
 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,


@@ -805,7 +834,7 @@ for example, \helpref{wxButton}{wxbutton}::GetClassDefaultAttributes() will typi
 return the values appropriate for a button which will be normally different
 from those returned by, say, \helpref{wxListCtrl}{wxlistctrl}::GetClassDefaultAttributes().
 
 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


@@ -880,7 +909,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


@@ -972,7 +1001,7 @@ Returns the grandparent of a window, or NULL if there isn't one.
 \constfunc{void*}{GetHandle}{\void}
 
 Returns the platform-specific handle of the physical window. Cast it to an appropriate
 \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.}
 
 
 \pythonnote{This method will return an integer in wxPython.}
 


@@ -1103,17 +1132,6 @@ method:\par
 Returns the size and position of the window as a \helpref{wxRect}{wxrect} object.
 
 
 Returns the size and position of the window as a \helpref{wxRect}{wxrect} object.
 
 

-\membersection{wxWindow::GetScrollThumb}\label{wxwindowgetscrollthumb}
-
-\func{virtual int}{GetScrollThumb}{\param{int }{orientation}}
-
-Returns the built-in scrollbar thumb size.
-
-\wxheading{See also}
-
-\helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar}
-
-

 \membersection{wxWindow::GetScrollPos}\label{wxwindowgetscrollpos}
 
 \func{virtual int}{GetScrollPos}{\param{int }{orientation}}
 \membersection{wxWindow::GetScrollPos}\label{wxwindowgetscrollpos}
 
 \func{virtual int}{GetScrollPos}{\param{int }{orientation}}


@@ -1136,6 +1154,17 @@ Returns the built-in scrollbar range.
 \helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar}
 
 
 \helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar}
 
 

+\membersection{wxWindow::GetScrollThumb}\label{wxwindowgetscrollthumb}
+
+\func{virtual int}{GetScrollThumb}{\param{int }{orientation}}
+
+Returns the built-in scrollbar thumb size.
+
+\wxheading{See also}
+
+\helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar}
+
+

 \membersection{wxWindow::GetSize}\label{wxwindowgetsize}
 
 \constfunc{void}{GetSize}{\param{int* }{width}, \param{int* }{height}}
 \membersection{wxWindow::GetSize}\label{wxwindowgetsize}
 
 \constfunc{void}{GetSize}{\param{int* }{width}, \param{int* }{height}}


@@ -1265,7 +1294,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}
 


@@ -1289,7 +1321,7 @@ 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}.
 
 


@@ -1297,15 +1329,38 @@ Returns the value previous passed to
 
 \constfunc{virtual bool}{HasCapture}{\void}
 
 
 \constfunc{virtual bool}{HasCapture}{\void}
 

-Returns true if this window has the current mouse capture.
+Returns {\tt true} if this window has the current mouse capture.

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

-\helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse}, 
-\helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse}, 
+\helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse},
+\helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse},

 \helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}
 
 
 \helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}
 
 

+\membersection{wxWindow::HasScrollbar}\label{wxwindowhasscrollbar}
+
+\constfunc{virtual bool}{HasScrollbar}{\param{int }{orient}}
+
+Returns {\tt true} if this window has a scroll bar for this orientation.
+
+\wxheading{Parameters}
+
+\docparam{orient}{Orientation to check, either {\tt wxHORIZONTAL} or {\tt wxVERTICAL}.}
+
+
+\membersection{wxWindow::HasTransparentBackground}\label{wxwindowhastransparentbackground}
+
+\constfunc{virtual bool}{HasTransparentBackground}{\void}
+
+Returns \true if this window background is transparent (as, for example, for
+wxStaticText) and should show the parent window background.
+
+This method is mostly used internally by the library itself and you normally
+shouldn't have to call it. You may, however, have to override it in your
+wxWindow-derived class to ensure that background is painted correctly.
+
+

 \membersection{wxWindow::Hide}\label{wxwindowhide}
 
 \func{bool}{Hide}{\void}
 \membersection{wxWindow::Hide}\label{wxwindowhide}
 
 \func{bool}{Hide}{\void}


@@ -1323,12 +1378,12 @@ the font and the foreground and background colours.
 
 By ``intelligently'' the following is meant: by default, all windows use their
 own \helpref{default}{wxwindowgetclassdefaultattributes} attributes. However
 
 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.
 


@@ -1350,6 +1405,13 @@ Sends an {\tt wxEVT\_INIT\_DIALOG} event, whose handler usually transfers data
 to the dialog via validators.
 
 
 to the dialog via validators.
 
 

+\membersection{wxWindow::InvalidateBestSize}\label{wxwindowinvalidatebestsize}
+
+\func{void}{InvalidateBestSize}{\void}
+
+Resets the cached best size value so it will be recalculated the next time it is needed.
+
+

 \membersection{wxWindow::IsEnabled}\label{wxwindowisenabled}
 
 \constfunc{virtual bool}{IsEnabled}{\void}
 \membersection{wxWindow::IsEnabled}\label{wxwindowisenabled}
 
 \constfunc{virtual bool}{IsEnabled}{\void}


@@ -1424,20 +1486,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.
+
+\wxheading{See also}
+
+\helpref{Raise}{wxwindowraise}

 
 
 \membersection{wxWindow::MakeModal}\label{wxwindowmakemodal}
 
 
 \membersection{wxWindow::MakeModal}\label{wxwindowmakemodal}


@@ -1500,7 +1565,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.
 


@@ -2040,7 +2105,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.
 
 


@@ -2155,17 +2220,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.
+
+In current version of wxWidgets this works both for manage 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}
 


@@ -2182,12 +2254,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}


@@ -2217,7 +2291,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}
 


@@ -2232,9 +2307,9 @@ 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{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}
 
 
 \helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}
 
 


@@ -2405,8 +2480,8 @@ 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 
-\helpref{wxWindow::SetSizer}{wxwindowsetsizer} but if you use 
+be called automatically when the window is resized. It is called implicitly by
+\helpref{wxWindow::SetSizer}{wxwindowsetsizer} but if you use

 \helpref{wxWindow::SetConstraints}{wxwindowsetconstraints} you should call it
 manually or otherwise the window layout won't be correctly updated when its
 size changes.
 \helpref{wxWindow::SetConstraints}{wxwindowsetconstraints} you should call it
 manually or otherwise the window layout won't be correctly updated when its
 size changes.


@@ -2428,7 +2503,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}


@@ -2585,6 +2660,13 @@ 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}}
 \membersection{wxWindow::SetMaxSize}\label{wxwindowsetmaxsize}
 
 \func{void}{SetMaxSize}{\param{const wxSize\& }{size}}


@@ -2616,7 +2698,7 @@ by the children of this window.
 
 \membersection{wxWindow::SetOwnFont}\label{wxwindowsetownfont}
 
 
 \membersection{wxWindow::SetOwnFont}\label{wxwindowsetownfont}
 

-\func{void}{SetOwnBackgroundColour}{\param{const wxColour\& }{colour}}
+\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.
 
 Sets the font of the window but prevents it from being inherited by the
 children of this window.


@@ -2732,6 +2814,8 @@ This sets the window to receive keyboard input.
 \wxheading{See also}
 
 \helpref{wxFocusEvent}{wxfocusevent}
 \wxheading{See also}
 
 \helpref{wxFocusEvent}{wxfocusevent}

+\helpref{wxPanel::SetFocus}{wxpanelsetfocus}
+\helpref{wxPanel::SetFocusIgnoringChildren}{wxpanelsetfocusignoringchildren}

 
 
 \membersection{wxWindow::SetFocusFromKbd}\label{wxwindowsetfocusfromkbd}
 
 
 \membersection{wxWindow::SetFocusFromKbd}\label{wxwindowsetfocusfromkbd}


@@ -2772,7 +2856,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}


@@ -2832,6 +2916,21 @@ on creation and should not be modified subsequently.
 
 
 
 
 
 

+\membersection{wxWindow::SetLabel}\label{wxwindowsetlabel}
+
+\func{virtual void}{SetLabel}{\param{const wxString\& }{label}}
+
+Sets the window's label.
+
+\wxheading{Parameters}
+
+\docparam{label}{The window label.}
+
+\wxheading{See also}
+
+\helpref{wxWindow::GetLabel}{wxwindowgetlabel}
+
+

 \membersection{wxWindow::SetName}\label{wxwindowsetname}
 
 \func{virtual void}{SetName}{\param{const wxString\& }{name}}
 \membersection{wxWindow::SetName}\label{wxwindowsetname}
 
 \func{virtual void}{SetName}{\param{const wxString\& }{name}}


@@ -2940,8 +3039,8 @@ handling of pages and ranges.
 \wxheading{See also}
 
 \helpref{wxWindow::SetScrollPos}{wxwindowsetscrollpos},\rtfsp
 \wxheading{See also}
 
 \helpref{wxWindow::SetScrollPos}{wxwindowsetscrollpos},\rtfsp

-\helpref{wxWindow::GetScrollPos}{wxwindowsetscrollpos},\rtfsp
-\helpref{wxWindow::GetScrollPage}{wxwindowsetscrollpage},\rtfsp
+\helpref{wxWindow::GetScrollPos}{wxwindowgetscrollpos},\rtfsp
+\helpref{wxWindow::GetScrollPage}{wxwindowgetscrollpage},\rtfsp

 \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow}
 \end{comment}
 
 \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow}
 \end{comment}
 


@@ -2968,7 +3067,7 @@ application to take note of scrollbar attributes and redraw contents accordingly
 \wxheading{See also}
 
 \helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar},\rtfsp
 \wxheading{See also}
 
 \helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar},\rtfsp

-\helpref{wxWindow::GetScrollPos}{wxwindowsetscrollpos},\rtfsp
+\helpref{wxWindow::GetScrollPos}{wxwindowgetscrollpos},\rtfsp

 \helpref{wxWindow::GetScrollThumb}{wxwindowgetscrollthumb},\rtfsp
 \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow}
 
 \helpref{wxWindow::GetScrollThumb}{wxwindowgetscrollthumb},\rtfsp
 \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow}
 


@@ -3001,8 +3100,8 @@ and usually the scrollbar will be automatically hidden.
 
 \helpref{wxWindow::SetScrollPos}{wxwindowsetscrollpos},\rtfsp
 \helpref{wxWindow::SetScrollPage}{wxwindowsetscrollpage},\rtfsp
 
 \helpref{wxWindow::SetScrollPos}{wxwindowsetscrollpos},\rtfsp
 \helpref{wxWindow::SetScrollPage}{wxwindowsetscrollpage},\rtfsp

-\helpref{wxWindow::GetScrollPos}{wxwindowsetscrollpos},\rtfsp
-\helpref{wxWindow::GetScrollPage}{wxwindowsetscrollpage},\rtfsp
+\helpref{wxWindow::GetScrollPos}{wxwindowgetscrollpos},\rtfsp
+\helpref{wxWindow::GetScrollPage}{wxwindowgetscrollpage},\rtfsp

 \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow}
 \end{comment}
 
 \helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow}
 \end{comment}
 


@@ -3042,16 +3141,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
+{\bf wxSIZE\_AUTO\_WIDTH}: a $-1$ width value is taken to indicate

 a wxWidgets-supplied default width.\\
 a wxWidgets-supplied default width.\\

-{\bf wxSIZE\_AUTO\_HEIGHT}: a -1 height value is taken to indicate
+{\bf wxSIZE\_AUTO\_HEIGHT}: a $-1$ height value is taken to indicate

 a wxWidgets-supplied default width.\\
 {\bf wxSIZE\_AUTO}: -1 size values are taken to indicate
 a wxWidgets-supplied default size.\\
 {\bf wxSIZE\_USE\_EXISTING}: existing dimensions should be used
 if -1 values are supplied.\\
 a wxWidgets-supplied default width.\\
 {\bf wxSIZE\_AUTO}: -1 size values are taken to indicate
 a wxWidgets-supplied default size.\\
 {\bf wxSIZE\_USE\_EXISTING}: existing dimensions should be used
 if -1 values are supplied.\\

-{\bf wxSIZE\_ALLOW\_MINUS\_ONE}: allow dimensions of -1 and less to be interpreted
+{\bf wxSIZE\_ALLOW\_MINUS\_ONE}: allow dimensions of $-1$ and less 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}


@@ -3079,7 +3182,7 @@ 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},
+\func{virtual void}{SetSizeHints}{\param{int}{ minW}, \param{int}{ minH}, \param{int}{ maxW=-1}, \param{int}{ maxH=-1},

  \param{int}{ incW=-1}, \param{int}{ incH=-1}}
 
 \func{void}{SetSizeHints}{\param{const wxSize\&}{ minSize},
  \param{int}{ incW=-1}, \param{int}{ incH=-1}}
 
 \func{void}{SetSizeHints}{\param{const wxSize\&}{ minSize},


@@ -3126,7 +3229,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.
 


@@ -3220,7 +3323,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}}
 
 


@@ -3296,11 +3399,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.
 
 


@@ -3323,15 +3426,16 @@ 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::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}.
 


@@ -3398,12 +3502,12 @@ This function is currently only implemented under MSW.
 
 \func{virtual void}{Update}{\void}
 
 
 \func{virtual void}{Update}{\void}
 

-Calling this method immediately repaints the invalidated area of the window
-while this would usually only happen when the flow of control returns to the
-event loop. Notice that this function doesn't refresh the window and does
-nothing if the window hadn't been already repainted. Use 
-\helpref{Refresh}{wxwindowrefresh} first if you want to immediately redraw the
-window unconditionally.
+Calling this method immediately repaints the invalidated area of the window and
+all of its children recursively while this would usually only happen when the
+flow of control returns to the event loop. Notice that this function doesn't
+refresh the window and does nothing if the window hadn't been already
+repainted. Use \helpref{Refresh}{wxwindowrefresh} first if you want to
+immediately redraw the window unconditionally.

 
 
 \membersection{wxWindow::UpdateWindowUI}\label{wxwindowupdatewindowui}
 
 
 \membersection{wxWindow::UpdateWindowUI}\label{wxwindowupdatewindowui}


@@ -3416,8 +3520,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.
 


@@ -3450,8 +3554,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}
 
 


@@ -3471,7 +3575,7 @@ Returns {\tt false} if any of the validations failed.
 \wxheading{See also}
 
 \helpref{wxWindow::TransferDataFromWindow}{wxwindowtransferdatafromwindow},\rtfsp
 \wxheading{See also}
 
 \helpref{wxWindow::TransferDataFromWindow}{wxwindowtransferdatafromwindow},\rtfsp

-\helpref{wxWindow::TransferDataFromWindow}{wxwindowtransferdatafromwindow},\rtfsp
+\helpref{wxWindow::TransferDataToWindow}{wxwindowtransferdatatowindow},\rtfsp

 \helpref{wxValidator}{wxvalidator}
 
 
 \helpref{wxValidator}{wxvalidator}