revision contributed by Utensil Candel

[wxWidgets.git] / interface / display.h

diff --git a/interface/display.h b/interface/display.h
index 14060218dab3ab29dd2d76cab50755498b1b7973..e4a3c747e2740a5eb223a483a82bb9369e0213d0 100644 (file)
--- a/interface/display.h
+++ b/interface/display.h
@@ -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,15 +15,14 @@
     @library{wxcore}
     @category{FIXME}
 
-    @seealso
-    wxClientDisplayRect, wxDisplaySize, wxDisplaySizeMM
+    @see wxClientDisplayRect(), wxDisplaySize(), wxDisplaySizeMM()
 */
 class wxDisplay
 {
 public:
     /**
         Constructor, setting up a wxDisplay instance with the specified display.
-        
+
         @param index
             The index of the display to use.  This must be non-negative
             and lower than the value returned by GetCount().
@@ -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,17 +67,17 @@ 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
         @c wxNOT_FOUND if the point is not on any connected display.
-        
+
         @param pt
             The point to locate.
     */
@@ -89,7 +88,7 @@ public:
         If the window is on more than one display it gets the display that overlaps the
         window the most.
         Returns @c wxNOT_FOUND if the window is not on any connected display.
-        
+
         @param win
             The window to locate.
     */
@@ -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();
 };
+