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.
35 static wxString wxPyEmptyStr("");
38 //---------------------------------------------------------------------------
40 class wxGDIObject : public wxObject {
46 void SetVisible( bool visible );
52 //---------------------------------------------------------------------------
54 class wxBitmap : public wxGDIObject
57 wxBitmap(const wxString& name, wxBitmapType type);
60 wxPalette* GetPalette();
62 bool LoadFile(const wxString& name, long flags);
63 bool SaveFile(const wxString& name, int type, wxPalette* palette = NULL);
64 void SetMask(wxMask* mask);
66 void SetPalette(wxPalette& palette);
72 void SetHandle(long handle);
79 void SetHeight(int h);
82 void SetSize(const wxSize& size);
85 wxBitmap GetSubBitmap( const wxRect& rect );
87 bool CopyFromIcon(const wxIcon& icon);
88 bool CopyFromCursor(const wxCursor& cursor);
90 void SetQuality(int q);
93 %pragma(python) addtoclass = "
94 def __del__(self,gdic=gdic):
96 if self.thisown == 1 :
97 gdic.delete_wxBitmap(self)
104 // Declarations of some alternate "constructors"
105 %new wxBitmap* wxEmptyBitmap(int width, int height, int depth=-1);
106 %new wxBitmap* wxBitmapFromXPMData(PyObject* listOfStrings);
107 %new wxBitmap* wxBitmapFromIcon(const wxIcon& icon);
108 %new wxBitmap* wxBitmapFromBits(char* bits, int width, int height, int depth = 1 );
111 // %new wxBitmap* wxBitmapFromData(PyObject* data, long type,
112 // int width, int height, int depth = 1);
117 %{ // Implementations of some alternate "constructors"
119 wxBitmap* wxEmptyBitmap(int width, int height, int depth=-1) {
120 return new wxBitmap(width, height, depth);
123 static char** ConvertListOfStrings(PyObject* listOfStrings) {
124 char** cArray = NULL;
127 if (!PyList_Check(listOfStrings)) {
128 PyErr_SetString(PyExc_TypeError, "Expected a list of strings.");
131 count = PyList_Size(listOfStrings);
132 cArray = new char*[count];
134 for(int x=0; x<count; x++) {
135 // TODO: Need some validation and error checking here
136 cArray[x] = PyString_AsString(PyList_GET_ITEM(listOfStrings, x));
142 wxBitmap* wxBitmapFromXPMData(PyObject* listOfStrings) {
143 char** cArray = NULL;
146 cArray = ConvertListOfStrings(listOfStrings);
149 bmp = new wxBitmap(cArray);
155 wxBitmap* wxBitmapFromIcon(const wxIcon& icon) {
156 return new wxBitmap(icon);
160 wxBitmap* wxBitmapFromBits(char* bits, int width, int height, int depth = 1 ) {
161 return new wxBitmap(bits, width, height, depth);
166 // wxBitmap* wxBitmapFromData(PyObject* data, long type,
167 // int width, int height, int depth = 1) {
168 // if (! PyString_Check(data)) {
169 // PyErr_SetString(PyExc_TypeError, "Expected string object");
172 // return new wxBitmap((void*)PyString_AsString(data), type, width, height, depth);
177 //---------------------------------------------------------------------------
179 class wxMask : public wxObject {
181 wxMask(const wxBitmap& bitmap);
184 %addmethods { void Destroy() { delete self; } }
187 %new wxMask* wxMaskColour(const wxBitmap& bitmap, const wxColour& colour);
189 wxMask* wxMaskColour(const wxBitmap& bitmap, const wxColour& colour) {
190 return new wxMask(bitmap, colour);
195 //---------------------------------------------------------------------------
198 class wxIcon : public wxGDIObject
201 wxIcon(const wxString& name, long flags,
202 int desiredWidth = -1, int desiredHeight = -1);
205 bool LoadFile(const wxString& name, long flags);
207 // wxGDIImage methods
210 void SetHandle(long handle);
216 void SetWidth(int w);
217 void SetHeight(int h);
218 void SetDepth(int d);
220 void SetSize(const wxSize& size);
222 void CopyFromBitmap(const wxBitmap& bmp);
224 %pragma(python) addtoclass = "
225 def __del__(self,gdic=gdic):
227 if self.thisown == 1 :
228 gdic.delete_wxIcon(self)
235 // Declarations of some alternate "constructors"
236 %new wxIcon* wxEmptyIcon();
237 %new wxIcon* wxIconFromXPMData(PyObject* listOfStrings);
239 %{ // Implementations of some alternate "constructors"
240 wxIcon* wxEmptyIcon() {
244 wxIcon* wxIconFromXPMData(PyObject* listOfStrings) {
245 char** cArray = NULL;
248 cArray = ConvertListOfStrings(listOfStrings);
251 icon = new wxIcon(cArray);
257 //---------------------------------------------------------------------------
259 class wxCursor : public wxGDIObject
263 wxCursor(const wxString& cursorName, long flags, int hotSpotX=0, int hotSpotY=0);
267 // wxGDIImage methods
270 void SetHandle(long handle);
277 void SetWidth(int w);
278 void SetHeight(int h);
279 void SetDepth(int d);
280 void SetSize(const wxSize& size);
284 %name(wxStockCursor) %new wxCursor* wxPyStockCursor(int id);
285 %{ // Alternate 'constructor'
286 wxCursor* wxPyStockCursor(int id) {
287 return new wxCursor(id);
291 //----------------------------------------------------------------------
296 wxFONTENCODING_SYSTEM = -1, // system default
297 wxFONTENCODING_DEFAULT, // current default encoding
299 // ISO8859 standard defines a number of single-byte charsets
300 wxFONTENCODING_ISO8859_1, // West European (Latin1)
301 wxFONTENCODING_ISO8859_2, // Central and East European (Latin2)
302 wxFONTENCODING_ISO8859_3, // Esperanto (Latin3)
303 wxFONTENCODING_ISO8859_4, // Baltic languages (Estonian) (Latin4)
304 wxFONTENCODING_ISO8859_5, // Cyrillic
305 wxFONTENCODING_ISO8859_6, // Arabic
306 wxFONTENCODING_ISO8859_7, // Greek
307 wxFONTENCODING_ISO8859_8, // Hebrew
308 wxFONTENCODING_ISO8859_9, // Turkish (Latin5)
309 wxFONTENCODING_ISO8859_10, // Variation of Latin4 (Latin6)
310 wxFONTENCODING_ISO8859_11, // Thai
311 wxFONTENCODING_ISO8859_12, // doesn't exist currently, but put it
312 // here anyhow to make all ISO8859
313 // consecutive numbers
314 wxFONTENCODING_ISO8859_13, // Latin7
315 wxFONTENCODING_ISO8859_14, // Latin8
316 wxFONTENCODING_ISO8859_15, // Latin9 (a.k.a. Latin0, includes euro)
318 // Cyrillic charset soup (see http://czyborra.com/charsets/cyrillic.html)
319 wxFONTENCODING_KOI8, // we don't support any of KOI8 variants
320 wxFONTENCODING_ALTERNATIVE, // same as MS-DOS CP866
321 wxFONTENCODING_BULGARIAN, // used under Linux in Bulgaria
323 // what would we do without Microsoft? They have their own encodings
325 wxFONTENCODING_CP437, // original MS-DOS codepage
326 wxFONTENCODING_CP850, // CP437 merged with Latin1
327 wxFONTENCODING_CP852, // CP437 merged with Latin2
328 wxFONTENCODING_CP855, // another cyrillic encoding
329 wxFONTENCODING_CP866, // and another one
331 wxFONTENCODING_CP1250, // WinLatin2
332 wxFONTENCODING_CP1251, // WinCyrillic
333 wxFONTENCODING_CP1252, // WinLatin1
339 class wxFont : public wxGDIObject {
341 wxFont( int pointSize, int family, int style, int weight,
342 int underline=FALSE, char* faceName = "",
343 wxFontEncoding encoding=wxFONTENCODING_DEFAULT);
347 wxString GetFaceName();
354 bool GetUnderlined();
356 wxFontEncoding GetEncoding();
357 void SetFaceName(const wxString& faceName);
358 void SetFamily(int family);
359 void SetPointSize(int pointSize);
360 void SetStyle(int style);
361 void SetUnderlined(bool underlined);
362 void SetWeight(int weight);
363 void SetEncoding(wxFontEncoding encoding);
364 wxString GetFamilyString();
365 wxString GetStyleString();
366 wxString GetWeightString();
370 wxFontEncoding wxFont_GetDefaultEncoding() {
371 return wxFont::GetDefaultEncoding();
374 void wxFont_SetDefaultEncoding(wxFontEncoding encoding) {
375 wxFont::SetDefaultEncoding(encoding);
380 class wxFontList : public wxObject {
383 void AddFont(wxFont* font);
384 wxFont * FindOrCreateFont(int point_size, int family, int style, int weight,
385 bool underline = FALSE, const char* facename = NULL,
386 wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
387 void RemoveFont(wxFont *font);
391 //----------------------------------------------------------------------
393 class wxColour : public wxObject {
395 wxColour(unsigned char red=0, unsigned char green=0, unsigned char blue=0);
398 unsigned char Green();
399 unsigned char Blue();
401 void Set(unsigned char red, unsigned char green, unsigned char blue);
404 PyObject* rv = PyTuple_New(3);
405 PyTuple_SetItem(rv, 0, PyInt_FromLong(self->Red()));
406 PyTuple_SetItem(rv, 1, PyInt_FromLong(self->Green()));
407 PyTuple_SetItem(rv, 2, PyInt_FromLong(self->Blue()));
411 %pragma(python) addtoclass = "asTuple = Get"
412 %pragma(python) addtoclass = "def __str__(self): return str(self.asTuple())"
413 %pragma(python) addtoclass = "def __repr__(self): return str(self.asTuple())"
417 %new wxColour* wxNamedColour(const wxString& colorName);
419 %{ // Alternate 'constructor'
420 wxColour* wxNamedColour(const wxString& colorName) {
421 return new wxColour(colorName);
427 class wxColourDatabase : public wxObject {
430 wxColour *FindColour(const wxString& colour);
431 wxString FindName(const wxColour& colour) const;
434 void Append(const wxString& name, int red, int green, int blue) {
435 self->Append(name.c_str(), new wxColour(red, green, blue));
441 //----------------------------------------------------------------------
444 class wxPen : public wxGDIObject {
446 wxPen(wxColour& colour, int width=1, int style=wxSOLID);
450 wxColour GetColour();
456 void SetCap(int cap_style);
457 void SetColour(wxColour& colour);
458 void SetJoin(int join_style);
459 void SetStyle(int style);
460 void SetWidth(int width);
462 // **** This one needs to return a list of ints (wxDash)
463 int GetDashes(wxDash **dashes);
464 void SetDashes(int LCOUNT, wxDash* choices);
467 wxBitmap* GetStipple();
468 void SetStipple(wxBitmap& stipple);
473 class wxPenList : public wxObject {
476 void AddPen(wxPen* pen);
477 wxPen* FindOrCreatePen(const wxColour& colour, int width, int style);
478 void RemovePen(wxPen* pen);
483 //----------------------------------------------------------------------
485 class wxBrush : public wxGDIObject {
487 wxBrush(const wxColour& colour, int style=wxSOLID);
490 wxColour GetColour();
491 wxBitmap * GetStipple();
494 void SetColour(wxColour &colour);
495 void SetStipple(wxBitmap& bitmap);
496 void SetStyle(int style);
503 void AddBrush(wxBrush *brush);
504 wxBrush * FindOrCreateBrush(const wxColour& colour, int style);
505 void RemoveBrush(wxBrush *brush);
508 //----------------------------------------------------------------------
512 class wxDC : public wxObject {
514 // wxDC(); **** abstract base class, can't instantiate.
519 bool Blit(long xdest, long ydest,
520 long width, long height,
521 wxDC *source, long xsrc, long ysrc,
522 int logicalFunc = wxCOPY, int useMask = FALSE);
523 // bool Blit(const wxPoint& destPt, const wxSize& sz,
524 // wxDC *source, const wxPoint& srcPt,
525 // int logicalFunc = wxCOPY, int useMask = FALSE);
528 void CrossHair(long x, long y);
529 void DestroyClippingRegion();
530 long DeviceToLogicalX(long x);
531 long DeviceToLogicalXRel(long x);
532 long DeviceToLogicalY(long y);
533 long DeviceToLogicalYRel(long y);
534 void DrawArc(long x1, long y1, long x2, long y2, long xc, long yc);
535 void DrawCircle(long x, long y, long radius);
536 void DrawEllipse(long x, long y, long width, long height);
537 void DrawEllipticArc(long x, long y, long width, long height, long start, long end);
538 void DrawIcon(const wxIcon& icon, long x, long y);
539 void DrawLine(long x1, long y1, long x2, long y2);
540 void DrawLines(int PCOUNT, wxPoint* points, long xoffset=0, long yoffset=0);
541 void DrawPolygon(int PCOUNT, wxPoint* points, long xoffset=0, long yoffset=0,
542 int fill_style=wxODDEVEN_RULE);
543 void DrawPoint(long x, long y);
544 void DrawRectangle(long x, long y, long width, long height);
545 void DrawRotatedText(const wxString& text, wxCoord x, wxCoord y, double angle);
546 void DrawRoundedRectangle(long x, long y, long width, long height, long radius=20);
547 void DrawSpline(int PCOUNT, wxPoint* points);
548 void DrawText(const wxString& text, long x, long y);
552 void FloodFill(long x, long y, const wxColour& colour, int style=wxFLOOD_SURFACE);
553 wxBrush& GetBackground();
555 long GetCharHeight();
557 void GetClippingBox(long *OUTPUT, long *OUTPUT,
558 long *OUTPUT, long *OUTPUT);
560 int GetLogicalFunction();
561 void GetLogicalScale(double *OUTPUT, double *OUTPUT);
563 bool GetOptimization();
566 %new wxColour* GetPixel(long x, long y) {
567 wxColour* wc = new wxColour();
568 self->GetPixel(x, y, wc);
572 %name(GetSizeTuple)void GetSize(int* OUTPUT, int* OUTPUT);
575 wxColour GetTextBackground();
576 void GetTextExtent(const wxString& string, long *OUTPUT, long *OUTPUT);
577 %name(GetFullTextExtent)void GetTextExtent(const wxString& string,
578 long *OUTPUT, long *OUTPUT, long *OUTPUT, long* OUTPUT,
579 const wxFont* font = NULL);
580 wxColour GetTextForeground();
581 void GetUserScale(double *OUTPUT, double *OUTPUT);
582 long LogicalToDeviceX(long x);
583 long LogicalToDeviceXRel(long x);
584 long LogicalToDeviceY(long y);
585 long LogicalToDeviceYRel(long y);
591 void SetDeviceOrigin(long x, long y);
592 void SetBackground(const wxBrush& brush);
593 void SetBackgroundMode(int mode);
594 void SetClippingRegion(long x, long y, long width, long height);
595 void SetPalette(const wxPalette& colourMap);
596 void SetBrush(const wxBrush& brush);
597 void SetFont(const wxFont& font);
598 void SetLogicalFunction(int function);
599 void SetLogicalScale(double x, double y);
600 void SetMapMode(int mode);
601 void SetOptimization(bool optimize);
602 void SetPen(const wxPen& pen);
603 void SetTextBackground(const wxColour& colour);
604 void SetTextForeground(const wxColour& colour);
605 void SetUserScale(double x_scale, double y_scale);
606 bool StartDoc(const wxString& message);
611 void DrawBitmap(const wxBitmap& bitmap, long x, long y,
612 int useMask = FALSE);
614 bool CanDrawBitmap();
615 bool CanGetTextExtent();
619 void GetLogicalOrigin(int *OUTPUT, int *OUTPUT);
620 void SetLogicalOrigin(int x, int y);
621 void GetDeviceOrigin(int *OUTPUT, int *OUTPUT);
622 void SetAxisOrientation(bool xLeftRight, bool yBottomUp);
624 void CalcBoundingBox(int x, int y);
625 void ResetBoundingBox();
629 //----------------------------------------------------------------------
631 class wxMemoryDC : public wxDC {
635 void SelectObject(const wxBitmap& bitmap);
638 %new wxMemoryDC* wxMemoryDCFromDC(wxDC* oldDC);
639 %{ // Alternate 'constructor'
640 wxMemoryDC* wxMemoryDCFromDC(wxDC* oldDC) {
641 return new wxMemoryDC(oldDC);
646 //---------------------------------------------------------------------------
648 class wxScreenDC : public wxDC {
652 %name(StartDrawingOnTopWin) bool StartDrawingOnTop(wxWindow* window);
653 bool StartDrawingOnTop(wxRect* rect = NULL);
654 bool EndDrawingOnTop();
657 //---------------------------------------------------------------------------
659 class wxClientDC : public wxDC {
661 wxClientDC(wxWindow* win);
664 //---------------------------------------------------------------------------
666 class wxPaintDC : public wxDC {
668 wxPaintDC(wxWindow* win);
671 //---------------------------------------------------------------------------
673 class wxWindowDC : public wxDC {
675 wxWindowDC(wxWindow* win);
678 //---------------------------------------------------------------------------
681 class wxPostScriptDC : public wxDC {
683 wxPostScriptDC(const wxString& output, bool interactive = TRUE, wxWindow* win = NULL);
687 //---------------------------------------------------------------------------
691 class wxMetaFileDC : public wxDC {
693 wxMetaFileDC(const wxString& filename = wxPyEmptyStr);
698 //---------------------------------------------------------------------------
699 //---------------------------------------------------------------------------
706 extern wxFont *wxNORMAL_FONT;
707 extern wxFont *wxSMALL_FONT;
708 extern wxFont *wxITALIC_FONT;
709 extern wxFont *wxSWISS_FONT;
711 extern wxPen *wxRED_PEN;
712 extern wxPen *wxCYAN_PEN;
713 extern wxPen *wxGREEN_PEN;
714 extern wxPen *wxBLACK_PEN;
715 extern wxPen *wxWHITE_PEN;
716 extern wxPen *wxTRANSPARENT_PEN;
717 extern wxPen *wxBLACK_DASHED_PEN;
718 extern wxPen *wxGREY_PEN;
719 extern wxPen *wxMEDIUM_GREY_PEN;
720 extern wxPen *wxLIGHT_GREY_PEN;
722 extern wxBrush *wxBLUE_BRUSH;
723 extern wxBrush *wxGREEN_BRUSH;
724 extern wxBrush *wxWHITE_BRUSH;
725 extern wxBrush *wxBLACK_BRUSH;
726 extern wxBrush *wxTRANSPARENT_BRUSH;
727 extern wxBrush *wxCYAN_BRUSH;
728 extern wxBrush *wxRED_BRUSH;
729 extern wxBrush *wxGREY_BRUSH;
730 extern wxBrush *wxMEDIUM_GREY_BRUSH;
731 extern wxBrush *wxLIGHT_GREY_BRUSH;
733 extern wxColour *wxBLACK;
734 extern wxColour *wxWHITE;
735 extern wxColour *wxRED;
736 extern wxColour *wxBLUE;
737 extern wxColour *wxGREEN;
738 extern wxColour *wxCYAN;
739 extern wxColour *wxLIGHT_GREY;
741 extern wxCursor *wxSTANDARD_CURSOR;
742 extern wxCursor *wxHOURGLASS_CURSOR;
743 extern wxCursor *wxCROSS_CURSOR;
745 extern wxBitmap wxNullBitmap;
746 extern wxIcon wxNullIcon;
747 extern wxCursor wxNullCursor;
748 extern wxPen wxNullPen;
749 extern wxBrush wxNullBrush;
750 extern wxPalette wxNullPalette;
751 extern wxFont wxNullFont;
752 extern wxColour wxNullColour;
755 extern wxFontList* wxTheFontList;
756 extern wxPenList* wxThePenList;
757 extern wxBrushlist* wxTheBrushList;
758 extern wxColourDatabase* wxTheColourDatabase;
766 //---------------------------------------------------------------------------
768 class wxPalette : public wxGDIObject {
770 wxPalette(int LCOUNT, byte* choices, byte* choices, byte* choices);
773 int GetPixel(byte red, byte green, byte blue);
774 bool GetRGB(int pixel, byte* OUTPUT, byte* OUTPUT, byte* OUTPUT);
778 //---------------------------------------------------------------------------
781 wxIMAGELIST_DRAW_NORMAL ,
782 wxIMAGELIST_DRAW_TRANSPARENT,
783 wxIMAGELIST_DRAW_SELECTED,
784 wxIMAGELIST_DRAW_FOCUSED,
790 class wxImageList : public wxObject {
792 wxImageList(int width, int height, int mask=TRUE, int initialCount=1);
795 int Add(const wxBitmap& bitmap, const wxBitmap& mask = wxNullBitmap);
796 %name(AddWithColourMask)int Add(const wxBitmap& bitmap, const wxColour& maskColour);
797 %name(AddIcon)int Add(const wxIcon& icon);
799 bool Replace(int index, const wxBitmap& bitmap, const wxBitmap& mask = wxNullBitmap);
801 // %name(ReplaceIcon)bool Replace(int index, const wxIcon& icon);
802 // int Add(const wxBitmap& bitmap);
803 bool Replace(int index, const wxBitmap& bitmap);
806 bool Draw(int index, wxDC& dc, int x, int x, int flags = wxIMAGELIST_DRAW_NORMAL,
807 const bool solidBackground = FALSE);
810 bool Remove(int index);
812 void GetSize(int index, int& OUTPUT, int& OUTPUT);
816 //---------------------------------------------------------------------------
819 enum wxRegionContain {
820 wxOutRegion, wxPartRegion, wxInRegion
824 class wxRegion : public wxGDIObject {
826 wxRegion(long x=0, long y=0, long width=0, long height=0);
830 wxRegionContain Contains(long x, long y);
831 %name(ContainsPoint)wxRegionContain Contains(const wxPoint& pt);
832 %name(ContainsRect)wxRegionContain Contains(const wxRect& rect);
833 %name(ContainsRectDim)wxRegionContain Contains(long x, long y, long w, long h);
837 bool Intersect(long x, long y, long width, long height);
838 %name(IntersectRect)bool Intersect(const wxRect& rect);
839 %name(IntersectRegion)bool Intersect(const wxRegion& region);
843 bool Union(long x, long y, long width, long height);
844 %name(UnionRect)bool Union(const wxRect& rect);
845 %name(UnionRegion)bool Union(const wxRegion& region);
847 bool Subtract(long x, long y, long width, long height);
848 %name(SubtractRect)bool Subtract(const wxRect& rect);
849 %name(SubtractRegion)bool Subtract(const wxRegion& region);
851 bool Xor(long x, long y, long width, long height);
852 %name(XorRect)bool Xor(const wxRect& rect);
853 %name(XorRegion)bool Xor(const wxRegion& region);
858 class wxRegionIterator : public wxObject {
860 wxRegionIterator(const wxRegion& region);
881 //---------------------------------------------------------------------------