fix typo in Selecting() description (bug 1726270)

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

diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex
index e170cc92da2dcd51806a3cd5d2d97d2532eea65e..c64902d2ee4e05b5f9bcffb3d678258a9e5baeb9 100644 (file)
--- a/docs/latex/wx/window.tex
+++ b/docs/latex/wx/window.tex
@@ -62,10 +62,10 @@ 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
-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.}
+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.}
@@ -171,6 +171,29 @@ can delete a window only when it is safe to do so, in idle time.
 \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}}
@@ -1294,20 +1317,25 @@ Return the sizer associated with the window by a previous call to
 
 \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}}}
 
+\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.
 
+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.}
 
-\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).}
 
@@ -1417,6 +1445,18 @@ Returns {\tt true} if this window has the current mouse capture.
 \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}}
@@ -1527,7 +1567,13 @@ and transferred to the screen all at once later.
 
 \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}
 
@@ -1603,6 +1649,16 @@ is shown and all its parents up to the toplevel window are shown as well.
 \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}
 
 \constfunc{bool}{IsTopLevel}{\void}
@@ -1727,13 +1783,19 @@ it.
 
 \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{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
@@ -1742,6 +1804,15 @@ a multiline text control with the wxTE\_PROCESS\_TAB style is to insert a tab
 and not navigate to the next control.
 
 
+\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::NextControlId}\label{wxwindownextcontrolid}
 
 \func{static int}{NextControlId}{\param{int }{winid}}
@@ -2921,7 +2992,7 @@ can be overridden to do something in addition to this in the derived classes.
 
 \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,
@@ -2940,6 +3011,11 @@ any standard controls for drawing their text as well as by
 \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},\\