Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/dcsvg.h b/include/wx/dcsvg.h
index b4eb84afa157755420ef01899265299bb6ad1ed7..ee99a8e703cd4140b367142805b20a693241597b 100644 (file)
--- a/include/wx/dcsvg.h
+++ b/include/wx/dcsvg.h
@@ -28,16 +28,16 @@ class WXDLLIMPEXP_FWD_BASE wxFileOutputStream;
 
 
 
 
 
 

-class WXDLLIMPEXP_FWD_BASE wxSVGFileDC;
+class WXDLLIMPEXP_FWD_CORE wxSVGFileDC;

 
 class WXDLLIMPEXP_CORE wxSVGFileDCImpl : public wxDCImpl
 {
 public:
 
 class WXDLLIMPEXP_CORE wxSVGFileDCImpl : public wxDCImpl
 {
 public:

-    wxSVGFileDCImpl( wxSVGFileDC *owner, const wxString &filename, 
+    wxSVGFileDCImpl( wxSVGFileDC *owner, const wxString &filename,

                      int width=320, int height=240, double dpi=72.0 );
 
     virtual ~wxSVGFileDCImpl();
                      int width=320, int height=240, double dpi=72.0 );
 
     virtual ~wxSVGFileDCImpl();

-    
+

     bool IsOk() const { return m_OK; }
 
     virtual bool CanDrawBitmap() const { return true; }
     bool IsOk() const { return m_OK; }
 
     virtual bool CanDrawBitmap() const { return true; }


@@ -54,10 +54,7 @@ public:
         wxFAIL_MSG(wxT("wxSVGFILEDC::Clear() Call not implemented \nNot sensible for an output file?"));
     }
 
         wxFAIL_MSG(wxT("wxSVGFILEDC::Clear() Call not implemented \nNot sensible for an output file?"));
     }
 

-    virtual void DestroyClippingRegion()
-    {
-        wxFAIL_MSG(wxT("wxSVGFILEDC::void Call not yet implemented"));
-    }
+    virtual void DestroyClippingRegion();

 
     virtual wxCoord GetCharHeight() const;
     virtual wxCoord GetCharWidth() const;
 
     virtual wxCoord GetCharHeight() const;
     virtual wxCoord GetCharWidth() const;


@@ -79,15 +76,15 @@ public:
         wxFAIL_MSG(wxT("wxSVGFILEDC::GetClippingBox not implemented"));
     }
 
         wxFAIL_MSG(wxT("wxSVGFILEDC::GetClippingBox not implemented"));
     }
 

-    virtual void SetLogicalFunction(int WXUNUSED(function))
+    virtual void SetLogicalFunction(wxRasterOperationMode WXUNUSED(function))

     {
         wxFAIL_MSG(wxT("wxSVGFILEDC::SetLogicalFunction Call not implemented"));
     }
 
     {
         wxFAIL_MSG(wxT("wxSVGFILEDC::SetLogicalFunction Call not implemented"));
     }
 

-    virtual int GetLogicalFunction() const
+    virtual wxRasterOperationMode GetLogicalFunction() const

     {
         wxFAIL_MSG(wxT("wxSVGFILEDC::GetLogicalFunction() not implemented"));
     {
         wxFAIL_MSG(wxT("wxSVGFILEDC::GetLogicalFunction() not implemented"));

-        return -1;
+        return wxCOPY;

     }
 
     virtual void SetBackground( const wxBrush &brush );
     }
 
     virtual void SetBackground( const wxBrush &brush );


@@ -96,6 +93,8 @@ public:
     virtual void SetFont(const wxFont& font);
     virtual void SetPen(const wxPen& pen);
 
     virtual void SetFont(const wxFont& font);
     virtual void SetPen(const wxPen& pen);
 

+    virtual void* GetHandle() const { return NULL; }
+

 private:
    virtual bool DoGetPixel(wxCoord, wxCoord, wxColour *) const
    {
 private:
    virtual bool DoGetPixel(wxCoord, wxCoord, wxColour *) const
    {


@@ -104,7 +103,7 @@ private:
    }
 
    virtual bool DoBlit(wxCoord, wxCoord, wxCoord, wxCoord, wxDC *,
    }
 
    virtual bool DoBlit(wxCoord, wxCoord, wxCoord, wxCoord, wxDC *,

-                       wxCoord, wxCoord, int = wxCOPY,
+                       wxCoord, wxCoord, wxRasterOperationMode = wxCOPY,

                        bool = 0, int = -1, int = -1);
 
    virtual void DoCrossHair(wxCoord, wxCoord)
                        bool = 0, int = -1, int = -1);
 
    virtual void DoCrossHair(wxCoord, wxCoord)


@@ -114,7 +113,7 @@ private:
 
    virtual void DoDrawArc(wxCoord, wxCoord, wxCoord, wxCoord, wxCoord, wxCoord);
 
 
    virtual void DoDrawArc(wxCoord, wxCoord, wxCoord, wxCoord, wxCoord, wxCoord);
 

-   virtual void DoDrawBitmap(const wxBitmap &, wxCoord, wxCoord, bool = 0);
+   virtual void DoDrawBitmap(const wxBitmap &, wxCoord, wxCoord, bool = false);

 
    virtual void DoDrawCheckMark(wxCoord x, wxCoord y, wxCoord w, wxCoord h);
 
 
    virtual void DoDrawCheckMark(wxCoord x, wxCoord y, wxCoord w, wxCoord h);
 


@@ -127,12 +126,14 @@ private:
 
    virtual void DoDrawLine (wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2);
 
 
    virtual void DoDrawLine (wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2);
 

-   virtual void DoDrawLines(int n, wxPoint points[],
+   virtual void DoDrawLines(int n, const wxPoint points[],

                             wxCoord xoffset = 0, wxCoord yoffset = 0);
 
    virtual void DoDrawPoint(wxCoord, wxCoord);
 
                             wxCoord xoffset = 0, wxCoord yoffset = 0);
 
    virtual void DoDrawPoint(wxCoord, wxCoord);
 

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

 
    virtual void DoDrawRectangle(wxCoord x, wxCoord y, wxCoord w, wxCoord h);
 
 
    virtual void DoDrawRectangle(wxCoord x, wxCoord y, wxCoord w, wxCoord h);
 


@@ -147,7 +148,7 @@ private:
 
    virtual bool DoFloodFill(wxCoord WXUNUSED(x), wxCoord WXUNUSED(y),
                             const wxColour& WXUNUSED(col),
 
    virtual bool DoFloodFill(wxCoord WXUNUSED(x), wxCoord WXUNUSED(y),
                             const wxColour& WXUNUSED(col),

-                            int WXUNUSED(style) = wxFLOOD_SURFACE)
+                            wxFloodFillStyle WXUNUSED(style) = wxFLOOD_SURFACE)

    {
        wxFAIL_MSG(wxT("wxSVGFILEDC::DoFloodFill Call not implemented"));
        return false;
    {
        wxFAIL_MSG(wxT("wxSVGFILEDC::DoFloodFill Call not implemented"));
        return false;


@@ -166,36 +167,46 @@ private:
                                 wxCoord *externalLeading = NULL,
                                 const wxFont *font = NULL) const;
 
                                 wxCoord *externalLeading = NULL,
                                 const wxFont *font = NULL) const;
 

-   virtual void DoSetClippingRegionAsRegion(const wxRegion& WXUNUSED(region))
+   virtual void DoSetDeviceClippingRegion(const wxRegion& WXUNUSED(region))

    {
    {

-       wxFAIL_MSG(wxT("wxSVGFILEDC::DoSetClippingRegionAsRegion not yet implemented"));
+       wxFAIL_MSG(wxT("wxSVGFILEDC::DoSetDeviceClippingRegion not yet implemented"));

    }
 
    }
 

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

 
    virtual void DoGetSizeMM( int *width, int *height ) const;
 
    virtual void DoGetSizeMM( int *width, int *height ) const;

-   
+

    virtual wxSize GetPPI() const;
 
    void Init (const wxString &filename, int width, int height, double dpi);
 
    virtual wxSize GetPPI() const;
 
    void Init (const wxString &filename, int width, int height, double dpi);
 

-   void NewGraphics();
-

    void write( const wxString &s );
 
 private:
    void write( const wxString &s );
 
 private:

+   // If m_graphics_changed is true, close the current <g> element and start a
+   // new one for the last pen/brush change.
+   void NewGraphicsIfNeeded();
+
+   // Open a new graphics group setting up all the attributes according to
+   // their current values in wxDC.
+   void DoStartNewGraphics();
+

    wxFileOutputStream *m_outfile;
    wxString            m_filename;
    int                 m_sub_images; // number of png format images we have
    bool                m_OK;
    wxFileOutputStream *m_outfile;
    wxString            m_filename;
    int                 m_sub_images; // number of png format images we have
    bool                m_OK;

-   bool                m_graphics_changed;
+   bool                m_graphics_changed;  // set by Set{Brush,Pen}()

    int                 m_width, m_height;
    double              m_dpi;
 
    int                 m_width, m_height;
    double              m_dpi;
 

-private:
+   // The clipping nesting level is incremented by every call to
+   // SetClippingRegion() and reset when DestroyClippingRegion() is called.
+   size_t m_clipNestingLevel;
+
+   // Unique ID for every clipping graphics group: this is simply always
+   // incremented in each SetClippingRegion() call.
+   size_t m_clipUniqueId;
+

    DECLARE_ABSTRACT_CLASS(wxSVGFileDCImpl)
 };
 
    DECLARE_ABSTRACT_CLASS(wxSVGFileDCImpl)
 };
 


@@ -203,10 +214,12 @@ private:
 class WXDLLIMPEXP_CORE wxSVGFileDC : public wxDC
 {
 public:
 class WXDLLIMPEXP_CORE wxSVGFileDC : public wxDC
 {
 public:

-    wxSVGFileDC( const wxString &filename, 
-                 int width=320, int height=240, double dpi=72.0 )
-    { 
-        m_pimpl = new wxSVGFileDCImpl( this, filename, width, height, dpi );
+    wxSVGFileDC(const wxString& filename,
+                int width = 320,
+                int height = 240,
+                double dpi = 72.0)
+        : wxDC(new wxSVGFileDCImpl(this, filename, width, height, dpi))
+    {

     }
 };
 
     }
 };