Add RunScript and implement on all backends. Document and add a very simple unit...

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

diff --git a/include/wx/dcsvg.h b/include/wx/dcsvg.h
index 12e18db630a95692118e33f703a24cb370ca9116..cf492e7938160134cacd958cc386ebce052358bf 100644 (file)
--- a/include/wx/dcsvg.h
+++ b/include/wx/dcsvg.h
@@ -1,323 +1,219 @@
-#ifndef __DCSVG_H
-#define __DCSVG_H
-#include <wx/wfstream.h>
-#include <wx/string.h>
+/////////////////////////////////////////////////////////////////////////////
+// Name:        wx/dcsvg.h
+// Purpose:     wxSVGFileDC
+// Author:      Chris Elliott
+// Modified by:
+// Created:
+// Copyright:   (c) Chris Elliott
+// RCS-ID:      $Id$
+// Licence:     wxWindows licence
+/////////////////////////////////////////////////////////////////////////////

 
 

-#define wxSVGVersion wxT("v0100")
-#ifdef __BORLANDC__
-#pragma warn -rch
-#pragma warn -ccc
-#endif
-
-//-----------------------------------------------------------------------------
-// constants
-//-----------------------------------------------------------------------------
-
-#define mm2inches        0.0393700787402
-#define inches2mm        25.4
-#define mm2twips         56.6929133859
-#define twips2mm         0.0176388888889
-#define mm2pt            2.83464566929
-#define pt2mm            0.352777777778
-
-class wxSVGFileDC : public wxDC
-{
-
-    private:
-        wxFileOutputStream * m_outfile ;
-        wxString m_filename ;
-        //holds number of png format images we have
-        int m_sub_images ;
-        bool m_OK, m_graphics_changed ;
-        int m_width, m_height ;
- 
-        double       
-            m_logicalScaleX,
-            m_logicalScaleY,
-            m_userScaleX,
-            m_userScaleY,
-            m_scaleX,
-            m_scaleY,
-           m_OriginX,  
-            m_OriginY,
-            m_mm_to_pix_x,
-            m_mm_to_pix_y;
-
-        bool         
-               m_needComputeScaleX,
-            m_needComputeScaleY; // not yet used
-            
-
-        bool DoGetPixel(wxCoord, wxCoord, class wxColour *) const 
-            { wxASSERT_MSG (FALSE, wxT("wxSVGFILEDC::DoGetPixel Call not implemented")); return TRUE ; };
-
-        virtual bool DoBlit(wxCoord, wxCoord, wxCoord, wxCoord, class wxDC *,
-            wxCoord, wxCoord, int = wxCOPY, bool = 0, int = -1, int = -1) ;
-
-        void DoCrossHair(wxCoord, wxCoord)            
-            { wxASSERT_MSG (FALSE, wxT("wxSVGFILEDC::CrossHair Call not implemented")); return  ; };
-
-        void DoDrawArc(wxCoord, wxCoord, wxCoord, wxCoord, wxCoord, wxCoord);
-
-        void DoDrawBitmap(const class wxBitmap &, wxCoord, wxCoord, bool = 0) ;
-
-        void DoDrawCheckMark(wxCoord x, wxCoord y, wxCoord width, wxCoord height) ;
-
-        void DoDrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height) ;
-
-        void DoDrawEllipticArc(wxCoord x,wxCoord y,wxCoord w,wxCoord h,double sa,double ea) ;
-
-        void DoDrawIcon(const class wxIcon &, wxCoord, wxCoord) ;
-
-        void DoDrawLine (wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2) ;
-
-        void DoDrawPoint(wxCoord, wxCoord) ;
-
-        void DoDrawPolygon(int n, wxPoint points[], wxCoord xoffset, wxCoord yoffset,int fillStyle) ;
-
-        void DoDrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height) ;
-
-        void DoDrawRotatedText(const wxString& text, wxCoord x, wxCoord y, double angle) ;
-
-        void DoDrawRoundedRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height, double radius = 20)  ;
-
-        void DoDrawText(const wxString& text, wxCoord x, wxCoord y);
+#ifndef _WX_DCSVG_H_
+#define _WX_DCSVG_H_

 
 

-        bool DoFloodFill(wxCoord x, wxCoord y, const wxColour& col,
-                             int style = wxFLOOD_SURFACE)
-            { wxASSERT_MSG (FALSE, wxT("wxSVGFILEDC::DoFloodFill Call not implemented")); return FALSE ; };
+#include "wx/string.h"
+#include "wx/dc.h"

 
 

-        void DoGetSize(int * x, int *y) const { *x = m_width; *y = m_height ; return ; } ;
+#if wxUSE_SVG

 
 

-        void DoGetTextExtent(const wxString& string, wxCoord *w, wxCoord *h, wxCoord *descent = NULL, wxCoord *externalLeading = NULL, wxFont *font = NULL) const ;
-
-        void DoSetClippingRegionAsRegion(const class wxRegion &)            
-            { wxASSERT_MSG (FALSE, wxT("wxSVGFILEDC::DoSetClippingRegionAsRegion Call not yet implemented")); return  ; };
-
-       void Init (wxString f, int Width, int Height, float dpi);
-
-       void NewGraphics () ;
+#define wxSVGVersion wxT("v0100")

 
 

-#ifdef XDEV2LOG
-#undef XDEV2LOG
-#endif
-        wxCoord XDEV2LOG(wxCoord x) const
-        {
-            wxCoord new_x = x - m_deviceOriginX;
-            if (new_x > 0)
-                return (wxCoord)((double)(new_x) / m_scaleX + 0.5) * m_signX + m_logicalOriginX;
-            else
-                return (wxCoord)((double)(new_x) / m_scaleX - 0.5) * m_signX + m_logicalOriginX;
-        }
-#ifdef XDEV2LOGREL
-#undef XDEV2LOGREL
-#endif
-        wxCoord XDEV2LOGREL(wxCoord x) const
-        {
-            if (x > 0)
-                return (wxCoord)((double)(x) / m_scaleX + 0.5);
-            else
-                return (wxCoord)((double)(x) / m_scaleX - 0.5);
-        }
-#ifdef YDEV2LOG
-#undef YDEV2LOG
-#endif
-        wxCoord YDEV2LOG(wxCoord y) const
-        {
-            wxCoord new_y = y - m_deviceOriginY;
-            if (new_y > 0)
-                return (wxCoord)((double)(new_y) / m_scaleY + 0.5) * m_signY + m_logicalOriginY;
-            else
-                return (wxCoord)((double)(new_y) / m_scaleY - 0.5) * m_signY + m_logicalOriginY;
-        }
-#ifdef YDEV2LOGREL
-#undef YDEV2LOGREL
-#endif
-        wxCoord YDEV2LOGREL(wxCoord y) const
-        {
-            if (y > 0)
-                return (wxCoord)((double)(y) / m_scaleY + 0.5);
-            else
-                return (wxCoord)((double)(y) / m_scaleY - 0.5);
-        }
-#ifdef XLOG2DEV
-#undef XLOG2DEV
-#endif
-        wxCoord XLOG2DEV(wxCoord x) const
-        {
-            wxCoord new_x = x - m_logicalOriginX;
-            if (new_x > 0)
-                return (wxCoord)((double)(new_x) * m_scaleX + 0.5) * m_signX + m_deviceOriginX;
-            else
-                return (wxCoord)((double)(new_x) * m_scaleX - 0.5) * m_signX + m_deviceOriginX;
-        }
-#ifdef XLOG2DEVREL
-#undef XLOG2DEVREL
-#endif
-        wxCoord XLOG2DEVREL(wxCoord x) const
-        {
-            if (x > 0)
-                return (wxCoord)((double)(x) * m_scaleX + 0.5);
-            else
-                return (wxCoord)((double)(x) * m_scaleX - 0.5);
-        }
-#ifdef YLOG2DEV
-#undef YLOG2DEV
-#endif
-        wxCoord YLOG2DEV(wxCoord y) const
-        {
-            wxCoord new_y = y - m_logicalOriginY;
-            if (new_y > 0)
-                return (wxCoord)((double)(new_y) * m_scaleY + 0.5) * m_signY + m_deviceOriginY;
-            else
-                return (wxCoord)((double)(new_y) * m_scaleY - 0.5) * m_signY + m_deviceOriginY;
-        }
-#ifdef YLOG2DEVREL
-#undef YLOG2DEVREL
+#ifdef __BORLANDC__
+#pragma warn -8008
+#pragma warn -8066

 #endif
 #endif

-        wxCoord YLOG2DEVREL(wxCoord y) const
-        {
-            if (y > 0)
-                return (wxCoord)((double)(y) * m_scaleY + 0.5);
-            else
-                return (wxCoord)((double)(y) * m_scaleY - 0.5);
-        }
-

 
 

-    public:
+class WXDLLIMPEXP_FWD_BASE wxFileOutputStream;

 
 

-        wxSVGFileDC (wxString f);
-        wxSVGFileDC (wxString f, int Width, int Height);
-        wxSVGFileDC (wxString f, int Width, int Height, float dpi);
-        ~wxSVGFileDC();

 
 
 
 

-        bool CanDrawBitmap() const { return TRUE ; };
+class WXDLLIMPEXP_FWD_CORE wxSVGFileDC;

 
 

-        bool CanGetTextExtent() const { return TRUE ; };
-
-        int GetDepth() const
-            { wxASSERT_MSG (FALSE, wxT("wxSVGFILEDC::GetDepth Call not implemented")); return -1 ; };
- 
-        void BeginDrawing() { return;};
-
-        bool Blit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height, wxDC* source, wxCoord xsrc, wxCoord ysrc, int logicalFunc = wxCOPY, bool useMask = FALSE)
-            { return DoBlit(xdest, ydest, width, height, source, xsrc, ysrc, logicalFunc, useMask); };
-
-        void Clear()
-            { wxASSERT_MSG (FALSE, wxT("wxSVGFILEDC::Clear() Call not implemented \nNot sensible for an output file?")); return ; };
-
-        void CrossHair(wxCoord x, wxCoord y)
-            { DoCrossHair (x,y); return; };
-
-        void ComputeScaleAndOrigin() ;
+class WXDLLIMPEXP_CORE wxSVGFileDCImpl : public wxDCImpl
+{
+public:
+    wxSVGFileDCImpl( wxSVGFileDC *owner, const wxString &filename,
+                     int width=320, int height=240, double dpi=72.0 );

 
 

-        void DestroyClippingRegion()
-            { wxASSERT_MSG (FALSE, wxT("wxSVGFILEDC::void Call not yet implemented")); return ; };
+    virtual ~wxSVGFileDCImpl();

 
 

-        wxCoord DeviceToLogicalX(wxCoord x) const ;
+    bool IsOk() const { return m_OK; }

 
 

-        wxCoord DeviceToLogicalXRel(wxCoord x)  const ;
+    virtual bool CanDrawBitmap() const { return true; }
+    virtual bool CanGetTextExtent() const { return true; }

 
 

-        wxCoord DeviceToLogicalY(wxCoord y)  const ;
+    virtual int GetDepth() const
+    {
+        wxFAIL_MSG(wxT("wxSVGFILEDC::GetDepth Call not implemented"));
+        return -1;
+    }

 
 

-        wxCoord DeviceToLogicalYRel(wxCoord y)  const ;
+    virtual void Clear()
+    {
+        wxFAIL_MSG(wxT("wxSVGFILEDC::Clear() Call not implemented \nNot sensible for an output file?"));
+    }

 
 

-        void DrawBitmap(const wxBitmap& bitmap, wxCoord x, wxCoord y, bool transparent)
-            {  DoDrawBitmap ( bitmap, x, y, transparent ) ; return ;};
+    virtual void DestroyClippingRegion()
+    {
+        wxFAIL_MSG(wxT("wxSVGFILEDC::void Call not yet implemented"));
+    }

 
 

- 
-        void DrawIcon(const wxIcon& icon, wxCoord x, wxCoord y)
-            {DoDrawIcon(icon, x, y) ; return ; };
+    virtual wxCoord GetCharHeight() const;
+    virtual wxCoord GetCharWidth() const;

 
 

-        void DoDrawLines(int n, wxPoint points[], wxCoord xoffset = 0, wxCoord yoffset = 0) ;
+    virtual void SetClippingRegion(wxCoord WXUNUSED(x), wxCoord WXUNUSED(y),
+                                   wxCoord WXUNUSED(w), wxCoord WXUNUSED(h))
+    {
+        wxFAIL_MSG(wxT("wxSVGFILEDC::SetClippingRegion not implemented"));
+    }

 
 

-        void EndDoc()
-            { return ; };
+    virtual void SetPalette(const wxPalette&  WXUNUSED(palette))
+    {
+        wxFAIL_MSG(wxT("wxSVGFILEDC::SetPalette not implemented"));
+    }

 
 

-        void EndDrawing()
-            { return ; };
+    virtual void GetClippingBox(wxCoord *WXUNUSED(x), wxCoord *WXUNUSED(y),
+                                wxCoord *WXUNUSED(w), wxCoord *WXUNUSED(h))
+    {
+        wxFAIL_MSG(wxT("wxSVGFILEDC::GetClippingBox not implemented"));
+    }

 
 

-        void EndPage()
-            {  return ; };
+    virtual void SetLogicalFunction(wxRasterOperationMode WXUNUSED(function))
+    {
+        wxFAIL_MSG(wxT("wxSVGFILEDC::SetLogicalFunction Call not implemented"));
+    }

 
 

-        void FloodFill(wxCoord x, wxCoord y, wxColour *colour, int style=wxFLOOD_SURFACE)
-            { DoFloodFill (x, y, *colour, style); return ;} ;
+    virtual wxRasterOperationMode GetLogicalFunction() const
+    {
+        wxFAIL_MSG(wxT("wxSVGFILEDC::GetLogicalFunction() not implemented"));
+        return wxCOPY;
+    }

 
 

-        wxCoord GetCharHeight() const;
+    virtual void SetBackground( const wxBrush &brush );
+    virtual void SetBackgroundMode( int mode );
+    virtual void SetBrush(const wxBrush& brush);
+    virtual void SetFont(const wxFont& font);
+    virtual void SetPen(const wxPen& pen);

 
 

-        wxCoord GetCharWidth() const;
+private:
+   virtual bool DoGetPixel(wxCoord, wxCoord, wxColour *) const
+   {
+       wxFAIL_MSG(wxT("wxSVGFILEDC::DoGetPixel Call not implemented"));
+       return true;
+   }

 
 

-        void GetClippingBox(wxCoord *x, wxCoord *y, wxCoord *width, wxCoord *height)
-            { wxASSERT_MSG (FALSE, wxT("wxSVGFILEDC::GetClippingBox Call not yet implemented")); return ; };
+   virtual bool DoBlit(wxCoord, wxCoord, wxCoord, wxCoord, wxDC *,
+                       wxCoord, wxCoord, wxRasterOperationMode = wxCOPY,
+                       bool = 0, int = -1, int = -1);

 
 

-        int GetLogicalFunction()
-            { wxASSERT_MSG (FALSE, wxT("wxSVGFILEDC::GetLogicalFunction()  Call not implemented")); return wxCOPY ; };
+   virtual void DoCrossHair(wxCoord, wxCoord)
+   {
+       wxFAIL_MSG(wxT("wxSVGFILEDC::CrossHair Call not implemented"));
+   }

 
 

-        int GetMapMode() ;
+   virtual void DoDrawArc(wxCoord, wxCoord, wxCoord, wxCoord, wxCoord, wxCoord);

 
 

-        bool GetOptimization()
-            { wxASSERT_MSG (FALSE, wxT("wxSVGFILEDC::GetOptimization()  No optimization code used")); return TRUE ; };
+   virtual void DoDrawBitmap(const wxBitmap &, wxCoord, wxCoord, bool = false);

 
 

-        bool GetPixel(wxCoord x, wxCoord y, wxColour *colour)
-            { return DoGetPixel (x, y, colour) ; } ;
+   virtual void DoDrawCheckMark(wxCoord x, wxCoord y, wxCoord w, wxCoord h);

 
 

-        void GetUserScale(double *x, double *y) const ;
+   virtual void DoDrawEllipse(wxCoord x, wxCoord y, wxCoord w, wxCoord h);

 
 

-        wxCoord LogicalToDeviceX(wxCoord x)  const ;
+   virtual void DoDrawEllipticArc(wxCoord x, wxCoord y, wxCoord w, wxCoord h,
+                                  double sa, double ea);

 
 

-        wxCoord LogicalToDeviceXRel(wxCoord x)  const ;
+   virtual void DoDrawIcon(const wxIcon &, wxCoord, wxCoord);

 
 

-        wxCoord LogicalToDeviceY(wxCoord y)  const ;
+   virtual void DoDrawLine (wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2);

 
 

-        wxCoord LogicalToDeviceYRel(wxCoord y)  const ;
+   virtual void DoDrawLines(int n, wxPoint points[],
+                            wxCoord xoffset = 0, wxCoord yoffset = 0);

 
 

-        bool Ok() const {return m_OK;};
+   virtual void DoDrawPoint(wxCoord, wxCoord);

 
 

-        void SetAxisOrientation( bool xLeftRight, bool yBottomUp ) ;
+   virtual void DoDrawPolygon(int n, wxPoint points[],
+                              wxCoord xoffset, wxCoord yoffset,
+                              wxPolygonFillMode fillStyle);

 
 

-        void SetClippingRegion(wxCoord x, wxCoord y, wxCoord width, wxCoord height)
-            { wxASSERT_MSG (FALSE, wxT("wxSVGFILEDC::SetClippingRegion Call not yet implemented")); return ; };
+   virtual void DoDrawRectangle(wxCoord x, wxCoord y, wxCoord w, wxCoord h);

 
 

-        void SetPalette(const wxPalette& palette)
-            { wxASSERT_MSG (FALSE, wxT("wxSVGFILEDC::SetPalette Call not yet implemented")); return ; };
+   virtual void DoDrawRotatedText(const wxString& text, wxCoord x, wxCoord y,
+                                  double angle);

 
 

-        void SetBackground( const wxBrush &brush ) ;
+   virtual void DoDrawRoundedRectangle(wxCoord x, wxCoord y,
+                                       wxCoord w, wxCoord h,
+                                       double radius = 20) ;

 
 

-        void SetBackgroundMode( int mode ) ;
+   virtual void DoDrawText(const wxString& text, wxCoord x, wxCoord y);

 
 

-        void SetBrush(const wxBrush& brush) ;
+   virtual bool DoFloodFill(wxCoord WXUNUSED(x), wxCoord WXUNUSED(y),
+                            const wxColour& WXUNUSED(col),
+                            wxFloodFillStyle WXUNUSED(style) = wxFLOOD_SURFACE)
+   {
+       wxFAIL_MSG(wxT("wxSVGFILEDC::DoFloodFill Call not implemented"));
+       return false;
+   }

 
 

-        void SetFont(const wxFont& font) ;
+   virtual void DoGetSize(int * x, int *y) const
+   {
+       if ( x )
+           *x = m_width;
+       if ( y )
+           *y = m_height;
+   }

 
 

-        void SetLogicalFunction(int function)
-            { wxASSERT_MSG (FALSE, wxT("wxSVGFILEDC::SetLogicalFunction Call implemented")); return ; };
+   virtual void DoGetTextExtent(const wxString& string, wxCoord *w, wxCoord *h,
+                                wxCoord *descent = NULL,
+                                wxCoord *externalLeading = NULL,
+                                const wxFont *font = NULL) const;

 
 

-        void SetLogicalScale( double x, double y ) ;
+   virtual void DoSetDeviceClippingRegion(const wxRegion& WXUNUSED(region))
+   {
+       wxFAIL_MSG(wxT("wxSVGFILEDC::DoSetDeviceClippingRegion not yet implemented"));
+   }

 
 

-        void SetLogicalOrigin( wxCoord x, wxCoord y ) ;
+   virtual void DoSetClippingRegion( int WXUNUSED(x),  int WXUNUSED(y), int WXUNUSED(width), int WXUNUSED(height) )
+   {
+       wxFAIL_MSG(wxT("wxSVGFILEDC::DoSetClippingRegion not yet implemented"));
+   }

 
 

-        void SetDeviceOrigin( wxCoord x, wxCoord y ) ;
+   virtual void DoGetSizeMM( int *width, int *height ) const;

 
 

-        void SetMapMode(int anint) ;
+   virtual wxSize GetPPI() const;

 
 

-        void SetOptimization(bool optimize) { return ; };
+   void Init (const wxString &filename, int width, int height, double dpi);

 
 

-        void SetPen(const wxPen& pen)  ;
+   void NewGraphics();

 
 

-        void SetUserScale(double xScale, double yScale) ;
+   void write( const wxString &s );

 
 

-        bool StartDoc(const wxString& message)
-            {  return FALSE; };
+private:
+   wxFileOutputStream *m_outfile;
+   wxString            m_filename;
+   int                 m_sub_images; // number of png format images we have
+   bool                m_OK;
+   bool                m_graphics_changed;
+   int                 m_width, m_height;
+   double              m_dpi;

 
 

-        void StartPage()
-            {  return ; };
+private:
+   DECLARE_ABSTRACT_CLASS(wxSVGFileDCImpl)
+};

 
 
 
 

+class WXDLLIMPEXP_CORE wxSVGFileDC : public wxDC
+{
+public:
+    wxSVGFileDC(const wxString& filename,
+                int width = 320,
+                int height = 240,
+                double dpi = 72.0)
+        : wxDC(new wxSVGFileDCImpl(this, filename, width, height, dpi))
+    {
+    }

 };
 
 };
 

-#ifdef __BORLANDC__
-#pragma warn .rch
-#pragma warn .ccc
-#endif
-#endif
+#endif // wxUSE_SVG
+
+#endif // _WX_DCSVG_H_