X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3c4f71cc3d63fb7bdfbd6cec3e39c8a8679f3e60..63b37a4e648320827a5b4a3161be13154370b5c3:/interface/display.h?ds=sidebyside

diff --git a/interface/display.h b/interface/display.h
index e4a3c747e2..71eeeba4f5 100644
--- a/interface/display.h
+++ b/interface/display.h
@@ -13,7 +13,7 @@
     Determines the sizes and locations of displays connected to the system.
 
     @library{wxcore}
-    @category{FIXME}
+    @category{misc}
 
     @see wxClientDisplayRect(), wxDisplaySize(), wxDisplaySizeMM()
 */
@@ -21,11 +21,12 @@ class wxDisplay
 {
 public:
     /**
-        Constructor, setting up a wxDisplay instance with the specified display.
+        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().
+            The index of the display to use. This must be non-negative and
+            lower than the value returned by GetCount().
     */
     wxDisplay(unsigned index = 0);
 
@@ -35,27 +36,28 @@ public:
     ~wxDisplay();
 
     /**
-        Changes the video mode of this display to the mode specified
-        in the mode parameter.
-        If wxDefaultVideoMode is passed in as the mode parameter,
-        the defined behaviour is that wxDisplay will reset the video
-        mode to the default mode used by the display.  On Windows,
-        the behavior is normal.  However, there are differences on other
-        platforms. On Unix variations using X11 extensions it should
-        behave as defined, but some irregularities may occur.
-        On wxMac passing in wxDefaultVideoMode as the mode
-        parameter does nothing.  This happens because carbon
-        no longer has access to DMUseScreenPrefs, an undocumented
-        function that changed the video mode to the system
-        default by using the system's 'scrn' resource.
+        Changes the video mode of this display to the mode specified in the
+        mode parameter.
+
+        If wxDefaultVideoMode is passed in as the mode parameter, the defined
+        behaviour is that wxDisplay will reset the video mode to the default
+        mode used by the display. On Windows, the behavior is normal. However,
+        there are differences on other platforms. On Unix variations using X11
+        extensions it should behave as defined, but some irregularities may
+        occur.
+
+        On wxMac passing in wxDefaultVideoMode as the mode parameter does
+        nothing. This happens because carbon no longer has access to
+        @c DMUseScreenPrefs(), an undocumented function that changed the video
+        mode to the system default by using the system's "scrn" resource.
     */
     bool ChangeMode(const wxVideoMode& mode = wxDefaultVideoMode);
 
     /**
-        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 GetGeometry() but it could be less if
-        there is a taskbar (or equivalent) on this display.
+        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 GetGeometry() but it could be less if there is a
+        taskbar (or equivalent) on this display.
     */
     wxRect GetClientArea() const;
 
@@ -70,12 +72,13 @@ public:
     wxVideoMode GetCurrentMode() const;
 
     /**
-        Returns the bit depth of the display whose index was passed to the constructor.
+        Returns the bit depth of the display whose index was passed to the
+        constructor.
     */
     int GetDepth() const;
 
     /**
-        Returns the index of the display on which the given point lies.  Returns
+        Returns the index of the display on which the given point lies, or
         @c wxNOT_FOUND if the point is not on any connected display.
 
         @param pt
@@ -85,8 +88,10 @@ public:
 
     /**
         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.
+
+        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
@@ -95,27 +100,28 @@ public:
     static int GetFromWindow(const wxWindow* win);
 
     /**
-        Returns the bounding rectangle of the display whose index was passed to the
-        constructor.
+        Returns the bounding rectangle of the display whose index was passed to
+        the constructor.
+
+        @see GetClientArea(), wxDisplaySize()
     */
     wxRect GetGeometry() const;
 
     /**
-        Fills and returns an array with all the video modes that
-        are supported by this display, or video modes that are
-        supported by this display and match the mode parameter
-        (if mode is not wxDefaultVideoMode).
+        Fills and returns an array with all the video modes that are supported
+        by this display, or video modes that are supported by this display and
+        match the mode parameter (if mode is not wxDefaultVideoMode).
     */
     wxArrayVideoModes GetModes(const wxVideoMode& mode = wxDefaultVideoMode) const;
 
     /**
-        Returns the display's name.  A name is not available on all platforms.
+        Returns the display's name. A name is not available on all platforms.
     */
     wxString GetName() const;
 
     /**
-        Returns @true if the display is the primary display.  The primary display is the
-        one whose index is 0.
+        Returns @true if the display is the primary display. The primary
+        display is the one whose index is 0.
     */
     bool IsPrimary();
 };