allows resetting color of text to black, closes #4826

[wxWidgets.git] / include / wx / graphics.h

diff --git a/include/wx/graphics.h b/include/wx/graphics.h
old mode 100755 (executable)
new mode 100644 (file)
index 68eb3ca..4ab38f4
--- a/include/wx/graphics.h
+++ b/include/wx/graphics.h
@@ -12,20 +12,25 @@
 #ifndef _WX_GRAPHICS_H_
 #define _WX_GRAPHICS_H_
 
 #ifndef _WX_GRAPHICS_H_
 #define _WX_GRAPHICS_H_
 

+#include "wx/defs.h"
+

 #if wxUSE_GRAPHICS_CONTEXT
 
 #include "wx/geometry.h"
 #include "wx/dynarray.h"
 
 #if wxUSE_GRAPHICS_CONTEXT
 
 #include "wx/geometry.h"
 #include "wx/dynarray.h"
 

-class WXDLLIMPEXP_CORE wxWindowDC;
-class WXDLLIMPEXP_CORE wxGraphicsContext;
-class WXDLLIMPEXP_CORE wxGraphicsPath;
-class WXDLLIMPEXP_CORE wxGraphicsMatrix;
-class WXDLLIMPEXP_CORE wxGraphicsFigure;
-class WXDLLIMPEXP_CORE wxGraphicsRenderer;
-class WXDLLIMPEXP_CORE wxGraphicsPen;
-class WXDLLIMPEXP_CORE wxGraphicsBrush;
-class WXDLLIMPEXP_CORE wxGraphicsFont;
+class WXDLLIMPEXP_FWD_CORE wxWindowDC;
+class WXDLLIMPEXP_FWD_CORE wxMemoryDC;
+class WXDLLIMPEXP_FWD_CORE wxPrinterDC;
+class WXDLLIMPEXP_FWD_CORE wxGraphicsContext;
+class WXDLLIMPEXP_FWD_CORE wxGraphicsPath;
+class WXDLLIMPEXP_FWD_CORE wxGraphicsMatrix;
+class WXDLLIMPEXP_FWD_CORE wxGraphicsFigure;
+class WXDLLIMPEXP_FWD_CORE wxGraphicsRenderer;
+class WXDLLIMPEXP_FWD_CORE wxGraphicsPen;
+class WXDLLIMPEXP_FWD_CORE wxGraphicsBrush;
+class WXDLLIMPEXP_FWD_CORE wxGraphicsFont;
+class WXDLLIMPEXP_FWD_CORE wxGraphicsBitmap;

 
 /*
  * notes about the graphics context apis
 
 /*
  * notes about the graphics context apis


@@ -44,17 +49,9 @@ class WXDLLIMPEXP_CORE wxGraphicsFont;
 // instance from the other instances that were shared - using copy on write semantics
 //
  
 // instance from the other instances that were shared - using copy on write semantics
 //
  

-class WXDLLIMPEXP_CORE wxGraphicsObjectRefData : public wxObjectRefData
-{
-public :
-    wxGraphicsObjectRefData( wxGraphicsRenderer* renderer );
-    wxGraphicsObjectRefData( const wxGraphicsObjectRefData* data );
-    wxGraphicsRenderer* GetRenderer() const ;
-    virtual wxGraphicsObjectRefData* Clone() const ;
-
-protected :
-    wxGraphicsRenderer* m_renderer;
-} ;
+class WXDLLIMPEXP_FWD_CORE wxGraphicsObjectRefData;
+class WXDLLIMPEXP_FWD_CORE wxGraphicsMatrixData;
+class WXDLLIMPEXP_FWD_CORE wxGraphicsPathData;

 
 class WXDLLIMPEXP_CORE wxGraphicsObject : public wxObject
 {
 
 class WXDLLIMPEXP_CORE wxGraphicsObject : public wxObject
 {


@@ -72,7 +69,7 @@ protected :
     virtual wxObjectRefData* CreateRefData() const;
     virtual wxObjectRefData* CloneRefData(const wxObjectRefData* data) const;
 
     virtual wxObjectRefData* CreateRefData() const;
     virtual wxObjectRefData* CloneRefData(const wxObjectRefData* data) const;
 

-    DECLARE_DYNAMIC_CLASS(wxGraphicsObject);
+    DECLARE_DYNAMIC_CLASS(wxGraphicsObject)

 } ;
 
 class WXDLLIMPEXP_CORE wxGraphicsPen : public wxGraphicsObject
 } ;
 
 class WXDLLIMPEXP_CORE wxGraphicsPen : public wxGraphicsObject


@@ -84,7 +81,7 @@ private :
     DECLARE_DYNAMIC_CLASS(wxGraphicsPen)
 } ;
 
     DECLARE_DYNAMIC_CLASS(wxGraphicsPen)
 } ;
 

-extern WXDLLEXPORT_DATA(wxGraphicsPen) wxNullGraphicsPen;
+extern WXDLLIMPEXP_DATA_CORE(wxGraphicsPen) wxNullGraphicsPen;

 
 class WXDLLIMPEXP_CORE wxGraphicsBrush : public wxGraphicsObject
 {
 
 class WXDLLIMPEXP_CORE wxGraphicsBrush : public wxGraphicsObject
 {


@@ -95,7 +92,7 @@ private :
     DECLARE_DYNAMIC_CLASS(wxGraphicsBrush)
 } ;
 
     DECLARE_DYNAMIC_CLASS(wxGraphicsBrush)
 } ;
 

-extern WXDLLEXPORT_DATA(wxGraphicsBrush) wxNullGraphicsBrush;
+extern WXDLLIMPEXP_DATA_CORE(wxGraphicsBrush) wxNullGraphicsBrush;

 
 class WXDLLIMPEXP_CORE wxGraphicsFont : public wxGraphicsObject
 {
 
 class WXDLLIMPEXP_CORE wxGraphicsFont : public wxGraphicsObject
 {


@@ -106,59 +103,18 @@ private :
     DECLARE_DYNAMIC_CLASS(wxGraphicsFont)
 } ;
 
     DECLARE_DYNAMIC_CLASS(wxGraphicsFont)
 } ;
 

-extern WXDLLEXPORT_DATA(wxGraphicsFont) wxNullGraphicsFont;
+extern WXDLLIMPEXP_DATA_CORE(wxGraphicsFont) wxNullGraphicsFont;

 
 

-
-class WXDLLIMPEXP_CORE wxGraphicsMatrixData : public wxGraphicsObjectRefData
+class WXDLLIMPEXP_CORE wxGraphicsBitmap : public wxGraphicsObject

 {
 public :
 {
 public :

-    wxGraphicsMatrixData( wxGraphicsRenderer* renderer) : 
-       wxGraphicsObjectRefData(renderer) {}
-
-       virtual ~wxGraphicsMatrixData() {}
-
-       // concatenates the matrix
-       virtual void Concat( const wxGraphicsMatrixData *t ) = 0;
-
-       // sets the matrix to the respective values
-       virtual void Set(wxDouble a=1.0, wxDouble b=0.0, wxDouble c=0.0, wxDouble d=1.0, 
-           wxDouble tx=0.0, wxDouble ty=0.0) = 0;
-
-       // makes this the inverse matrix
-       virtual void Invert() = 0;
-
-       // returns true if the elements of the transformation matrix are equal ?
-       virtual bool IsEqual( const wxGraphicsMatrixData* t) const  = 0;
-
-       // return true if this is the identity matrix
-       virtual bool IsIdentity() const = 0;
-
-       //
-       // transformation
-       //
-
-       // add the translation to this matrix
-       virtual void Translate( wxDouble dx , wxDouble dy ) = 0;
-
-       // add the scale to this matrix
-       virtual void Scale( wxDouble xScale , wxDouble yScale ) = 0;
-
-       // add the rotation to this matrix (radians)
-       virtual void Rotate( wxDouble angle ) = 0;  
-
-       //
-       // apply the transforms
-       //
-
-       // applies that matrix to the point
-       virtual void TransformPoint( wxDouble *x, wxDouble *y ) const = 0;
-
-       // applies the matrix except for translations
-       virtual void TransformDistance( wxDouble *dx, wxDouble *dy ) const =0;
-
-       // returns the native representation
-       virtual void * GetNativeMatrix() const = 0;
+    wxGraphicsBitmap() {}
+    virtual ~wxGraphicsBitmap() {}
+private :
+    DECLARE_DYNAMIC_CLASS(wxGraphicsBitmap)

 } ;
 } ;

+ 
+extern WXDLLIMPEXP_DATA_CORE(wxGraphicsBitmap) wxNullGraphicsBitmap;

 
 class WXDLLIMPEXP_CORE wxGraphicsMatrix : public wxGraphicsObject
 {
 
 class WXDLLIMPEXP_CORE wxGraphicsMatrix : public wxGraphicsObject
 {


@@ -175,6 +131,10 @@ public :
     virtual void Set(wxDouble a=1.0, wxDouble b=0.0, wxDouble c=0.0, wxDouble d=1.0, 
         wxDouble tx=0.0, wxDouble ty=0.0);
 
     virtual void Set(wxDouble a=1.0, wxDouble b=0.0, wxDouble c=0.0, wxDouble d=1.0, 
         wxDouble tx=0.0, wxDouble ty=0.0);
 

+    // gets the component valuess of the matrix
+    virtual void Get(wxDouble* a=NULL, wxDouble* b=NULL,  wxDouble* c=NULL,
+                     wxDouble* d=NULL, wxDouble* tx=NULL, wxDouble* ty=NULL) const;
+       

     // makes this the inverse matrix
     virtual void Invert();
 
     // makes this the inverse matrix
     virtual void Invert();
 


@@ -220,76 +180,7 @@ private :
     DECLARE_DYNAMIC_CLASS(wxGraphicsMatrix)
 } ;
 
     DECLARE_DYNAMIC_CLASS(wxGraphicsMatrix)
 } ;
 

-extern WXDLLEXPORT_DATA(wxGraphicsMatrix) wxNullGraphicsMatrix;
-
-class WXDLLIMPEXP_CORE wxGraphicsPathData : public wxGraphicsObjectRefData
-{
-public :
-    wxGraphicsPathData(wxGraphicsRenderer* renderer) : wxGraphicsObjectRefData(renderer) {}
-    virtual ~wxGraphicsPathData() {}
-
-    //
-    // These are the path primitives from which everything else can be constructed
-    //
-
-    // begins a new subpath at (x,y)
-    virtual void MoveToPoint( wxDouble x, wxDouble y ) = 0;
-
-    // adds a straight line from the current point to (x,y) 
-    virtual void AddLineToPoint( wxDouble x, wxDouble y ) = 0;
-
-    // adds a cubic Bezier curve from the current point, using two control points and an end point
-    virtual void AddCurveToPoint( wxDouble cx1, wxDouble cy1, wxDouble cx2, wxDouble cy2, wxDouble x, wxDouble y ) = 0;
-
-    // adds another path
-    virtual void AddPath( const wxGraphicsPathData* path ) =0;
-
-    // closes the current sub-path
-    virtual void CloseSubpath() = 0;
-
-    // gets the last point of the current path, (0,0) if not yet set
-    virtual void GetCurrentPoint( wxDouble* x, wxDouble* y) const = 0;
-
-    // adds an arc of a circle centering at (x,y) with radius (r) from startAngle to endAngle
-    virtual void AddArc( wxDouble x, wxDouble y, wxDouble r, wxDouble startAngle, wxDouble endAngle, bool clockwise ) = 0;
-
-    //
-    // These are convenience functions which - if not available natively will be assembled 
-    // using the primitives from above
-    //
-
-    // adds a quadratic Bezier curve from the current point, using a control point and an end point
-    virtual void AddQuadCurveToPoint( wxDouble cx, wxDouble cy, wxDouble x, wxDouble y );
-
-    // appends a rectangle as a new closed subpath 
-    virtual void AddRectangle( wxDouble x, wxDouble y, wxDouble w, wxDouble h );
-
-    // appends an ellipsis as a new closed subpath fitting the passed rectangle
-    virtual void AddCircle( wxDouble x, wxDouble y, wxDouble r );
-
-    // appends a an arc to two tangents connecting (current) to (x1,y1) and (x1,y1) to (x2,y2), also a straight line from (current) to (x1,y1)
-    virtual void AddArcToPoint( wxDouble x1, wxDouble y1 , wxDouble x2, wxDouble y2, wxDouble r ) ;
-
-    // appends an ellipse
-    virtual void AddEllipse( wxDouble x, wxDouble y, wxDouble w, wxDouble h);
-
-    // appends a rounded rectangle
-    virtual void AddRoundedRectangle( wxDouble x, wxDouble y, wxDouble w, wxDouble h, wxDouble radius);
-
-    // returns the native path
-    virtual void * GetNativePath() const = 0;
-
-    // give the native path returned by GetNativePath() back (there might be some deallocations necessary)
-    virtual void UnGetNativePath(void *p) const= 0;
-
-    // transforms each point of this path by the matrix
-    virtual void Transform( const wxGraphicsMatrixData* matrix ) =0;
-
-    // gets the bounding box enclosing all points (possibly including control points)
-    virtual void GetBox(wxDouble *x, wxDouble *y, wxDouble *w, wxDouble *h) const=0;
-
-    virtual bool Contains( wxDouble x, wxDouble y, int fillStyle = wxODDEVEN_RULE) const=0;
-};
+extern WXDLLIMPEXP_DATA_CORE(wxGraphicsMatrix) wxNullGraphicsMatrix;

 
 class WXDLLIMPEXP_CORE wxGraphicsPath : public wxGraphicsObject
 {
 
 class WXDLLIMPEXP_CORE wxGraphicsPath : public wxGraphicsObject
 {


@@ -375,7 +266,7 @@ private :
     DECLARE_DYNAMIC_CLASS(wxGraphicsPath)
 } ;
 
     DECLARE_DYNAMIC_CLASS(wxGraphicsPath)
 } ;
 

-extern WXDLLEXPORT_DATA(wxGraphicsPath) wxNullGraphicsPath;
+extern WXDLLIMPEXP_DATA_CORE(wxGraphicsPath) wxNullGraphicsPath;

 
 
 class WXDLLIMPEXP_CORE wxGraphicsContext : public wxGraphicsObject
 
 
 class WXDLLIMPEXP_CORE wxGraphicsContext : public wxGraphicsObject


@@ -386,13 +277,34 @@ public:
     virtual ~wxGraphicsContext();
     
     static wxGraphicsContext* Create( const wxWindowDC& dc) ;
     virtual ~wxGraphicsContext();
     
     static wxGraphicsContext* Create( const wxWindowDC& dc) ;

-    
+    static wxGraphicsContext * Create( const wxMemoryDC& dc) ;
+    static wxGraphicsContext * Create( const wxPrinterDC& dc) ;
+

     static wxGraphicsContext* CreateFromNative( void * context ) ;
 
     static wxGraphicsContext* CreateFromNativeWindow( void * window ) ;
 
     static wxGraphicsContext* Create( wxWindow* window ) ;
 
     static wxGraphicsContext* CreateFromNative( void * context ) ;
 
     static wxGraphicsContext* CreateFromNativeWindow( void * window ) ;
 
     static wxGraphicsContext* Create( wxWindow* window ) ;
 

+    // create a context that can be used for measuring texts only, no drawing allowed
+    static wxGraphicsContext * Create();
+
+    // begin a new document (relevant only for printing / pdf etc) if there is a progress dialog, message will be shown
+    virtual bool StartDoc( const wxString& message ) ;
+    
+    // done with that document (relevant only for printing / pdf etc) 
+    virtual void EndDoc();
+
+    // opens a new page  (relevant only for printing / pdf etc) with the given size in points 
+    // (if both are null the default page size will be used)
+    virtual void StartPage( wxDouble width = 0, wxDouble height = 0 );
+    
+    // ends the current page  (relevant only for printing / pdf etc) 
+    virtual void EndPage();
+    
+    // make sure that the current content of this context is immediately visible
+    virtual void Flush();
+

     wxGraphicsPath CreatePath() const;
     
     virtual wxGraphicsPen CreatePen(const wxPen& pen) const;
     wxGraphicsPath CreatePath() const;
     
     virtual wxGraphicsPen CreatePen(const wxPen& pen) const;


@@ -411,6 +323,12 @@ public:
     // sets the font
     virtual wxGraphicsFont CreateFont( const wxFont &font , const wxColour &col = *wxBLACK ) const;
 
     // sets the font
     virtual wxGraphicsFont CreateFont( const wxFont &font , const wxColour &col = *wxBLACK ) const;
 

+    // create a native bitmap representation
+    virtual wxGraphicsBitmap CreateBitmap( const wxBitmap &bitmap ) const;
+    
+    // create a native bitmap representation
+    virtual wxGraphicsBitmap CreateSubBitmap( const wxGraphicsBitmap &bitmap, wxDouble x, wxDouble y, wxDouble w, wxDouble h  ) const;
+

     // create a 'native' matrix corresponding to these values
     virtual wxGraphicsMatrix CreateMatrix( wxDouble a=1.0, wxDouble b=0.0, wxDouble c=0.0, wxDouble d=1.0, 
         wxDouble tx=0.0, wxDouble ty=0.0) const;
     // create a 'native' matrix corresponding to these values
     virtual wxGraphicsMatrix CreateMatrix( wxDouble a=1.0, wxDouble b=0.0, wxDouble c=0.0, wxDouble d=1.0, 
         wxDouble tx=0.0, wxDouble ty=0.0) const;


@@ -421,10 +339,10 @@ public:
     // pops a stored state from the stack
     virtual void PopState() = 0;
 
     // pops a stored state from the stack
     virtual void PopState() = 0;
 

-    // clips drawings to the region, combined to current clipping region
+    // clips drawings to the region intersected with the current clipping region

     virtual void Clip( const wxRegion &region ) = 0;
 
     virtual void Clip( const wxRegion &region ) = 0;
 

-    // clips drawings to the rect
+    // clips drawings to the rect intersected with the current clipping region

     virtual void Clip( wxDouble x, wxDouble y, wxDouble w, wxDouble h ) = 0;
     
     // resets the clipping to original extent
     virtual void Clip( wxDouble x, wxDouble y, wxDouble w, wxDouble h ) = 0;
     
     // resets the clipping to original extent


@@ -433,6 +351,25 @@ public:
     // returns the native context
     virtual void * GetNativeContext() = 0;
 
     // returns the native context
     virtual void * GetNativeContext() = 0;
 

+    // returns the current logical function
+    virtual int GetLogicalFunction() const { return m_logicalFunction; }
+    
+    // sets the current logical function, returns true if it supported
+    virtual bool SetLogicalFunction(int function) ;
+
+    // returns the size of the graphics context in device coordinates
+    virtual void GetSize( wxDouble* width, wxDouble* height);
+
+    // returns the resolution of the graphics context in device points per inch
+    virtual void GetDPI( wxDouble* dpiX, wxDouble* dpiY);
+    
+#if 0
+    // sets the current alpha on this context
+    virtual void SetAlpha( wxDouble alpha );
+    
+    // returns the alpha on this context
+    virtual wxDouble GetAlpha() const;
+#endif

     //
     // transformation : changes the current transformation matrix CTM of the context
     //
     //
     // transformation : changes the current transformation matrix CTM of the context
     //


@@ -491,6 +428,10 @@ public:
 
     virtual void DrawText( const wxString &str, wxDouble x, wxDouble y, wxDouble angle );
 
 
     virtual void DrawText( const wxString &str, wxDouble x, wxDouble y, wxDouble angle );
 

+    virtual void DrawText( const wxString &str, wxDouble x, wxDouble y, const wxGraphicsBrush& backgroundBrush ) ;
+
+    virtual void DrawText( const wxString &str, wxDouble x, wxDouble y, wxDouble angle, const wxGraphicsBrush& backgroundBrush );
+

     virtual void GetTextExtent( const wxString &text, wxDouble *width, wxDouble *height,
         wxDouble *descent, wxDouble *externalLeading ) const  = 0;
 
     virtual void GetTextExtent( const wxString &text, wxDouble *width, wxDouble *height,
         wxDouble *descent, wxDouble *externalLeading ) const  = 0;
 


@@ -500,6 +441,10 @@ public:
     // image support
     //
 
     // image support
     //
 

+#ifndef __WXGTK20__
+    virtual void DrawBitmap( const wxGraphicsBitmap &bmp, wxDouble x, wxDouble y, wxDouble w, wxDouble h ) = 0;
+#endif
+

     virtual void DrawBitmap( const wxBitmap &bmp, wxDouble x, wxDouble y, wxDouble w, wxDouble h ) = 0;
 
     virtual void DrawIcon( const wxIcon &icon, wxDouble x, wxDouble y, wxDouble w, wxDouble h ) = 0;
     virtual void DrawBitmap( const wxBitmap &bmp, wxDouble x, wxDouble y, wxDouble w, wxDouble h ) = 0;
 
     virtual void DrawIcon( const wxIcon &icon, wxDouble x, wxDouble y, wxDouble w, wxDouble h ) = 0;


@@ -539,6 +484,7 @@ protected :
     wxGraphicsPen m_pen;
     wxGraphicsBrush m_brush;
     wxGraphicsFont m_font;
     wxGraphicsPen m_pen;
     wxGraphicsBrush m_brush;
     wxGraphicsFont m_font;

+    int m_logicalFunction;

 
 private :
     DECLARE_NO_COPY_CLASS(wxGraphicsContext)
 
 private :
     DECLARE_NO_COPY_CLASS(wxGraphicsContext)


@@ -598,6 +544,8 @@ public :
     // Context
 
     virtual wxGraphicsContext * CreateContext( const wxWindowDC& dc) = 0 ;
     // Context
 
     virtual wxGraphicsContext * CreateContext( const wxWindowDC& dc) = 0 ;

+    virtual wxGraphicsContext * CreateContext( const wxMemoryDC& dc) = 0 ;
+    virtual wxGraphicsContext * CreateContext( const wxPrinterDC& dc) = 0 ;

     
     virtual wxGraphicsContext * CreateContextFromNativeContext( void * context ) = 0;
 
     
     virtual wxGraphicsContext * CreateContextFromNativeContext( void * context ) = 0;
 


@@ -605,6 +553,9 @@ public :
 
     virtual wxGraphicsContext * CreateContext( wxWindow* window ) = 0;
 
 
     virtual wxGraphicsContext * CreateContext( wxWindow* window ) = 0;
 

+    // create a context that can be used for measuring texts only, no drawing allowed
+    virtual wxGraphicsContext * CreateMeasuringContext() = 0;
+

     // Path
     
     virtual wxGraphicsPath CreatePath() = 0;
     // Path
     
     virtual wxGraphicsPath CreatePath() = 0;


@@ -631,7 +582,16 @@ public :
 
    // sets the font
     virtual wxGraphicsFont CreateFont( const wxFont &font , const wxColour &col = *wxBLACK ) = 0;
 
    // sets the font
     virtual wxGraphicsFont CreateFont( const wxFont &font , const wxColour &col = *wxBLACK ) = 0;

+
+#ifndef __WXGTK20__    
+    // create a native bitmap representation
+    virtual wxGraphicsBitmap CreateBitmap( const wxBitmap &bitmap ) = 0;

     
     

+    // create a subimage from a native image representation
+    virtual wxGraphicsBitmap CreateSubBitmap( const wxGraphicsBitmap &bitmap, wxDouble x, wxDouble y, wxDouble w, wxDouble h  ) = 0;
+#endif
+
+

 private :
     DECLARE_NO_COPY_CLASS(wxGraphicsRenderer)
     DECLARE_ABSTRACT_CLASS(wxGraphicsRenderer)
 private :
     DECLARE_NO_COPY_CLASS(wxGraphicsRenderer)
     DECLARE_ABSTRACT_CLASS(wxGraphicsRenderer)