1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: SWIG interface file for wxDC, wxBrush, wxPen, wxFont, etc.
9 // Copyright: (c) 1998 by Total Control Software
10 // Licence: wxWindows license
11 /////////////////////////////////////////////////////////////////////////////
18 #include <wx/metafile.h>
19 #include <wx/imaglist.h>
25 //----------------------------------------------------------------------
28 %include my_typemaps.i
30 // Import some definitions of other classes, etc.
34 //---------------------------------------------------------------------------
39 // void SetHandle(long handle);
44 // void SetWidth(int w);
45 // void SetHeight(int h);
46 // void SetDepth(int d);
47 // void SetSize(const wxSize& size);
50 //---------------------------------------------------------------------------
56 wxBitmap(const wxString& name, long type);
59 wxPalette* GetPalette();
61 bool LoadFile(const wxString& name, long flags);
62 bool SaveFile(const wxString& name, int type, wxPalette* palette = NULL);
63 void SetMask(wxMask* mask);
65 void SetPalette(wxPalette& palette);
71 void SetHandle(long handle);
78 void SetHeight(int h);
81 void SetSize(const wxSize& size);
84 wxBitmap GetSubBitmap( const wxRect& rect );
86 bool CopyFromIcon(const wxIcon& icon);
87 bool CopyFromCursor(const wxCursor& cursor);
89 void SetQuality(int q);
92 %pragma(python) addtoclass = "
93 def __del__(self,gdic=gdic):
95 if self.thisown == 1 :
96 gdic.delete_wxBitmap(self)
103 %new wxBitmap* wxEmptyBitmap(int width, int height, int depth=-1);
106 %new wxBitmap* wxBitmapFromData(PyObject* data, long type,
107 int width, int height, int depth = 1);
110 %{ // Alternate 'constructor'
111 wxBitmap* wxEmptyBitmap(int width, int height, int depth=-1) {
112 return new wxBitmap(width, height, depth);
116 wxBitmap* wxBitmapFromData(PyObject* data, long type,
117 int width, int height, int depth = 1) {
118 if (! PyString_Check(data)) {
119 PyErr_SetString(PyExc_TypeError, "Expected string object");
123 return new wxBitmap((void*)PyString_AsString(data), type, width, height, depth);
128 //---------------------------------------------------------------------------
132 wxMask(const wxBitmap& bitmap);
136 %new wxMask* wxMaskColour(const wxBitmap& bitmap, const wxColour& colour);
138 wxMask* wxMaskColour(const wxBitmap& bitmap, const wxColour& colour) {
139 return new wxMask(bitmap, colour);
144 //---------------------------------------------------------------------------
148 //: public wxGDIImage
151 wxIcon(const wxString& name, long flags,
152 int desiredWidth = -1, int desiredHeight = -1);
155 bool LoadFile(const wxString& name, long flags);
157 // wxGDIImage methods
160 void SetHandle(long handle);
166 void SetWidth(int w);
167 void SetHeight(int h);
168 void SetDepth(int d);
170 void SetSize(const wxSize& size);
172 %pragma(python) addtoclass = "
173 def __del__(self,gdic=gdic):
175 if self.thisown == 1 :
176 gdic.delete_wxIcon(self)
184 //---------------------------------------------------------------------------
187 //: public wxGDIImage
191 wxCursor(const wxString& cursorName, long flags, int hotSpotX=0, int hotSpotY=0);
195 // wxGDIImage methods
198 void SetHandle(long handle);
205 void SetWidth(int w);
206 void SetHeight(int h);
207 void SetDepth(int d);
208 void SetSize(const wxSize& size);
212 %name(wxStockCursor) %new wxCursor* wxPyStockCursor(int id);
213 %{ // Alternate 'constructor'
214 wxCursor* wxPyStockCursor(int id) {
215 return new wxCursor(id);
219 //----------------------------------------------------------------------
224 wxFONTENCODING_SYSTEM = -1, // system default
225 wxFONTENCODING_DEFAULT, // current default encoding
227 // ISO8859 standard defines a number of single-byte charsets
228 wxFONTENCODING_ISO8859_1, // West European (Latin1)
229 wxFONTENCODING_ISO8859_2, // Central and East European (Latin2)
230 wxFONTENCODING_ISO8859_3, // Esperanto (Latin3)
231 wxFONTENCODING_ISO8859_4, // Baltic languages (Estonian) (Latin4)
232 wxFONTENCODING_ISO8859_5, // Cyrillic
233 wxFONTENCODING_ISO8859_6, // Arabic
234 wxFONTENCODING_ISO8859_7, // Greek
235 wxFONTENCODING_ISO8859_8, // Hebrew
236 wxFONTENCODING_ISO8859_9, // Turkish (Latin5)
237 wxFONTENCODING_ISO8859_10, // Variation of Latin4 (Latin6)
238 wxFONTENCODING_ISO8859_11, // Thai
239 wxFONTENCODING_ISO8859_12, // doesn't exist currently, but put it
240 // here anyhow to make all ISO8859
241 // consecutive numbers
242 wxFONTENCODING_ISO8859_13, // Latin7
243 wxFONTENCODING_ISO8859_14, // Latin8
244 wxFONTENCODING_ISO8859_15, // Latin9 (a.k.a. Latin0, includes euro)
246 // Cyrillic charset soup (see http://czyborra.com/charsets/cyrillic.html)
247 wxFONTENCODING_KOI8, // we don't support any of KOI8 variants
248 wxFONTENCODING_ALTERNATIVE, // same as MS-DOS CP866
249 wxFONTENCODING_BULGARIAN, // used under Linux in Bulgaria
251 // what would we do without Microsoft? They have their own encodings
253 wxFONTENCODING_CP437, // original MS-DOS codepage
254 wxFONTENCODING_CP850, // CP437 merged with Latin1
255 wxFONTENCODING_CP852, // CP437 merged with Latin2
256 wxFONTENCODING_CP855, // another cyrillic encoding
257 wxFONTENCODING_CP866, // and another one
259 wxFONTENCODING_CP1250, // WinLatin2
260 wxFONTENCODING_CP1251, // WinCyrillic
261 wxFONTENCODING_CP1252, // WinLatin1
268 // I'll do it this way to use long-lived objects and not have to
269 // worry about when python may delete the object.
271 wxFont( int pointSize, int family, int style, int weight,
272 int underline=FALSE, char* faceName = "",
273 wxFontEncoding encoding=wxFONTENCODING_DEFAULT) {
275 return wxTheFontList->FindOrCreateFont(pointSize, family, style, weight,
276 underline, faceName, encoding);
283 wxString GetFaceName();
290 bool GetUnderlined();
292 wxFontEncoding GetEncoding();
293 void SetFaceName(const wxString& faceName);
294 void SetFamily(int family);
295 void SetPointSize(int pointSize);
296 void SetStyle(int style);
297 void SetUnderlined(bool underlined);
298 void SetWeight(int weight);
299 void SetEncoding(wxFontEncoding encoding);
300 wxString GetFamilyString();
301 wxString GetStyleString();
302 wxString GetWeightString();
306 wxFontEncoding wxFont_GetDefaultEncoding() {
307 return wxFont::GetDefaultEncoding();
310 void wxFont_SetDefaultEncoding(wxFontEncoding encoding) {
311 wxFont::SetDefaultEncoding(encoding);
315 //----------------------------------------------------------------------
319 wxColour(unsigned char red=0, unsigned char green=0, unsigned char blue=0);
322 unsigned char Green();
323 unsigned char Blue();
325 void Set(unsigned char red, unsigned char green, unsigned char blue);
328 PyObject* rv = PyTuple_New(3);
329 PyTuple_SetItem(rv, 0, PyInt_FromLong(self->Red()));
330 PyTuple_SetItem(rv, 1, PyInt_FromLong(self->Green()));
331 PyTuple_SetItem(rv, 2, PyInt_FromLong(self->Blue()));
335 %pragma(python) addtoclass = "asTuple = Get"
336 %pragma(python) addtoclass = "def __str__(self): return str(self.asTuple())"
337 %pragma(python) addtoclass = "def __repr__(self): return str(self.asTuple())"
341 %new wxColour* wxNamedColour(const wxString& colorName);
343 %{ // Alternate 'constructor'
344 wxColour* wxNamedColour(const wxString& colorName) {
345 return new wxColour(colorName);
350 //----------------------------------------------------------------------
355 // I'll do it this way to use long-lived objects and not have to
356 // worry about when python may delete the object.
358 wxPen(wxColour* colour, int width=1, int style=wxSOLID) {
359 return wxThePenList->FindOrCreatePen(*colour, width, style);
365 wxColour& GetColour();
371 void SetCap(int cap_style);
372 void SetColour(wxColour& colour);
373 void SetJoin(int join_style);
374 void SetStyle(int style);
375 void SetWidth(int width);
377 // **** This one needs to return a list of ints (wxDash)
378 int GetDashes(wxDash **dashes);
379 void SetDashes(int LCOUNT, wxDash* choices);
382 wxBitmap* GetStipple();
383 void SetStipple(wxBitmap& stipple);
387 //----------------------------------------------------------------------
391 // I'll do it this way to use long-lived objects and not have to
392 // worry about when python may delete the object.
394 wxBrush(const wxColour* colour, int style=wxSOLID) {
395 return wxTheBrushList->FindOrCreateBrush(*colour, style);
400 // wxBrush(const wxColour& colour, int style=wxSOLID);
402 wxColour& GetColour();
403 wxBitmap * GetStipple();
406 void SetColour(wxColour &colour);
407 void SetStipple(wxBitmap& bitmap);
408 void SetStyle(int style);
411 //----------------------------------------------------------------------
417 // wxDC(); **** abstract base class, can't instantiate.
422 bool Blit(long xdest, long ydest,
423 long width, long height,
424 wxDC *source, long xsrc, long ysrc,
425 int logicalFunc = wxCOPY, int useMask = FALSE);
426 // bool Blit(const wxPoint& destPt, const wxSize& sz,
427 // wxDC *source, const wxPoint& srcPt,
428 // int logicalFunc = wxCOPY, int useMask = FALSE);
431 void CrossHair(long x, long y);
432 void DestroyClippingRegion();
433 long DeviceToLogicalX(long x);
434 long DeviceToLogicalXRel(long x);
435 long DeviceToLogicalY(long y);
436 long DeviceToLogicalYRel(long y);
437 void DrawArc(long x1, long y1, long x2, long y2, long xc, long yc);
438 void DrawCircle(long x, long y, long radius);
439 void DrawEllipse(long x, long y, long width, long height);
440 void DrawEllipticArc(long x, long y, long width, long height, long start, long end);
441 void DrawIcon(const wxIcon& icon, long x, long y);
442 void DrawLine(long x1, long y1, long x2, long y2);
443 void DrawLines(int PCOUNT, wxPoint* points, long xoffset=0, long yoffset=0);
444 void DrawPolygon(int PCOUNT, wxPoint* points, long xoffset=0, long yoffset=0,
445 int fill_style=wxODDEVEN_RULE);
446 void DrawPoint(long x, long y);
447 void DrawRectangle(long x, long y, long width, long height);
448 void DrawRotatedText(const wxString& text, wxCoord x, wxCoord y, double angle);
449 void DrawRoundedRectangle(long x, long y, long width, long height, long radius=20);
450 void DrawSpline(int PCOUNT, wxPoint* points);
451 void DrawText(const wxString& text, long x, long y);
455 void FloodFill(long x, long y, const wxColour& colour, int style=wxFLOOD_SURFACE);
456 wxBrush& GetBackground();
458 long GetCharHeight();
460 void GetClippingBox(long *OUTPUT, long *OUTPUT,
461 long *OUTPUT, long *OUTPUT);
463 int GetLogicalFunction();
464 void GetLogicalScale(double *OUTPUT, double *OUTPUT);
466 bool GetOptimization();
469 %new wxColour* GetPixel(long x, long y) {
470 wxColour* wc = new wxColour();
471 self->GetPixel(x, y, wc);
475 %name(GetSizeTuple)void GetSize(int* OUTPUT, int* OUTPUT);
478 wxColour& GetTextBackground();
479 void GetTextExtent(const wxString& string, long *OUTPUT, long *OUTPUT);
480 %name(GetFullTextExtent)void GetTextExtent(const wxString& string,
481 long *OUTPUT, long *OUTPUT, long *OUTPUT, long* OUTPUT,
482 const wxFont* font = NULL);
483 wxColour& GetTextForeground();
484 void GetUserScale(double *OUTPUT, double *OUTPUT);
485 long LogicalToDeviceX(long x);
486 long LogicalToDeviceXRel(long x);
487 long LogicalToDeviceY(long y);
488 long LogicalToDeviceYRel(long y);
494 void SetDeviceOrigin(long x, long y);
495 void SetBackground(const wxBrush& brush);
496 void SetBackgroundMode(int mode);
497 void SetClippingRegion(long x, long y, long width, long height);
498 void SetPalette(const wxPalette& colourMap);
499 void SetBrush(const wxBrush& brush);
500 void SetFont(const wxFont& font);
501 void SetLogicalFunction(int function);
502 void SetLogicalScale(double x, double y);
503 void SetMapMode(int mode);
504 void SetOptimization(bool optimize);
505 void SetPen(const wxPen& pen);
506 void SetTextBackground(const wxColour& colour);
507 void SetTextForeground(const wxColour& colour);
508 void SetUserScale(double x_scale, double y_scale);
509 bool StartDoc(const wxString& message);
514 void DrawBitmap(const wxBitmap& bitmap, long x, long y,
515 int useMask = FALSE);
517 bool CanDrawBitmap();
518 bool CanGetTextExtent();
522 void GetLogicalOrigin(int *OUTPUT, int *OUTPUT);
523 void SetLogicalOrigin(int x, int y);
524 void GetDeviceOrigin(int *OUTPUT, int *OUTPUT);
525 void SetAxisOrientation(bool xLeftRight, bool yBottomUp);
527 void CalcBoundingBox(int x, int y);
528 void ResetBoundingBox();
532 //----------------------------------------------------------------------
534 class wxMemoryDC : public wxDC {
538 void SelectObject(const wxBitmap& bitmap);
541 %new wxMemoryDC* wxMemoryDCFromDC(wxDC* oldDC);
542 %{ // Alternate 'constructor'
543 wxMemoryDC* wxMemoryDCFromDC(wxDC* oldDC) {
544 return new wxMemoryDC(oldDC);
549 //---------------------------------------------------------------------------
551 class wxScreenDC : public wxDC {
555 %name(StartDrawingOnTopWin) bool StartDrawingOnTop(wxWindow* window);
556 bool StartDrawingOnTop(wxRect* rect = NULL);
557 bool EndDrawingOnTop();
560 //---------------------------------------------------------------------------
562 class wxClientDC : public wxDC {
564 wxClientDC(wxWindow* win);
567 //---------------------------------------------------------------------------
569 class wxPaintDC : public wxDC {
571 wxPaintDC(wxWindow* win);
574 //---------------------------------------------------------------------------
576 class wxWindowDC : public wxDC {
578 wxWindowDC(wxWindow* win);
581 //---------------------------------------------------------------------------
584 class wxPostScriptDC : public wxDC {
586 wxPostScriptDC(const wxString& output, bool interactive = TRUE, wxWindow* win = NULL);
590 //---------------------------------------------------------------------------
593 class wxPrinterDC : public wxDC {
595 wxPrinterDC(const wxString& driver, const wxString& device, const wxString& output,
596 bool interactive = TRUE, int orientation = wxPORTRAIT);
600 //---------------------------------------------------------------------------
603 class wxMetaFileDC : public wxDC {
605 wxMetaFileDC(const wxString& filename = wxPyEmptyStr);
610 //---------------------------------------------------------------------------
611 //---------------------------------------------------------------------------
618 extern wxFont *wxNORMAL_FONT;
619 extern wxFont *wxSMALL_FONT;
620 extern wxFont *wxITALIC_FONT;
621 extern wxFont *wxSWISS_FONT;
623 extern wxPen *wxRED_PEN;
624 extern wxPen *wxCYAN_PEN;
625 extern wxPen *wxGREEN_PEN;
626 extern wxPen *wxBLACK_PEN;
627 extern wxPen *wxWHITE_PEN;
628 extern wxPen *wxTRANSPARENT_PEN;
629 extern wxPen *wxBLACK_DASHED_PEN;
630 extern wxPen *wxGREY_PEN;
631 extern wxPen *wxMEDIUM_GREY_PEN;
632 extern wxPen *wxLIGHT_GREY_PEN;
634 extern wxBrush *wxBLUE_BRUSH;
635 extern wxBrush *wxGREEN_BRUSH;
636 extern wxBrush *wxWHITE_BRUSH;
637 extern wxBrush *wxBLACK_BRUSH;
638 extern wxBrush *wxTRANSPARENT_BRUSH;
639 extern wxBrush *wxCYAN_BRUSH;
640 extern wxBrush *wxRED_BRUSH;
641 extern wxBrush *wxGREY_BRUSH;
642 extern wxBrush *wxMEDIUM_GREY_BRUSH;
643 extern wxBrush *wxLIGHT_GREY_BRUSH;
645 extern wxColour *wxBLACK;
646 extern wxColour *wxWHITE;
647 extern wxColour *wxRED;
648 extern wxColour *wxBLUE;
649 extern wxColour *wxGREEN;
650 extern wxColour *wxCYAN;
651 extern wxColour *wxLIGHT_GREY;
653 extern wxCursor *wxSTANDARD_CURSOR;
654 extern wxCursor *wxHOURGLASS_CURSOR;
655 extern wxCursor *wxCROSS_CURSOR;
657 extern wxBitmap wxNullBitmap;
658 extern wxIcon wxNullIcon;
659 extern wxCursor wxNullCursor;
660 extern wxPen wxNullPen;
661 extern wxBrush wxNullBrush;
662 extern wxPalette wxNullPalette;
663 extern wxFont wxNullFont;
664 extern wxColour wxNullColour;
671 //---------------------------------------------------------------------------
675 wxPalette(int LCOUNT, byte* choices, byte* choices, byte* choices);
678 int GetPixel(byte red, byte green, byte blue);
679 bool GetRGB(int pixel, byte* OUTPUT, byte* OUTPUT, byte* OUTPUT);
683 //---------------------------------------------------------------------------
686 wxIMAGELIST_DRAW_NORMAL ,
687 wxIMAGELIST_DRAW_TRANSPARENT,
688 wxIMAGELIST_DRAW_SELECTED,
689 wxIMAGELIST_DRAW_FOCUSED,
697 wxImageList(int width, int height, int mask=TRUE, int initialCount=1);
700 int Add(const wxBitmap& bitmap, const wxBitmap& mask = wxNullBitmap);
701 %name(AddWithColourMask)int Add(const wxBitmap& bitmap, const wxColour& maskColour);
702 %name(AddIcon)int Add(const wxIcon& icon);
704 bool Replace(int index, const wxBitmap& bitmap, const wxBitmap& mask = wxNullBitmap);
706 // %name(ReplaceIcon)bool Replace(int index, const wxIcon& icon);
707 // int Add(const wxBitmap& bitmap);
708 bool Replace(int index, const wxBitmap& bitmap);
711 bool Draw(int index, wxDC& dc, int x, int x, int flags = wxIMAGELIST_DRAW_NORMAL,
712 const bool solidBackground = FALSE);
715 bool Remove(int index);
717 void GetSize(int index, int& OUTPUT, int& OUTPUT);
721 //---------------------------------------------------------------------------