]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/window.tex
Fixed wxTextCtrl::SetMaxLength for rich edit controls
[wxWidgets.git] / docs / latex / wx / window.tex
index e32ce366dd77c6f626fcac32e511536d970ef85c..12745281a313f55c76d14884fb0e65a15de7a13a 100644 (file)
@@ -1,6 +1,6 @@
 \section{\class{wxWindow}}\label{wxwindow}
 
-wxWindow is the base class for all windows and represents any visible objectn
+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.
 
@@ -701,6 +701,19 @@ Returns the background colour of the window.
 \helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour}
 
 
+\membersection{wxWindow::GetBestFittingSize}\label{wxwindowgetbestfittingsize}
+
+\constfunc{wxSize}{GetBestFittingSize}{\void}
+
+Merges the window's best size into the min size and returns the result.
+
+\wxheading{See also}
+
+\helpref{wxWindow::GetBestSize}{wxwindowgetbestsize},\rtfsp
+\helpref{wxWindow::SetBestFittingSize}{wxwindowsetbestfittingsize},\rtfsp
+\helpref{wxWindow::SetSizeHints}{wxwindowsetsizehints}
+
+
 \membersection{wxWindow::GetBestSize}\label{wxwindowgetbestsize}
 
 \constfunc{wxSize}{GetBestSize}{\void}
@@ -902,9 +915,9 @@ Returns the extra style bits for the window.
 
 \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}
 
@@ -1282,7 +1295,7 @@ By ``intelligently'' the following is meant: by default, all windows use their
 own \helpref{default}{wxwindowgetclassdefaultattributes} attributes. However
 if some of the parents attributes are explicitly (that is, using 
 \helpref{SetFont}{wxwindowsetfont} and not 
-\helpref{SetDefaultFont}{wxwindowsetdefaultfont}) changed \emph{and} if the
+\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} 
@@ -1448,6 +1461,34 @@ implements the following methods:\par
 \end{twocollist}}
 }
 
+
+\membersection{wxWindow::MoveAfterInTabOrder}\label{wxwindowmoveafterintaborder}
+
+\func{void}{MoveAfterInTabOrder}{\param{wxWindow *}{win}}
+
+Moves this window in the tab navigation order after the specified \arg{win}.
+This means that when the user presses \texttt{TAB} key on that other window,
+the focus switches to this window.
+
+Default tab order is the same as creation order, this function and 
+\helpref{MoveBeforeInTabOrder()}{wxwindowmovebeforeintaborder} allow to change
+it after creating all the windows.
+
+\wxheading{Parameters}
+
+\docparam{win}{A sibling of this window which should precede it in tab order,
+must not be NULL}
+
+
+\membersection{wxWindow::MoveBeforeInTabOrder}\label{wxwindowmovebeforeintaborder}
+
+\func{void}{MoveBeforeInTabOrder}{\param{wxWindow *}{win}}
+
+Same as \helpref{MoveAfterInTabOrder}{wxwindowmoveafterintaborder} except that
+it inserts this window just before \arg{win} instead of putting it right after
+it.
+
+
 \membersection{wxWindow::Navigate}\label{wxwindownavigate}
 
 \func{bool}{Navigate}{\param{int}{ flags = wxNavigationKeyEvent::IsForward}}
@@ -2358,11 +2399,12 @@ Sets the background colour of the window.
 
 Please see \helpref{InheritAttributes}{wxwindowinheritattributes} for
 explanation of the difference between this method and 
-\helpref{SetDefaultBackgroundColour}{wxwindowsetdefaultbackgroundcolour}.
+\helpref{SetOwnBackgroundColour}{wxwindowsetownbackgroundcolour}.
 
 \wxheading{Parameters}
 
-\docparam{colour}{The colour to be used as the background colour.}
+\docparam{colour}{The colour to be used as the background colour, pass
+  {\tt wxNullColour} to reset to the default colour.}
 
 \wxheading{Remarks}
 
@@ -2374,9 +2416,11 @@ Note that setting the background colour does not cause an immediate refresh, so
 may wish to call \helpref{wxWindow::ClearBackground}{wxwindowclearbackground} or \helpref{wxWindow::Refresh}{wxwindowrefresh} after
 calling this function.
 
-Use this function with care under GTK+ as the new appearance of the window might
-not look equally well when used with "Themes", i.e GTK+'s ability to change its
-look as the user wishes with run-time loadable modules.
+Using this function will disable attempts to use themes for this
+window, if the system supports them.  Use with care since usually the
+themes represent the appearance chosen by the user to be used for all
+applications on the system.
+
 
 \wxheading{See also}
 
@@ -2388,6 +2432,25 @@ look as the user wishes with run-time loadable modules.
 \helpref{wxEraseEvent}{wxeraseevent}
 
 
+\membersection{wxWindow::SetBestFittingSize}\label{wxwindowsetbestfittingsize}
+
+\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
+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.
+
+\wxheading{See also}
+
+\helpref{wxWindow::SetSize}{wxwindowsetsize},\rtfsp
+\helpref{wxWindow::GetBestSize}{wxwindowgetbestsize},\rtfsp
+\helpref{wxWindow::GetBestFittingSize}{wxwindowgetbestfittingsize},\rtfsp
+\helpref{wxWindow::SetSizeHints}{wxwindowsetsizehints}
+
+
 \membersection{wxWindow::SetCaret}\label{wxwindowsetcaret}
 
 \constfunc{void}{SetCaret}{\param{wxCaret *}{caret}}
@@ -2475,9 +2538,9 @@ explicitly. When setting both a wxLayoutConstraints and a \helpref{wxSizer}{wxsi
 sizer will have effect.
 
 
-\membersection{wxWindow::SetDefaultBackgroundColour}\label{wxwindowsetdefaultbackgroundcolour}
+\membersection{wxWindow::SetOwnBackgroundColour}\label{wxwindowsetownbackgroundcolour}
 
-\func{void}{SetDefaultBackgroundColour}{\param{const wxColour\& }{colour}}
+\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.
@@ -2488,9 +2551,9 @@ by the children of this window.
 \helpref{InheritAttributes}{wxwindowinheritattributes}
 
 
-\membersection{wxWindow::SetDefaultFont}\label{wxwindowsetdefaultfont}
+\membersection{wxWindow::SetOwnFont}\label{wxwindowsetownfont}
 
-\func{void}{SetDefaultBackgroundColour}{\param{const wxColour\& }{colour}}
+\func{void}{SetOwnBackgroundColour}{\param{const wxColour\& }{colour}}
 
 Sets the font of the window but prevents it from being inherited by the
 children of this window.
@@ -2501,9 +2564,9 @@ children of this window.
 \helpref{InheritAttributes}{wxwindowinheritattributes}
 
 
-\membersection{wxWindow::SetDefaultForegroundColour}\label{wxwindowsetdefaultforegroundcolour}
+\membersection{wxWindow::SetOwnForegroundColour}\label{wxwindowsetownforegroundcolour}
 
-\func{void}{SetDefaultForegroundColour}{\param{const wxColour\& }{colour}}
+\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.
@@ -2624,13 +2687,14 @@ can be overridden to do something in addition to this in the derived classes.
 
 Sets the font for this window. This function should not be called for the
 parent window if you don't want its font to be inherited by its children,
-use \helpref{SetDefaultFont}{wxwindowsetdefaultfont} instead in this case and
+use \helpref{SetOwnFont}{wxwindowsetownfont} instead in this case and
 see \helpref{InheritAttributes}{wxwindowinheritattributes} for more
 explanations.
 
 \wxheading{Parameters}
 
-\docparam{font}{Font to associate with this window.}
+\docparam{font}{Font to associate with this window, pass
+{\tt wxNullFont} to reset to the default font.}
 
 \wxheading{See also}
 
@@ -2646,11 +2710,12 @@ Sets the foreground colour of the window.
 
 Please see \helpref{InheritAttributes}{wxwindowinheritattributes} for
 explanation of the difference between this method and 
-\helpref{SetDefaultForegroundColour}{wxwindowsetdefaultforegroundcolour}.
+\helpref{SetOwnForegroundColour}{wxwindowsetownforegroundcolour}.
 
 \wxheading{Parameters}
 
-\docparam{colour}{The colour to be used as the foreground colour.}
+\docparam{colour}{The colour to be used as the foreground colour, pass
+  {\tt wxNullColour} to reset to the default colour.}
 
 \wxheading{Remarks}
 
@@ -2658,9 +2723,10 @@ The interpretation of foreground colour is open to interpretation according
 to the window class; it may be the text colour or other colour, or it may not
 be used at all.
 
-Note that when using this functions under GTK, you will disable the so called "themes",
-i.e. the user chosen appearance of windows and controls, including the themes of
-their parent windows.
+Using this function will disable attempts to use themes for this
+window, if the system supports them.  Use with care since usually the
+themes represent the appearance chosen by the user to be used for all
+applications on the system.
 
 \wxheading{See also}