AuroraMiddleware/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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

Browse Source 
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
1 changed files with 30 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
wxPython/src/_display.i
View File

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