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 DrawEllipse( wxDouble , wxDouble , wxDouble , wxDouble ) {}
259 virtual void DrawRoundedRectangle( wxDouble , wxDouble , wxDouble , wxDouble , wxDouble ) {}
260 virtual bool ShouldOffset() const { return false; }
264 class wxGraphicsRenderer : public wxObject
267 wxGraphicsRenderer() {
268 PyErr_SetString(PyExc_NotImplementedError,
269 "wx.GraphicsRenderer is not available on this platform.");
272 virtual ~wxGraphicsRenderer() {}
274 static wxGraphicsRenderer* GetDefaultRenderer() {
275 PyErr_SetString(PyExc_NotImplementedError,
276 "wx.GraphicsRenderer is not available on this platform.");
280 virtual wxGraphicsContext * CreateContext( const wxWindowDC& ) { return NULL; }
281 virtual wxGraphicsContext * CreateContextFromNativeContext( void * ) { return NULL; }
282 virtual wxGraphicsContext * CreateContextFromNativeWindow( void * ) { return NULL; }
283 virtual wxGraphicsContext * CreateContext( wxWindow* ) { return NULL; }
284 virtual wxGraphicsContext * CreateMeasuringContext() { return NULL; }
286 virtual wxGraphicsPath CreatePath() { return wxNullGraphicsPath; }
288 virtual wxGraphicsMatrix CreateMatrix( wxDouble , wxDouble , wxDouble , wxDouble ,
289 wxDouble , wxDouble ) { return wxNullGraphicsMatrix; }
291 virtual wxGraphicsPen CreatePen(const wxPen& ) { return wxNullGraphicsPen; }
292 virtual wxGraphicsBrush CreateBrush(const wxBrush& ) { return wxNullGraphicsBrush; }
293 virtual wxGraphicsBrush CreateLinearGradientBrush(wxDouble , wxDouble , wxDouble , wxDouble ,
294 const wxColour&, const wxColour&) { return wxNullGraphicsBrush; }
295 virtual wxGraphicsBrush CreateRadialGradientBrush(wxDouble , wxDouble , wxDouble , wxDouble , wxDouble ,
296 const wxColour &, const wxColour &) { return wxNullGraphicsBrush; }
297 virtual wxGraphicsFont CreateFont( const wxFont & , const wxColour & ) { return wxNullGraphicsFont; }
302 class wxGCDC: public wxWindowDC
305 wxGCDC(const wxWindowDC&) {
306 wxPyBlock_t blocked = wxPyBeginBlockThreads();
307 PyErr_SetString(PyExc_NotImplementedError,
308 "wxGCDC is not available on this platform.");
309 wxPyEndBlockThreads(blocked);
312 wxGCDC(const wxWindow*) {
313 wxPyBlock_t blocked = wxPyBeginBlockThreads();
314 PyErr_SetString(PyExc_NotImplementedError,
315 "wxGCDC is not available on this platform.");
316 wxPyEndBlockThreads(blocked);
320 wxPyBlock_t blocked = wxPyBeginBlockThreads();
321 PyErr_SetString(PyExc_NotImplementedError,
322 "wxGCDC is not available on this platform.");
323 wxPyEndBlockThreads(blocked);
328 wxGraphicsContext* GetGraphicsContext() { return NULL; }
329 void SetGraphicsContext( wxGraphicsContext* ) {}
335 //---------------------------------------------------------------------------
336 //---------------------------------------------------------------------------
339 %typemap(in) (size_t points, wxPoint2D* points_array ) {
340 $2 = wxPoint2D_LIST_helper($input, &$1);
341 if ($2 == NULL) SWIG_fail;
343 %typemap(freearg) (size_t points, wxPoint2D* points_array ) {
344 if ($2) delete [] $2;
349 MustHaveApp(wxGraphicsPath);
350 MustHaveApp(wxGraphicsContext);
353 //---------------------------------------------------------------------------
356 DocStr(wxGraphicsObject,
357 "This class is the superclass of native graphics objects like pens
358 etc. It provides the internal reference counting. It is not to be
359 instantiated by user code.", "");
360 class wxGraphicsObject : public wxObject
363 wxGraphicsObject( wxGraphicsRenderer* renderer = NULL );
364 virtual ~wxGraphicsObject();
367 bool , IsNull() const ,
368 "Is this object valid (false) or still empty (true)?", "");
371 wxGraphicsRenderer* , GetRenderer() const,
372 "Returns the renderer that was used to create this instance, or
373 ``None`` if it has not been initialized yet.", "");
378 DocStr(wxGraphicsPen,
379 "A wx.GraphicsPen is a native representation of a pen. It is used for
380 stroking a path on a `wx.GraphicsContext`. The contents are specific and
381 private to the respective renderer. The only way to get a valid instance
382 is via a CreatePen call on the graphics context or the renderer
384 class wxGraphicsPen : public wxGraphicsObject
388 virtual ~wxGraphicsPen();
391 DocStr(wxGraphicsBrush,
392 "A wx.GraphicsBrush is a native representation of a brush. It is used
393 for filling a path on a `wx.GraphicsContext`. The contents are
394 specific and private to the respective renderer. The only way to get a
395 valid instance is via a Create...Brush call on the graphics context or
396 the renderer instance.", "");
397 class wxGraphicsBrush : public wxGraphicsObject
401 virtual ~wxGraphicsBrush();
405 DocStr(wxGraphicsFont,
406 "A `wx.GraphicsFont` is a native representation of a font (including
407 text colour). The contents are specific an private to the respective
408 renderer. The only way to get a valid instance is via a CreateFont
409 call on the graphics context or the renderer instance.", "");
410 class wxGraphicsFont : public wxGraphicsObject
414 virtual ~wxGraphicsFont();
418 //---------------------------------------------------------------------------
420 DocStr(wxGraphicsMatrix,
421 "A wx.GraphicsMatrix is a native representation of an affine
422 matrix. The contents are specific and private to the respective
423 renderer. The only way to get a valid instance is via a CreateMatrix
424 call on the graphics context or the renderer instance.", "");
425 class wxGraphicsMatrix : public wxGraphicsObject
428 // wxGraphicsMatrix();
429 virtual ~wxGraphicsMatrix();
432 virtual void , Concat( const wxGraphicsMatrix& t ),
433 "Concatenates the passed in matrix to the current matrix.", "");
437 virtual void , Set(wxDouble a=1.0, wxDouble b=0.0, wxDouble c=0.0, wxDouble d=1.0,
438 wxDouble tx=0.0, wxDouble ty=0.0),
439 "Sets the matrix to the specified values (default values are the
440 identity matrix.)", "");
444 virtual void , Get(wxDouble* OUTPUT, wxDouble* OUTPUT, wxDouble* OUTPUT,
445 wxDouble* OUTPUT, wxDouble* OUTPUT, wxDouble* OUTPUT),
446 "Get(self) --> (a, b, c, d, tx, ty)",
447 "Gets the component values of the matrix and returns them as a tuple.", "");
451 virtual void , Invert(),
452 "Inverts the matrix.", "");
456 virtual bool , IsEqual( const wxGraphicsMatrix& t) const,
457 "Returns ``True`` if the elements of the transformation matrix are
462 virtual bool , IsIdentity() const,
463 "Returns ``True`` if this is the identity matrix", "");
467 virtual void , Translate( wxDouble dx , wxDouble dy ),
468 "Add a translation to this matrix.", "");
472 virtual void , Scale( wxDouble xScale , wxDouble yScale ),
473 "Scales this matrix.", "");
477 virtual void , Rotate( wxDouble angle ),
478 "Rotates this matrix. The angle should be specified in radians.", "");
482 virtual void , TransformPoint( wxDouble *INOUT, wxDouble *INOUT ) const,
483 "TransformPoint(self, x, y) --> (x, y)",
484 "Applies this matrix to a point, returns the resulting point values", "");
488 virtual void , TransformDistance( wxDouble *INOUT, wxDouble *INOUT ) const,
489 "TransformDistance(self, dx, dy) --> (dx, dy)",
490 "Applies this matrix to a distance (ie. performs all transforms except
495 virtual void * , GetNativeMatrix() const,
496 "Returns the native representation of the matrix. For CoreGraphics this
497 is a CFAffineMatrix pointer. For GDIPlus a Matrix Pointer and for
498 Cairo a cairo_matrix_t pointer. NOTE: For wxPython we still need a
499 way to make this value usable.", "");
502 //---------------------------------------------------------------------------
504 class wxGraphicsPath : public wxGraphicsObject
508 virtual ~wxGraphicsPath();
511 %nokwargs MoveToPoint;
513 "Begins a new subpath at the specified point.", "");
514 virtual void MoveToPoint( wxDouble x, wxDouble y );
515 void MoveToPoint( const wxPoint2D& p);
518 %nokwargs AddLineToPoint;
519 DocStr(AddLineToPoint,
520 "Adds a straight line from the current point to the specified point.", "");
521 virtual void AddLineToPoint( wxDouble x, wxDouble y );
522 void AddLineToPoint( const wxPoint2D& p);
525 %nokwargs AddCurveToPoint;
526 DocStr(AddCurveToPoint,
527 "Adds a cubic Bezier curve from the current point, using two control
528 points and an end point", "");
529 virtual void AddCurveToPoint( wxDouble cx1, wxDouble cy1,
530 wxDouble cx2, wxDouble cy2,
531 wxDouble x, wxDouble y );
532 void AddCurveToPoint( const wxPoint2D& c1, const wxPoint2D& c2, const wxPoint2D& e);
537 virtual void , AddPath( const wxGraphicsPath& path ),
538 "Adds another path", "");
542 virtual void , CloseSubpath(),
543 "Closes the current sub-path.", "");
547 wxPoint2D , GetCurrentPoint() const,
548 "Gets the last point of the current path, (0,0) if not yet set", "");
553 "Adds an arc of a circle centering at (x,y) with radius (r) from
554 startAngle to endAngle", "");
555 virtual void AddArc( wxDouble x, wxDouble y, wxDouble r,
556 wxDouble startAngle, wxDouble endAngle, bool clockwise=true );
557 void AddArc( const wxPoint2D& c, wxDouble r, wxDouble startAngle, wxDouble endAngle, bool clockwise=true);
561 virtual void , AddQuadCurveToPoint( wxDouble cx, wxDouble cy, wxDouble x, wxDouble y ),
562 "Adds a quadratic Bezier curve from the current point, using a control
563 point and an end point", "");
567 virtual void , AddRectangle( wxDouble x, wxDouble y, wxDouble w, wxDouble h ),
568 "Appends a rectangle as a new closed subpath.", "");
572 virtual void , AddCircle( wxDouble x, wxDouble y, wxDouble r ),
573 "Appends a circle around (x,y) with radius r as a new closed subpath.", "");
577 virtual void , AddArcToPoint( wxDouble x1, wxDouble y1 , wxDouble x2, wxDouble y2, wxDouble r ) ,
578 "Appends an arc to two tangents connecting (current) to (x1,y1) and
579 (x1,y1) to (x2,y2), also a straight line from (current) to (x1,y1)", "");
583 virtual void , AddEllipse( wxDouble x, wxDouble y, wxDouble w, wxDouble h),
584 "Appends an ellipse fitting into the passed in rectangle.", "");
588 virtual void , AddRoundedRectangle( wxDouble x, wxDouble y, wxDouble w, wxDouble h, wxDouble radius),
589 "Appends a rounded rectangle.", "");
593 virtual void * , GetNativePath() const,
594 "Returns the native path (CGPathRef for Core Graphics, Path pointer for
595 GDIPlus and a cairo_path_t pointer for cairo). NOTE: For wxPython we
596 still need a way to make this value usable.", "");
600 virtual void , UnGetNativePath(void *p) const,
601 "Gives back the native path returned by GetNativePath() because there
602 might be some deallocations necessary (eg on cairo the native path
603 returned by GetNativePath is newly allocated each time).", "");
607 virtual void , Transform( const wxGraphicsMatrix& matrix ),
608 "Transforms each point of this path by the matrix", "");
612 wxRect2D , GetBox() const,
613 "Gets the bounding box enclosing all points (possibly including control
619 "Returns ``True`` if the point is within the path.", "");
620 virtual bool Contains( wxDouble x, wxDouble y, int fillStyle = wxODDEVEN_RULE) const;
621 bool Contains( const wxPoint2D& c, int fillStyle = wxODDEVEN_RULE) const;
626 //---------------------------------------------------------------------------
629 const wxGraphicsPen wxNullGraphicsPen;
630 const wxGraphicsBrush wxNullGraphicsBrush;
631 const wxGraphicsFont wxNullGraphicsFont;
632 const wxGraphicsMatrix wxNullGraphicsMatrix;
633 const wxGraphicsPath wxNullGraphicsPath;
636 //---------------------------------------------------------------------------
638 DocStr(wxGraphicsContext,
639 "A `wx.GraphicsContext` instance is the object that is drawn upon. It is
640 created by a renderer using the CreateContext calls, this can be done
641 either directly using a renderer instance, or indirectly using the
642 static convenience CreateXXX functions of wx.GraphicsContext that
643 always delegate the task to the default renderer.", "");
645 class wxGraphicsContext : public wxGraphicsObject
648 //wxGraphicsContext(); This is an ABC, use Create to make an instance...
649 virtual ~wxGraphicsContext();
654 "val.__dc = args[0] # save a ref so the dc will not be deleted before self";
656 "Creates a wx.GraphicsContext either from a window or a DC.", "");
657 static wxGraphicsContext* Create( const wxWindowDC& dc);
658 static wxGraphicsContext* Create( wxWindow* window ) ;
661 static wxGraphicsContext* , Create(),
662 "Create a lightwieght context that can be used for measuring text only.", "",
663 CreateMeasuringContext);
665 %newobject CreateFromNative;
667 static wxGraphicsContext* , CreateFromNative( void * context ) ,
668 "Creates a wx.GraphicsContext from a native context. This native
669 context must be eg a CGContextRef for Core Graphics, a Graphics
670 pointer for GDIPlus or a cairo_t pointer for Cairo. NOTE: For
671 wxPython we still need a way to make this value usable.", "");
674 %newobject CreateFromNative;
676 static wxGraphicsContext* , CreateFromNativeWindow( void * window ) ,
677 "Creates a wx.GraphicsContext from a native window. NOTE: For wxPython
678 we still need a way to make this value usable.", "");
683 virtual wxGraphicsPath , CreatePath(),
684 "Creates a native graphics path which is initially empty.", "");
688 virtual wxGraphicsPen , CreatePen(const wxPen& pen),
689 "Creates a native pen from a `wx.Pen`.", "");
693 virtual wxGraphicsBrush , CreateBrush(const wxBrush& brush ),
694 "Creates a native brush from a `wx.Brush`.", "");
698 virtual wxGraphicsBrush ,
699 CreateLinearGradientBrush( wxDouble x1, wxDouble y1, wxDouble x2, wxDouble y2,
700 const wxColour& c1, const wxColour& c2),
701 "Creates a native brush, having a linear gradient, starting at (x1,y1)
702 with color c1 to (x2,y2) with color c2.", "");
706 virtual wxGraphicsBrush ,
707 CreateRadialGradientBrush( wxDouble xo, wxDouble yo, wxDouble xc, wxDouble yc, wxDouble radius,
708 const wxColour &oColor, const wxColour &cColor),
709 "Creates a native brush, having a radial gradient originating at point
710 (xo,yc) with color oColour and ends on a circle around (xc,yc) with
711 radius r and color cColour.", "");
715 virtual wxGraphicsFont , CreateFont( const wxFont &font , const wxColour &col = *wxBLACK ),
716 "Creates a native graphics font from a `wx.Font` and a text colour.", "");
720 virtual wxGraphicsMatrix , CreateMatrix( wxDouble a=1.0, wxDouble b=0.0,
721 wxDouble c=0.0, wxDouble d=1.0,
722 wxDouble tx=0.0, wxDouble ty=0.0),
723 "Creates a native affine transformation matrix from the passed in
724 values. The defaults result in an identity matrix.", "");
729 virtual void , PushState(),
730 "Push the current state of the context, (ie the transformation matrix)
735 virtual void , PopState(),
736 "Pops a stored state from the stack", "");
740 virtual void , Clip( const wxRegion ®ion ),
741 "Clips drawings to the region, combined to current clipping region.", "",
746 virtual void , Clip( wxDouble x, wxDouble y, wxDouble w, wxDouble h ),
747 "Clips drawings to the rectangle.", "");
751 virtual void , ResetClip(),
752 "Resets the clipping to original shape.", "");
756 virtual void * , GetNativeContext(),
757 "Returns the native context (CGContextRef for Core Graphics, Graphics
758 pointer for GDIPlus and cairo_t pointer for cairo).", "");
762 virtual int , GetLogicalFunction() const,
763 "Returns the current logical function.", "");
767 virtual bool , SetLogicalFunction(int function) ,
768 "Sets the current logical function, returns ``True`` if it supported", "");
772 virtual void , Translate( wxDouble dx , wxDouble dy ),
773 "Translates the current transformation matrix.", "");
777 virtual void , Scale( wxDouble xScale , wxDouble yScale ),
778 "Scale the current transformation matrix of the context.", "");
782 virtual void , Rotate( wxDouble angle ),
783 "Rotate the current transformation matrix of the context. ``angle`` is
784 specified in radians.", "");
788 virtual void , ConcatTransform( const wxGraphicsMatrix& matrix ),
789 "Concatenates the passed in transform with the current transform of
794 virtual void , SetTransform( const wxGraphicsMatrix& matrix ),
795 "Sets the current transform of this context.", "");
799 virtual wxGraphicsMatrix , GetTransform() const,
800 "Gets the current transformation matrix of this context.", "");
804 DocStr(SetPen, "Sets the stroke pen", "");
806 virtual void SetPen( const wxGraphicsPen& pen );
807 void SetPen( const wxPen& pen );
810 DocStr(SetBrush, "Sets the brush for filling", "");
812 virtual void SetBrush( const wxGraphicsBrush& brush );
813 void SetBrush( const wxBrush& brush );
816 DocStr(SetFont, "Sets the font", "");
818 virtual void SetFont( const wxGraphicsFont& font );
819 void SetFont( const wxFont& font, const wxColour& colour = *wxBLACK);
824 virtual void , StrokePath( const wxGraphicsPath& path ),
825 "Strokes along a path with the current pen.", "");
829 virtual void , FillPath( const wxGraphicsPath& path, int fillStyle = wxODDEVEN_RULE ),
830 "Fills a path with the current brush.", "");
834 virtual void , DrawPath( const wxGraphicsPath& path, int fillStyle = wxODDEVEN_RULE ),
835 "Draws the path by first filling and then stroking.", "");
840 "Draws a text string at the defined position.", "");
841 void DrawText( const wxString &str, wxDouble x, wxDouble y,
842 const wxGraphicsBrush& backgroundBrush = wxNullGraphicsBrush )
844 if ( !backgroundBrush.IsNull() )
845 self->DrawText(str, x, y, backgroundBrush);
847 self->DrawText(str, x, y);
850 DocStr(DrawRotatedText,
851 "Draws a text string at the defined position, at the specified angle,
852 which is given in radians.", "");
853 void DrawRotatedText( const wxString &str, wxDouble x, wxDouble y, wxDouble angle,
854 const wxGraphicsBrush& backgroundBrush = wxNullGraphicsBrush )
856 if ( !backgroundBrush.IsNull() )
857 self->DrawText(str, x, y, angle, backgroundBrush);
859 self->DrawText(str, x, y, angle);
866 virtual void , GetTextExtent( const wxString &text,
867 wxDouble *OUTPUT /*width*/,
868 wxDouble *OUTPUT /*height*/,
869 wxDouble *OUTPUT /*descent*/,
870 wxDouble *OUTPUT /*externalLeading*/ ) const ,
871 "GetFullTextExtent(self, text) --> (width, height, descent, externalLeading)",
872 "Gets the dimensions of the string using the currently selected
873 font. ``text`` is the string to measure, ``w`` and ``h`` are the total
874 width and height respectively, ``descent`` is the dimension from the
875 baseline of the font to the bottom of the descender, and
876 ``externalLeading`` is any extra vertical space added to the font by
877 the font designer (usually is zero).", "",
881 DocAStr(GetTextExtent,
882 "GetTextExtent(self, text) --> (width, height)",
883 "Gets the dimensions of the string using the currently selected
884 font. ``text`` is the string to measure, ``w`` and ``h`` are the total
885 width and height respectively.", "");
887 PyObject* GetTextExtent( const wxString &text )
889 wxDouble width = 0.0,
891 self->GetTextExtent(text, &width, &height, NULL, NULL);
892 // thread wrapers are turned off for this .i file, so no need to acquire GIL...
893 PyObject* rv = PyTuple_New(2);
894 PyTuple_SET_ITEM(rv, 0, PyFloat_FromDouble(width));
895 PyTuple_SET_ITEM(rv, 1, PyFloat_FromDouble(height));
902 DocAStr(GetPartialTextExtents,
903 "GetPartialTextExtents(self, text) -> [widths]",
904 "Returns a list of widths from the beginning of ``text`` to the
905 coresponding character in ``text``.", "");
906 wxArrayDouble GetPartialTextExtents(const wxString& text) {
907 wxArrayDouble widths;
908 self->GetPartialTextExtents(text, widths);
915 virtual void , DrawBitmap( const wxBitmap &bmp, wxDouble x, wxDouble y, wxDouble w, wxDouble h ),
916 "Draws the bitmap. In case of a mono bitmap, this is treated as a mask
917 and the current brush is used for filling.", "");
921 virtual void , DrawIcon( const wxIcon &icon, wxDouble x, wxDouble y, wxDouble w, wxDouble h ),
922 "Draws the icon.", "");
927 virtual void , StrokeLine( wxDouble x1, wxDouble y1, wxDouble x2, wxDouble y2),
928 "Strokes a single line.", "");
932 virtual void , StrokeLines( size_t points, const wxPoint2D *points_array),
933 "StrokeLines(self, List points)",
934 "Stroke lines connecting each of the points", "");
938 DocAStr(StrokeLineSegements,
939 "StrokeLineSegments(self, List beginPoints, List endPoints)",
940 "Stroke disconnected lines from begin to end points", "");
941 void StrokeLineSegements(PyObject* beginPoints, PyObject* endPoints)
943 size_t c1, c2, count;
944 wxPoint2D* beginP = wxPoint2D_LIST_helper(beginPoints, &c1);
945 wxPoint2D* endP = wxPoint2D_LIST_helper(endPoints, &c2);
947 if ( beginP != NULL && endP != NULL )
949 count = wxMin(c1, c2);
950 self->StrokeLines(count, beginP, endP);
959 virtual void , DrawLines( size_t points, const wxPoint2D *points_array,
960 int fillStyle = wxODDEVEN_RULE ),
961 "Draws a polygon.", "");
965 virtual void , DrawRectangle( wxDouble x, wxDouble y, wxDouble w, wxDouble h),
966 "Draws a rectangle.", "");
970 virtual void , DrawEllipse( wxDouble x, wxDouble y, wxDouble w, wxDouble h),
971 "Draws an ellipse.", "");
975 virtual void , DrawRoundedRectangle( wxDouble x, wxDouble y, wxDouble w, wxDouble h, wxDouble radius),
976 "Draws a rounded rectangle", "");
981 virtual bool , ShouldOffset() const,
982 "helper to determine if a 0.5 offset should be applied for the drawing operation", "");
987 //---------------------------------------------------------------------------
989 class wxGraphicsRenderer : public wxObject
992 // wxGraphicsRenderer(); This is an ABC, use GetDefaultRenderer
994 virtual ~wxGraphicsRenderer();
996 // %newobject GetDefaultRenderer; ???
997 static wxGraphicsRenderer* GetDefaultRenderer();
999 %nokwargs CreateContext;
1000 %newobject CreateContext;
1001 virtual wxGraphicsContext * CreateContext( const wxWindowDC& dc) ;
1002 virtual wxGraphicsContext * CreateContext( wxWindow* window );
1004 // create a context that can be used for measuring texts only, no drawing allowed
1005 virtual wxGraphicsContext * CreateMeasuringContext();
1007 %newobject CreateContextFromNativeContext;
1008 virtual wxGraphicsContext * CreateContextFromNativeContext( void * context );
1010 %newobject CreateContextFromNativeWindow;
1011 virtual wxGraphicsContext * CreateContextFromNativeWindow( void * window );
1014 virtual wxGraphicsPath CreatePath();
1016 virtual wxGraphicsMatrix CreateMatrix( wxDouble a=1.0, wxDouble b=0.0, wxDouble c=0.0, wxDouble d=1.0,
1017 wxDouble tx=0.0, wxDouble ty=0.0);
1019 virtual wxGraphicsPen CreatePen(const wxPen& pen) ;
1021 virtual wxGraphicsBrush CreateBrush(const wxBrush& brush ) ;
1023 virtual wxGraphicsBrush CreateLinearGradientBrush( wxDouble x1, wxDouble y1, wxDouble x2, wxDouble y2,
1024 const wxColour&c1, const wxColour&c2);
1026 virtual wxGraphicsBrush CreateRadialGradientBrush( wxDouble xo, wxDouble yo, wxDouble xc, wxDouble yc, wxDouble radius,
1027 const wxColour &oColor, const wxColour &cColor);
1029 virtual wxGraphicsFont CreateFont( const wxFont &font , const wxColour &col = *wxBLACK );
1035 //---------------------------------------------------------------------------
1038 #include "wx/dcgraph.h"
1041 class wxGCDC: public wxDC
1045 %pythonAppend wxGCDC
1046 "self.__dc = args[0] # save a ref so the other dc will not be deleted before self";
1047 wxGCDC(const wxWindowDC& dc);
1048 wxGCDC(wxWindow* window);
1052 wxGraphicsContext* GetGraphicsContext();
1053 virtual void SetGraphicsContext( wxGraphicsContext* ctx );
1055 %property(GraphicsContext, GetGraphicsContext, SetGraphicsContext);
1059 //---------------------------------------------------------------------------
1061 // Turn GIL acquisition back on.