wxPython/src/_graphics.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        _graphics.i
   3 // Purpose:     Wrapper definitions for wx.GraphicsPath, wx.GraphicsContext
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     2-Oct-2006
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 2006 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 // Not a %module
  14
  15
  16 //---------------------------------------------------------------------------
  17 %newgroup
  18
  19 %{
  20 #include <wx/graphics.h>
  21 %}
  22
  23 // Turn off the aquisition of the Global Interpreter Lock for the classes and
  24 // functions in this file
  25 %threadWrapperOff
  26
  27
  28 //---------------------------------------------------------------------------
  29 //---------------------------------------------------------------------------
  30
  31 %{
  32 #if !wxUSE_GRAPHICS_CONTEXT
  33 // C++ stub classes for platforms or build configurations that don't have
  34 // wxGraphicsContext yet.
  35
  36 class wxGraphicsRenderer;
  37 class wxGraphicsMatrix;
  38
  39
  40 class wxGraphicsObject : public wxObject
  41 {
  42 public :
  43     wxGraphicsObject() {}
  44     wxGraphicsObject( wxGraphicsRenderer*  ) {
  45         PyErr_SetString(PyExc_NotImplementedError,
  46                         "wx.GraphicsObject is not available on this platform.");
  47     }
  48     wxGraphicsObject( const wxGraphicsObject&  ) {}
  49     virtual ~wxGraphicsObject() {}
  50     bool IsNull() const { return false; }
  51     wxGraphicsRenderer* GetRenderer() const { return NULL; }
  52 } ;
  53
  54
  55
  56 class wxGraphicsPen : public wxGraphicsObject
  57 {
  58 public:
  59     wxGraphicsPen()  {}
  60     virtual ~wxGraphicsPen() {}
  61 } ;
  62 wxGraphicsPen wxNullGraphicsPen;
  63
  64
  65
  66 class wxGraphicsBrush : public wxGraphicsObject
  67 {
  68 public :
  69     wxGraphicsBrush() {}
  70     virtual ~wxGraphicsBrush() {}
  71 } ;
  72 wxGraphicsBrush wxNullGraphicsBrush;
  73
  74
  75
  76 class wxGraphicsFont : public wxGraphicsObject
  77 {
  78 public :
  79     wxGraphicsFont() {}
  80     virtual ~wxGraphicsFont() {}
  81 } ;
  82 wxGraphicsFont wxNullGraphicsFont;
  83
  84
  85
  86 class wxGraphicsPath : public wxGraphicsObject
  87 {
  88 public :
  89     wxGraphicsPath() { }
  90     wxGraphicsPath(wxGraphicsRenderer* ) {
  91         PyErr_SetString(PyExc_NotImplementedError,
  92                         "wx.GraphicsPath is not available on this platform.");
  93     }
  94     virtual ~wxGraphicsPath() {}
  95
  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 ) {}
 108
 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 )  {}
 113
 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); }
 121
 122     bool Contains( wxDouble , wxDouble , int ) const { return false; }
 123     bool Contains( const wxPoint2DDouble& , int ) const { return false; }
 124 };
 125 wxGraphicsPath wxNullGraphicsPath;
 126
 127
 128 class wxGraphicsMatrix : public wxGraphicsObject
 129 {
 130 public :
 131     wxGraphicsMatrix() { }
 132     wxGraphicsMatrix(wxGraphicsRenderer* ) {
 133         PyErr_SetString(PyExc_NotImplementedError,
 134                         "wx.GraphicsMatrix is not available on this platform.");
 135     }
 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; }
 152 };
 153 wxGraphicsMatrix wxNullGraphicsMatrix;
 154
 155
 156 class wxGraphicsContext : public wxGraphicsObject
 157 {
 158 public:
 159
 160     wxGraphicsContext(wxGraphicsRenderer* ) {
 161         PyErr_SetString(PyExc_NotImplementedError,
 162                         "wx.GraphicsContext is not available on this platform.");
 163     }
 164
 165     virtual ~wxGraphicsContext() {}
 166
 167     static wxGraphicsContext* Create()   {
 168         PyErr_SetString(PyExc_NotImplementedError,
 169                         "wx.GraphicsContext is not available on this platform.");
 170         return NULL;
 171     }
 172     static wxGraphicsContext* Create( const wxWindowDC& )  {
 173         PyErr_SetString(PyExc_NotImplementedError,
 174                         "wx.GraphicsContext is not available on this platform.");
 175         return NULL;
 176     }
 177
 178     static wxGraphicsContext* CreateFromNative( void *  )  {
 179         PyErr_SetString(PyExc_NotImplementedError,
 180                         "wx.GraphicsContext is not available on this platform.");
 181         return NULL;
 182     }
 183
 184     static wxGraphicsContext* CreateFromNativeWindow( void *  )  {
 185         PyErr_SetString(PyExc_NotImplementedError,
 186                         "wx.GraphicsContext is not available on this platform.");
 187         return NULL;
 188     }
 189
 190     static wxGraphicsContext* Create( wxWindow*  )  {
 191         PyErr_SetString(PyExc_NotImplementedError,
 192                         "wx.GraphicsContext is not available on this platform.");
 193         return NULL;
 194     }
 195
 196     wxGraphicsPath CreatePath()  { return wxNullGraphicsPath; }
 197
 198     virtual wxGraphicsPen CreatePen(const wxPen& )  { return wxNullGraphicsPen; }
 199
 200     virtual wxGraphicsBrush CreateBrush(const wxBrush& ) { return wxNullGraphicsBrush; }
 201
 202     virtual wxGraphicsBrush CreateLinearGradientBrush( wxDouble , wxDouble , wxDouble , wxDouble ,
 203                                                         const wxColour&, const wxColour&) { return wxNullGraphicsBrush; }
 204
 205     virtual wxGraphicsBrush CreateRadialGradientBrush( wxDouble xo, wxDouble yo,
 206                                                         wxDouble xc, wxDouble yc, wxDouble radius,
 207                                                         const wxColour &oColor, const wxColour &cColor) { return wxNullGraphicsBrush; }
 208
 209     virtual wxGraphicsFont CreateFont( const wxFont &, const wxColour & )  { return wxNullGraphicsFont; }
 210
 211     virtual wxGraphicsMatrix CreateMatrix( wxDouble, wxDouble, wxDouble, wxDouble,
 212                                             wxDouble, wxDouble)  { return wxNullGraphicsMatrix; }
 213
 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; }
 228
 229     virtual void SetPen( const wxGraphicsPen& ) {}
 230     void SetPen( const wxPen& ) {}
 231
 232     virtual void SetBrush( const wxGraphicsBrush& ) {}
 233     void SetBrush( const wxBrush& ) {}
 234
 235     virtual void SetFont( const wxGraphicsFont& ) {}
 236     void SetFont( const wxFont&, const wxColour& ) {}
 237
 238     virtual void StrokePath( const wxGraphicsPath & ) {}
 239     virtual void FillPath( const wxGraphicsPath &, int ) {}
 240     virtual void DrawPath( const wxGraphicsPath &, int ) {}
 241
 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  {}
 249
 250     virtual void DrawBitmap( const wxBitmap &, wxDouble , wxDouble , wxDouble , wxDouble  )  {}
 251     virtual void DrawIcon( const wxIcon &, wxDouble , wxDouble , wxDouble , wxDouble  )  {}
 252
 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; }
 261 };
 262
 263
 264 class wxGraphicsRenderer : public wxObject
 265 {
 266 public :
 267     wxGraphicsRenderer() {
 268         PyErr_SetString(PyExc_NotImplementedError,
 269                         "wx.GraphicsRenderer is not available on this platform.");
 270     }
 271
 272     virtual ~wxGraphicsRenderer() {}
 273
 274     static wxGraphicsRenderer* GetDefaultRenderer() {
 275         PyErr_SetString(PyExc_NotImplementedError,
 276                         "wx.GraphicsRenderer is not available on this platform.");
 277         return NULL;
 278     }
 279
 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; }
 285
 286     virtual wxGraphicsPath CreatePath()  { return wxNullGraphicsPath; }
 287
 288     virtual wxGraphicsMatrix CreateMatrix( wxDouble , wxDouble , wxDouble , wxDouble ,
 289                                              wxDouble , wxDouble ) { return wxNullGraphicsMatrix; }
 290
 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; }
 298 };
 299
 300
 301
 302 class wxGCDC: public wxWindowDC
 303 {
 304 public:
 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);
 310      }
 311
 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);
 317      }
 318
 319     wxGCDC() {
 320         wxPyBlock_t blocked = wxPyBeginBlockThreads();
 321         PyErr_SetString(PyExc_NotImplementedError,
 322                         "wxGCDC is not available on this platform.");
 323         wxPyEndBlockThreads(blocked);
 324     }
 325
 326     virtual ~wxGCDC() {}
 327
 328     wxGraphicsContext* GetGraphicsContext() { return NULL; }
 329     void SetGraphicsContext( wxGraphicsContext* ) {}
 330 };
 331
 332 #endif
 333 %}
 334
 335 //---------------------------------------------------------------------------
 336 //---------------------------------------------------------------------------
 337
 338
 339 %typemap(in) (size_t points, wxPoint2D* points_array ) {
 340     $2 = wxPoint2D_LIST_helper($input, &$1);
 341     if ($2 == NULL) SWIG_fail;
 342 }
 343 %typemap(freearg) (size_t points, wxPoint2D* points_array ) {
 344     if ($2) delete [] $2;
 345 }
 346
 347
 348
 349 MustHaveApp(wxGraphicsPath);
 350 MustHaveApp(wxGraphicsContext);
 351 MustHaveApp(wxGCDC);
 352
 353 typedef double wxDouble;
 354
 355
 356 //---------------------------------------------------------------------------
 357
 358
 359 DocStr(wxGraphicsObject,
 360 "This class is the superclass of native graphics objects like pens
 361 etc. It provides the internal reference counting.  It is not to be
 362 instantiated by user code.", "");
 363 class wxGraphicsObject : public wxObject
 364 {
 365 public :
 366     wxGraphicsObject( wxGraphicsRenderer* renderer = NULL );
 367     virtual ~wxGraphicsObject();
 368
 369     DocDeclStr(
 370         bool , IsNull() const ,
 371         "Is this object valid (false) or still empty (true)?", "");
 372
 373     DocDeclStr(
 374         wxGraphicsRenderer* , GetRenderer() const,
 375         "Returns the renderer that was used to create this instance, or
 376 ``None`` if it has not been initialized yet.", "");
 377
 378 };
 379
 380
 381 DocStr(wxGraphicsPen,
 382 "A wx.GraphicsPen is a native representation of a pen. It is used for
 383 stroking a path on a `wx.GraphicsContext`. The contents are specific and
 384 private to the respective renderer. The only way to get a valid instance
 385 is via a CreatePen call on the graphics context or the renderer
 386 instance.", "");
 387 class wxGraphicsPen : public wxGraphicsObject
 388 {
 389 public :
 390     wxGraphicsPen();
 391     virtual ~wxGraphicsPen();
 392 };
 393
 394 DocStr(wxGraphicsBrush,
 395 "A wx.GraphicsBrush is a native representation of a brush. It is used
 396 for filling a path on a `wx.GraphicsContext`. The contents are
 397 specific and private to the respective renderer. The only way to get a
 398 valid instance is via a Create...Brush call on the graphics context or
 399 the renderer instance.", "");
 400 class wxGraphicsBrush : public wxGraphicsObject
 401 {
 402 public :
 403     wxGraphicsBrush();
 404     virtual ~wxGraphicsBrush();
 405 };
 406
 407
 408 DocStr(wxGraphicsFont,
 409 "A `wx.GraphicsFont` is a native representation of a font (including
 410 text colour). The contents are specific an private to the respective
 411 renderer.  The only way to get a valid instance is via a CreateFont
 412 call on the graphics context or the renderer instance.", "");
 413 class wxGraphicsFont : public wxGraphicsObject
 414 {
 415 public :
 416     wxGraphicsFont();
 417     virtual ~wxGraphicsFont();
 418 };
 419
 420
 421 //---------------------------------------------------------------------------
 422
 423 DocStr(wxGraphicsMatrix,
 424 "A wx.GraphicsMatrix is a native representation of an affine
 425 matrix. The contents are specific and private to the respective
 426 renderer. The only way to get a valid instance is via a CreateMatrix
 427 call on the graphics context or the renderer instance.", "");
 428 class wxGraphicsMatrix : public wxGraphicsObject
 429 {
 430 public :
 431 //    wxGraphicsMatrix();
 432     virtual ~wxGraphicsMatrix();
 433
 434     DocDeclStr(
 435         virtual void , Concat( const wxGraphicsMatrix& t ),
 436         "Concatenates the passed in matrix to the current matrix.", "");
 437
 438
 439     DocDeclStr(
 440         virtual void , Set(wxDouble a=1.0, wxDouble b=0.0, wxDouble c=0.0, wxDouble d=1.0,
 441                            wxDouble tx=0.0, wxDouble ty=0.0),
 442         "Sets the matrix to the specified values (default values are the
 443 identity matrix.)", "");
 444
 445
 446     DocDeclAStr(
 447         virtual void , Get(wxDouble* OUTPUT, wxDouble* OUTPUT, wxDouble* OUTPUT,
 448                            wxDouble* OUTPUT, wxDouble* OUTPUT, wxDouble* OUTPUT),
 449         "Get(self) --> (a, b, c, d, tx, ty)",
 450         "Gets the component values of the matrix and returns them as a tuple.", "");
 451
 452
 453     DocDeclStr(
 454         virtual void , Invert(),
 455         "Inverts the matrix.", "");
 456
 457
 458     DocDeclStr(
 459         virtual bool , IsEqual( const wxGraphicsMatrix& t) const,
 460         "Returns ``True`` if the elements of the transformation matrix are
 461 equal", "");
 462
 463
 464     DocDeclStr(
 465         virtual bool , IsIdentity() const,
 466         "Returns ``True`` if this is the identity matrix", "");
 467
 468
 469     DocDeclStr(
 470         virtual void , Translate( wxDouble dx , wxDouble dy ),
 471         "Add a translation to this matrix.", "");
 472
 473
 474     DocDeclStr(
 475         virtual void , Scale( wxDouble xScale , wxDouble yScale ),
 476         "Scales this matrix.", "");
 477
 478
 479     DocDeclStr(
 480         virtual void , Rotate( wxDouble angle ),
 481         "Rotates this matrix.  The angle should be specified in radians.", "");
 482
 483
 484     DocDeclAStr(
 485         virtual void , TransformPoint( wxDouble *INOUT, wxDouble *INOUT ) const,
 486         "TransformPoint(self, x, y) --> (x, y)",
 487         "Applies this matrix to a point, returns the resulting point values", "");
 488
 489
 490     DocDeclAStr(
 491         virtual void , TransformDistance( wxDouble *INOUT, wxDouble *INOUT ) const,
 492         "TransformDistance(self, dx, dy) --> (dx, dy)",
 493         "Applies this matrix to a distance (ie. performs all transforms except
 494 translations)", "");
 495
 496
 497     DocDeclStr(
 498         virtual void * , GetNativeMatrix() const,
 499         "Returns the native representation of the matrix. For CoreGraphics this
 500 is a CFAffineMatrix pointer. For GDIPlus a Matrix Pointer and for
 501 Cairo a cairo_matrix_t pointer.  NOTE: For wxPython we still need a
 502 way to make this value usable.", "");
 503 };
 504
 505 //---------------------------------------------------------------------------
 506
 507 class wxGraphicsPath : public wxGraphicsObject
 508 {
 509 public :
 510 //    wxGraphicsPath();
 511     virtual ~wxGraphicsPath();
 512
 513
 514     %nokwargs MoveToPoint;
 515     DocStr(MoveToPoint,
 516            "Begins a new subpath at the specified point.", "");
 517     virtual void  MoveToPoint( wxDouble x, wxDouble y );
 518     void MoveToPoint( const wxPoint2D& p);
 519
 520
 521     %nokwargs AddLineToPoint;
 522     DocStr(AddLineToPoint,
 523         "Adds a straight line from the current point to the specified point.", "");
 524     virtual void AddLineToPoint( wxDouble x, wxDouble y );
 525     void AddLineToPoint( const wxPoint2D& p);
 526
 527
 528     %nokwargs AddCurveToPoint;
 529     DocStr(AddCurveToPoint,
 530         "Adds a cubic Bezier curve from the current point, using two control
 531 points and an end point", "");
 532     virtual void AddCurveToPoint( wxDouble cx1, wxDouble cy1,
 533                                   wxDouble cx2, wxDouble cy2,
 534                                   wxDouble x, wxDouble y );
 535     void AddCurveToPoint( const wxPoint2D& c1, const wxPoint2D& c2, const wxPoint2D& e);
 536
 537
 538
 539     DocDeclStr(
 540         virtual void , AddPath( const wxGraphicsPath& path ),
 541         "Adds another path", "");
 542
 543
 544     DocDeclStr(
 545         virtual void , CloseSubpath(),
 546         "Closes the current sub-path.", "");
 547
 548
 549     DocDeclStr(
 550         wxPoint2D , GetCurrentPoint() const,
 551         "Gets the last point of the current path, (0,0) if not yet set", "");
 552
 553
 554     %nokwargs AddArc;
 555     DocStr(AddArc,
 556         "Adds an arc of a circle centering at (x,y) with radius (r) from
 557 startAngle to endAngle", "");
 558     virtual void AddArc( wxDouble x, wxDouble y, wxDouble r,
 559                          wxDouble startAngle, wxDouble endAngle, bool clockwise=true );
 560     void AddArc( const wxPoint2D& c, wxDouble r, wxDouble startAngle, wxDouble endAngle, bool clockwise=true);
 561
 562
 563     DocDeclStr(
 564         virtual void , AddQuadCurveToPoint( wxDouble cx, wxDouble cy, wxDouble x, wxDouble y ),
 565         "Adds a quadratic Bezier curve from the current point, using a control
 566 point and an end point", "");
 567
 568
 569     DocDeclStr(
 570         virtual void , AddRectangle( wxDouble x, wxDouble y, wxDouble w, wxDouble h ),
 571         "Appends a rectangle as a new closed subpath.", "");
 572
 573
 574     DocDeclStr(
 575         virtual void , AddCircle( wxDouble x, wxDouble y, wxDouble r ),
 576         "Appends a circle around (x,y) with radius r as a new closed subpath.", "");
 577
 578
 579     DocDeclStr(
 580         virtual void , AddArcToPoint( wxDouble x1, wxDouble y1 , wxDouble x2, wxDouble y2, wxDouble r ) ,
 581         "Appends an arc to two tangents connecting (current) to (x1,y1) and
 582 (x1,y1) to (x2,y2), also a straight line from (current) to (x1,y1)", "");
 583
 584
 585     DocDeclStr(
 586         virtual void , AddEllipse( wxDouble x, wxDouble y, wxDouble w, wxDouble h),
 587         "Appends an ellipse fitting into the passed in rectangle.", "");
 588
 589
 590     DocDeclStr(
 591         virtual void , AddRoundedRectangle( wxDouble x, wxDouble y, wxDouble w, wxDouble h, wxDouble radius),
 592         "Appends a rounded rectangle.", "");
 593
 594
 595     DocDeclStr(
 596         virtual void * , GetNativePath() const,
 597         "Returns the native path (CGPathRef for Core Graphics, Path pointer for
 598 GDIPlus and a cairo_path_t pointer for cairo).  NOTE: For wxPython we
 599 still need a way to make this value usable.", "");
 600
 601
 602     DocDeclStr(
 603         virtual void , UnGetNativePath(void *p) const,
 604         "Gives back the native path returned by GetNativePath() because there
 605 might be some deallocations necessary (eg on cairo the native path
 606 returned by GetNativePath is newly allocated each time).", "");
 607
 608
 609     DocDeclStr(
 610         virtual void , Transform( const wxGraphicsMatrix& matrix ),
 611         "Transforms each point of this path by the matrix", "");
 612
 613
 614     DocDeclStr(
 615         wxRect2D , GetBox() const,
 616         "Gets the bounding box enclosing all points (possibly including control
 617 points)", "");
 618
 619
 620     %nokwargs Contains;
 621     DocStr(Contains,
 622         "Returns ``True`` if the point is within the path.", "");
 623     virtual bool Contains( wxDouble x, wxDouble y, int fillStyle = wxODDEVEN_RULE) const;
 624     bool Contains( const wxPoint2D& c, int fillStyle = wxODDEVEN_RULE) const;
 625
 626 };
 627
 628
 629 //---------------------------------------------------------------------------
 630
 631 %immutable;
 632 const wxGraphicsPen     wxNullGraphicsPen;
 633 const wxGraphicsBrush   wxNullGraphicsBrush;
 634 const wxGraphicsFont    wxNullGraphicsFont;
 635 const wxGraphicsMatrix  wxNullGraphicsMatrix;
 636 const wxGraphicsPath    wxNullGraphicsPath;
 637 %mutable;
 638
 639 //---------------------------------------------------------------------------
 640
 641 DocStr(wxGraphicsContext,
 642 "A `wx.GraphicsContext` instance is the object that is drawn upon. It is
 643 created by a renderer using the CreateContext calls, this can be done
 644 either directly using a renderer instance, or indirectly using the
 645 static convenience CreateXXX functions of wx.GraphicsContext that
 646 always delegate the task to the default renderer.", "");
 647
 648 class wxGraphicsContext : public wxGraphicsObject
 649 {
 650 public:
 651     //wxGraphicsContext();         This is an ABC, use Create to make an instance...
 652     virtual ~wxGraphicsContext();
 653
 654     %newobject Create;
 655     %nokwargs Create;
 656     %pythonAppend Create
 657         "val.__dc = args[0] # save a ref so the dc will not be deleted before self";
 658     DocStr(Create,
 659            "Creates a wx.GraphicsContext either from a window or a DC.", "");
 660     static wxGraphicsContext* Create( const wxWindowDC& dc);
 661     static wxGraphicsContext* Create( wxWindow* window ) ;
 662
 663     DocDeclStrName(
 664         static wxGraphicsContext* , Create(),
 665         "Create a lightwieght context that can be used for measuring text only.", "",
 666         CreateMeasuringContext);
 667
 668     %newobject CreateFromNative;
 669     DocDeclStr(
 670         static wxGraphicsContext* , CreateFromNative( void * context ) ,
 671         "Creates a wx.GraphicsContext from a native context. This native
 672 context must be eg a CGContextRef for Core Graphics, a Graphics
 673 pointer for GDIPlus or a cairo_t pointer for Cairo.", "");
 674
 675
 676     %newobject CreateFromNative;
 677     DocDeclStr(
 678         static wxGraphicsContext* , CreateFromNativeWindow( void * window ) ,
 679         "Creates a wx.GraphicsContext from a native window.", "");
 680
 681
 682
 683     DocDeclStr(
 684         virtual wxGraphicsPath , CreatePath(),
 685         "Creates a native graphics path which is initially empty.", "");
 686
 687
 688     DocDeclStr(
 689         virtual wxGraphicsPen , CreatePen(const wxPen& pen),
 690         "Creates a native pen from a `wx.Pen`.", "");
 691
 692
 693     DocDeclStr(
 694         virtual wxGraphicsBrush , CreateBrush(const wxBrush& brush ),
 695         "Creates a native brush from a `wx.Brush`.", "");
 696
 697
 698     DocDeclStr(
 699         virtual wxGraphicsBrush ,
 700         CreateLinearGradientBrush( wxDouble x1, wxDouble y1, wxDouble x2, wxDouble y2,
 701                                    const wxColour& c1, const wxColour& c2),
 702         "Creates a native brush, having a linear gradient, starting at (x1,y1)
 703 with color c1 to (x2,y2) with color c2.", "");
 704
 705
 706     DocDeclStr(
 707         virtual wxGraphicsBrush ,
 708         CreateRadialGradientBrush( wxDouble xo, wxDouble yo, wxDouble xc, wxDouble yc, wxDouble radius,
 709                                    const wxColour &oColor, const wxColour &cColor),
 710         "Creates a native brush, having a radial gradient originating at point
 711 (xo,yc) with color oColour and ends on a circle around (xc,yc) with
 712 radius r and color cColour.", "");
 713
 714
 715     DocDeclStr(
 716         virtual wxGraphicsFont , CreateFont( const wxFont &font , const wxColour &col = *wxBLACK ),
 717         "Creates a native graphics font from a `wx.Font` and a text colour.", "");
 718
 719
 720     DocDeclStr(
 721         virtual wxGraphicsMatrix , CreateMatrix( wxDouble a=1.0, wxDouble b=0.0,
 722                                                  wxDouble c=0.0, wxDouble d=1.0,
 723                                                  wxDouble tx=0.0, wxDouble ty=0.0),
 724         "Creates a native affine transformation matrix from the passed in
 725 values. The defaults result in an identity matrix.", "");
 726
 727
 728
 729     DocDeclStr(
 730         virtual void , PushState(),
 731         "Push the current state of the context, (ie the transformation matrix)
 732 on a stack", "");
 733
 734
 735     DocDeclStr(
 736         virtual void , PopState(),
 737         "Pops a stored state from the stack", "");
 738
 739
 740     DocDeclStrName(
 741         virtual void , Clip( const wxRegion &region ),
 742         "Clips drawings to the region, combined to current clipping region.", "",
 743         ClipRegion);
 744
 745
 746     DocDeclStr(
 747         virtual void , Clip( wxDouble x, wxDouble y, wxDouble w, wxDouble h ),
 748         "Clips drawings to the rectangle.", "");
 749
 750
 751     DocDeclStr(
 752         virtual void , ResetClip(),
 753         "Resets the clipping to original shape.", "");
 754
 755
 756     DocDeclStr(
 757         virtual void * , GetNativeContext(),
 758         "Returns the native context (CGContextRef for Core Graphics, Graphics
 759 pointer for GDIPlus and cairo_t pointer for cairo).", "");
 760
 761
 762     DocDeclStr(
 763         virtual int , GetLogicalFunction() const,
 764         "Returns the current logical function.", "");
 765
 766
 767     DocDeclStr(
 768         virtual bool , SetLogicalFunction(int function) ,
 769         "Sets the current logical function, returns ``True`` if it supported", "");
 770
 771
 772     DocDeclStr(
 773         virtual void , Translate( wxDouble dx , wxDouble dy ),
 774         "Translates the current transformation matrix.", "");
 775
 776
 777     DocDeclStr(
 778         virtual void , Scale( wxDouble xScale , wxDouble yScale ),
 779         "Scale the current transformation matrix of the context.", "");
 780
 781
 782     DocDeclStr(
 783         virtual void , Rotate( wxDouble angle ),
 784         "Rotate the current transformation matrix of the context.  ``angle`` is
 785 specified in radians.", "");
 786
 787
 788     DocDeclStr(
 789         virtual void , ConcatTransform( const wxGraphicsMatrix& matrix ),
 790         "Concatenates the passed in transform with the current transform of
 791 this context.", "");
 792
 793
 794     DocDeclStr(
 795         virtual void , SetTransform( const wxGraphicsMatrix& matrix ),
 796         "Sets the current transform of this context.", "");
 797
 798
 799     DocDeclStr(
 800         virtual wxGraphicsMatrix , GetTransform() const,
 801         "Gets the current transformation matrix of this context.", "");
 802
 803
 804
 805
 806     DocStr(SetPen, "Sets the stroke pen", "");
 807     %nokwargs SetPen;
 808     virtual void SetPen( const wxGraphicsPen& pen );
 809     void SetPen( const wxPen& pen );
 810
 811
 812     DocStr(SetBrush, "Sets the brush for filling", "");
 813     %nokwargs SetBrush;
 814     virtual void SetBrush( const wxGraphicsBrush& brush );
 815     void SetBrush( const wxBrush& brush );
 816
 817
 818     DocStr(SetFont, "Sets the font", "");
 819     %nokwargs SetFont;
 820     virtual void SetFont( const wxGraphicsFont& font );
 821     void SetFont( const wxFont& font, const wxColour& colour = *wxBLACK);
 822
 823
 824
 825     DocDeclStr(
 826         virtual void , StrokePath( const wxGraphicsPath& path ),
 827         "Strokes along a path with the current pen.", "");
 828
 829
 830     DocDeclStr(
 831         virtual void , FillPath( const wxGraphicsPath& path, int fillStyle = wxODDEVEN_RULE ),
 832         "Fills a path with the current brush.", "");
 833
 834
 835     DocDeclStr(
 836         virtual void , DrawPath( const wxGraphicsPath& path, int fillStyle = wxODDEVEN_RULE ),
 837         "Draws the path by first filling and then stroking.", "");
 838
 839
 840     %extend {
 841         DocStr(DrawText,
 842                "Draws a text string at the defined position.", "");
 843         void DrawText( const wxString &str, wxDouble x, wxDouble y,
 844                        const wxGraphicsBrush& backgroundBrush = wxNullGraphicsBrush )
 845         {
 846             if ( !backgroundBrush.IsNull() )
 847                 self->DrawText(str, x, y, backgroundBrush);
 848             else
 849                 self->DrawText(str, x, y);
 850         }
 851
 852         DocStr(DrawRotatedText,
 853                "Draws a text string at the defined position, at the specified angle,
 854 which is given in radians.", "");
 855         void DrawRotatedText(  const wxString &str, wxDouble x, wxDouble y, wxDouble angle,
 856                                const wxGraphicsBrush& backgroundBrush = wxNullGraphicsBrush )
 857         {
 858             if ( !backgroundBrush.IsNull() )
 859                 self->DrawText(str, x, y, angle, backgroundBrush);
 860             else
 861                 self->DrawText(str, x, y, angle);
 862         }
 863     }
 864
 865
 866
 867     DocDeclAStrName(
 868         virtual void , GetTextExtent( const wxString &text,
 869                                       wxDouble *OUTPUT /*width*/,
 870                                       wxDouble *OUTPUT /*height*/,
 871                                       wxDouble *OUTPUT /*descent*/,
 872                                       wxDouble *OUTPUT /*externalLeading*/ ) const ,
 873         "GetFullTextExtent(self, text) --> (width, height, descent, externalLeading)",
 874         "Gets the dimensions of the string using the currently selected
 875 font. ``text`` is the string to measure, ``w`` and ``h`` are the total
 876 width and height respectively, ``descent`` is the dimension from the
 877 baseline of the font to the bottom of the descender, and
 878 ``externalLeading`` is any extra vertical space added to the font by
 879 the font designer (usually is zero).", "",
 880         GetFullTextExtent);
 881
 882     %extend {
 883         DocAStr(GetTextExtent,
 884                 "GetTextExtent(self, text) --> (width, height)",
 885                 "Gets the dimensions of the string using the currently selected
 886 font. ``text`` is the string to measure, ``w`` and ``h`` are the total
 887 width and height respectively.", "");
 888
 889         PyObject* GetTextExtent( const wxString &text )
 890         {
 891             wxDouble width = 0.0,
 892                      height = 0.0;
 893             self->GetTextExtent(text, &width, &height, NULL, NULL);
 894             // thread wrapers are turned off for this .i file, so no need to acquire GIL...
 895             PyObject* rv = PyTuple_New(2);
 896             PyTuple_SET_ITEM(rv, 0, PyFloat_FromDouble(width));
 897             PyTuple_SET_ITEM(rv, 1, PyFloat_FromDouble(height));
 898             return rv;
 899         }
 900     }
 901
 902
 903     %extend {
 904         DocAStr(GetPartialTextExtents,
 905                 "GetPartialTextExtents(self, text) -> [widths]",
 906                 "Returns a list of widths from the beginning of ``text`` to the
 907 coresponding character in ``text``.", "");
 908         wxArrayDouble GetPartialTextExtents(const wxString& text) {
 909             wxArrayDouble widths;
 910             self->GetPartialTextExtents(text, widths);
 911             return widths;
 912         }
 913     }
 914
 915
 916     DocDeclStr(
 917         virtual void , DrawBitmap( const wxBitmap &bmp, wxDouble x, wxDouble y, wxDouble w, wxDouble h ),
 918         "Draws the bitmap. In case of a mono bitmap, this is treated as a mask
 919 and the current brush is used for filling.", "");
 920
 921
 922     DocDeclStr(
 923         virtual void , DrawIcon( const wxIcon &icon, wxDouble x, wxDouble y, wxDouble w, wxDouble h ),
 924         "Draws the icon.", "");
 925
 926
 927
 928     DocDeclStr(
 929         virtual void , StrokeLine( wxDouble x1, wxDouble y1, wxDouble x2, wxDouble y2),
 930         "Strokes a single line.", "");
 931
 932
 933     DocDeclAStr(
 934         virtual void , StrokeLines( size_t points, const wxPoint2D *points_array),
 935         "StrokeLines(self, List points)",
 936         "Stroke lines connecting each of the points", "");
 937
 938
 939     %extend {
 940         DocStr(StrokeLineSegements,
 941                "Stroke disconnected lines from begin to end points", "");
 942         void StrokeLineSegements(PyObject* beginPoints, PyObject* endPoints)
 943         {
 944             size_t c1, c2, count;
 945             wxPoint2D* beginP = wxPoint2D_LIST_helper(beginPoints, &c1);
 946             wxPoint2D* endP =   wxPoint2D_LIST_helper(endPoints, &c2);
 947
 948             if ( beginP != NULL && endP != NULL )
 949             {
 950                 count = wxMin(c1, c2);
 951                 self->StrokeLines(count, beginP, endP);
 952             }
 953             delete [] beginP;
 954             delete [] endP;
 955         }
 956     }
 957
 958
 959     DocDeclStr(
 960         virtual void , DrawLines( size_t points, const wxPoint2D *points_array,
 961                                   int fillStyle = wxODDEVEN_RULE ),
 962         "Draws a polygon.", "");
 963
 964
 965     DocDeclStr(
 966         virtual void , DrawRectangle( wxDouble x, wxDouble y, wxDouble w, wxDouble h),
 967         "Draws a rectangle.", "");
 968
 969
 970     DocDeclStr(
 971         virtual void , DrawEllipse( wxDouble x, wxDouble y, wxDouble w, wxDouble h),
 972         "Draws an ellipse.", "");
 973
 974
 975     DocDeclStr(
 976         virtual void , DrawRoundedRectangle( wxDouble x, wxDouble y, wxDouble w, wxDouble h, wxDouble radius),
 977         "Draws a rounded rectangle", "");
 978
 979
 980
 981     DocDeclStr(
 982         virtual bool , ShouldOffset() const,
 983         "helper to determine if a 0.5 offset should be applied for the drawing operation", "");
 984
 985 };
 986
 987
 988 //---------------------------------------------------------------------------
 989
 990 class wxGraphicsRenderer : public wxObject
 991 {
 992 public :
 993     // wxGraphicsRenderer();  This is an ABC, use GetDefaultRenderer
 994
 995     virtual ~wxGraphicsRenderer();
 996
 997     // %newobject GetDefaultRenderer;  ???
 998     static wxGraphicsRenderer* GetDefaultRenderer();
 999
1000     %nokwargs CreateContext;
1001     %newobject CreateContext;
1002     virtual wxGraphicsContext * CreateContext( const wxWindowDC& dc) ;
1003     virtual wxGraphicsContext * CreateContext( wxWindow* window );
1004
1005     // create a context that can be used for measuring texts only, no drawing allowed
1006     virtual wxGraphicsContext * CreateMeasuringContext();
1007
1008     %newobject CreateContextFromNativeContext;
1009     virtual wxGraphicsContext * CreateContextFromNativeContext( void * context );
1010
1011     %newobject CreateContextFromNativeWindow;
1012     virtual wxGraphicsContext * CreateContextFromNativeWindow( void * window );
1013
1014
1015     virtual wxGraphicsPath CreatePath();
1016
1017     virtual wxGraphicsMatrix CreateMatrix( wxDouble a=1.0, wxDouble b=0.0, wxDouble c=0.0, wxDouble d=1.0,
1018                                            wxDouble tx=0.0, wxDouble ty=0.0);
1019
1020     virtual wxGraphicsPen CreatePen(const wxPen& pen) ;
1021
1022     virtual wxGraphicsBrush CreateBrush(const wxBrush& brush ) ;
1023
1024     virtual wxGraphicsBrush CreateLinearGradientBrush( wxDouble x1, wxDouble y1, wxDouble x2, wxDouble y2,
1025                                                         const wxColour&c1, const wxColour&c2);
1026
1027     virtual wxGraphicsBrush CreateRadialGradientBrush( wxDouble xo, wxDouble yo, wxDouble xc, wxDouble yc, wxDouble radius,
1028                                                         const wxColour &oColor, const wxColour &cColor);
1029
1030     virtual wxGraphicsFont CreateFont( const wxFont &font , const wxColour &col = *wxBLACK );
1031
1032 };
1033
1034
1035
1036 //---------------------------------------------------------------------------
1037
1038 %{
1039 #include "wx/dcgraph.h"
1040 %}
1041
1042 class wxGCDC: public wxDC
1043 {
1044 public:
1045     %nokwargs wxGCDC;
1046     %pythonAppend wxGCDC
1047         "self.__dc = args[0] # save a ref so the other dc will not be deleted before self";
1048     wxGCDC(const wxWindowDC& dc);
1049     wxGCDC(wxWindow* window);
1050     //wxGCDC();
1051     virtual ~wxGCDC();
1052
1053     wxGraphicsContext* GetGraphicsContext();
1054     virtual void SetGraphicsContext( wxGraphicsContext* ctx );
1055
1056     %property(GraphicsContext, GetGraphicsContext, SetGraphicsContext);
1057 };
1058
1059
1060 //---------------------------------------------------------------------------
1061
1062 // Turn GIL acquisition back on.
1063 %threadWrapperOn
1064