cleanup - fixed a warning, some typos, and made minor reformatting changes

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@38165 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
David Surovell
2006-03-17 04:09:10 +00:00
parent f5a45ee2e9
commit 611ac06b89

View File

@@ -31,32 +31,30 @@ struct wxVideoMode
{ {
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);
~wxVideoMode(); ~wxVideoMode();
DocDeclStr( DocDeclStr(
bool , Matches(const wxVideoMode& other) const, bool , Matches(const wxVideoMode& other) const,
"Returns True if this mode matches the other one in the sense that all "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 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)", ""); one (except for refresh which is allowed to have a greater value)", "");
DocDeclStr( DocDeclStr(
int , GetWidth() const, int , GetWidth() const,
"Returns the screen width in pixels (e.g. 640*480), 0 means unspecified", ""); "Returns the screen width in pixels (e.g. 640*480), 0 means unspecified", "");
DocDeclStr( DocDeclStr(
int , GetHeight() const, int , GetHeight() const,
"Returns the screen width in pixels (e.g. 640*480), 0 means "Returns the screen height in pixels (e.g. 640*480), 0 means unspecified", "");
unspecified", "");
DocDeclStr( DocDeclStr(
int , GetDepth() const, int , GetDepth() const,
"Returns the screen's bits per pixel (e.g. 32), 1 is monochrome and 0 "Returns the screen's bits per pixel (e.g. 32), 1 is monochrome and 0
means unspecified/known", ""); means unspecified/known", "");
DocDeclStr( DocDeclStr(
bool , IsOk() const, bool , IsOk() const,
"returns true if the object has been initialized", ""); "returns true if the object has been initialized", "");
%pythoncode { def __nonzero__(self): return self.IsOk() } %pythoncode { def __nonzero__(self): return self.IsOk() }
@@ -65,7 +63,7 @@ means unspecified/known", "");
bool __ne__(const wxVideoMode* other) { return other ? (*self != *other) : true; } bool __ne__(const wxVideoMode* other) { return other ? (*self != *other) : true; }
} }
// 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;
@@ -81,7 +79,7 @@ means unspecified/known", "");
#if !wxUSE_DISPLAY #if !wxUSE_DISPLAY
const wxVideoMode wxDefaultVideoMode; const wxVideoMode wxDefaultVideoMode;
#endif #endif
%} %}
%immutable; %immutable;
const wxVideoMode wxDefaultVideoMode; const wxVideoMode wxDefaultVideoMode;
@@ -92,13 +90,11 @@ const wxVideoMode wxDefaultVideoMode;
DocStr(wxDisplay, DocStr(wxDisplay,
"Represents a display/monitor attached to the system", ""); "Represents a display/monitor attached to the system", "");
class wxDisplay class wxDisplay
{ {
public: public:
//
DocCtorStr( DocCtorStr(
wxDisplay(size_t index = 0), wxDisplay(size_t index = 0),
"Set up a Display instance with the specified display. The displays "Set up a Display instance with the specified display. The displays
@@ -110,51 +106,46 @@ and the only one which is always supported", "");
DocDeclStr( DocDeclStr(
static size_t , GetCount(), static size_t , GetCount(),
"Return the number of available displays.", ""); "Return the number of available displays.", "");
DocDeclStr( DocDeclStr(
static int , GetFromPoint(const wxPoint& pt), static int , GetFromPoint(const wxPoint& pt),
"Find the display where the given point lies, return wx.NOT_FOUND if it "Find the display where the given point lies, return wx.NOT_FOUND if it
doesn't belong to any display", ""); doesn't belong to any display", "");
DocStr(GetFromWindow, DocStr(GetFromWindow,
"Find the display where the given window lies, return wx.NOT_FOUND if "Find the display where the given window lies, return wx.NOT_FOUND if
it is not shown at all.", ""); it is not shown at all.", "");
static int GetFromWindow(wxWindow *window); static int GetFromWindow(wxWindow *window);
DocDeclStr( DocDeclStr(
bool , IsOk() const, bool , IsOk() const,
"Return true if the object was initialized successfully", ""); "Return true if the object was initialized successfully", "");
%pythoncode { def __nonzero__(self): return self.IsOk() } %pythoncode { def __nonzero__(self): return self.IsOk() }
DocDeclStr( DocDeclStr(
wxRect , GetGeometry() const, wxRect , GetGeometry() const,
"Returns the bounding rectangle of the display whose index was passed "Returns the bounding rectangle of the display whose index was passed
to the constructor.", ""); to the constructor.", "");
DocDeclStr( DocDeclStr(
wxRect , GetClientArea() const, wxRect , GetClientArea() const,
"Get the client area of the display, i.e. without taskbars and such", ""); "Returns the bounding rectangle the client area of the display,
i.e., without taskbars and such.", "");
DocDeclStr( DocDeclStr(
wxString , GetName() const, wxString , GetName() 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.", "");
DocDeclStr( DocDeclStr(
bool , IsPrimary() const, bool , IsPrimary() const,
"Returns true if the display is the primary display. The primary "Returns True if the display is the primary display. The primary
display is the one whose index is 0.", ""); display is the one whose index is 0.", "");
%extend { %extend
{
DocAStr(GetModes, DocAStr(GetModes,
"GetModes(VideoMode mode=DefaultVideoMode) -> [videoMode...]", "GetModes(VideoMode mode=DefaultVideoMode) -> [videoMode...]",
"Enumerate all video modes supported by this display matching the given "Enumerate all video modes supported by this display matching the given
@@ -164,14 +155,16 @@ As any mode matches the default value of the argument and there is
always at least one video mode supported by display, the returned always at least one video mode supported by display, the returned
array is only empty for the default value of the argument if this array is only empty for the default value of the argument if this
function is not supported at all on this platform.", ""); function is not supported at all on this platform.", "");
PyObject* GetModes(const wxVideoMode& mode = wxDefaultVideoMode) { PyObject* GetModes(const wxVideoMode& mode = wxDefaultVideoMode)
{
%#if wxUSE_DISPLAY %#if wxUSE_DISPLAY
PyObject* pyList = NULL; PyObject* pyList = NULL;
wxArrayVideoModes arr = self->GetModes(mode); wxArrayVideoModes arr = self->GetModes(mode);
wxPyBlock_t blocked = wxPyBeginBlockThreads(); wxPyBlock_t blocked = wxPyBeginBlockThreads();
pyList = PyList_New(0); pyList = PyList_New(0);
for (int i=0; i < arr.GetCount(); i++) { for (size_t i=0; i < arr.GetCount(); i++)
{
wxVideoMode* m = new wxVideoMode(arr.Item(i)); wxVideoMode* m = new wxVideoMode(arr.Item(i));
PyObject* pyObj = wxPyConstructObject(m, wxT("wxVideoMode"), true); PyObject* pyObj = wxPyConstructObject(m, wxT("wxVideoMode"), true);
PyList_Append(pyList, pyObj); PyList_Append(pyList, pyObj);
@@ -184,10 +177,11 @@ function is not supported at all on this platform.", "");
return NULL; return NULL;
%#endif %#endif
} }
DocStr(GetCurrentMode, DocStr(GetCurrentMode,
"Get the current video mode.", ""); "Get the current video mode.", "");
wxVideoMode GetCurrentMode() const { wxVideoMode GetCurrentMode() const
{
%#if wxUSE_DISPLAY %#if wxUSE_DISPLAY
return self->GetCurrentMode(); return self->GetCurrentMode();
%#else %#else
@@ -195,7 +189,7 @@ function is not supported at all on this platform.", "");
return wxDefaultVideoMode; return wxDefaultVideoMode;
%#endif %#endif
} }
DocStr( DocStr(
ChangeMode, ChangeMode,
@@ -215,8 +209,9 @@ DMUseScreenPrefs, an undocumented function that changed the video mode
to the system default by using the system's 'scrn' resource. to the system default by using the system's 'scrn' resource.
Returns True if succeeded, False otherwise", ""); Returns True if succeeded, False otherwise", "");
bool ChangeMode(const wxVideoMode& mode = wxDefaultVideoMode) { bool ChangeMode(const wxVideoMode& mode = wxDefaultVideoMode)
{
%#if wxUSE_DISPLAY %#if wxUSE_DISPLAY
return self->ChangeMode(mode); return self->ChangeMode(mode);
%#else %#else
@@ -225,19 +220,19 @@ Returns True if succeeded, False otherwise", "");
%#endif %#endif
} }
DocStr( DocStr(
ResetMode, ResetMode,
"Restore the default video mode (just a more readable synonym)", ""); "Restore the default video mode (just a more readable synonym)", "");
void ResetMode() { void ResetMode()
{
%#if wxUSE_DISPLAY %#if wxUSE_DISPLAY
self->ResetMode(); self->ResetMode();
%#else %#else
wxPyRaiseNotImplemented(); wxPyRaiseNotImplemented();
%#endif %#endif
} }
} // end of %extend } // end of %extend
}; };