1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Wrapper definitions for wx.GraphicsPath, wx.GraphicsContext
9 // Copyright: (c) 2006 by Total Control Software
10 // Licence: wxWindows license
11 /////////////////////////////////////////////////////////////////////////////
16 //---------------------------------------------------------------------------
20 #include <wx/graphics.h>
23 // Turn off the aquisition of the Global Interpreter Lock for the classes and
24 // functions in this file
28 //---------------------------------------------------------------------------
29 //---------------------------------------------------------------------------
32 #if !wxUSE_GRAPHICS_CONTEXT
33 // C++ stub classes for platforms or build configurations that don't have
34 // wxGraphicsContext yet.
36 class wxGraphicsRenderer;
37 class wxGraphicsMatrix;
40 class wxGraphicsObject : public wxObject
44 wxGraphicsObject( wxGraphicsRenderer* ) {
45 PyErr_SetString(PyExc_NotImplementedError,
46 "wx.GraphicsObject is not available on this platform.");
48 wxGraphicsObject( const wxGraphicsObject& ) {}
49 virtual ~wxGraphicsObject() {}
50 bool IsNull() const { return false; }
51 wxGraphicsRenderer* GetRenderer() const { return NULL; }
56 class wxGraphicsPen : public wxGraphicsObject
60 virtual ~wxGraphicsPen() {}
62 wxGraphicsPen wxNullGraphicsPen;
66 class wxGraphicsBrush : public wxGraphicsObject
70 virtual ~wxGraphicsBrush() {}
72 wxGraphicsBrush wxNullGraphicsBrush;
76 class wxGraphicsFont : public wxGraphicsObject
80 virtual ~wxGraphicsFont() {}
82 wxGraphicsFont wxNullGraphicsFont;
86 class wxGraphicsPath : public wxGraphicsObject
90 wxGraphicsPath(wxGraphicsRenderer* ) {
91 PyErr_SetString(PyExc_NotImplementedError,
92 "wx.GraphicsPath is not available on this platform.");
94 virtual ~wxGraphicsPath() {}
96 void MoveToPoint( wxDouble, wxDouble ) {}
97 void MoveToPoint( const wxPoint2DDouble& ) {}
98 void AddLineToPoint( wxDouble, wxDouble ) {}
99 void AddLineToPoint( const wxPoint2DDouble& ) {}
100 void AddCurveToPoint( wxDouble, wxDouble, wxDouble, wxDouble, wxDouble, wxDouble ) {}
101 void AddCurveToPoint( const wxPoint2DDouble&, const wxPoint2DDouble&, const wxPoint2DDouble&) {}
102 void AddPath( const wxGraphicsPath& ) {}
103 void CloseSubpath() {}
104 void GetCurrentPoint( wxDouble&, wxDouble&) const {}
105 wxPoint2DDouble GetCurrentPoint() const { return wxPoint2D(0,0); }
106 void AddArc( wxDouble, wxDouble, wxDouble, wxDouble, wxDouble, bool ) {}
107 void AddArc( const wxPoint2DDouble& , wxDouble, wxDouble , wxDouble , bool ) {}
109 void AddQuadCurveToPoint( wxDouble, wxDouble, wxDouble, wxDouble ) {}
110 void AddRectangle( wxDouble, wxDouble, wxDouble, wxDouble ) {}
111 void AddCircle( wxDouble, wxDouble, wxDouble ) {}
112 void AddArcToPoint( wxDouble, wxDouble , wxDouble, wxDouble, wxDouble ) {}
114 void AddEllipse( wxDouble , wxDouble , wxDouble , wxDouble ) {}
115 void AddRoundedRectangle( wxDouble , wxDouble , wxDouble , wxDouble , wxDouble ) {}
116 void * GetNativePath() const { return NULL; }
117 void UnGetNativePath(void *) const {}
118 void Transform( const wxGraphicsMatrix& ) {}
119 void GetBox(wxDouble *, wxDouble *, wxDouble *, wxDouble *) const {}
120 wxRect2D GetBox() const { return wxRect2D(0,0,0,0); }
122 bool Contains( wxDouble , wxDouble , int ) const { return false; }
123 bool Contains( const wxPoint2DDouble& , int ) const { return false; }
125 wxGraphicsPath wxNullGraphicsPath;
128 class wxGraphicsMatrix : public wxGraphicsObject
131 wxGraphicsMatrix() { }
132 wxGraphicsMatrix(wxGraphicsRenderer* ) {
133 PyErr_SetString(PyExc_NotImplementedError,
134 "wx.GraphicsMatrix is not available on this platform.");
136 virtual ~wxGraphicsMatrix() {}
137 virtual void Concat( const wxGraphicsMatrix & ) {}
138 virtual void Copy( const wxGraphicsMatrix & ) {}
139 virtual void Set(wxDouble , wxDouble , wxDouble , wxDouble ,
140 wxDouble , wxDouble ) {}
141 virtual void Get(wxDouble*, wxDouble*, wxDouble*,
142 wxDouble*, wxDouble*, wxDouble*) {}
143 virtual void Invert() {}
144 virtual bool IsEqual( const wxGraphicsMatrix& t) const { return false; }
145 virtual bool IsIdentity() const { return false; }
146 virtual void Translate( wxDouble , wxDouble ) {}
147 virtual void Scale( wxDouble , wxDouble ) {}
148 virtual void Rotate( wxDouble ) {}
149 virtual void TransformPoint( wxDouble *, wxDouble * ) const {}
150 virtual void TransformDistance( wxDouble *, wxDouble * ) const {}
151 virtual void * GetNativeMatrix() const { return NULL; }
153 wxGraphicsMatrix wxNullGraphicsMatrix;
156 class wxGraphicsContext : public wxGraphicsObject
160 wxGraphicsContext(wxGraphicsRenderer* ) {
161 PyErr_SetString(PyExc_NotImplementedError,
162 "wx.GraphicsContext is not available on this platform.");
165 virtual ~wxGraphicsContext() {}
167 static wxGraphicsContext* Create() {
168 PyErr_SetString(PyExc_NotImplementedError,
169 "wx.GraphicsContext is not available on this platform.");
172 static wxGraphicsContext* Create( const wxWindowDC& ) {
173 PyErr_SetString(PyExc_NotImplementedError,
174 "wx.GraphicsContext is not available on this platform.");
178 static wxGraphicsContext* CreateFromNative( void * ) {
179 PyErr_SetString(PyExc_NotImplementedError,
180 "wx.GraphicsContext is not available on this platform.");
184 static wxGraphicsContext* CreateFromNativeWindow( void * ) {
185 PyErr_SetString(PyExc_NotImplementedError,
186 "wx.GraphicsContext is not available on this platform.");
190 static wxGraphicsContext* Create( wxWindow* ) {
191 PyErr_SetString(PyExc_NotImplementedError,
192 "wx.GraphicsContext is not available on this platform.");
196 wxGraphicsPath CreatePath() { return wxNullGraphicsPath; }
198 virtual wxGraphicsPen CreatePen(const wxPen& ) { return wxNullGraphicsPen; }
200 virtual wxGraphicsBrush CreateBrush(const wxBrush& ) { return wxNullGraphicsBrush; }
202 virtual wxGraphicsBrush CreateLinearGradientBrush( wxDouble , wxDouble , wxDouble , wxDouble ,
203 const wxColour&, const wxColour&) { return wxNullGraphicsBrush; }
205 virtual wxGraphicsBrush CreateRadialGradientBrush( wxDouble xo, wxDouble yo,
206 wxDouble xc, wxDouble yc, wxDouble radius,
207 const wxColour &oColor, const wxColour &cColor) { return wxNullGraphicsBrush; }
209 virtual wxGraphicsFont CreateFont( const wxFont &, const wxColour & ) { return wxNullGraphicsFont; }
211 virtual wxGraphicsMatrix CreateMatrix( wxDouble, wxDouble, wxDouble, wxDouble,
212 wxDouble, wxDouble) { return wxNullGraphicsMatrix; }
214 virtual void PushState() {}
215 virtual void PopState() {}
216 virtual void Clip( const wxRegion & ) {}
217 virtual void Clip( wxDouble , wxDouble , wxDouble , wxDouble ) {}
218 virtual void ResetClip() {}
219 virtual void * GetNativeContext() { return NULL; }
220 virtual int GetLogicalFunction() const { return 0; }
221 virtual bool SetLogicalFunction(int ) {}
222 virtual void Translate( wxDouble , wxDouble ) {}
223 virtual void Scale( wxDouble , wxDouble ) {}
224 virtual void Rotate( wxDouble ) {}
225 virtual void ConcatTransform( const wxGraphicsMatrix& ) {}
226 virtual void SetTransform( const wxGraphicsMatrix& ) {}
227 virtual wxGraphicsMatrix GetTransform() const { return wxNullGraphicsMatrix; }
229 virtual void SetPen( const wxGraphicsPen& ) {}
230 void SetPen( const wxPen& ) {}
232 virtual void SetBrush( const wxGraphicsBrush& ) {}
233 void SetBrush( const wxBrush& ) {}
235 virtual void SetFont( const wxGraphicsFont& ) {}
236 void SetFont( const wxFont&, const wxColour& ) {}
238 virtual void StrokePath( const wxGraphicsPath & ) {}
239 virtual void FillPath( const wxGraphicsPath &, int ) {}
240 virtual void DrawPath( const wxGraphicsPath &, int ) {}
242 virtual void DrawText( const wxString &, wxDouble , wxDouble ) {}
243 virtual void DrawText( const wxString &, wxDouble , wxDouble , wxDouble ) {}
244 virtual void DrawText( const wxString &, wxDouble , wxDouble , wxGraphicsBrush ) {}
245 virtual void DrawText( const wxString &, wxDouble , wxDouble , wxDouble , wxGraphicsBrush ) {}
246 virtual void GetTextExtent( const wxString &, wxDouble *, wxDouble *,
247 wxDouble *, wxDouble * ) const {}
248 virtual void GetPartialTextExtents(const wxString& , wxArrayDouble& ) const {}
250 virtual void DrawBitmap( const wxBitmap &, wxDouble , wxDouble , wxDouble , wxDouble ) {}
251 virtual void DrawIcon( const wxIcon &, wxDouble , wxDouble , wxDouble , wxDouble ) {}
253 virtual void StrokeLine( wxDouble , wxDouble , wxDouble , wxDouble ) {}
254 virtual void StrokeLines( size_t , const wxPoint2DDouble *) {}
255 virtual void StrokeLines( size_t , const wxPoint2DDouble *, const wxPoint2DDouble *) {}
256 virtual void DrawLines( size_t , const wxPoint2DDouble *, int ) {}
257 virtual void DrawRectangle( wxDouble , wxDouble , wxDouble , wxDouble ) {}
258 virtual void DrawRoundedRectangle( wxDouble , wxDouble , wxDouble , wxDouble , wxDouble ) {}
259 virtual void DrawEllipse( wxDouble , wxDouble , wxDouble , wxDouble ) {}
260 virtual void DrawRoundedRectangle( wxDouble wxDouble , wxDouble , wxDouble , wxDouble ) {}
261 virtual bool ShouldOffset() const { return false; }
265 class wxGraphicsRenderer : public wxObject
268 wxGraphicsRenderer() {
269 PyErr_SetString(PyExc_NotImplementedError,
270 "wx.GraphicsRenderer is not available on this platform.");
273 virtual ~wxGraphicsRenderer() {}
275 static wxGraphicsRenderer* GetDefaultRenderer() {
276 PyErr_SetString(PyExc_NotImplementedError,
277 "wx.GraphicsRenderer is not available on this platform.");
281 virtual wxGraphicsContext * CreateContext( const wxWindowDC& ) { return NULL; }
282 virtual wxGraphicsContext * CreateContextFromNativeContext( void * ) { return NULL; }
283 virtual wxGraphicsContext * CreateContextFromNativeWindow( void * ) { return NULL; }
284 virtual wxGraphicsContext * CreateContext( wxWindow* ) { return NULL; }
285 virtual wxGraphicsContext * CreateMeasuringContext() { return NULL; }
287 virtual wxGraphicsPath CreatePath() { return wxNullGraphicsPath; }
289 virtual wxGraphicsMatrix CreateMatrix( wxDouble , wxDouble , wxDouble , wxDouble ,
290 wxDouble , wxDouble ) { return wxNullGraphicsMatrix; }
292 virtual wxGraphicsPen CreatePen(const wxPen& ) { return wxNullGraphicsPen; }
293 virtual wxGraphicsBrush CreateBrush(const wxBrush& ) { return wxNullGraphicsBrush; }
294 virtual wxGraphicsBrush CreateLinearGradientBrush(wxDouble , wxDouble , wxDouble , wxDouble ,
295 const wxColour&, const wxColour&) { return wxNullGraphicsBrush; }
296 virtual wxGraphicsBrush CreateRadialGradientBrush(wxDouble , wxDouble , wxDouble , wxDouble , wxDouble ,
297 const wxColour &, const wxColour &) { return wxNullGraphicsBrush; }
298 virtual wxGraphicsFont CreateFont( const wxFont & , const wxColour & ) { return wxNullGraphicsFont; }
303 class wxGCDC: public wxWindowDC
306 wxGCDC(const wxWindowDC&) {
307 wxPyBlock_t blocked = wxPyBeginBlockThreads();
308 PyErr_SetString(PyExc_NotImplementedError,
309 "wxGCDC is not available on this platform.");
310 wxPyEndBlockThreads(blocked);
313 wxGCDC(const wxWindow*) {
314 wxPyBlock_t blocked = wxPyBeginBlockThreads();
315 PyErr_SetString(PyExc_NotImplementedError,
316 "wxGCDC is not available on this platform.");
317 wxPyEndBlockThreads(blocked);
321 wxPyBlock_t blocked = wxPyBeginBlockThreads();
322 PyErr_SetString(PyExc_NotImplementedError,
323 "wxGCDC is not available on this platform.");
324 wxPyEndBlockThreads(blocked);
329 wxGraphicsContext* GetGraphicsContext() { return NULL; }
330 void SetGraphicsContext( wxGraphicsContext* ) {}
336 //---------------------------------------------------------------------------
337 //---------------------------------------------------------------------------
340 %typemap(in) (size_t points, wxPoint2D* points_array ) {
341 $2 = wxPoint2D_LIST_helper($input, &$1);
342 if ($2 == NULL) SWIG_fail;
344 %typemap(freearg) (size_t points, wxPoint2D* points_array ) {
345 if ($2) delete [] $2;
350 MustHaveApp(wxGraphicsPath);
351 MustHaveApp(wxGraphicsContext);
354 typedef double wxDouble;
357 //---------------------------------------------------------------------------
360 DocStr(wxGraphicsObject,
361 "This class is the superclass of native graphics objects like pens
362 etc. It provides the internal reference counting. It is not to be
363 instantiated by user code.", "");
364 class wxGraphicsObject : public wxObject
367 wxGraphicsObject( wxGraphicsRenderer* renderer = NULL );
368 virtual ~wxGraphicsObject();
371 bool , IsNull() const ,
372 "Is this object valid (false) or still empty (true)?", "");
375 wxGraphicsRenderer* , GetRenderer() const,
376 "Returns the renderer that was used to create this instance, or
377 ``None`` if it has not been initialized yet.", "");
382 DocStr(wxGraphicsPen,
383 "A wx.GraphicsPen is a native representation of a pen. It is used for
384 stroking a path on a `wx.GraphicsContext`. The contents are specific and
385 private to the respective renderer. The only way to get a valid instance
386 is via a CreatePen call on the graphics context or the renderer
388 class wxGraphicsPen : public wxGraphicsObject
392 virtual ~wxGraphicsPen();
395 DocStr(wxGraphicsBrush,
396 "A wx.GraphicsBrush is a native representation of a brush. It is used
397 for filling a path on a `wx.GraphicsContext`. The contents are
398 specific and private to the respective renderer. The only way to get a
399 valid instance is via a Create...Brush call on the graphics context or
400 the renderer instance.", "");
401 class wxGraphicsBrush : public wxGraphicsObject
405 virtual ~wxGraphicsBrush();
409 DocStr(wxGraphicsFont,
410 "A `wx.GraphicsFont` is a native representation of a font (including
411 text colour). The contents are specific an private to the respective
412 renderer. The only way to get a valid instance is via a CreateFont
413 call on the graphics context or the renderer instance.", "");
414 class wxGraphicsFont : public wxGraphicsObject
418 virtual ~wxGraphicsFont();
422 //---------------------------------------------------------------------------
424 DocStr(wxGraphicsMatrix,
425 "A wx.GraphicsMatrix is a native representation of an affine
426 matrix. The contents are specific an private to the respective
427 renderer. The only way to get a valid instance is via a CreateMatrix
428 call on the graphics context or the renderer instance.", "");
429 class wxGraphicsMatrix : public wxGraphicsObject
433 virtual ~wxGraphicsMatrix();
436 virtual void , Concat( const wxGraphicsMatrix& t ),
437 "Concatenates the passed in matrix to the current matrix.", "");
441 // "Copy the passed in matrix to this one.", "");
442 // void Copy( const wxGraphicsMatrix& t ) {
449 virtual void , Set(wxDouble a=1.0, wxDouble b=0.0, wxDouble c=0.0, wxDouble d=1.0,
450 wxDouble tx=0.0, wxDouble ty=0.0),
451 "Sets the matrix to the specified values (default values are the
452 identity matrix.)", "");
456 virtual void , Get(wxDouble* OUTPUT, wxDouble* OUTPUT, wxDouble* OUTPUT,
457 wxDouble* OUTPUT, wxDouble* OUTPUT, wxDouble* OUTPUT),
458 "Get(self) --> (a, b, c, d, tx, ty)",
459 "Gets the component values of the matrix and returns them as a tuple.", "");
463 virtual void , Invert(),
464 "Inverts the matrix.", "");
468 virtual bool , IsEqual( const wxGraphicsMatrix& t) const,
469 "Returns ``True`` if the elements of the transformation matrix are equal", "");
473 virtual bool , IsIdentity() const,
474 "Returns ``True`` if this is the identity matrix", "");
478 virtual void , Translate( wxDouble dx , wxDouble dy ),
479 "Add a translation to this matrix.", "");
483 virtual void , Scale( wxDouble xScale , wxDouble yScale ),
484 "Scales this matrix.", "");
488 virtual void , Rotate( wxDouble angle ),
489 "Rotates this matrix. The angle should be specified in radians.", "");
493 virtual void , TransformPoint( wxDouble *INOUT, wxDouble *INOUT ) const,
494 "TransformPoint(self, x, y) --> (x, y)",
495 "Applies this matrix to a point, returns the resulting point values", "");
499 virtual void , TransformDistance( wxDouble *INOUT, wxDouble *INOUT ) const,
500 "TransformDistance(self, dx, dy) --> (dx, dy)",
501 "Applies this matrix to a distance (ie. performs all transforms except
506 virtual void * , GetNativeMatrix() const,
507 "Returns the native representation of the matrix. For CoreGraphics this
508 is a CFAffineMatrix pointer. For GDIPlus a Matrix Pointer and for
509 Cairo a cairo_matrix_t pointer. NOTE: For wxPython we still need a
510 way to make this value usable.", "");
513 //---------------------------------------------------------------------------
515 class wxGraphicsPath : public wxGraphicsObject
519 virtual ~wxGraphicsPath();
522 %nokwargs MoveToPoint;
524 "Begins a new subpath at the specified point.", "");
525 virtual void MoveToPoint( wxDouble x, wxDouble y );
526 void MoveToPoint( const wxPoint2D& p);
529 %nokwargs AddLineToPoint;
530 DocStr(AddLineToPoint,
531 "Adds a straight line from the current point to the specified point.", "");
532 virtual void AddLineToPoint( wxDouble x, wxDouble y );
533 void AddLineToPoint( const wxPoint2D& p);
536 %nokwargs AddCurveToPoint;
537 DocStr(AddCurveToPoint,
538 "Adds a cubic Bezier curve from the current point, using two control
539 points and an end point", "");
540 virtual void AddCurveToPoint( wxDouble cx1, wxDouble cy1,
541 wxDouble cx2, wxDouble cy2,
542 wxDouble x, wxDouble y );
543 void AddCurveToPoint( const wxPoint2D& c1, const wxPoint2D& c2, const wxPoint2D& e);
548 virtual void , AddPath( const wxGraphicsPath& path ),
549 "Adds another path", "");
553 virtual void , CloseSubpath(),
554 "Closes the current sub-path.", "");
558 wxPoint2D , GetCurrentPoint() const,
559 "Gets the last point of the current path, (0,0) if not yet set", "");
564 "Adds an arc of a circle centering at (x,y) with radius (r) from
565 startAngle to endAngle", "");
566 virtual void AddArc( wxDouble x, wxDouble y, wxDouble r,
567 wxDouble startAngle, wxDouble endAngle, bool clockwise );
568 void AddArc( const wxPoint2D& c, wxDouble r, wxDouble startAngle, wxDouble endAngle, bool clockwise);
572 virtual void , AddQuadCurveToPoint( wxDouble cx, wxDouble cy, wxDouble x, wxDouble y ),
573 "Adds a quadratic Bezier curve from the current point, using a control
574 point and an end point", "");
578 virtual void , AddRectangle( wxDouble x, wxDouble y, wxDouble w, wxDouble h ),
579 "Appends a rectangle as a new closed subpath.", "");
583 virtual void , AddCircle( wxDouble x, wxDouble y, wxDouble r ),
584 "Appends a circle around (x,y) with radius r as a new closed subpath.", "");
588 virtual void , AddArcToPoint( wxDouble x1, wxDouble y1 , wxDouble x2, wxDouble y2, wxDouble r ) ,
589 "Appends an arc to two tangents connecting (current) to (x1,y1) and (x1,y1)
590 to (x2,y2), also a straight line from (current) to (x1,y1)", "");
594 virtual void , AddEllipse( wxDouble x, wxDouble y, wxDouble w, wxDouble h),
595 "Appends an ellipse fitting into the passed in rectangle.", "");
599 virtual void , AddRoundedRectangle( wxDouble x, wxDouble y, wxDouble w, wxDouble h, wxDouble radius),
600 "Appends a rounded rectangle.", "");
604 virtual void * , GetNativePath() const,
605 "Returns the native path (CGPathRef for Core Graphics, Path pointer for
606 GDIPlus and a cairo_path_t pointer for cairo). NOTE: For wxPython we
607 still need a way to make this value usable.", "");
611 virtual void , UnGetNativePath(void *p) const,
612 "Gives back the native path returned by GetNativePath() because there
613 might be some deallocations necessary (eg on cairo the native path
614 returned by GetNativePath is newly allocated each time).", "");
618 virtual void , Transform( const wxGraphicsMatrix& matrix ),
619 "Transforms each point of this path by the matrix", "");
623 wxRect2DDouble , GetBox() const,
624 "Gets the bounding box enclosing all points (possibly including control points)", "");
629 "Returns ``True`` if the point is within the path.", "");
630 virtual bool Contains( wxDouble x, wxDouble y, int fillStyle = wxODDEVEN_RULE) const;
631 bool Contains( const wxPoint2DDouble& c, int fillStyle = wxODDEVEN_RULE) const;
636 //---------------------------------------------------------------------------
639 const wxGraphicsPen wxNullGraphicsPen;
640 const wxGraphicsBrush wxNullGraphicsBrush;
641 const wxGraphicsFont wxNullGraphicsFont;
642 const wxGraphicsMatrix wxNullGraphicsMatrix;
643 const wxGraphicsPath wxNullGraphicsPath;
646 //---------------------------------------------------------------------------
648 DocStr(wxGraphicsContext,
649 "A `wx.GraphicsContext` instance is the object that is drawn upon. It is
650 created by a renderer using the CreateContext calls, this can be done
651 either directly using a renderer instance, or indirectly using the
652 static convenience CreateXXX functions of wx.GraphicsContext that
653 always delegate the task to the default renderer.", "");
655 class wxGraphicsContext : public wxGraphicsObject
658 //wxGraphicsContext(); This is an ABC, use Create to make an instance...
659 virtual ~wxGraphicsContext();
664 "val.__dc = args[0] # save a ref so the dc will not be deleted before self";
666 "Creates a wx.GraphicsContext either from a window or a DC.", "");
667 static wxGraphicsContext* Create( const wxWindowDC& dc);
668 static wxGraphicsContext* Create( wxWindow* window ) ;
671 static wxGraphicsContext* , Create(),
672 "Create a lightwieght context that can be used for measuring text only.", "",
673 CreateMeasuringContext);
675 %newobject CreateFromNative;
677 static wxGraphicsContext* , CreateFromNative( void * context ) ,
678 "Creates a wx.GraphicsContext from a native context. This native context
679 must be eg a CGContextRef for Core Graphics, a Graphics pointer for
680 GDIPlus or a cairo_t pointer for Cairo.", "");
683 %newobject CreateFromNative;
685 static wxGraphicsContext* , CreateFromNativeWindow( void * window ) ,
686 "Creates a wx.GraphicsContext from a native window.", "");
691 virtual wxGraphicsPath , CreatePath(),
692 "Creates a native graphics path which is initially empty.", "");
696 virtual wxGraphicsPen , CreatePen(const wxPen& pen),
697 "Creates a native pen from a `wx.Pen`.", "");
701 virtual wxGraphicsBrush , CreateBrush(const wxBrush& brush ),
702 "Creates a native brush from a `wx.Brush`.", "");
706 virtual wxGraphicsBrush ,
707 CreateLinearGradientBrush( wxDouble x1, wxDouble y1, wxDouble x2, wxDouble y2,
708 const wxColour& c1, const wxColour& c2),
709 "Creates a native brush, having a linear gradient, starting at (x1,y1)
710 with color c1 to (x2,y2) with color c2.", "");
714 virtual wxGraphicsBrush ,
715 CreateRadialGradientBrush( wxDouble xo, wxDouble yo, wxDouble xc, wxDouble yc, wxDouble radius,
716 const wxColour &oColor, const wxColour &cColor),
717 "Creates a native brush, having a radial gradient originating at
718 point (xo,yc) with color oColour and ends on a circle around (xc,yc) with
719 radius r and color cColour.", "");
723 virtual wxGraphicsFont , CreateFont( const wxFont &font , const wxColour &col = *wxBLACK ),
724 "Creates a native graphics font from a `wx.Font` and a text colour.", "");
728 virtual wxGraphicsMatrix , CreateMatrix( wxDouble a=1.0, wxDouble b=0.0,
729 wxDouble c=0.0, wxDouble d=1.0,
730 wxDouble tx=0.0, wxDouble ty=0.0),
731 "Creates a native affine transformation matrix from the passed in
732 values. The defaults result in an identity matrix.", "");
737 virtual void , PushState(),
738 "push the current state of the context, ie the transformation matrix on a stack", "");
742 virtual void , PopState(),
743 "pops a stored state from the stack", "");
747 virtual void , Clip( const wxRegion ®ion ),
748 "Clips drawings to the region, combined to current clipping region.", "",
753 virtual void , Clip( wxDouble x, wxDouble y, wxDouble w, wxDouble h ),
754 "Clips drawings to the rectangle.", "");
758 virtual void , ResetClip(),
759 "Resets the clipping to original shape.", "");
763 virtual void * , GetNativeContext(),
764 "Returns the native context (CGContextRef for Core Graphics, Graphics
765 pointer for GDIPlus and cairo_t pointer for cairo).", "");
769 virtual int , GetLogicalFunction() const,
770 "Returns the current logical function.", "");
774 virtual bool , SetLogicalFunction(int function) ,
775 "Sets the current logical function, returns ``True`` if it supported", "");
779 virtual void , Translate( wxDouble dx , wxDouble dy ),
780 "Translates the current transformation matrix.", "");
784 virtual void , Scale( wxDouble xScale , wxDouble yScale ),
785 "Scale the current transformation matrix of the context.", "");
789 virtual void , Rotate( wxDouble angle ),
790 "Rotate the current transformation matrix of the context. ``angle`` is
791 specified in radians.", "");
795 virtual void , ConcatTransform( const wxGraphicsMatrix& matrix ),
796 "Concatenates the passed in transform with the current transform of
801 virtual void , SetTransform( const wxGraphicsMatrix& matrix ),
802 "Sets the current transform of this context.", "");
806 virtual wxGraphicsMatrix , GetTransform() const,
807 "Gets the current transformation matrix of this context.", "");
812 DocStr(SetPen, "Sets the stroke pen", "");
814 virtual void SetPen( const wxGraphicsPen& pen );
815 void SetPen( const wxPen& pen );
818 DocStr(SetBrush, "Sets the brush for filling", "");
820 virtual void SetBrush( const wxGraphicsBrush& brush );
821 void SetBrush( const wxBrush& brush );
824 DocStr(SetFont, "Sets the font", "");
826 virtual void SetFont( const wxGraphicsFont& font );
827 void SetFont( const wxFont& font, const wxColour& colour = *wxBLACK);
832 virtual void , StrokePath( const wxGraphicsPath& path ),
833 "Strokes along a path with the current pen.", "");
837 virtual void , FillPath( const wxGraphicsPath& path, int fillStyle = wxODDEVEN_RULE ),
838 "Fills a path with the current brush.", "");
842 virtual void , DrawPath( const wxGraphicsPath& path, int fillStyle = wxODDEVEN_RULE ),
843 "Draws the path by first filling and then stroking.", "");
848 "Draws a text string at the defined position.", "");
849 void DrawText( const wxString &str, wxDouble x, wxDouble y,
850 const wxGraphicsBrush& backgroundBrush = wxNullGraphicsBrush )
852 if ( !backgroundBrush.IsNull() )
853 self->DrawText(str, x, y, backgroundBrush);
855 self->DrawText(str, x, y);
858 DocStr(DrawRotatedText,
859 "Draws a text string at the defined position, at the specified angle,
860 which is given in radians.", "");
861 void DrawRotatedText( const wxString &str, wxDouble x, wxDouble y, wxDouble angle,
862 const wxGraphicsBrush& backgroundBrush = wxNullGraphicsBrush )
864 if ( !backgroundBrush.IsNull() )
865 self->DrawText(str, x, y, angle, backgroundBrush);
867 self->DrawText(str, x, y, angle);
874 virtual void , GetTextExtent( const wxString &text,
875 wxDouble *OUTPUT /*width*/,
876 wxDouble *OUTPUT /*height*/,
877 wxDouble *OUTPUT /*descent*/,
878 wxDouble *OUTPUT /*externalLeading*/ ) const ,
879 "GetFullTextExtent(self, text) --> (width, height, descent, externalLeading)",
880 "Gets the dimensions of the string using the currently selected
881 font. ``text`` is the string to measure, ``w`` and ``h`` are the total
882 width and height respectively, ``descent`` is the dimension from the
883 baseline of the font to the bottom of the descender, and
884 ``externalLeading`` is any extra vertical space added to the font by
885 the font designer (usually is zero).", "",
889 DocAStr(GetTextExtent,
890 "GetTextExtent(self, text) --> (width, height)",
891 "Gets the dimensions of the string using the currently selected
892 font. ``text`` is the string to measure, ``w`` and ``h`` are the total
893 width and height respectively.", "");
895 PyObject* GetTextExtent( const wxString &text )
897 wxDouble width = 0.0,
899 self->GetTextExtent(text, &width, &height, NULL, NULL);
900 // thread wrapers are turned off for this .i file, so no need to acquire GIL...
901 PyObject* rv = PyTuple_New(2);
902 PyTuple_SET_ITEM(rv, 0, PyFloat_FromDouble(width));
903 PyTuple_SET_ITEM(rv, 1, PyFloat_FromDouble(height));
910 DocAStr(GetPartialTextExtents,
911 "GetPartialTextExtents(self, text) -> [widths]",
912 "Returns a list of widths from the beginning of ``text`` to the
913 coresponding character in ``text``.", "");
914 wxArrayDouble GetPartialTextExtents(const wxString& text) {
915 wxArrayDouble widths;
916 self->GetPartialTextExtents(text, widths);
923 virtual void , DrawBitmap( const wxBitmap &bmp, wxDouble x, wxDouble y, wxDouble w, wxDouble h ),
924 "Draws the bitmap. In case of a mono bitmap, this is treated as a mask
925 and the current brush is used for filling.", "");
929 virtual void , DrawIcon( const wxIcon &icon, wxDouble x, wxDouble y, wxDouble w, wxDouble h ),
930 "Draws the icon.", "");
935 virtual void , StrokeLine( wxDouble x1, wxDouble y1, wxDouble x2, wxDouble y2),
936 "Strokes a single line.", "");
940 virtual void , StrokeLines( size_t points, const wxPoint2D *points_array),
941 "StrokeLines(self, List points)",
942 "Stroke lines connecting each of the points", "");
946 DocStr(StrokeLineSegements,
947 "Stroke disconnected lines from begin to end points", "");
948 void StrokeLineSegements(PyObject* beginPoints, PyObject* endPoints)
950 size_t c1, c2, count;
951 wxPoint2D* beginP = wxPoint2D_LIST_helper(beginPoints, &c1);
952 wxPoint2D* endP = wxPoint2D_LIST_helper(endPoints, &c2);
954 if ( beginP != NULL && endP != NULL )
956 count = wxMin(c1, c2);
957 self->StrokeLines(count, beginP, endP);
966 virtual void , DrawLines( size_t points, const wxPoint2D *points_array,
967 int fillStyle = wxODDEVEN_RULE ),
968 "Draws a polygon.", "");
972 virtual void , DrawRectangle( wxDouble x, wxDouble y, wxDouble w, wxDouble h),
973 "Draws a rectangle.", "");
977 virtual void , DrawEllipse( wxDouble x, wxDouble y, wxDouble w, wxDouble h),
978 "Draws an ellipse.", "");
982 virtual void , DrawRoundedRectangle( wxDouble x, wxDouble y, wxDouble w, wxDouble h, wxDouble radius),
983 "Draws a rounded rectangle", "");
988 virtual bool , ShouldOffset() const,
989 "helper to determine if a 0.5 offset should be applied for the drawing operation", "");
994 //---------------------------------------------------------------------------
996 class wxGraphicsRenderer : public wxObject
999 // wxGraphicsRenderer(); This is an ABC, use GetDefaultRenderer
1001 virtual ~wxGraphicsRenderer();
1003 // %newobject GetDefaultRenderer; ???
1004 static wxGraphicsRenderer* GetDefaultRenderer();
1006 %nokwargs CreateContext;
1007 %newobject CreateContext;
1008 virtual wxGraphicsContext * CreateContext( const wxWindowDC& dc) ;
1009 virtual wxGraphicsContext * CreateContext( wxWindow* window );
1011 // create a context that can be used for measuring texts only, no drawing allowed
1012 virtual wxGraphicsContext * CreateMeasuringContext();
1014 %newobject CreateContextFromNativeContext;
1015 virtual wxGraphicsContext * CreateContextFromNativeContext( void * context );
1017 %newobject CreateContextFromNativeWindow;
1018 virtual wxGraphicsContext * CreateContextFromNativeWindow( void * window );
1021 virtual wxGraphicsPath CreatePath();
1023 virtual wxGraphicsMatrix CreateMatrix( wxDouble a=1.0, wxDouble b=0.0, wxDouble c=0.0, wxDouble d=1.0,
1024 wxDouble tx=0.0, wxDouble ty=0.0);
1026 virtual wxGraphicsPen CreatePen(const wxPen& pen) ;
1028 virtual wxGraphicsBrush CreateBrush(const wxBrush& brush ) ;
1030 virtual wxGraphicsBrush CreateLinearGradientBrush( wxDouble x1, wxDouble y1, wxDouble x2, wxDouble y2,
1031 const wxColour&c1, const wxColour&c2);
1033 virtual wxGraphicsBrush CreateRadialGradientBrush( wxDouble xo, wxDouble yo, wxDouble xc, wxDouble yc, wxDouble radius,
1034 const wxColour &oColor, const wxColour &cColor);
1036 virtual wxGraphicsFont CreateFont( const wxFont &font , const wxColour &col = *wxBLACK );
1042 //---------------------------------------------------------------------------
1045 #include "wx/dcgraph.h"
1048 class wxGCDC: public wxDC
1052 %pythonAppend wxGCDC
1053 "self.__dc = args[0] # save a ref so the other dc will not be deleted before self";
1054 wxGCDC(const wxWindowDC& dc);
1055 wxGCDC(wxWindow* window);
1059 wxGraphicsContext* GetGraphicsContext();
1060 virtual void SetGraphicsContext( wxGraphicsContext* ctx );
1062 %property(GraphicsContext, GetGraphicsContext, SetGraphicsContext);
1066 //---------------------------------------------------------------------------
1068 // Turn GIL acquisition back on.