]> git.saurik.com Git - wxWidgets.git/commitdiff
Document wxDisplay::GetFromWindow
authorRyan Norton <wxprojects@comcast.net>
Wed, 2 Mar 2005 01:08:35 +0000 (01:08 +0000)
committerRyan Norton <wxprojects@comcast.net>
Wed, 2 Mar 2005 01:08:35 +0000 (01:08 +0000)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@32553 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

docs/latex/wx/display.tex

index 77ce0c738e2e38482bb91bb07f5dde96a492b434..3a39b3da8e9530e279b42d37a9ee9c6ece2ce421 100644 (file)
@@ -90,6 +90,21 @@ the point is not on any connected display.
 \docparam{pt}{The point to locate.}
 
 
 \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 -1 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}
 \membersection{wxDisplay::GetGeometry}\label{wxdisplaygetgeometry}
 
 \constfunc{wxRect }{GetGeometry}{\void}