utils/wxPython/src/gdi.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        gdi.i
   3 // Purpose:     SWIG interface file for wxDC, wxBrush, wxPen, wxFont, etc.
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     7/7/97
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 1998 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13
  14 %module gdi
  15
  16 %{
  17 #include "helpers.h"
  18 #include <wx/metafile.h>
  19 #include <wx/imaglist.h>
  20 #ifndef __WXMSW__
  21 #include <wx/dcps.h>
  22 #endif
  23 %}
  24
  25 //----------------------------------------------------------------------
  26
  27 %include typemaps.i
  28 %include my_typemaps.i
  29
  30 // Import some definitions of other classes, etc.
  31 %import _defs.i
  32 %import misc.i
  33
  34 //---------------------------------------------------------------------------
  35
  36 class wxBitmap {
  37 public:
  38     wxBitmap(const wxString& name, long type);
  39     ~wxBitmap();
  40
  41 #ifdef __WXMSW__
  42     void Create(int width, int height, int depth = -1);
  43 #endif
  44     int GetDepth();
  45     int GetHeight();
  46     wxPalette* GetPalette();
  47     wxMask* GetMask();
  48     int GetWidth();
  49     bool LoadFile(const wxString& name, long flags);
  50     bool Ok();
  51     bool SaveFile(const wxString& name, int type, wxPalette* palette = NULL);
  52     void SetDepth(int depth);
  53     void SetHeight(int height);
  54     void SetMask(wxMask* mask);
  55 #ifdef __WXMSW__
  56     void SetPalette(wxPalette& palette);
  57 #endif
  58     void SetWidth(int width);
  59 };
  60
  61 %new wxBitmap* wxEmptyBitmap(int width, int height, int depth=-1);
  62 wxBitmap* wxNoRefBitmap(char* name, long flags);
  63
  64 #ifdef __WXMSW__
  65 %new wxBitmap* wxBitmapFromData(char* data, long type,
  66                                 int width, int height, int depth = 1);
  67 #endif
  68
  69 %{                              // Alternate 'constructor'
  70     wxBitmap* wxEmptyBitmap(int width, int height, int depth=-1) {
  71         return new wxBitmap(width, height, depth);
  72     }
  73
  74                                 // This one won't own the reference, so Python
  75                                 // won't call the dtor, this is good for
  76                                 // toolbars and such where the parent will
  77                                 // manage the bitmap.
  78     wxBitmap* wxNoRefBitmap(char* name, long flags) {
  79         return new wxBitmap(name, flags);
  80     }
  81
  82 #ifdef __WXMSW__
  83     wxBitmap* wxBitmapFromData(char* data, long type,
  84                                int width, int height, int depth = 1) {
  85         return new wxBitmap((void*)data, type, width, height, depth);
  86     }
  87 #endif
  88 %}
  89
  90 //---------------------------------------------------------------------------
  91
  92 class wxMask {
  93 public:
  94     wxMask(const wxBitmap& bitmap);
  95     ~wxMask();
  96 };
  97
  98 %new wxMask* wxMaskColour(const wxBitmap& bitmap, const wxColour& colour);
  99 %{
 100     wxMask* wxMaskColour(const wxBitmap& bitmap, const wxColour& colour) {
 101         return new wxMask(bitmap, colour);
 102     }
 103 %}
 104
 105
 106 //---------------------------------------------------------------------------
 107
 108
 109 class wxIcon : public wxBitmap {
 110 public:
 111     wxIcon(const wxString& name, long flags,
 112            int desiredWidth = -1, int desiredHeight = -1);
 113     ~wxIcon();
 114
 115     int GetDepth();
 116     int GetHeight();
 117     int GetWidth();
 118     bool LoadFile(const wxString& name, long flags);
 119     bool Ok();
 120     void SetDepth(int depth);
 121     void SetHeight(int height);
 122     void SetWidth(int width);
 123 };
 124
 125
 126 //---------------------------------------------------------------------------
 127
 128 class wxCursor : public wxBitmap {
 129 public:
 130 #ifdef __WXMSW__
 131     wxCursor(const wxString& cursorName, long flags, int hotSpotX=0, int hotSpotY=0);
 132 #endif
 133     ~wxCursor();
 134     bool Ok();
 135 };
 136
 137 %name(wxStockCursor) %new wxCursor* wxPyStockCursor(int id);
 138 %{                              // Alternate 'constructor'
 139     wxCursor* wxPyStockCursor(int id) {
 140         return new wxCursor(id);
 141     }
 142 %}
 143
 144 //----------------------------------------------------------------------
 145
 146 class wxFont {
 147 public:
 148     // I'll do it this way to use long-lived objects and not have to
 149     // worry about when python may delete the object.
 150     %addmethods {
 151         wxFont( int pointSize, int family, int style, int weight,
 152                 int underline=FALSE, char* faceName = "") {
 153
 154             return wxTheFontList->FindOrCreateFont(pointSize, family, style, weight,
 155                                                    underline, faceName);
 156         }
 157         // NO Destructor.
 158     }
 159
 160
 161     wxString GetFaceName();
 162     int GetFamily();
 163 #ifdef __WXMSW__
 164     int GetFontId();
 165 #endif
 166     int GetPointSize();
 167     int GetStyle();
 168     bool GetUnderlined();
 169     int GetWeight();
 170     void SetFaceName(const wxString& faceName);
 171     void SetFamily(int family);
 172     void SetPointSize(int pointSize);
 173     void SetStyle(int style);
 174     void SetUnderlined(bool underlined);
 175     void SetWeight(int weight);
 176 };
 177
 178 //----------------------------------------------------------------------
 179
 180 class wxColour {
 181 public:
 182     wxColour(unsigned char red=0, unsigned char green=0, unsigned char blue=0);
 183     ~wxColour();
 184     unsigned char Red();
 185     unsigned char Green();
 186     unsigned char Blue();
 187     bool Ok();
 188     void Set(unsigned char red, unsigned char green, unsigned char blue);
 189     %addmethods {
 190         PyObject* Get() {
 191             PyObject* rv = PyTuple_New(3);
 192             PyTuple_SetItem(rv, 0, PyInt_FromLong(self->Red()));
 193             PyTuple_SetItem(rv, 1, PyInt_FromLong(self->Green()));
 194             PyTuple_SetItem(rv, 2, PyInt_FromLong(self->Blue()));
 195             return rv;
 196         }
 197     }
 198 };
 199
 200 %new wxColour* wxNamedColour(const wxString& colorName);
 201 %{                                      // Alternate 'constructor'
 202     wxColour* wxNamedColour(const wxString& colorName) {
 203         return new wxColour(colorName);
 204     }
 205 %}
 206
 207
 208 //----------------------------------------------------------------------
 209
 210 typedef unsigned long wxDash;
 211
 212 class wxPen {
 213 public:
 214     // I'll do it this way to use long-lived objects and not have to
 215     // worry about when python may delete the object.
 216     %addmethods {
 217         wxPen(wxColour* colour, int width=1, int style=wxSOLID) {
 218             return wxThePenList->FindOrCreatePen(*colour, width, style);
 219         }
 220         // NO Destructor.
 221     }
 222
 223     int GetCap();
 224     wxColour& GetColour();
 225
 226     int GetJoin();
 227     int GetStyle();
 228     int GetWidth();
 229     bool Ok();
 230     void SetCap(int cap_style);
 231     void SetColour(wxColour& colour);
 232     void SetJoin(int join_style);
 233     void SetStyle(int style);
 234     void SetWidth(int width);
 235
 236 #ifdef __WXMSW__
 237             // **** This one needs to return a list of ints (wxDash)
 238     int GetDashes(wxDash **dashes);
 239     wxBitmap* GetStipple();
 240     void SetDashes(int LCOUNT, wxDash* LIST);
 241     void SetStipple(wxBitmap& stipple);
 242 #endif
 243 };
 244
 245 //----------------------------------------------------------------------
 246
 247 class wxBrush {
 248 public:
 249     // I'll do it this way to use long-lived objects and not have to
 250     // worry about when python may delete the object.
 251     %addmethods {
 252         wxBrush(wxColour* colour, int style=wxSOLID) {
 253             return wxTheBrushList->FindOrCreateBrush(*colour, style);
 254         }
 255         // NO Destructor.
 256     }
 257
 258     wxColour& GetColour();
 259     wxBitmap * GetStipple();
 260     int GetStyle();
 261     bool Ok();
 262     void SetColour(wxColour &colour);
 263     void SetStipple(wxBitmap& bitmap);
 264     void SetStyle(int style);
 265 };
 266
 267 //----------------------------------------------------------------------
 268
 269
 270
 271 class wxDC {
 272 public:
 273 //    wxDC(); **** abstract base class, can't instantiate.
 274     ~wxDC();
 275
 276     void BeginDrawing();
 277     bool Blit(long xdest, long ydest, long width, long height,
 278                 wxDC *source, long xsrc, long ysrc, long logical_func);
 279     void Clear();
 280     void CrossHair(long x, long y);
 281     void DestroyClippingRegion();
 282     long DeviceToLogicalX(long x);
 283     long DeviceToLogicalXRel(long x);
 284     long DeviceToLogicalY(long y);
 285     long DeviceToLogicalYRel(long y);
 286     void DrawArc(long x1, long y1, long x2, long y2, long xc, long yc);
 287     void DrawCircle(long x, long y, long radius);
 288     void DrawEllipse(long x, long y, long width, long height);
 289     void DrawEllipticArc(long x, long y, long width, long height, long start, long end);
 290     void DrawIcon(const wxIcon& icon, long x, long y);
 291     void DrawLine(long x1, long y1, long x2, long y2);
 292     void DrawLines(int LCOUNT, wxPoint* LIST, long xoffset=0, long yoffset=0);
 293     void DrawPolygon(int LCOUNT, wxPoint* LIST, long xoffset=0, long yoffset=0,
 294                      int fill_style=wxODDEVEN_RULE);
 295     void DrawPoint(long x, long y);
 296     void DrawRectangle(long x, long y, long width, long height);
 297     void DrawRoundedRectangle(long x, long y, long width, long height, long radius=20);
 298     void DrawSpline(int LCOUNT, wxPoint* LIST);
 299     void DrawText(const wxString& text, long x, long y);
 300     void EndDoc();
 301     void EndDrawing();
 302     void EndPage();
 303     void FloodFill(long x, long y, const wxColour& colour, int style=wxFLOOD_SURFACE);
 304     wxBrush&  GetBackground();
 305     wxBrush&  GetBrush();
 306     long GetCharHeight();
 307     long GetCharWidth();
 308     void GetClippingBox(long *OUTPUT, long *OUTPUT,
 309                         long *OUTPUT, long *OUTPUT);
 310     wxFont& GetFont();
 311     int GetLogicalFunction();
 312     int GetMapMode();
 313     bool GetOptimization();
 314     wxPen& GetPen();
 315     %addmethods {
 316         %new wxColour* GetPixel(long x, long y) {
 317             wxColour* wc = new wxColour();
 318             self->GetPixel(x, y, wc);
 319             return wc;
 320         }
 321     }
 322     %name(GetSizeTuple)void GetSize(int* OUTPUT, int* OUTPUT);
 323     wxSize GetSize();
 324     wxColour& GetTextBackground();
 325     void GetTextExtent(const wxString& string, long *OUTPUT, long *OUTPUT);
 326     %name(GetFullTextExtent)void GetTextExtent(const wxString& string,
 327                        long *OUTPUT, long *OUTPUT, long *OUTPUT, long* OUTPUT,
 328                        const wxFont* font = NULL);
 329     wxColour& GetTextForeground();
 330     long LogicalToDeviceX(long x);
 331     long LogicalToDeviceXRel(long x);
 332     long LogicalToDeviceY(long y);
 333     long LogicalToDeviceYRel(long y);
 334     long MaxX();
 335     long MaxY();
 336     long MinX();
 337     long MinY();
 338     bool Ok();
 339     void SetDeviceOrigin(long x, long y);
 340     void SetBackground(const wxBrush& brush);
 341     void SetBackgroundMode(int mode);
 342     void SetClippingRegion(long x, long y, long width, long height);
 343     void SetPalette(const wxPalette& colourMap);
 344     void SetBrush(const wxBrush& brush);
 345     void SetFont(const wxFont& font);
 346     void SetLogicalFunction(int function);
 347     void SetMapMode(int mode);
 348     void SetOptimization(bool optimize);
 349     void SetPen(const wxPen& pen);
 350     void SetTextBackground(const wxColour& colour);
 351     void SetTextForeground(const wxColour& colour);
 352     void SetUserScale(double x_scale, double y_scale);
 353     bool StartDoc(const wxString& message);
 354     void StartPage();
 355
 356
 357     %addmethods {
 358             // This one is my own creation...
 359         void DrawBitmap(wxBitmap& bitmap, long x, long y, bool swapPalette=TRUE) {
 360             wxMemoryDC* memDC = new wxMemoryDC;
 361             memDC->SelectObject(bitmap);
 362 #ifdef __WXMSW__
 363             if (swapPalette)
 364                 self->SetPalette(*bitmap.GetPalette());
 365 #endif
 366             self->Blit(x, y, bitmap.GetWidth(), bitmap.GetHeight(), memDC,
 367                     0, 0, self->GetLogicalFunction());
 368             memDC->SelectObject(wxNullBitmap);
 369             delete memDC;
 370         }
 371     }
 372 };
 373
 374
 375 //----------------------------------------------------------------------
 376
 377 class wxMemoryDC : public wxDC {
 378 public:
 379     wxMemoryDC();
 380
 381     void SelectObject(const wxBitmap& bitmap);
 382 }
 383
 384 %new wxMemoryDC* wxMemoryDCFromDC(wxDC* oldDC);
 385 %{                                      // Alternate 'constructor'
 386     wxMemoryDC* wxMemoryDCFromDC(wxDC* oldDC) {
 387         return new wxMemoryDC(oldDC);
 388     }
 389 %}
 390
 391
 392 //---------------------------------------------------------------------------
 393
 394 class wxScreenDC : public wxDC {
 395 public:
 396     wxScreenDC();
 397
 398     bool StartDrawingOnTop(wxWindow* window);
 399     %name(StartDrawingOnTopRect) bool StartDrawingOnTop(wxRect* rect = NULL);
 400     bool EndDrawingOnTop();
 401 };
 402
 403 //---------------------------------------------------------------------------
 404
 405 class wxClientDC : public wxDC {
 406 public:
 407       wxClientDC(wxWindow* win);
 408 };
 409
 410 //---------------------------------------------------------------------------
 411
 412 class wxPaintDC : public wxDC {
 413 public:
 414       wxPaintDC(wxWindow* win);
 415 };
 416
 417 //---------------------------------------------------------------------------
 418
 419 class wxWindowDC : public wxDC {
 420 public:
 421       wxWindowDC(wxWindow* win);
 422 };
 423
 424 //---------------------------------------------------------------------------
 425
 426 #ifndef __WXMSW__
 427 class wxPostScriptDC : public wxDC {
 428 public:
 429       wxPostScriptDC(const wxString& output, bool interactive = TRUE, wxWindow* win = NULL);
 430 };
 431 #endif
 432
 433 //---------------------------------------------------------------------------
 434
 435 #ifdef __WXMSW__
 436 class  wxPrinterDC : public wxDC {
 437 public:
 438     wxPrinterDC(const wxString& driver, const wxString& device, const wxString& output,
 439                 bool interactive = TRUE, int orientation = wxPORTRAIT);
 440 };
 441 #endif
 442
 443 //---------------------------------------------------------------------------
 444
 445 #ifdef __WXMSW__
 446 class wxMetaFileDC : public wxDC {
 447 public:
 448     wxMetaFileDC(const wxString& filename = wxPyEmptyStr);
 449     wxMetaFile* Close();
 450 };
 451 #endif
 452
 453 //---------------------------------------------------------------------------
 454 //---------------------------------------------------------------------------
 455
 456
 457 %readonly
 458 %{
 459 #if 0
 460 %}
 461 extern wxFont *wxNORMAL_FONT;
 462 extern wxFont *wxSMALL_FONT;
 463 extern wxFont *wxITALIC_FONT;
 464 extern wxFont *wxSWISS_FONT;
 465 extern wxPen *wxRED_PEN;
 466
 467 extern wxPen *wxCYAN_PEN;
 468 extern wxPen *wxGREEN_PEN;
 469 extern wxPen *wxBLACK_PEN;
 470 extern wxPen *wxWHITE_PEN;
 471 extern wxPen *wxTRANSPARENT_PEN;
 472 extern wxPen *wxBLACK_DASHED_PEN;
 473 extern wxPen *wxGREY_PEN;
 474 extern wxPen *wxMEDIUM_GREY_PEN;
 475 extern wxPen *wxLIGHT_GREY_PEN;
 476
 477 extern wxBrush *wxBLUE_BRUSH;
 478 extern wxBrush *wxGREEN_BRUSH;
 479 extern wxBrush *wxWHITE_BRUSH;
 480 extern wxBrush *wxBLACK_BRUSH;
 481 extern wxBrush *wxTRANSPARENT_BRUSH;
 482 extern wxBrush *wxCYAN_BRUSH;
 483 extern wxBrush *wxRED_BRUSH;
 484 extern wxBrush *wxGREY_BRUSH;
 485 extern wxBrush *wxMEDIUM_GREY_BRUSH;
 486 extern wxBrush *wxLIGHT_GREY_BRUSH;
 487
 488 extern wxColour *wxBLACK;
 489 extern wxColour *wxWHITE;
 490 extern wxColour *wxRED;
 491 extern wxColour *wxBLUE;
 492 extern wxColour *wxGREEN;
 493 extern wxColour *wxCYAN;
 494 extern wxColour *wxLIGHT_GREY;
 495
 496 extern wxCursor *wxSTANDARD_CURSOR;
 497 extern wxCursor *wxHOURGLASS_CURSOR;
 498 extern wxCursor *wxCROSS_CURSOR;
 499
 500 extern wxBitmap wxNullBitmap;
 501 extern wxIcon   wxNullIcon;
 502 extern wxCursor wxNullCursor;
 503 extern wxPen    wxNullPen;
 504 extern wxBrush  wxNullBrush;
 505 extern wxPalette wxNullPalette;
 506 extern wxFont   wxNullFont;
 507 extern wxColour wxNullColour;
 508
 509 %readwrite
 510 %{
 511 #endif
 512 %}
 513
 514 //---------------------------------------------------------------------------
 515
 516 class wxPalette {
 517 public:
 518     wxPalette(int LCOUNT, byte* LIST, byte* LIST, byte* LIST);
 519     ~wxPalette();
 520
 521     int GetPixel(byte red, byte green, byte blue);
 522     bool GetRGB(int pixel, byte* OUTPUT, byte* OUTPUT, byte* OUTPUT);
 523     bool Ok();
 524 };
 525
 526 //---------------------------------------------------------------------------
 527
 528 enum {
 529     wxIMAGELIST_DRAW_NORMAL ,
 530     wxIMAGELIST_DRAW_TRANSPARENT,
 531     wxIMAGELIST_DRAW_SELECTED,
 532     wxIMAGELIST_DRAW_FOCUSED,
 533     wxIMAGE_LIST_NORMAL,
 534     wxIMAGE_LIST_SMALL,
 535     wxIMAGE_LIST_STATE
 536 };
 537
 538 class wxImageList {
 539 public:
 540     wxImageList(int width, int height, const bool mask=TRUE, int initialCount=1);
 541     ~wxImageList();
 542
 543 #ifdef __WXMSW__
 544     int Add(const wxBitmap& bitmap, const wxBitmap& mask = wxNullBitmap);
 545     %name(AddWithColourMask)int Add(const wxBitmap& bitmap, const wxColour& maskColour);
 546     %name(AddIcon)int Add(const wxIcon& icon);
 547     bool Replace(int index, const wxBitmap& bitmap, const wxBitmap& mask = wxNullBitmap);
 548     %name(ReplaceIcon)bool Replace(int index, const wxIcon& icon);
 549 #else
 550     int Add(const wxBitmap& bitmap);
 551     bool Replace(int index, const wxBitmap& bitmap);
 552 #endif
 553
 554     bool Draw(int index, wxDC& dc, int x, int x, int flags = wxIMAGELIST_DRAW_NORMAL,
 555               const bool solidBackground = FALSE);
 556
 557     int GetImageCount();
 558     bool Remove(int index);
 559     bool RemoveAll();
 560 };
 561
 562
 563 //---------------------------------------------------------------------------
 564