whilst -> while

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

diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex
index eb5af0361b7f1e2715c7801a5288a3156c19f160..62a3be878a4e844fc80949c221fb1c42e3908b29 100644 (file)
--- a/docs/latex/wx/window.tex
+++ b/docs/latex/wx/window.tex
@@ -142,7 +142,7 @@ correctly sized. }
 \docparam{name}{Window name.}
 
 
 \docparam{name}{Window name.}
 
 

-\membersection{wxWindow::\destruct{wxWindow}}
+\membersection{wxWindow::\destruct{wxWindow}}\label{wxwindowdtor}

 
 \func{}{\destruct{wxWindow}}{\void}
 
 
 \func{}{\destruct{wxWindow}}{\void}
 


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

-\membersection{wxWindow::AddChild}
+\membersection{wxWindow::AddChild}\label{wxwindowaddchild}

 
 \func{virtual void}{AddChild}{\param{wxWindow* }{child}}
 
 
 \func{virtual void}{AddChild}{\param{wxWindow* }{child}}
 


@@ -173,6 +173,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}


@@ -287,7 +294,7 @@ Clears the window by filling it with the current background colour. Does not
 cause an erase background event to be generated.
 
 
 cause an erase background event to be generated.
 
 

-\membersection{wxWindow::ClientToScreen}
+\membersection{wxWindow::ClientToScreen}\label{wxwindowclienttoscreen}

 
 \constfunc{virtual void}{ClientToScreen}{\param{int* }{x}, \param{int* }{y}}
 
 
 \constfunc{virtual void}{ClientToScreen}{\param{int* }{x}, \param{int* }{y}}
 


@@ -426,7 +433,7 @@ Dialog units are used for maintaining a dialog's proportions even if the font ch
 
 \helpref{wxWindow::ConvertDialogToPixels}{wxwindowconvertdialogtopixels}
 
 
 \helpref{wxWindow::ConvertDialogToPixels}{wxwindowconvertdialogtopixels}
 

-\pythonnote{In place of a single overloaded method name, wxPythonimplements the following methods:\par
+\pythonnote{In place of a single overloaded method name, wxPython implements the following methods:\par

 \indented{2cm}{\begin{twocollist}
 \twocolitem{{\bf ConvertDialogPointToPixels(point)}}{Accepts and returns a wxPoint}
 \twocolitem{{\bf ConvertDialogSizeToPixels(size)}}{Accepts and returns a wxSize}
 \indented{2cm}{\begin{twocollist}
 \twocolitem{{\bf ConvertDialogPointToPixels(point)}}{Accepts and returns a wxPoint}
 \twocolitem{{\bf ConvertDialogSizeToPixels(size)}}{Accepts and returns a wxSize}


@@ -451,7 +458,7 @@ windows.
 to the list of windows pending real deletion.
 
 
 to the list of windows pending real deletion.
 
 

-\membersection{wxWindow::DestroyChildren}
+\membersection{wxWindow::DestroyChildren}\label{wxwindowdestroychildren}

 
 \func{virtual void}{DestroyChildren}{\void}
 
 
 \func{virtual void}{DestroyChildren}{\void}
 


@@ -470,6 +477,15 @@ 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}}
 \membersection{wxWindow::DoUpdateWindowUI}\label{wxwindowdoupdatewindowui}
 
 \func{virtual void}{DoUpdateWindowUI}{\param{wxUpdateUIEvent\&}{ event}}


@@ -655,8 +671,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.
 


@@ -670,7 +686,7 @@ Gets the accelerator table for this window. See \helpref{wxAcceleratorTable}{wxa
 
 \membersection{wxWindow::GetAccessible}\label{wxwindowgetaccessible}
 
 
 \membersection{wxWindow::GetAccessible}\label{wxwindowgetaccessible}
 

-\func{wxAccessibile*}{GetAccessible}{\void}
+\func{wxAccessible*}{GetAccessible}{\void}

 
 Returns the accessible object for this window, if any.
 
 
 Returns the accessible object for this window, if any.
 


@@ -764,28 +780,28 @@ Returns the currently captured window.
 \helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}
 
 
 \helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent}
 
 

-\membersection{wxWindow::GetCharHeight}
+\membersection{wxWindow::GetCharHeight}\label{wxwindowgetcharheight}

 
 \constfunc{virtual int}{GetCharHeight}{\void}
 
 Returns the character height for this window.
 
 
 
 \constfunc{virtual int}{GetCharHeight}{\void}
 
 Returns the character height for this window.
 
 

-\membersection{wxWindow::GetCharWidth}
+\membersection{wxWindow::GetCharWidth}\label{wxwindowgetcharwidth}

 
 \constfunc{virtual int}{GetCharWidth}{\void}
 
 Returns the average character width for this window.
 
 
 
 \constfunc{virtual int}{GetCharWidth}{\void}
 
 Returns the average character width for this window.
 
 

-\membersection{wxWindow::GetChildren}
+\membersection{wxWindow::GetChildren}\label{wxwindowgetchildren}

 
 \func{wxList\&}{GetChildren}{\void}
 
 Returns a reference to the list of the window's children.
 
 
 
 \func{wxList\&}{GetChildren}{\void}
 
 Returns a reference to the list of the window's children.
 
 

-\membersection{wxControl::GetClassDefaultAttributes}\label{wxwindowgetclassdefaultattributes}
+\membersection{wxWindow::GetClassDefaultAttributes}\label{wxwindowgetclassdefaultattributes}

 
 \func{static wxVisualAttributes}{GetClassDefaultAttributes}{\param{wxWindowVariant}{ variant = \texttt{wxWINDOW\_VARIANT\_NORMAL}}}
 
 
 \func{static wxVisualAttributes}{GetClassDefaultAttributes}{\param{wxWindowVariant}{ variant = \texttt{wxWINDOW\_VARIANT\_NORMAL}}}
 


@@ -876,7 +892,7 @@ Return the cursor associated with this window.
 \helpref{wxWindow::SetCursor}{wxwindowsetcursor}
 
 
 \helpref{wxWindow::SetCursor}{wxwindowsetcursor}
 
 

-\membersection{wxControl::GetDefaultAttributes}\label{wxwindowgetdefaultattributes}
+\membersection{wxWindow::GetDefaultAttributes}\label{wxwindowgetdefaultattributes}

 
 \constfunc{virtual wxVisualAttributes}{GetDefaultAttributes}{\void}
 
 
 \constfunc{virtual wxVisualAttributes}{GetDefaultAttributes}{\void}
 


@@ -960,7 +976,7 @@ be used at all.
 \helpref{wxWindow::GetBackgroundColour}{wxwindowgetbackgroundcolour}
 
 
 \helpref{wxWindow::GetBackgroundColour}{wxwindowgetbackgroundcolour}
 
 

-\membersection{wxWindow::GetGrandParent}
+\membersection{wxWindow::GetGrandParent}\label{wxwindowgetgrandparent}

 
 \constfunc{wxWindow*}{GetGrandParent}{\void}
 
 
 \constfunc{wxWindow*}{GetGrandParent}{\void}
 


@@ -1010,7 +1026,7 @@ Each window has an integer identifier. If the application has not provided one
 \helpref{Window identifiers}{windowids}
 
 
 \helpref{Window identifiers}{windowids}
 
 

-\membersection{wxWindow::GetLabel}
+\membersection{wxWindow::GetLabel}\label{wxwindowgetlabel}

 
 \constfunc{virtual wxString }{GetLabel}{\void}
 
 
 \constfunc{virtual wxString }{GetLabel}{\void}
 


@@ -1025,6 +1041,19 @@ the button text. This function can be useful for meta-programs (such as testing
 tools or special-needs access programs) which need to identify windows
 by name.
 
 tools or special-needs access programs) which need to identify windows
 by name.
 

+\membersection{wxWindow::GetMaxSize}\label{wxwindowgetmaxsize}
+
+\constfunc{wxSize}{GetMaxSize}{\void}
+
+Returns the maximum size of the window, an indication to the sizer layout mechanism
+that this is the maximum possible size.
+
+\membersection{wxWindow::GetMinSize}\label{wxwindowgetminsize}
+
+\constfunc{wxSize}{GetMinSize}{\void}
+
+Returns the minimum size of the window, an indication to the sizer layout mechanism
+that this is the minimum required size.

 
 \membersection{wxWindow::GetName}\label{wxwindowgetname}
 
 
 \membersection{wxWindow::GetName}\label{wxwindowgetname}
 


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

-\membersection{wxWindow::GetParent}
+\membersection{wxWindow::GetParent}\label{wxwindowgetparent}

 
 \constfunc{virtual wxWindow*}{GetParent}{\void}
 
 
 \constfunc{virtual wxWindow*}{GetParent}{\void}
 


@@ -1090,17 +1119,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}}


@@ -1123,6 +1141,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}}


@@ -1284,7 +1313,7 @@ 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}
 


@@ -1293,6 +1322,18 @@ Returns true if this window has the current mouse capture.
 \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::Hide}\label{wxwindowhide}
 
 \func{bool}{Hide}{\void}
 \membersection{wxWindow::Hide}\label{wxwindowhide}
 
 \func{bool}{Hide}{\void}


@@ -1319,8 +1360,8 @@ 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.
 

-This rather complicated logic is necessary in order to accomodate the
-different usage scenarius. The most common one is when all default attributes
+This rather complicated logic is necessary in order to accommodate the
+different usage scenarios. The most common one is when all default attributes

 are used and in this case, nothing should be inherited as in modern GUIs
 different controls use different fonts (and colours) than their siblings so
 they can't inherit the same value from the parent. However it was also deemed
 are used and in this case, nothing should be inherited as in modern GUIs
 different controls use different fonts (and colours) than their siblings so
 they can't inherit the same value from the parent. However it was also deemed


@@ -1337,6 +1378,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}


@@ -1609,7 +1657,7 @@ and not navigate to the next control.
 %%
 %% This function is only relevant to top-level windows (frames and dialogs), and under
 %% Windows only. Under GTK the normal EVT\_CHAR\_ event has the functionality, i.e.
 %%
 %% This function is only relevant to top-level windows (frames and dialogs), and under
 %% Windows only. Under GTK the normal EVT\_CHAR\_ event has the functionality, i.e.

-%% you can intercepts it and if you don't call \helpref{wxEvent::Skip}{wxeventskip}
+%% you can intercept it, and if you don't call \helpref{wxEvent::Skip}{wxeventskip}

 %% the window won't get the event.
 %%
 %% \wxheading{See also}
 %% the window won't get the event.
 %%
 %% \wxheading{See also}


@@ -2379,7 +2427,7 @@ Sets the accelerator table for this window. See \helpref{wxAcceleratorTable}{wxa
 
 \membersection{wxWindow::SetAccessible}\label{wxwindowsetaccessible}
 
 
 \membersection{wxWindow::SetAccessible}\label{wxwindowsetaccessible}
 

-\func{void}{SetAccessible}{\param{wxAccessibile*}{ accessible}}
+\func{void}{SetAccessible}{\param{wxAccessible*}{ accessible}}

 
 Sets the accessible for this window. Any existing accessible for this window
 will be deleted first, if not identical to {\it accessible}.
 
 Sets the accessible for this window. Any existing accessible for this window
 will be deleted first, if not identical to {\it accessible}.


@@ -2469,7 +2517,7 @@ background, such as a tiled bitmap. Currently the style has no effect on other p
 
 \membersection{wxWindow::SetBestFittingSize}\label{wxwindowsetbestfittingsize}
 
 
 \membersection{wxWindow::SetBestFittingSize}\label{wxwindowsetbestfittingsize}
 

-\func{void}{SetBestFittingSize}{\param{const wxSize& }{size = wxDefaultSize}}
+\func{void}{SetBestFittingSize}{\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
 
 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


@@ -2572,6 +2620,28 @@ 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}
 
 
 \membersection{wxWindow::SetOwnBackgroundColour}\label{wxwindowsetownbackgroundcolour}
 


@@ -2704,6 +2774,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}


@@ -2804,6 +2876,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}}


@@ -3248,7 +3335,7 @@ See \helpref{Window styles}{windowstyles} for more information about flags.
 
 This function can be called under all platforms but only does anything under
 Mac OS X 10.3+ currently. Under this system, each of the standard control can
 
 This function can be called under all platforms but only does anything under
 Mac OS X 10.3+ currently. Under this system, each of the standard control can

-exist in several sizes which correpond to the elements of wxWindowVariant
+exist in several sizes which correspond to the elements of wxWindowVariant

 enum:
 \begin{verbatim}
 enum wxWindowVariant
 enum:
 \begin{verbatim}
 enum wxWindowVariant


@@ -3443,7 +3530,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}