HitTest() seems to be implemented on most platforms now (replaces patch 1467212)

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

diff --git a/docs/latex/wx/display.tex b/docs/latex/wx/display.tex
index baf8889cbd6e847aa310897ae7f7cce4d5533438..fd78c8f15e59d66a1246ba6f901eb296b7cae4ab 100644 (file)
--- a/docs/latex/wx/display.tex
+++ b/docs/latex/wx/display.tex
@@ -17,7 +17,7 @@ None
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
-\membersection{wxDisplay::wxDisplay}\label{wxdisplayconstr}
+\membersection{wxDisplay::wxDisplay}\label{wxdisplayctor}
 
 \func{}{wxDisplay}{\param{size\_t }{index = 0}}
 
@@ -29,7 +29,7 @@ Constructor, setting up a wxDisplay instance with the specified display.
 and lower than the value returned by \helpref{GetCount()}{wxdisplaygetcount}.}
 
 
-\membersection{wxDisplay::\destruct{wxDisplay}}
+\membersection{wxDisplay::\destruct{wxDisplay}}\label{wxdisplaydtor}
 
 \func{void}{\destruct{wxDisplay}}{\void}
 
@@ -57,6 +57,20 @@ function that changed the video mode to the system
 default by using the system's 'scrn' resource.
 
 
+\membersection{wxDisplay::GetClientArea}\label{wxdisplaygetclientarea}
+
+\constfunc{wxRect }{GetClientArea}{\void}
+
+Returns the client area of the display. The client area is the part of the
+display available for the normal (non full screen) windows, usually it is the
+same as \helpref{GetGeometry}{wxdisplaygetgeometry} but it could be less if
+there is a taskbar (or equivalent) on this display.
+
+\wxheading{See also:}
+
+\helpref{wxClientDisplayRect}{wxclientdisplayrect}
+
+
 \membersection{wxDisplay::GetCount}\label{wxdisplaygetcount}
 
 \func{static size\_t}{GetCount}{\void}
@@ -82,14 +96,29 @@ Returns the bit depth of the display whose index was passed to the constructor.
 
 \func{static int}{GetFromPoint}{\param{const wxPoint\& }{pt}}
 
-Returns the index of the display on which the given point lies.  Returns -1 if
-the point is not on any connected display.
+Returns the index of the display on which the given point lies.  Returns 
+\texttt{wxNOT\_FOUND} if the point is not on any connected display.
 
 \wxheading{Parameters}
 
 \docparam{pt}{The point to locate.}
 
 
+\membersection{wxDisplay::GetFromWindow}\label{wxdisplaygetfromwindow}
+
+\func{static int}{GetFromWindow}{\param{wxWindow* }{win}}
+
+Returns the index of the display on which the given window lies.
+
+If the window is on more than one display it gets the display that overlaps the window the most.
+
+Returns \texttt{wxNOT\_FOUND} if the window is not on any connected display.
+
+\wxheading{Parameters}
+
+\docparam{win}{The window to locate.}
+
+
 \membersection{wxDisplay::GetGeometry}\label{wxdisplaygetgeometry}
 
 \constfunc{wxRect }{GetGeometry}{\void}
@@ -97,6 +126,10 @@ the point is not on any connected display.
 Returns the bounding rectangle of the display whose index was passed to the
 constructor.
 
+\wxheading{See also:}
+
+\helpref{GetClientArea}{wxdisplaygetclientarea}, \helpref{wxDisplaySize}{wxdisplaysize}
+
 
 \membersection{wxDisplay::GetModes}\label{wxdisplaygetmodes}
 
@@ -115,20 +148,6 @@ supported by this display and match the mode parameter
 Returns the display's name.  A name is not available on all platforms.
 
 
-\membersection{wxDisplay::IsColour}\label{wxdisplayiscolour}
-
-\constfunc{bool }{IsColour}{\void}
-
-Returns true if the display is color (has a depth greater than 1).
-
-
-\membersection{wxDisplay::IsColor}\label{wxdisplayiscolor}
-
-\constfunc{bool }{IsColor}{\void}
-
-Same as \helpref{IsColour()}{wxdisplayiscolour}.
-
-
 \membersection{wxDisplay::IsPrimary}\label{wxdisplayisprimary}
 
 \func{bool }{IsPrimary}{\void}