reverted wxVideoMode API breakage by r53049, finished documentation for it

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@53124 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Václav Slavík
2008-04-11 09:52:04 +00:00
parent 9b4fd94a4a
commit 077f75a51d
2 changed files with 28 additions and 7 deletions

View File

@@ -13,12 +13,11 @@
#define _WX_VMODE_H_ #define _WX_VMODE_H_
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
// wxVideoMode: a simple class containing video mode parameters for a display // wxVideoMode: a simple struct containing video mode parameters for a display
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
class WXDLLIMPEXP_CORE wxVideoMode struct WXDLLIMPEXP_CORE wxVideoMode
{ {
public:
wxVideoMode(int width = 0, int height = 0, int depth = 0, int freq = 0) wxVideoMode(int width = 0, int height = 0, int depth = 0, int freq = 0)
{ {
w = width; w = width;
@@ -61,8 +60,6 @@ public:
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 // the screen size in pixels (e.g. 640*480), 0 means unspecified
int w, h; int w, h;

View File

@@ -7,7 +7,7 @@
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/** /**
@class wxVideoMode @struct wxVideoMode
@wxheader{display.h} @wxheader{display.h}
Determines the sizes and locations of displays connected to the system. Determines the sizes and locations of displays connected to the system.
@@ -20,7 +20,7 @@
@see wxClientDisplayRect(), wxDisplaySize(), wxDisplaySizeMM() @see wxClientDisplayRect(), wxDisplaySize(), wxDisplaySizeMM()
*/ */
class wxVideoMode struct wxVideoMode
{ {
public: public:
/** /**
@@ -38,14 +38,38 @@ public:
*/ */
bool Matches(const wxVideoMode& other) const; bool Matches(const wxVideoMode& other) const;
/**
Returns the screen width in pixels (e.g. 640), 0 means unspecified.
*/
int GetWidth() const; int GetWidth() const;
/**
Returns the screen height in pixels (e.g. 480), 0 means unspecified.
*/
int GetHeight() const; int GetHeight() const;
/**
Returns bits per pixel (e.g. 32), 1 is monochrome and 0 means
unspecified/known.
*/
int GetDepth() const; int GetDepth() const;
/** /**
Returns true if the object has been initialized Returns true if the object has been initialized
*/ */
bool IsOk() const; bool IsOk() const;
/// The screen width in pixels (e.g. 640), 0 means unspecified.
int w;
/// The screen height in pixels (e.g. 480), 0 means unspecified.
int h;
/// Bits per pixel (e.g. 32), 1 is monochrome and 0 means unspecified/known.
int bpp;
/// Refresh frequency in Hz, 0 means unspecified/unknown.
int refresh;
}; };
/** /**