]> git.saurik.com Git - wxWidgets.git/blob - utils/wxPython/src/gdi.i
Compilation fixes
[wxWidgets.git] / 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 wxGDIImage {
37 // public:
38 // long GetHandle();
39 // void SetHandle(long handle);
40 // bool Ok();
41 // int GetWidth();
42 // int GetHeight();
43 // int GetDepth();
44 // void SetWidth(int w);
45 // void SetHeight(int h);
46 // void SetDepth(int d);
47 // void SetSize(const wxSize& size);
48 // };
49
50 //---------------------------------------------------------------------------
51
52 class wxBitmap
53 //: public wxGDIImage
54 {
55 public:
56 wxBitmap(const wxString& name, long type);
57 ~wxBitmap();
58
59 wxPalette* GetPalette();
60 wxMask* GetMask();
61 bool LoadFile(const wxString& name, long flags);
62 bool SaveFile(const wxString& name, int type, wxPalette* palette = NULL);
63 void SetMask(wxMask* mask);
64 #ifdef __WXMSW__
65 void SetPalette(wxPalette& palette);
66 #endif
67
68 // wxGDIImage methods
69 #ifdef __WXMSW__
70 long GetHandle();
71 void SetHandle(long handle);
72 #endif
73 bool Ok();
74 int GetWidth();
75 int GetHeight();
76 int GetDepth();
77 void SetWidth(int w);
78 void SetHeight(int h);
79 void SetDepth(int d);
80 #ifdef __WXMSW__
81 void SetSize(const wxSize& size);
82 #endif
83 };
84
85
86 %new wxBitmap* wxEmptyBitmap(int width, int height, int depth=-1);
87
88 #ifdef __WXMSW__
89 %new wxBitmap* wxBitmapFromData(char* data, long type,
90 int width, int height, int depth = 1);
91 #endif
92
93 %{ // Alternate 'constructor'
94 wxBitmap* wxEmptyBitmap(int width, int height, int depth=-1) {
95 return new wxBitmap(width, height, depth);
96 }
97
98 #ifdef __WXMSW__
99 wxBitmap* wxBitmapFromData(char* data, long type,
100 int width, int height, int depth = 1) {
101 return new wxBitmap((void*)data, type, width, height, depth);
102 }
103 #endif
104 %}
105
106 //---------------------------------------------------------------------------
107
108 class wxMask {
109 public:
110 wxMask(const wxBitmap& bitmap);
111 //~wxMask();
112 };
113
114 %new wxMask* wxMaskColour(const wxBitmap& bitmap, const wxColour& colour);
115 %{
116 wxMask* wxMaskColour(const wxBitmap& bitmap, const wxColour& colour) {
117 return new wxMask(bitmap, colour);
118 }
119 %}
120
121
122 //---------------------------------------------------------------------------
123
124
125 class wxIcon
126 //: public wxGDIImage
127 {
128 public:
129 wxIcon(const wxString& name, long flags,
130 int desiredWidth = -1, int desiredHeight = -1);
131 ~wxIcon();
132
133 bool LoadFile(const wxString& name, long flags);
134
135 // wxGDIImage methods
136 #ifdef __WXMSW__
137 long GetHandle();
138 void SetHandle(long handle);
139 #endif
140 bool Ok();
141 int GetWidth();
142 int GetHeight();
143 int GetDepth();
144 void SetWidth(int w);
145 void SetHeight(int h);
146 void SetDepth(int d);
147 #ifdef __WXMSW__
148 void SetSize(const wxSize& size);
149 #endif
150 };
151
152
153 //---------------------------------------------------------------------------
154
155 class wxCursor
156 //: public wxGDIImage
157 {
158 public:
159 #ifdef __WXMSW__
160 wxCursor(const wxString& cursorName, long flags, int hotSpotX=0, int hotSpotY=0);
161 #endif
162 ~wxCursor();
163
164 // wxGDIImage methods
165 #ifdef __WXMSW__
166 long GetHandle();
167 void SetHandle(long handle);
168 #endif
169 bool Ok();
170 #ifdef __WXMSW__
171 int GetWidth();
172 int GetHeight();
173 int GetDepth();
174 void SetWidth(int w);
175 void SetHeight(int h);
176 void SetDepth(int d);
177 void SetSize(const wxSize& size);
178 #endif
179 };
180
181 %name(wxStockCursor) %new wxCursor* wxPyStockCursor(int id);
182 %{ // Alternate 'constructor'
183 wxCursor* wxPyStockCursor(int id) {
184 return new wxCursor(id);
185 }
186 %}
187
188 //----------------------------------------------------------------------
189
190
191 enum wxFontEncoding
192 {
193 wxFONTENCODING_SYSTEM = -1, // system default
194 wxFONTENCODING_DEFAULT, // current default encoding
195
196 // ISO8859 standard defines a number of single-byte charsets
197 wxFONTENCODING_ISO8859_1, // West European (Latin1)
198 wxFONTENCODING_ISO8859_2, // Central and East European (Latin2)
199 wxFONTENCODING_ISO8859_3, // Esperanto (Latin3)
200 wxFONTENCODING_ISO8859_4, // Baltic languages (Estonian) (Latin4)
201 wxFONTENCODING_ISO8859_5, // Cyrillic
202 wxFONTENCODING_ISO8859_6, // Arabic
203 wxFONTENCODING_ISO8859_7, // Greek
204 wxFONTENCODING_ISO8859_8, // Hebrew
205 wxFONTENCODING_ISO8859_9, // Turkish (Latin5)
206 wxFONTENCODING_ISO8859_10, // Variation of Latin4 (Latin6)
207 wxFONTENCODING_ISO8859_11, // Thai
208 wxFONTENCODING_ISO8859_12, // doesn't exist currently, but put it
209 // here anyhow to make all ISO8859
210 // consecutive numbers
211 wxFONTENCODING_ISO8859_13, // Latin7
212 wxFONTENCODING_ISO8859_14, // Latin8
213 wxFONTENCODING_ISO8859_15, // Latin9 (a.k.a. Latin0, includes euro)
214
215 // Cyrillic charset soup (see http://czyborra.com/charsets/cyrillic.html)
216 wxFONTENCODING_KOI8, // we don't support any of KOI8 variants
217 wxFONTENCODING_ALTERNATIVE, // same as MS-DOS CP866
218 wxFONTENCODING_BULGARIAN, // used under Linux in Bulgaria
219
220 // what would we do without Microsoft? They have their own encodings
221 // for DOS
222 wxFONTENCODING_CP437, // original MS-DOS codepage
223 wxFONTENCODING_CP850, // CP437 merged with Latin1
224 wxFONTENCODING_CP852, // CP437 merged with Latin2
225 wxFONTENCODING_CP855, // another cyrillic encoding
226 wxFONTENCODING_CP866, // and another one
227 // and for Windows
228 wxFONTENCODING_CP1250, // WinLatin2
229 wxFONTENCODING_CP1251, // WinCyrillic
230 wxFONTENCODING_CP1252, // WinLatin1
231
232 wxFONTENCODING_MAX
233 };
234
235 class wxFont {
236 public:
237 // I'll do it this way to use long-lived objects and not have to
238 // worry about when python may delete the object.
239 %addmethods {
240 wxFont( int pointSize, int family, int style, int weight,
241 int underline=FALSE, char* faceName = "",
242 wxFontEncoding encoding=wxFONTENCODING_DEFAULT) {
243
244 return wxTheFontList->FindOrCreateFont(pointSize, family, style, weight,
245 underline, faceName, encoding);
246 }
247 // NO Destructor.
248 }
249
250 bool Ok();
251
252 wxString GetFaceName();
253 int GetFamily();
254 #ifdef __WXMSW__
255 int GetFontId();
256 #endif
257 int GetPointSize();
258 int GetStyle();
259 bool GetUnderlined();
260 int GetWeight();
261 wxFontEncoding GetEncoding();
262 void SetFaceName(const wxString& faceName);
263 void SetFamily(int family);
264 void SetPointSize(int pointSize);
265 void SetStyle(int style);
266 void SetUnderlined(bool underlined);
267 void SetWeight(int weight);
268 void SetEncoding(wxFontEncoding encoding);
269 wxString GetFamilyString();
270 wxString GetStyleString();
271 wxString GetWeightString();
272 };
273
274 %inline %{
275 wxFontEncoding wxFont_GetDefaultEncoding() {
276 return wxFont::GetDefaultEncoding();
277 }
278
279 void wxFont_SetDefaultEncoding(wxFontEncoding encoding) {
280 wxFont::SetDefaultEncoding(encoding);
281 }
282 %}
283
284 //----------------------------------------------------------------------
285
286 class wxColour {
287 public:
288 wxColour(unsigned char red=0, unsigned char green=0, unsigned char blue=0);
289 ~wxColour();
290 unsigned char Red();
291 unsigned char Green();
292 unsigned char Blue();
293 bool Ok();
294 void Set(unsigned char red, unsigned char green, unsigned char blue);
295 %addmethods {
296 PyObject* Get() {
297 PyObject* rv = PyTuple_New(3);
298 PyTuple_SetItem(rv, 0, PyInt_FromLong(self->Red()));
299 PyTuple_SetItem(rv, 1, PyInt_FromLong(self->Green()));
300 PyTuple_SetItem(rv, 2, PyInt_FromLong(self->Blue()));
301 return rv;
302 }
303 }
304 %pragma(python) addtoclass = "asTuple = Get"
305 %pragma(python) addtoclass = "def __str__(self): return str(self.asTuple())"
306 %pragma(python) addtoclass = "def __repr__(self): return str(self.asTuple())"
307
308 };
309
310 %new wxColour* wxNamedColour(const wxString& colorName);
311 %{ // Alternate 'constructor'
312 wxColour* wxNamedColour(const wxString& colorName) {
313 return new wxColour(colorName);
314 }
315 %}
316
317
318 //----------------------------------------------------------------------
319
320 #ifdef __WXMSW__
321 typedef unsigned long wxDash;
322 #else
323 typedef char wxDash;
324 #endif
325
326
327 class wxPen {
328 public:
329 // I'll do it this way to use long-lived objects and not have to
330 // worry about when python may delete the object.
331 %addmethods {
332 wxPen(wxColour* colour, int width=1, int style=wxSOLID) {
333 return wxThePenList->FindOrCreatePen(*colour, width, style);
334 }
335 // NO Destructor.
336 }
337
338 int GetCap();
339 wxColour& GetColour();
340
341 int GetJoin();
342 int GetStyle();
343 int GetWidth();
344 bool Ok();
345 void SetCap(int cap_style);
346 void SetColour(wxColour& colour);
347 void SetJoin(int join_style);
348 void SetStyle(int style);
349 void SetWidth(int width);
350
351 // **** This one needs to return a list of ints (wxDash)
352 int GetDashes(wxDash **dashes);
353 void SetDashes(int LCOUNT, wxDash* choices);
354
355 #ifdef __WXMSW__
356 wxBitmap* GetStipple();
357 void SetStipple(wxBitmap& stipple);
358 #endif
359 };
360
361 //----------------------------------------------------------------------
362
363 class wxBrush {
364 public:
365 // I'll do it this way to use long-lived objects and not have to
366 // worry about when python may delete the object.
367 %addmethods {
368 wxBrush(const wxColour* colour, int style=wxSOLID) {
369 return wxTheBrushList->FindOrCreateBrush(*colour, style);
370 }
371 // NO Destructor.
372 }
373
374 // wxBrush(const wxColour& colour, int style=wxSOLID);
375
376 wxColour& GetColour();
377 wxBitmap * GetStipple();
378 int GetStyle();
379 bool Ok();
380 void SetColour(wxColour &colour);
381 void SetStipple(wxBitmap& bitmap);
382 void SetStyle(int style);
383 };
384
385 //----------------------------------------------------------------------
386
387
388
389 class wxDC {
390 public:
391 // wxDC(); **** abstract base class, can't instantiate.
392 ~wxDC();
393
394 void BeginDrawing();
395 // %name(BlitXY)
396 bool Blit(long xdest, long ydest,
397 long width, long height,
398 wxDC *source, long xsrc, long ysrc,
399 int logicalFunc = wxCOPY, int useMask = FALSE);
400 // bool Blit(const wxPoint& destPt, const wxSize& sz,
401 // wxDC *source, const wxPoint& srcPt,
402 // int logicalFunc = wxCOPY, int useMask = FALSE);
403
404 void Clear();
405 void CrossHair(long x, long y);
406 void DestroyClippingRegion();
407 long DeviceToLogicalX(long x);
408 long DeviceToLogicalXRel(long x);
409 long DeviceToLogicalY(long y);
410 long DeviceToLogicalYRel(long y);
411 void DrawArc(long x1, long y1, long x2, long y2, long xc, long yc);
412 void DrawCircle(long x, long y, long radius);
413 void DrawEllipse(long x, long y, long width, long height);
414 void DrawEllipticArc(long x, long y, long width, long height, long start, long end);
415 void DrawIcon(const wxIcon& icon, long x, long y);
416 void DrawLine(long x1, long y1, long x2, long y2);
417 void DrawLines(int PCOUNT, wxPoint* points, long xoffset=0, long yoffset=0);
418 void DrawPolygon(int PCOUNT, wxPoint* points, long xoffset=0, long yoffset=0,
419 int fill_style=wxODDEVEN_RULE);
420 void DrawPoint(long x, long y);
421 void DrawRectangle(long x, long y, long width, long height);
422 void DrawRotatedText(const wxString& text, wxCoord x, wxCoord y, double angle);
423 void DrawRoundedRectangle(long x, long y, long width, long height, long radius=20);
424 void DrawSpline(int PCOUNT, wxPoint* points);
425 void DrawText(const wxString& text, long x, long y);
426 void EndDoc();
427 void EndDrawing();
428 void EndPage();
429 void FloodFill(long x, long y, const wxColour& colour, int style=wxFLOOD_SURFACE);
430 wxBrush& GetBackground();
431 wxBrush& GetBrush();
432 long GetCharHeight();
433 long GetCharWidth();
434 void GetClippingBox(long *OUTPUT, long *OUTPUT,
435 long *OUTPUT, long *OUTPUT);
436 wxFont& GetFont();
437 int GetLogicalFunction();
438 void GetLogicalScale(double *OUTPUT, double *OUTPUT);
439 int GetMapMode();
440 bool GetOptimization();
441 wxPen& GetPen();
442 %addmethods {
443 %new wxColour* GetPixel(long x, long y) {
444 wxColour* wc = new wxColour();
445 self->GetPixel(x, y, wc);
446 return wc;
447 }
448 }
449 %name(GetSizeTuple)void GetSize(int* OUTPUT, int* OUTPUT);
450 wxSize GetSize();
451 wxSize GetSizeMM();
452 wxColour& GetTextBackground();
453 void GetTextExtent(const wxString& string, long *OUTPUT, long *OUTPUT);
454 %name(GetFullTextExtent)void GetTextExtent(const wxString& string,
455 long *OUTPUT, long *OUTPUT, long *OUTPUT, long* OUTPUT,
456 const wxFont* font = NULL);
457 wxColour& GetTextForeground();
458 void GetUserScale(double *OUTPUT, double *OUTPUT);
459 long LogicalToDeviceX(long x);
460 long LogicalToDeviceXRel(long x);
461 long LogicalToDeviceY(long y);
462 long LogicalToDeviceYRel(long y);
463 long MaxX();
464 long MaxY();
465 long MinX();
466 long MinY();
467 bool Ok();
468 void SetDeviceOrigin(long x, long y);
469 void SetBackground(const wxBrush& brush);
470 void SetBackgroundMode(int mode);
471 void SetClippingRegion(long x, long y, long width, long height);
472 void SetPalette(const wxPalette& colourMap);
473 void SetBrush(const wxBrush& brush);
474 void SetFont(const wxFont& font);
475 void SetLogicalFunction(int function);
476 void SetLogicalScale(double x, double y);
477 void SetMapMode(int mode);
478 void SetOptimization(bool optimize);
479 void SetPen(const wxPen& pen);
480 void SetTextBackground(const wxColour& colour);
481 void SetTextForeground(const wxColour& colour);
482 void SetUserScale(double x_scale, double y_scale);
483 bool StartDoc(const wxString& message);
484 void StartPage();
485
486
487
488 void DrawBitmap(const wxBitmap& bitmap, long x, long y,
489 int useMask = FALSE);
490
491 bool CanDrawBitmap();
492 bool CanGetTextExtent();
493 int GetDepth();
494 wxSize GetPPI();
495
496 void GetLogicalOrigin(int *OUTPUT, int *OUTPUT);
497 void SetLogicalOrigin(int x, int y);
498 void GetDeviceOrigin(int *OUTPUT, int *OUTPUT);
499 void SetAxisOrientation(bool xLeftRight, bool yBottomUp);
500
501 };
502
503
504 //----------------------------------------------------------------------
505
506 class wxMemoryDC : public wxDC {
507 public:
508 wxMemoryDC();
509
510 void SelectObject(const wxBitmap& bitmap);
511 }
512
513 %new wxMemoryDC* wxMemoryDCFromDC(wxDC* oldDC);
514 %{ // Alternate 'constructor'
515 wxMemoryDC* wxMemoryDCFromDC(wxDC* oldDC) {
516 return new wxMemoryDC(oldDC);
517 }
518 %}
519
520
521 //---------------------------------------------------------------------------
522
523 class wxScreenDC : public wxDC {
524 public:
525 wxScreenDC();
526
527 %name(StartDrawingOnTopWin) bool StartDrawingOnTop(wxWindow* window);
528 bool StartDrawingOnTop(wxRect* rect = NULL);
529 bool EndDrawingOnTop();
530 };
531
532 //---------------------------------------------------------------------------
533
534 class wxClientDC : public wxDC {
535 public:
536 wxClientDC(wxWindow* win);
537 };
538
539 //---------------------------------------------------------------------------
540
541 class wxPaintDC : public wxDC {
542 public:
543 wxPaintDC(wxWindow* win);
544 };
545
546 //---------------------------------------------------------------------------
547
548 class wxWindowDC : public wxDC {
549 public:
550 wxWindowDC(wxWindow* win);
551 };
552
553 //---------------------------------------------------------------------------
554
555 #ifndef __WXMSW__
556 class wxPostScriptDC : public wxDC {
557 public:
558 wxPostScriptDC(const wxString& output, bool interactive = TRUE, wxWindow* win = NULL);
559 };
560 #endif
561
562 //---------------------------------------------------------------------------
563
564 #ifdef __WXMSW__
565 class wxPrinterDC : public wxDC {
566 public:
567 wxPrinterDC(const wxString& driver, const wxString& device, const wxString& output,
568 bool interactive = TRUE, int orientation = wxPORTRAIT);
569 };
570 #endif
571
572 //---------------------------------------------------------------------------
573
574 #ifdef __WXMSW__
575 class wxMetaFileDC : public wxDC {
576 public:
577 wxMetaFileDC(const wxString& filename = wxPyEmptyStr);
578 wxMetaFile* Close();
579 };
580 #endif
581
582 //---------------------------------------------------------------------------
583 //---------------------------------------------------------------------------
584
585
586 %readonly
587 %{
588 #if 0
589 %}
590 extern wxFont *wxNORMAL_FONT;
591 extern wxFont *wxSMALL_FONT;
592 extern wxFont *wxITALIC_FONT;
593 extern wxFont *wxSWISS_FONT;
594
595 extern wxPen *wxRED_PEN;
596 extern wxPen *wxCYAN_PEN;
597 extern wxPen *wxGREEN_PEN;
598 extern wxPen *wxBLACK_PEN;
599 extern wxPen *wxWHITE_PEN;
600 extern wxPen *wxTRANSPARENT_PEN;
601 extern wxPen *wxBLACK_DASHED_PEN;
602 extern wxPen *wxGREY_PEN;
603 extern wxPen *wxMEDIUM_GREY_PEN;
604 extern wxPen *wxLIGHT_GREY_PEN;
605
606 extern wxBrush *wxBLUE_BRUSH;
607 extern wxBrush *wxGREEN_BRUSH;
608 extern wxBrush *wxWHITE_BRUSH;
609 extern wxBrush *wxBLACK_BRUSH;
610 extern wxBrush *wxTRANSPARENT_BRUSH;
611 extern wxBrush *wxCYAN_BRUSH;
612 extern wxBrush *wxRED_BRUSH;
613 extern wxBrush *wxGREY_BRUSH;
614 extern wxBrush *wxMEDIUM_GREY_BRUSH;
615 extern wxBrush *wxLIGHT_GREY_BRUSH;
616
617 extern wxColour *wxBLACK;
618 extern wxColour *wxWHITE;
619 extern wxColour *wxRED;
620 extern wxColour *wxBLUE;
621 extern wxColour *wxGREEN;
622 extern wxColour *wxCYAN;
623 extern wxColour *wxLIGHT_GREY;
624
625 extern wxCursor *wxSTANDARD_CURSOR;
626 extern wxCursor *wxHOURGLASS_CURSOR;
627 extern wxCursor *wxCROSS_CURSOR;
628
629 extern wxBitmap wxNullBitmap;
630 extern wxIcon wxNullIcon;
631 extern wxCursor wxNullCursor;
632 extern wxPen wxNullPen;
633 extern wxBrush wxNullBrush;
634 extern wxPalette wxNullPalette;
635 extern wxFont wxNullFont;
636 extern wxColour wxNullColour;
637
638 %readwrite
639 %{
640 #endif
641 %}
642
643 //---------------------------------------------------------------------------
644
645 class wxPalette {
646 public:
647 wxPalette(int LCOUNT, byte* choices, byte* choices, byte* choices);
648 ~wxPalette();
649
650 int GetPixel(byte red, byte green, byte blue);
651 bool GetRGB(int pixel, byte* OUTPUT, byte* OUTPUT, byte* OUTPUT);
652 bool Ok();
653 };
654
655 //---------------------------------------------------------------------------
656
657 enum {
658 wxIMAGELIST_DRAW_NORMAL ,
659 wxIMAGELIST_DRAW_TRANSPARENT,
660 wxIMAGELIST_DRAW_SELECTED,
661 wxIMAGELIST_DRAW_FOCUSED,
662 wxIMAGE_LIST_NORMAL,
663 wxIMAGE_LIST_SMALL,
664 wxIMAGE_LIST_STATE
665 };
666
667 class wxImageList {
668 public:
669 wxImageList(int width, int height, int mask=FALSE, int initialCount=1);
670 ~wxImageList();
671
672 #ifdef __WXMSW__
673 int Add(const wxBitmap& bitmap, const wxBitmap& mask = wxNullBitmap);
674 %name(AddWithColourMask)int Add(const wxBitmap& bitmap, const wxColour& maskColour);
675 %name(AddIcon)int Add(const wxIcon& icon);
676 bool Replace(int index, const wxBitmap& bitmap, const wxBitmap& mask = wxNullBitmap);
677 %name(ReplaceIcon)bool Replace(int index, const wxIcon& icon);
678 #else
679 int Add(const wxBitmap& bitmap);
680 bool Replace(int index, const wxBitmap& bitmap);
681 #endif
682
683 bool Draw(int index, wxDC& dc, int x, int x, int flags = wxIMAGELIST_DRAW_NORMAL,
684 const bool solidBackground = FALSE);
685
686 int GetImageCount();
687 bool Remove(int index);
688 bool RemoveAll();
689 };
690
691
692 //---------------------------------------------------------------------------
693