don't disable non top tabs if visual themes are not used

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

diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex
index b3b6ba5ab00c0d33c7b1a152e31436e35b000b9f..08564bb8ff268938024ff8b1a4b4d55f153f42e8 100644 (file)
--- a/docs/latex/wx/window.tex
+++ b/docs/latex/wx/window.tex
@@ -1,6 +1,6 @@
 \section{\class{wxWindow}}\label{wxwindow}
 
 \section{\class{wxWindow}}\label{wxwindow}
 

-wxWindow is the base class for all windows and represents any visible objecto n
+wxWindow is the base class for all windows and represents any visible object on

 screen. All controls, top level windows and so on are windows. Sizers and
 device contexts are not, however, as they don't appear on screen themselves.
 
 screen. All controls, top level windows and so on are windows. Sizers and
 device contexts are not, however, as they don't appear on screen themselves.
 


@@ -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}}
 


@@ -287,7 +287,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 +426,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 +451,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}
 


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


@@ -700,6 +700,23 @@ Returns the background colour of the window.
 \helpref{wxWindow::SetForegroundColour}{wxwindowsetforegroundcolour},\rtfsp
 \helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour}
 
 \helpref{wxWindow::SetForegroundColour}{wxwindowsetforegroundcolour},\rtfsp
 \helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour}
 

+\membersection{wxWindow::GetBackgroundStyle}\label{wxwindowgetbackgroundstyle}
+
+\constfunc{virtual wxBackgroundStyle}{GetBackgroundStyle}{\void}
+
+Returns the background style of the window. The background style indicates
+whether background colour should be determined by the system (wxBG\_STYLE\_SYSTEM),
+be set to a specific colour (wxBG\_STYLE\_COLOUR), or should be left to the
+application to implement (wxBG\_STYLE\_CUSTOM).
+
+On GTK+, use of wxBG\_STYLE\_CUSTOM allows the flicker-free drawing of a custom
+background, such as a tiled bitmap. Currently the style has no effect on other platforms.
+
+\wxheading{See also}
+
+\helpref{wxWindow::SetBackgroundColour}{wxwindowsetbackgroundcolour},\rtfsp
+\helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour},\rtfsp
+\helpref{wxWindow::SetBackgroundStyle}{wxwindowsetbackgroundstyle}

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


@@ -747,28 +764,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}}}
 


@@ -859,7 +876,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}
 


@@ -915,9 +932,9 @@ Returns the extra style bits for the window.
 
 \membersection{wxWindow::GetFont}\label{wxwindowgetfont}
 
 
 \membersection{wxWindow::GetFont}\label{wxwindowgetfont}
 

-\constfunc{wxFont\&}{GetFont}{\void}
+\constfunc{wxFont}{GetFont}{\void}

 
 

-Returns a reference to the font for this window.
+Returns the font for this window.

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


@@ -943,7 +960,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}
 


@@ -993,7 +1010,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}
 


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


@@ -1025,7 +1055,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}
 


@@ -1302,8 +1332,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


@@ -1592,7 +1622,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}


@@ -2362,7 +2392,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}.


@@ -2431,10 +2461,28 @@ applications on the system.
 \helpref{wxWindow::Refresh}{wxwindowrefresh},\rtfsp
 \helpref{wxEraseEvent}{wxeraseevent}
 
 \helpref{wxWindow::Refresh}{wxwindowrefresh},\rtfsp
 \helpref{wxEraseEvent}{wxeraseevent}
 

+\membersection{wxWindow::SetBackgroundStyle}\label{wxwindowsetbackgroundstyle}
+
+\func{virtual void}{SetBackgroundStyle}{\param{wxBackgroundStyle}{ style}}
+
+Sets the background style of the window. The background style indicates
+whether background colour should be determined by the system (wxBG\_STYLE\_SYSTEM),
+be set to a specific colour (wxBG\_STYLE\_COLOUR), or should be left to the
+application to implement (wxBG\_STYLE\_CUSTOM).
+
+On GTK+, use of wxBG\_STYLE\_CUSTOM allows the flicker-free drawing of a custom
+background, such as a tiled bitmap. Currently the style has no effect on other platforms.
+
+\wxheading{See also}
+
+\helpref{wxWindow::SetBackgroundColour}{wxwindowsetbackgroundcolour},\rtfsp
+\helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour},\rtfsp
+\helpref{wxWindow::GetBackgroundStyle}{wxwindowgetbackgroundstyle}
+

 
 \membersection{wxWindow::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


@@ -2537,6 +2585,21 @@ 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::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}
 


@@ -3213,7 +3276,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