wxPython/src/_dc.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        _dc.i
   3 // Purpose:     SWIG interface defs for wxDC and releated classes
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     7-July-1997
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 2003 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 // Not a %module
  14
  15
  16
  17 //---------------------------------------------------------------------------
  18
  19 %{
  20 #include "wx/wxPython/pydrawxxx.h"
  21 %}
  22
  23 // TODO: 1. wrappers for wxDrawObject and wxDC::DrawObject
  24
  25
  26 //---------------------------------------------------------------------------
  27
  28 %typemap(in) (int points, wxPoint* points_array ) {
  29     $2 = wxPoint_LIST_helper($input, &$1);
  30     if ($2 == NULL) SWIG_fail;
  31 }
  32 %typemap(freearg) (int points, wxPoint* points_array ) {
  33     if ($2) delete [] $2;
  34 }
  35
  36
  37 //---------------------------------------------------------------------------
  38 %newgroup;
  39
  40
  41 // wxDC is the device context - object on which any drawing is done
  42 class wxDC : public wxObject {
  43 public:
  44 //    wxDC(); **** abstract base class, can't instantiate.
  45     ~wxDC();
  46
  47
  48     virtual void BeginDrawing();
  49     virtual void EndDrawing();
  50
  51
  52 //    virtual void DrawObject(wxDrawObject* drawobject);
  53
  54
  55
  56 #if defined(wxUSE_DC_OLD_METHODS)
  57
  58     bool FloodFill(wxCoord x, wxCoord y, const wxColour& col, int style = wxFLOOD_SURFACE);
  59     //bool GetPixel(wxCoord x, wxCoord y, wxColour *col) const;
  60     %extend {
  61         wxColour GetPixel(wxCoord x, wxCoord y) {
  62             wxColour col;
  63             self->GetPixel(x, y, &col);
  64             return col;
  65         }
  66     }
  67     void DrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2);
  68     void CrossHair(wxCoord x, wxCoord y);
  69     void DrawArc(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2, wxCoord xc, wxCoord yc);
  70     void DrawCheckMark(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
  71     void DrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h, double sa, double ea);
  72     void DrawPoint(wxCoord x, wxCoord y);
  73     void DrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
  74     %name(DrawRectangleRect)void DrawRectangle(const wxRect& rect);
  75     void DrawRoundedRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height, double radius);
  76     void DrawCircle(wxCoord x, wxCoord y, wxCoord radius);
  77     void DrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
  78     void DrawIcon(const wxIcon& icon, wxCoord x, wxCoord y);
  79     void DrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y, bool useMask = False);
  80     void DrawText(const wxString& text, wxCoord x, wxCoord y);
  81     void DrawRotatedText(const wxString& text, wxCoord x, wxCoord y, double angle);
  82     bool Blit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
  83               wxDC *source, wxCoord xsrc, wxCoord ysrc,
  84               int rop = wxCOPY, bool useMask = False,
  85               wxCoord xsrcMask = -1, wxCoord ysrcMask = -1);
  86
  87
  88
  89 #else  // The new way
  90
  91     %name(FloodFillXY) bool FloodFill(wxCoord x, wxCoord y, const wxColour& col, int style = wxFLOOD_SURFACE);
  92     bool FloodFill(const wxPoint& pt, const wxColour& col, int style = wxFLOOD_SURFACE);
  93
  94     //%name(GetPixelXY) bool GetPixel(wxCoord x, wxCoord y, wxColour *col) const;
  95     //bool GetPixel(const wxPoint& pt, wxColour *col) const;
  96     %extend {
  97         wxColour GetPixelXY(wxCoord x, wxCoord y) {
  98             wxColour col;
  99             self->GetPixel(x, y, &col);
 100             return col;
 101         }
 102         wxColour GetPixel(const wxPoint& pt) {
 103             wxColour col;
 104             self->GetPixel(pt, &col);
 105             return col;
 106         }
 107     }
 108     %name(DrawLineXY) void DrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2);
 109     void DrawLine(const wxPoint& pt1, const wxPoint& pt2);
 110
 111     %name(CrossHairXY) void CrossHair(wxCoord x, wxCoord y);
 112     void CrossHair(const wxPoint& pt);
 113
 114     %name(DrawArcXY) void DrawArc(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2, wxCoord xc, wxCoord yc);
 115     void DrawArc(const wxPoint& pt1, const wxPoint& pt2, const wxPoint& centre);
 116
 117     %name(DrawCheckMarkXY) void DrawCheckMark(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
 118     void DrawCheckMark(const wxRect& rect);
 119
 120     %name(DrawEllipticArcXY) void DrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h, double sa, double ea);
 121     void DrawEllipticArc(const wxPoint& pt, const wxSize& sz, double sa, double ea);
 122
 123     %name(DrawPointXY) void DrawPoint(wxCoord x, wxCoord y);
 124     void DrawPoint(const wxPoint& pt);
 125
 126     %name(DrawRectangleXY) void DrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
 127     void DrawRectangle(const wxPoint& pt, const wxSize& sz);
 128     %name(DrawRectangleRect) void DrawRectangle(const wxRect& rect);
 129
 130     %name(DrawRoundedRectangleXY) void DrawRoundedRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height, double radius);
 131     void DrawRoundedRectangle(const wxPoint& pt, const wxSize& sz, double radius);
 132     %name(DrawRoundedRectangleRect) void DrawRoundedRectangle(const wxRect& r, double radius);
 133
 134     %name(DrawCircleXY) void DrawCircle(wxCoord x, wxCoord y, wxCoord radius);
 135     void DrawCircle(const wxPoint& pt, wxCoord radius);
 136
 137     %name(DrawEllipseXY) void DrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
 138     void DrawEllipse(const wxPoint& pt, const wxSize& sz);
 139     %name(DrawEllipseRect) void DrawEllipse(const wxRect& rect);
 140
 141     %name(DrawIconXY) void DrawIcon(const wxIcon& icon, wxCoord x, wxCoord y);
 142     void DrawIcon(const wxIcon& icon, const wxPoint& pt);
 143
 144     %name(DrawBitmapXY) void DrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y, bool useMask = False);
 145     void DrawBitmap(const wxBitmap &bmp, const wxPoint& pt, bool useMask = False);
 146
 147     %name(DrawTextXY) void DrawText(const wxString& text, wxCoord x, wxCoord y);
 148     void DrawText(const wxString& text, const wxPoint& pt);
 149
 150     %name(DrawRotatedTextXY) void DrawRotatedText(const wxString& text, wxCoord x, wxCoord y, double angle);
 151     void DrawRotatedText(const wxString& text, const wxPoint& pt, double angle);
 152
 153
 154     %name(BlitXY) bool Blit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
 155                             wxDC *source, wxCoord xsrc, wxCoord ysrc,
 156                             int rop = wxCOPY, bool useMask = False,
 157                             wxCoord xsrcMask = -1, wxCoord ysrcMask = -1);
 158     bool Blit(const wxPoint& destPt, const wxSize& sz,
 159               wxDC *source, const wxPoint& srcPt,
 160               int rop = wxCOPY, bool useMask = False,
 161               const wxPoint& srcPtMask = wxDefaultPosition);
 162
 163 #endif
 164
 165     void DrawLines(int points, wxPoint* points_array, wxCoord xoffset = 0, wxCoord yoffset = 0);
 166
 167     void DrawPolygon(int points, wxPoint* points_array,
 168                      wxCoord xoffset = 0, wxCoord yoffset = 0,
 169                      int fillStyle = wxODDEVEN_RULE);
 170
 171     // TODO:  Figure out what the start parameter means and devise a
 172     // good typemap for this
 173     //void DrawPolyPolygon(int n, int start[], wxPoint points[],
 174     //                     wxCoord xoffset = 0, wxCoord yoffset = 0,
 175     //                     int fillStyle = wxODDEVEN_RULE)
 176
 177     // this version puts both optional bitmap and the text into the given
 178     // rectangle and aligns is as specified by alignment parameter; it also
 179     // will emphasize the character with the given index if it is != -1 and
 180     // return the bounding rectangle if required
 181     void DrawLabel(const wxString& text, const wxRect& rect,
 182                    int alignment = wxALIGN_LEFT | wxALIGN_TOP,
 183                    int indexAccel = -1);
 184     %extend {
 185         wxRect DrawImageLabel(const wxString& text,
 186                               const wxBitmap& image,
 187                               const wxRect& rect,
 188                               int alignment = wxALIGN_LEFT | wxALIGN_TOP,
 189                               int indexAccel = -1) {
 190             wxRect rv;
 191             self->DrawLabel(text, image, rect, alignment, indexAccel, &rv);
 192             return rv;
 193         }
 194     }
 195
 196
 197
 198     void DrawSpline(int points, wxPoint* points_array);
 199
 200
 201
 202     // global DC operations
 203     // --------------------
 204
 205     virtual void Clear();
 206
 207     virtual bool StartDoc(const wxString& message);
 208     virtual void EndDoc();
 209
 210     virtual void StartPage();
 211     virtual void EndPage();
 212
 213
 214     // set objects to use for drawing
 215     // ------------------------------
 216
 217     virtual void SetFont(const wxFont& font);
 218     virtual void SetPen(const wxPen& pen);
 219     virtual void SetBrush(const wxBrush& brush);
 220     virtual void SetBackground(const wxBrush& brush);
 221     virtual void SetBackgroundMode(int mode);
 222     virtual void SetPalette(const wxPalette& palette);
 223
 224
 225     // clipping region
 226     // ---------------
 227
 228     %name(SetClippingRegionXY)void SetClippingRegion(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
 229     void SetClippingRegion(const wxPoint& pt, const wxSize& sz);
 230     %name(SetClippingRect) void SetClippingRegion(const wxRect& rect);
 231     %name(SetClippingRegionAsRegion) void SetClippingRegion(const wxRegion& region);
 232
 233     virtual void DestroyClippingRegion();
 234
 235     DocDeclA(
 236         void, GetClippingBox(wxCoord *OUTPUT, wxCoord *OUTPUT, wxCoord *OUTPUT, wxCoord *OUTPUT) const,
 237         "GetClippingBox() -> (x, y, width, height)");
 238
 239     %extend {
 240         wxRect GetClippingRect() {
 241             wxRect rect;
 242             self->GetClippingBox(rect);
 243             return rect;
 244         }
 245     }
 246
 247
 248
 249     // text extent
 250     // -----------
 251
 252     virtual wxCoord GetCharHeight() const;
 253     virtual wxCoord GetCharWidth() const;
 254
 255
 256     DocDeclAStr(
 257         void, GetTextExtent(const wxString& string, wxCoord *OUTPUT, wxCoord *OUTPUT),
 258         "GetTextExtent(wxString string) -> (width, height)",
 259         "Get the width and height of the text using the current font.\n"
 260         "Only works for single line strings.");
 261     DocDeclAStrName(
 262         void, GetTextExtent(const wxString& string,
 263                             wxCoord *OUTPUT, wxCoord *OUTPUT, wxCoord *OUTPUT, wxCoord* OUTPUT,
 264                             wxFont* font = NULL),
 265         "GetFullTextExtent(wxString string, Font font=None) ->\n   (width, height, descent, externalLeading)",
 266         "Get the width, height, decent and leading of the text using the current or specified font.\n"
 267         "Only works for single line strings.",
 268         GetFullTextExtent);
 269
 270
 271     // works for single as well as multi-line strings
 272     DocDeclAStr(
 273         void, GetMultiLineTextExtent(const wxString& text,
 274                                      wxCoord *OUTPUT, wxCoord *OUTPUT, wxCoord *OUTPUT,
 275                                      wxFont *font = NULL),
 276         "GetMultiLineTextExtent(wxString string, Font font=None) ->\n   (width, height, descent, externalLeading)",
 277         "Get the width, height, decent and leading of the text using the current or specified font.\n"
 278         "Works for single as well as multi-line strings.");
 279
 280
 281     // size and resolution
 282     // -------------------
 283
 284     DocStr(GetSize, "Get the DC size in device units.");
 285     wxSize GetSize();
 286     DocDeclAName(
 287         void, GetSize( int *OUTPUT, int *OUTPUT ),
 288         "GetSizeTuple() -> (width, height)",
 289         GetSizeTuple);
 290
 291
 292     DocStr(GetSizeMM, "Get the DC size in milimeters.");
 293     wxSize GetSizeMM() const;
 294     DocDeclAName(
 295         void, GetSizeMM( int *OUTPUT, int *OUTPUT ) const,
 296         "GetSizeMMTuple() -> (width, height)",
 297         GetSizeMMTuple);
 298
 299
 300
 301     // coordinates conversions
 302     // -----------------------
 303
 304     // This group of functions does actual conversion of the input, as you'd
 305     // expect.
 306     wxCoord DeviceToLogicalX(wxCoord x) const;
 307     wxCoord DeviceToLogicalY(wxCoord y) const;
 308     wxCoord DeviceToLogicalXRel(wxCoord x) const;
 309     wxCoord DeviceToLogicalYRel(wxCoord y) const;
 310     wxCoord LogicalToDeviceX(wxCoord x) const;
 311     wxCoord LogicalToDeviceY(wxCoord y) const;
 312     wxCoord LogicalToDeviceXRel(wxCoord x) const;
 313     wxCoord LogicalToDeviceYRel(wxCoord y) const;
 314
 315     // query DC capabilities
 316     // ---------------------
 317
 318     virtual bool CanDrawBitmap() const;
 319     virtual bool CanGetTextExtent() const;
 320
 321     // colour depth
 322     virtual int GetDepth() const;
 323
 324     // Resolution in Pixels per inch
 325     virtual wxSize GetPPI() const;
 326
 327     virtual bool Ok() const;
 328
 329
 330
 331     int GetBackgroundMode() const;
 332     const wxBrush&  GetBackground() const;
 333     const wxBrush&  GetBrush() const;
 334     const wxFont&   GetFont() const;
 335     const wxPen&    GetPen() const;
 336     const wxColour& GetTextBackground() const;
 337     const wxColour& GetTextForeground() const;
 338
 339     virtual void SetTextForeground(const wxColour& colour);
 340     virtual void SetTextBackground(const wxColour& colour);
 341
 342     int GetMapMode() const;
 343     virtual void SetMapMode(int mode);
 344
 345
 346     DocDeclA(
 347         virtual void, GetUserScale(double *OUTPUT, double *OUTPUT) const,
 348         "GetUserScale() -> (xScale, yScale)");
 349
 350     virtual void SetUserScale(double x, double y);
 351
 352
 353     DocDeclA(
 354         virtual void, GetLogicalScale(double *OUTPUT, double *OUTPUT),
 355         "GetLogicalScale() -> (xScale, yScale)");
 356
 357     virtual void SetLogicalScale(double x, double y);
 358
 359
 360     wxPoint GetLogicalOrigin() const;
 361     DocDeclAName(
 362         void, GetLogicalOrigin(wxCoord *OUTPUT, wxCoord *OUTPUT) const,
 363         "GetLogicalOriginTuple() -> (x,y)",
 364         GetLogicalOriginTuple);
 365
 366     virtual void SetLogicalOrigin(wxCoord x, wxCoord y);
 367
 368
 369     wxPoint GetDeviceOrigin() const;
 370     DocDeclAName(
 371         void, GetDeviceOrigin(wxCoord *OUTPUT, wxCoord *OUTPUT) const,
 372         "GetDeviceOriginTuple() -> (x,y)",
 373         GetDeviceOriginTuple);
 374
 375     virtual void SetDeviceOrigin(wxCoord x, wxCoord y);
 376
 377     virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp);
 378
 379     int GetLogicalFunction() const;
 380     virtual void SetLogicalFunction(int function);
 381
 382     virtual void SetOptimization(bool opt);
 383     virtual bool GetOptimization();
 384
 385
 386     // bounding box
 387     // ------------
 388
 389     virtual void CalcBoundingBox(wxCoord x, wxCoord y);
 390     void ResetBoundingBox();
 391
 392     // Get the final bounding box of the PostScript or Metafile picture.
 393     wxCoord MinX() const;
 394     wxCoord MaxX() const;
 395     wxCoord MinY() const;
 396     wxCoord MaxY() const;
 397
 398
 399     DocA(GetBoundingBox,
 400          "GetBoundingBox() -> (x1,y1, x2,y2)");
 401     %extend {
 402         void GetBoundingBox(int* OUTPUT, int* OUTPUT, int* OUTPUT, int* OUTPUT);
 403         // See below for implementation
 404     }
 405     %pythoncode { def __nonzero__(self): return self.Ok() };
 406
 407
 408
 409     %extend { // See drawlist.cpp for impplementaion of these...
 410         PyObject* _DrawPointList(PyObject* pyCoords, PyObject* pyPens, PyObject* pyBrushes)
 411         {
 412             return wxPyDrawXXXList(*self, wxPyDrawXXXPoint, pyCoords, pyPens, pyBrushes);
 413         }
 414
 415         PyObject* _DrawLineList(PyObject* pyCoords, PyObject* pyPens, PyObject* pyBrushes)
 416         {
 417             return wxPyDrawXXXList(*self, wxPyDrawXXXLine, pyCoords, pyPens, pyBrushes);
 418         }
 419
 420         PyObject* _DrawRectangleList(PyObject* pyCoords, PyObject* pyPens, PyObject* pyBrushes)
 421         {
 422             return wxPyDrawXXXList(*self, wxPyDrawXXXRectangle, pyCoords, pyPens, pyBrushes);
 423         }
 424
 425         PyObject* _DrawEllipseList(PyObject* pyCoords, PyObject* pyPens, PyObject* pyBrushes)
 426         {
 427             return wxPyDrawXXXList(*self, wxPyDrawXXXEllipse, pyCoords, pyPens, pyBrushes);
 428         }
 429
 430         PyObject* _DrawPolygonList(PyObject* pyCoords, PyObject* pyPens, PyObject* pyBrushes)
 431         {
 432             return wxPyDrawXXXList(*self, wxPyDrawXXXPolygon, pyCoords, pyPens, pyBrushes);
 433         }
 434
 435         PyObject* _DrawTextList(PyObject* textList, PyObject* pyPoints,
 436                                 PyObject* foregroundList, PyObject* backgroundList) {
 437             return wxPyDrawTextList(*self, textList, pyPoints, foregroundList, backgroundList);
 438         }
 439     }
 440
 441     %pythoncode {
 442     def DrawPointList(self, points, pens=None):
 443         if pens is None:
 444            pens = []
 445         elif isinstance(pens, wx.Pen):
 446            pens = [pens]
 447         elif len(pens) != len(points):
 448            raise ValueError('points and pens must have same length')
 449         return self._DrawPointList(points, pens, [])
 450
 451
 452     def DrawLineList(self, lines, pens=None):
 453         if pens is None:
 454            pens = []
 455         elif isinstance(pens, wx.Pen):
 456            pens = [pens]
 457         elif len(pens) != len(lines):
 458            raise ValueError('lines and pens must have same length')
 459         return self._DrawLineList(lines, pens, [])
 460
 461
 462     def DrawRectangleList(self, rectangles, pens=None, brushes=None):
 463         if pens is None:
 464            pens = []
 465         elif isinstance(pens, wx.Pen):
 466            pens = [pens]
 467         elif len(pens) != len(rectangles):
 468            raise ValueError('rectangles and pens must have same length')
 469         if brushes is None:
 470            brushes = []
 471         elif isinstance(brushes, wx.Brush):
 472            brushes = [brushes]
 473         elif len(brushes) != len(rectangles):
 474            raise ValueError('rectangles and brushes must have same length')
 475         return self._DrawRectangleList(rectangles, pens, brushes)
 476
 477
 478     def DrawEllipseList(self, ellipses, pens=None, brushes=None):
 479         if pens is None:
 480            pens = []
 481         elif isinstance(pens, wx.Pen):
 482            pens = [pens]
 483         elif len(pens) != len(ellipses):
 484            raise ValueError('ellipses and pens must have same length')
 485         if brushes is None:
 486            brushes = []
 487         elif isinstance(brushes, wx.Brush):
 488            brushes = [brushes]
 489         elif len(brushes) != len(ellipses):
 490            raise ValueError('ellipses and brushes must have same length')
 491         return self._DrawEllipseList(ellipses, pens, brushes)
 492
 493
 494     def DrawPolygonList(self, polygons, pens=None, brushes=None):
 495         %## Note: This does not currently support fill style or offset
 496         %## you can always use the non-List version if need be.
 497         if pens is None:
 498            pens = []
 499         elif isinstance(pens, wx.Pen):
 500            pens = [pens]
 501         elif len(pens) != len(polygons):
 502            raise ValueError('polygons and pens must have same length')
 503         if brushes is None:
 504            brushes = []
 505         elif isinstance(brushes, wx.Brush):
 506            brushes = [brushes]
 507         elif len(brushes) != len(polygons):
 508            raise ValueError('polygons and brushes must have same length')
 509         return self._DrawPolygonList(polygons, pens, brushes)
 510
 511
 512     def DrawTextList(self, textList, coords, foregrounds = None, backgrounds = None, fonts = None):
 513         %## NOTE: this does not currently support changing the font
 514         %##       Make sure you set Background mode to wxSolid (DC.SetBackgroundMode)
 515         %##       If you want backgounds to do anything.
 516         if type(textList) == type(''):
 517            textList = [textList]
 518         elif len(textList) != len(coords):
 519            raise ValueError('textlist and coords must have same length')
 520         if foregrounds is None:
 521            foregrounds = []
 522         elif isinstance(foregrounds, wx.Colour):
 523            foregrounds = [foregrounds]
 524         elif len(foregrounds) != len(coords):
 525            raise ValueError('foregrounds and coords must have same length')
 526         if backgrounds is None:
 527            backgrounds = []
 528         elif isinstance(backgrounds, wx.Colour):
 529            backgrounds = [backgrounds]
 530         elif len(backgrounds) != len(coords):
 531            raise ValueError('backgrounds and coords must have same length')
 532         return  self._DrawTextList(textList, coords, foregrounds, backgrounds)
 533     }
 534
 535 };
 536
 537
 538
 539 %{
 540 static void wxDC_GetBoundingBox(wxDC* dc, int* x1, int* y1, int* x2, int* y2) {
 541     *x1 = dc->MinX();
 542     *y1 = dc->MinY();
 543     *x2 = dc->MaxX();
 544     *y2 = dc->MaxY();
 545 }
 546 %}
 547
 548
 549 //---------------------------------------------------------------------------
 550 %newgroup
 551
 552 class wxMemoryDC : public wxDC {
 553 public:
 554     wxMemoryDC();
 555     %name(MemoryDCFromDC) wxMemoryDC(wxDC* oldDC);
 556
 557     void SelectObject(const wxBitmap& bitmap);
 558 };
 559
 560 //---------------------------------------------------------------------------
 561 %newgroup
 562
 563 enum
 564 {
 565     // this is more efficient and hence default
 566     wxBUFFER_DC_OVERWRITE_BG = 0,
 567
 568     // preserve the old background: more time consuming
 569     wxBUFFER_DC_PRESERVE_BG = 1,
 570
 571     // flags used by default
 572     wxBUFFER_DC_DEFAULT = wxBUFFER_DC_OVERWRITE_BG
 573 };
 574
 575
 576 class wxBufferedDC : public wxMemoryDC
 577 {
 578 public:
 579     %pythonAppend wxBufferedDC( wxDC *dc, const wxBitmap &buffer )
 580         "self._dc = args[0] # save a ref so the other dc will not be deleted before self";
 581     %pythonAppend wxBufferedDC( wxDC *dc, const wxSize &area, int flags = wxBUFFER_DC_DEFAULT )
 582         "val._dc = args[0] # save a ref so the other dc will not be deleted before self";
 583
 584     %nokwargs wxBufferedDC;
 585
 586     // Construct a wxBufferedDC using a user supplied buffer.
 587     wxBufferedDC( wxDC *dc, const wxBitmap &buffer );
 588
 589     // Construct a wxBufferedDC with an internal buffer of 'area'
 590     // (where area is usually something like the size of the window
 591     // being buffered)
 592     wxBufferedDC( wxDC *dc, const wxSize &area, int flags = wxBUFFER_DC_DEFAULT );
 593
 594     // TODO: Keep this one too?
 595     %name(BufferedDCInternalBuffer) wxBufferedDC( wxDC *dc, const wxSize &area, int flags = wxBUFFER_DC_DEFAULT );
 596
 597     // Blits the buffer to the dc, and detaches the dc from
 598     // the buffer.  Usually called in the dtor or by the dtor
 599     // of derived classes if the BufferedDC must blit before
 600     // the derived class (which may own the dc it's blitting
 601     // to) is destroyed.
 602     void UnMask();
 603 };
 604
 605
 606 class wxBufferedPaintDC : public wxBufferedDC
 607 {
 608 public:
 609
 610     %nokwargs wxBufferedPaintDC;
 611
 612     wxBufferedPaintDC( wxWindow *window, const wxBitmap &buffer );
 613
 614     // this ctor creates a bitmap of the size of the window for buffering
 615     wxBufferedPaintDC(wxWindow *window, int flags = wxBUFFER_DC_DEFAULT);
 616
 617 };
 618
 619
 620 //---------------------------------------------------------------------------
 621 %newgroup
 622
 623 class wxScreenDC : public wxDC {
 624 public:
 625     wxScreenDC();
 626
 627     %name(StartDrawingOnTopWin) bool StartDrawingOnTop(wxWindow* window);
 628     bool StartDrawingOnTop(wxRect* rect = NULL);
 629     bool EndDrawingOnTop();
 630 };
 631
 632 //---------------------------------------------------------------------------
 633 %newgroup
 634
 635 class wxClientDC : public wxDC {
 636 public:
 637       wxClientDC(wxWindow* win);
 638 };
 639
 640 //---------------------------------------------------------------------------
 641 %newgroup
 642
 643 class wxPaintDC : public wxDC {
 644 public:
 645       wxPaintDC(wxWindow* win);
 646 };
 647
 648 //---------------------------------------------------------------------------
 649 %newgroup
 650
 651 class wxWindowDC : public wxDC {
 652 public:
 653       wxWindowDC(wxWindow* win);
 654 };
 655
 656 //---------------------------------------------------------------------------
 657 %newgroup
 658
 659 class wxMirrorDC : public wxDC
 660 {
 661 public:
 662     // constructs a mirror DC associated with the given real DC
 663     //
 664     // if mirror parameter is True, all vertical and horizontal coordinates are
 665     // exchanged, otherwise this class behaves in exactly the same way as a
 666     // plain DC
 667     //
 668     wxMirrorDC(wxDC& dc, bool mirror);
 669 };
 670
 671 //---------------------------------------------------------------------------
 672 %newgroup
 673
 674 %{
 675 #include <wx/dcps.h>
 676 %}
 677
 678 class wxPostScriptDC : public wxDC {
 679 public:
 680     wxPostScriptDC(const wxPrintData& printData);
 681 //     %name(PostScriptDC2)wxPostScriptDC(const wxString& output,
 682 //                                          bool interactive = True,
 683 //                                          wxWindow* parent = NULL);
 684
 685     wxPrintData& GetPrintData();
 686     void SetPrintData(const wxPrintData& data);
 687
 688     static void SetResolution(int ppi);
 689     static int GetResolution();
 690 };
 691
 692 //---------------------------------------------------------------------------
 693 %newgroup
 694
 695
 696 #ifdef __WXMSW__
 697
 698 %{
 699 #include <wx/metafile.h>
 700 %}
 701
 702 class wxMetaFile : public wxObject {
 703 public:
 704     wxMetaFile(const wxString& filename = wxPyEmptyString);
 705     ~wxMetaFile();
 706
 707     bool Ok();
 708     bool SetClipboard(int width = 0, int height = 0);
 709
 710     wxSize GetSize();
 711     int GetWidth();
 712     int GetHeight();
 713
 714     const wxString& GetFileName() const;
 715
 716     %pythoncode { def __nonzero__(self): return self.Ok() }
 717 };
 718
 719 // bool wxMakeMetaFilePlaceable(const wxString& filename,
 720 //                              int minX, int minY, int maxX, int maxY, float scale=1.0);
 721
 722
 723 class wxMetaFileDC : public wxDC {
 724 public:
 725     wxMetaFileDC(const wxString& filename = wxPyEmptyString,
 726                  int width = 0, int height = 0,
 727                  const wxString& description = wxPyEmptyString);
 728     wxMetaFile* Close();
 729 };
 730
 731
 732
 733 #else  // Make some dummies for the other platforms
 734
 735 %{
 736 class wxMetaFile : public wxObject {
 737 public:
 738     wxMetaFile(const wxString&)
 739         { wxPyRaiseNotImplemented(); }
 740 };
 741
 742 class wxMetaFileDC : public wxClientDC {
 743 public:
 744     wxMetaFileDC(const wxString&, int, int, const wxString&)
 745         { wxPyRaiseNotImplemented(); }
 746 };
 747
 748 %}
 749
 750 class wxMetaFile : public wxObject {
 751 public:
 752     wxMetaFile(const wxString& filename = wxPyEmptyString);
 753 };
 754
 755 class wxMetaFileDC : public wxDC {
 756 public:
 757     wxMetaFileDC(const wxString& filename = wxPyEmptyString,
 758                  int width = 0, int height = 0,
 759                  const wxString& description = wxPyEmptyString);
 760 };
 761
 762
 763 #endif
 764
 765
 766 //---------------------------------------------------------------------------
 767
 768 #if defined(__WXMSW__) || defined(__WXMAC__)
 769
 770 class  wxPrinterDC : public wxDC {
 771 public:
 772     wxPrinterDC(const wxPrintData& printData);
 773 //     %name(PrinterDC2) wxPrinterDC(const wxString& driver,
 774 //                                     const wxString& device,
 775 //                                     const wxString& output,
 776 //                                     bool interactive = True,
 777 //                                     int orientation = wxPORTRAIT);
 778 };
 779
 780 #else
 781 %{
 782 class  wxPrinterDC : public wxClientDC {
 783 public:
 784     wxPrinterDC(const wxPrintData&)
 785         { wxPyRaiseNotImplemented(); }
 786
 787 //     wxPrinterDC(const wxString&, const wxString&, const wxString&, bool, int)
 788 //         { wxPyRaiseNotImplemented(); }
 789 };
 790 %}
 791
 792 class  wxPrinterDC : public wxDC {
 793 public:
 794     wxPrinterDC(const wxPrintData& printData);
 795 //     %name(PrinterDC2) wxPrinterDC(const wxString& driver,
 796 //                                     const wxString& device,
 797 //                                     const wxString& output,
 798 //                                     bool interactive = True,
 799 //                                     int orientation = wxPORTRAIT);
 800 };
 801 #endif
 802
 803 //---------------------------------------------------------------------------
 804 //---------------------------------------------------------------------------
 805
 806 // Now define some Python classes that rename the Draw methods to be
 807 // compatible with the DC Draw methods in 2.4.  See also wxPython/_wx.py.
 808
 809
 810 %define MAKE_OLD_DC_CLASS(classname)
 811     %pythoncode {
 812     class classname##_old(classname):
 813         """DC class that has methods with 2.4 compatible parameters."""
 814         FloodFill = classname.FloodFillXY
 815         GetPixel = classname.GetPixelXY
 816         DrawLine = classname.DrawLineXY
 817         CrossHair = classname.CrossHairXY
 818         DrawArc = classname.DrawArcXY
 819         DrawCheckMark = classname.DrawCheckMarkXY
 820         DrawEllipticArc = classname.DrawEllipticArcXY
 821         DrawPoint = classname.DrawPointXY
 822         DrawRectangle = classname.DrawRectangleXY
 823         DrawRoundedRectangle = classname.DrawRoundedRectangleXY
 824         DrawCircle = classname.DrawCircleXY
 825         DrawEllipse = classname.DrawEllipseXY
 826         DrawIcon = classname.DrawIconXY
 827         DrawBitmap = classname.DrawBitmapXY
 828         DrawText = classname.DrawTextXY
 829         DrawRotatedText = classname.DrawRotatedTextXY
 830         Blit = classname.BlitXY
 831     }
 832 %enddef
 833
 834 MAKE_OLD_DC_CLASS(DC);
 835 MAKE_OLD_DC_CLASS(MemoryDC);
 836 MAKE_OLD_DC_CLASS(BufferedDC);
 837 MAKE_OLD_DC_CLASS(BufferedPaintDC);
 838 MAKE_OLD_DC_CLASS(ScreenDC);
 839 MAKE_OLD_DC_CLASS(ClientDC);
 840 MAKE_OLD_DC_CLASS(PaintDC);
 841 MAKE_OLD_DC_CLASS(WindowDC);
 842 MAKE_OLD_DC_CLASS(MirrorDC);
 843 MAKE_OLD_DC_CLASS(PostScriptDC);
 844 MAKE_OLD_DC_CLASS(MetaFileDC);
 845 MAKE_OLD_DC_CLASS(PrinterDC);
 846
 847
 848 //---------------------------------------------------------------------------