documented wxVideoMode (otherwise wxDisplay docs are not very useful)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@53049 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/include/wx/vidmode.h b/include/wx/vidmode.h
index 839fae4f1d2d383719699f96d00a3fe1619f3ed8..e22c8d8f07f79430311a0b4159ea9ed4760ace3d 100644 (file)
--- a/include/wx/vidmode.h
+++ b/include/wx/vidmode.h
@@ -13,11 +13,12 @@
 #define _WX_VMODE_H_
 
 // ----------------------------------------------------------------------------
 #define _WX_VMODE_H_
 
 // ----------------------------------------------------------------------------

-// wxVideoMode: a simple struct containing video mode parameters for a display
+// wxVideoMode: a simple class containing video mode parameters for a display

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-struct WXDLLIMPEXP_CORE wxVideoMode
+class WXDLLIMPEXP_CORE wxVideoMode

 {
 {

+public:

     wxVideoMode(int width = 0, int height = 0, int depth = 0, int freq = 0)
     {
         w = width;
     wxVideoMode(int width = 0, int height = 0, int depth = 0, int freq = 0)
     {
         w = width;


@@ -59,6 +60,8 @@ struct WXDLLIMPEXP_CORE wxVideoMode
     bool IsOk() const { return w && h; }
 
 
     bool IsOk() const { return w && h; }
 
 

+protected:
+

     // the screen size in pixels (e.g. 640*480), 0 means unspecified
     int w, h;
 
     // the screen size in pixels (e.g. 640*480), 0 means unspecified
     int w, h;
 

diff --git a/interface/vidmode.h b/interface/vidmode.h
new file mode 100644 (file)
index 0000000..2fcfa70
--- /dev/null
+++ b/interface/vidmode.h
@@ -0,0 +1,54 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        vidmode.h
+// Purpose:     interface of wxVideoMode
+// Author:      wxWidgets team
+// RCS-ID:      $Id: display.h 52634 2008-03-20 13:45:17Z VS $
+// Licence:     wxWindows license
+/////////////////////////////////////////////////////////////////////////////
+
+/**
+    @class wxVideoMode
+    @wxheader{display.h}
+
+    Determines the sizes and locations of displays connected to the system.
+
+    @library{wxcore}
+    @category{FIXME}
+
+    @stdobjects
+    ::wxDefaultVideoMode
+
+    @see wxClientDisplayRect(), wxDisplaySize(), wxDisplaySizeMM()
+*/
+class wxVideoMode
+{
+public:
+    /**
+        Constructs this class using the given parameters.
+    */
+    wxVideoMode(int width = 0, int height = 0, int depth = 0, int freq = 0);
+
+    bool operator==(const wxVideoMode& m) const
+    bool operator!=(const wxVideoMode& mode) const
+
+    /**
+        Returns true if this mode matches the other one in the sense that all
+        non zero fields of the other mode have the same value in this one
+        (except for refresh which is allowed to have a greater value).
+    */
+    bool Matches(const wxVideoMode& other) const;
+
+    int GetWidth() const;
+    int GetHeight() const;
+    int GetDepth() const;
+
+    /**
+        Returns true if the object has been initialized
+    */
+    bool IsOk() const;
+};
+
+/**
+    A global wxVideoMode instance used by wxDisplay.
+*/
+wxVideoMode wxDefaultVideoMode;