Added wxPROPSHEET_TREEBOOK option

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

diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex
index ce35f652a9b1a466f44a4bde8a02eb97d3eee171..019e5b90b1f2d60712cc221acf67daf555d4bdda 100644 (file)
--- a/docs/latex/wx/window.tex
+++ b/docs/latex/wx/window.tex
@@ -1016,6 +1016,23 @@ handle, such as {\bf HWND} for Windows, {\bf Widget} for Motif, {\bf GtkWidget}
 \perlnote{This method will return an integer in wxPerl.}
 
 
+\membersection{wxWindow::GetHelpTextAtPoint}\label{wxwindowgethelptextatpoint}
+
+\constfunc{virtual wxString}{GetHelpTextAtPoint}{\param{const wxPoint &}{point}, \param{wxHelpEvent::Origin }{origin}}
+
+Gets the help text to be used as context-sensitive help for this window. This
+method should be overridden if the help message depends on the position inside
+the window, otherwise \helpref{GetHelpText}{wxwindowgethelptext} can be used.
+
+\wxheading{Parameters}
+
+\docparam{point}{Coordinates of the mouse at the moment of help event emission.}
+
+\docparam{origin}{Help event origin, see also \helpref{wxHelpEvent::GetOrigin}{wxhelpeventgetorigin}.}
+
+\newsince{2.7.0}
+
+
 \membersection{wxWindow::GetHelpText}\label{wxwindowgethelptext}
 
 \constfunc{virtual wxString}{GetHelpText}{\void}
@@ -1027,7 +1044,7 @@ and not in the window object itself.
 
 \wxheading{See also}
 
-\helpref{SetHelpText}{wxwindowsethelptext}, \helpref{wxHelpProvider}{wxhelpprovider}
+\helpref{SetHelpText}{wxwindowsethelptext}, \helpref{GetHelpTextAtPoint}{wxwindowgethelptextatpoint}, \helpref{wxHelpProvider}{wxhelpprovider}
 
 
 \membersection{wxWindow::GetId}\label{wxwindowgetid}
@@ -1111,9 +1128,9 @@ windows.
 
 \wxheading{Parameters}
 
-\docparam{x}{Receives the x position of the window.}
+\docparam{x}{Receives the x position of the window if non-\NULL.}
 
-\docparam{y}{Receives the y position of the window.}
+\docparam{y}{Receives the y position of the window if non-\NULL.}
 
 \pythonnote{In place of a single overloaded method name, wxPython
 implements the following methods:\par
@@ -1133,12 +1150,53 @@ method:\par
 }}
 
 
+\wxheading{See also}
+
+\helpref{GetScreenPosition}{wxwindowgetscreenposition}
+
+
 \membersection{wxWindow::GetRect}\label{wxwindowgetrect}
 
 \constfunc{virtual wxRect}{GetRect}{\void}
 
 Returns the size and position of the window as a \helpref{wxRect}{wxrect} object.
 
+\wxheading{See also}
+
+\helpref{GetScreenRect}{wxwindowgetscreenrect}
+
+
+\membersection{wxWindow::GetScreenPosition}\label{wxwindowgetscreenposition}
+
+\constfunc{virtual void}{GetScreenPosition}{\param{int* }{x}, \param{int* }{y}}
+
+\constfunc{wxPoint}{GetScreenPosition}{\void}
+
+Returns the window position in screen coordinates, whether the window is a
+child window or a top level one.
+
+\wxheading{Parameters}
+
+\docparam{x}{Receives the x position of the window on the screen if non-\NULL.}
+
+\docparam{y}{Receives the y position of the window on the screen if non-\NULL.}
+
+\wxheading{See also}
+
+\helpref{GetPosition}{wxwindowgetposition}
+
+
+\membersection{wxWindow::GetScreenRect}\label{wxwindowgetscreenrect}
+
+\constfunc{virtual wxRect}{GetScreenRect}{\void}
+
+Returns the size and position of the window on the screen as a 
+\helpref{wxRect}{wxrect} object.
+
+\wxheading{See also}
+
+\helpref{GetRect}{wxwindowgetrect}
+
 
 \membersection{wxWindow::GetScrollPos}\label{wxwindowgetscrollpos}
 
@@ -2318,7 +2376,7 @@ not delete) it from it.
 
 \wxheading{Parameters}
 
-\docparam{handler}{The event handler to remove, must be non {\tt NULL} and
+\docparam{handler}{The event handler to remove, must be non-{\tt NULL} and
 must be present in this windows event handlers chain}
 
 \wxheading{Return value}
@@ -2339,7 +2397,7 @@ handler is supposed to be there).
 
 Reparents the window, i.e the window will be removed from its
 current parent window (e.g. a non-standard toolbar in a wxFrame)
-and then re-inserted into another. Available on Windows and GTK.
+and then re-inserted into another.
 
 \wxheading{Parameters}