wxPython/src/_display.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        _display.i
   3 // Purpose:     SWIG interface for wxVideoMode and wxDisplay
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     9-Mar-2004
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 2004 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 // Not a %module
  14
  15
  16 //---------------------------------------------------------------------------
  17
  18 %{
  19 #include <wx/display.h>
  20 %}
  21
  22
  23 //---------------------------------------------------------------------------
  24 %newgroup
  25
  26
  27 DocStr(wxVideoMode,
  28        "A simple struct containing video mode parameters for a display", "");
  29
  30 struct wxVideoMode
  31 {
  32     wxVideoMode(int width = 0, int height = 0, int depth = 0, int freq = 0);
  33     ~wxVideoMode();
  34
  35     DocDeclStr(
  36         bool , Matches(const wxVideoMode& other) const,
  37         "Returns true if this mode matches the other one in the sense that all
  38 non zero fields of the other mode have the same value in this
  39 one (except for refresh which is allowed to have a greater value)", "");
  40
  41     DocDeclStr(
  42         int , GetWidth() const,
  43         "Returns the screen width in pixels (e.g. 640*480), 0 means unspecified", "");
  44
  45     DocDeclStr(
  46         int , GetHeight() const,
  47         "Returns the screen width in pixels (e.g. 640*480), 0 means
  48 unspecified", "");
  49
  50     DocDeclStr(
  51         int , GetDepth() const,
  52         "Returns the screen's bits per pixel (e.g. 32), 1 is monochrome and 0
  53 means unspecified/known", "");
  54
  55
  56     DocDeclStr(
  57         bool , IsOk() const,
  58         "returns true if the object has been initialized", "");
  59
  60
  61
  62     %pythoncode { def __nonzero__(self): return self.IsOk() }
  63     %extend {
  64         bool __eq__(const wxVideoMode* other) { return other ? (*self == *other) : false; }
  65         bool __ne__(const wxVideoMode* other) { return other ? (*self != *other) : true;  }
  66     }
  67
  68
  69     // the screen size in pixels (e.g. 640*480), 0 means unspecified
  70     int w, h;
  71
  72     // bits per pixel (e.g. 32), 1 is monochrome and 0 means unspecified/known
  73     int bpp;
  74
  75     // refresh frequency in Hz, 0 means unspecified/unknown
  76     int refresh;
  77 };
  78
  79
  80 %immutable;
  81 const wxVideoMode     wxDefaultVideoMode;
  82 %mutable;
  83
  84
  85 //---------------------------------------------------------------------------
  86
  87
  88 %{
  89 // dummy version of wxDisplay for when it is not enabled in the wxWidgets build
  90 #if !wxUSE_DISPLAY
  91 #include <wx/dynarray.h>
  92 #include <wx/vidmode.h>
  93
  94     WX_DECLARE_OBJARRAY(wxVideoMode, wxArrayVideoModes);
  95 #include "wx/arrimpl.cpp"
  96 WX_DEFINE_OBJARRAY(wxArrayVideoModes);
  97 const wxVideoMode wxDefaultVideoMode;
  98
  99 class wxDisplay
 100 {
 101 public:
 102     wxDisplay(size_t index = 0) { wxPyRaiseNotImplemented(); }
 103     ~wxDisplay() {}
 104
 105     static size_t  GetCount()
 106         { wxPyRaiseNotImplemented(); return 0; }
 107
 108     static int GetFromPoint(const wxPoint& pt)
 109         { wxPyRaiseNotImplemented(); return wxNOT_FOUND; }
 110     static int GetFromWindow(wxWindow *window)
 111         { wxPyRaiseNotImplemented(); return wxNOT_FOUND; }
 112
 113     virtual bool IsOk() const { return false; }
 114     virtual wxRect GetGeometry() const { wxRect r; return r; }
 115     virtual wxString GetName() const { return wxEmptyString; }
 116     bool IsPrimary() const { return false; }
 117
 118     wxArrayVideoModes GetModes(const wxVideoMode& mode = wxDefaultVideoMode)
 119         { wxArrayVideoModes a; return a; }
 120
 121     virtual wxVideoMode GetCurrentMode() const
 122         { return wxDefaultVideoMode; }
 123
 124     virtual bool ChangeMode(const wxVideoMode& mode = wxDefaultVideoMode)
 125        { return false; }
 126
 127     void  ResetMode() {}
 128 };
 129 #endif
 130 %}
 131
 132
 133
 134 DocStr(wxDisplay,
 135        "Represents a display/monitor attached to the system", "");
 136 class wxDisplay
 137 {
 138 public:
 139     //
 140     DocCtorStr(
 141         wxDisplay(size_t index = 0),
 142         "Set up a Display instance with the specified display.  The displays
 143 are numbered from 0 to GetCount() - 1, 0 is always the primary display
 144 and the only one which is always supported", "");
 145
 146     virtual ~wxDisplay();
 147
 148     DocDeclStr(
 149         static size_t , GetCount(),
 150         "Return the number of available displays.", "");
 151
 152
 153     DocDeclStr(
 154         static int , GetFromPoint(const wxPoint& pt),
 155         "Find the display where the given point lies, return wx.NOT_FOUND if it
 156 doesn't belong to any display", "");
 157
 158
 159     DocStr(GetFromWindow,
 160            "Find the display where the given window lies, return wx.NOT_FOUND if
 161 it is not shown at all.", "");
 162     static int GetFromWindow(wxWindow *window);
 163
 164
 165     DocDeclStr(
 166         virtual bool , IsOk() const,
 167         "Return true if the object was initialized successfully", "");
 168     %pythoncode { def __nonzero__(self): return self.IsOk() }
 169
 170
 171     DocDeclStr(
 172         virtual wxRect , GetGeometry() const,
 173         "Returns the bounding rectangle of the display whose index was passed
 174 to the constructor.", "");
 175
 176
 177     DocDeclStr(
 178         virtual wxString , GetName() const,
 179         "Returns the display's name. A name is not available on all platforms.", "");
 180
 181
 182     DocDeclStr(
 183         bool , IsPrimary() const,
 184         "Returns true if the display is the primary display. The primary
 185 display is the one whose index is 0.", "");
 186
 187
 188
 189     %extend {
 190         DocAStr(GetModes,
 191                 "GetModes(VideoMode mode=DefaultVideoMode) -> [videoMode...]",
 192                 "Enumerate all video modes supported by this display matching the given
 193 one (in the sense of VideoMode.Match()).
 194
 195 As any mode matches the default value of the argument and there is
 196 always at least one video mode supported by display, the returned
 197 array is only empty for the default value of the argument if this
 198 function is not supported at all on this platform.", "");
 199
 200         PyObject* GetModes(const wxVideoMode& mode = wxDefaultVideoMode) {
 201             PyObject* pyList = NULL;
 202             wxArrayVideoModes arr = self->GetModes(mode);
 203             wxPyBlock_t blocked = wxPyBeginBlockThreads();
 204             pyList = PyList_New(0);
 205             for (int i=0; i < arr.GetCount(); i++) {
 206                 wxVideoMode* m = new wxVideoMode(arr.Item(i));
 207                 PyObject* pyObj = wxPyConstructObject(m, wxT("wxVideoMode"), true);
 208                 PyList_Append(pyList, pyObj);
 209                 Py_DECREF(pyObj);
 210             }
 211             wxPyEndBlockThreads(blocked);
 212             return pyList;
 213         }
 214     }
 215
 216
 217     DocDeclStr(
 218         virtual wxVideoMode , GetCurrentMode() const,
 219         "Get the current video mode.", "");
 220
 221
 222     DocDeclStr(
 223         virtual bool , ChangeMode(const wxVideoMode& mode = wxDefaultVideoMode),
 224         "Changes the video mode of this display to the mode specified in the
 225 mode parameter.
 226
 227 If wx.DefaultVideoMode is passed in as the mode parameter, the defined
 228 behaviour is that wx.Display will reset the video mode to the default
 229 mode used by the display.  On Windows, the behavior is normal.
 230 However, there are differences on other platforms. On Unix variations
 231 using X11 extensions it should behave as defined, but some
 232 irregularities may occur.
 233
 234 On wxMac passing in wx.DefaultVideoMode as the mode parameter does
 235 nothing.  This happens because Carbon no longer has access to
 236 DMUseScreenPrefs, an undocumented function that changed the video mode
 237 to the system default by using the system's 'scrn' resource.
 238
 239 Returns True if succeeded, False otherwise", "");
 240
 241
 242     DocDeclStr(
 243         void , ResetMode(),
 244         "Restore the default video mode (just a more readable synonym)", "");
 245
 246
 247 };
 248
 249 //---------------------------------------------------------------------------