]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/display.h
regenerated headers to remove @seealso in favour of @see; fixed links to global funct...
[wxWidgets.git] / interface / display.h
index 14060218dab3ab29dd2d76cab50755498b1b7973..ce3d62c7045ff7b1051ca80edf0294e8afce65de 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        display.h
-// Purpose:     documentation for wxDisplay class
+// Purpose:     interface of wxDisplay
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -15,8 +15,7 @@
     @library{wxcore}
     @category{FIXME}
 
-    @seealso
-    wxClientDisplayRect, wxDisplaySize, wxDisplaySizeMM
+    @see wxClientDisplayRect(), wxDisplaySize(), wxDisplaySizeMM()
 */
 class wxDisplay
 {
@@ -58,7 +57,7 @@ public:
         same as GetGeometry() but it could be less if
         there is a taskbar (or equivalent) on this display.
     */
-    wxRect GetClientArea();
+    wxRect GetClientArea() const;
 
     /**
         Returns the number of connected displays.
@@ -68,12 +67,12 @@ public:
     /**
         Returns the current video mode that this display is in.
     */
-    wxVideoMode GetCurrentMode();
+    wxVideoMode GetCurrentMode() const;
 
     /**
         Returns the bit depth of the display whose index was passed to the constructor.
     */
-    int GetDepth();
+    int GetDepth() const;
 
     /**
         Returns the index of the display on which the given point lies.  Returns
@@ -99,7 +98,7 @@ public:
         Returns the bounding rectangle of the display whose index was passed to the
         constructor.
     */
-    wxRect GetGeometry();
+    wxRect GetGeometry() const;
 
     /**
         Fills and returns an array with all the video modes that
@@ -107,12 +106,12 @@ public:
         supported by this display and match the mode parameter
         (if mode is not wxDefaultVideoMode).
     */
-    wxArrayVideoModes GetModes(const wxVideoMode& mode = wxDefaultVideoMode);
+    wxArrayVideoModes GetModes(const wxVideoMode& mode = wxDefaultVideoMode) const;
 
     /**
         Returns the display's name.  A name is not available on all platforms.
     */
-    wxString GetName();
+    wxString GetName() const;
 
     /**
         Returns @true if the display is the primary display.  The primary display is the
@@ -120,3 +119,4 @@ public:
     */
     bool IsPrimary();
 };
+