Minor corrections to make dist after reports

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

diff --git a/include/wx/dc.h b/include/wx/dc.h
index f0fe623aa7da8ca63fc75bb2a5068e4b6d4d1c37..10e091b2289f53cbd5c036c06529b27d2eb51257 100644 (file)
--- a/include/wx/dc.h
+++ b/include/wx/dc.h
@@ -116,11 +116,8 @@ public:
     wxDCFactory() {}
     virtual ~wxDCFactory() {}
 
     wxDCFactory() {}
     virtual ~wxDCFactory() {}
 

-    virtual wxDCImpl* CreateWindowDC( wxWindowDC *owner ) = 0;

     virtual wxDCImpl* CreateWindowDC( wxWindowDC *owner, wxWindow *window ) = 0;
     virtual wxDCImpl* CreateWindowDC( wxWindowDC *owner, wxWindow *window ) = 0;

-    virtual wxDCImpl* CreateClientDC( wxClientDC *owner ) = 0;

     virtual wxDCImpl* CreateClientDC( wxClientDC *owner, wxWindow *window ) = 0;
     virtual wxDCImpl* CreateClientDC( wxClientDC *owner, wxWindow *window ) = 0;

-    virtual wxDCImpl* CreatePaintDC( wxPaintDC *owner ) = 0;

     virtual wxDCImpl* CreatePaintDC( wxPaintDC *owner, wxWindow *window ) = 0;
     virtual wxDCImpl* CreateMemoryDC( wxMemoryDC *owner ) = 0;
     virtual wxDCImpl* CreateMemoryDC( wxMemoryDC *owner, wxBitmap &bitmap ) = 0;
     virtual wxDCImpl* CreatePaintDC( wxPaintDC *owner, wxWindow *window ) = 0;
     virtual wxDCImpl* CreateMemoryDC( wxMemoryDC *owner ) = 0;
     virtual wxDCImpl* CreateMemoryDC( wxMemoryDC *owner, wxBitmap &bitmap ) = 0;


@@ -146,11 +143,8 @@ class WXDLLIMPEXP_CORE wxNativeDCFactory: public wxDCFactory
 public:
     wxNativeDCFactory() {}
 
 public:
     wxNativeDCFactory() {}
 

-    virtual wxDCImpl* CreateWindowDC( wxWindowDC *owner );

     virtual wxDCImpl* CreateWindowDC( wxWindowDC *owner, wxWindow *window );
     virtual wxDCImpl* CreateWindowDC( wxWindowDC *owner, wxWindow *window );

-    virtual wxDCImpl* CreateClientDC( wxClientDC *owner );

     virtual wxDCImpl* CreateClientDC( wxClientDC *owner, wxWindow *window );
     virtual wxDCImpl* CreateClientDC( wxClientDC *owner, wxWindow *window );

-    virtual wxDCImpl* CreatePaintDC( wxPaintDC *owner );

     virtual wxDCImpl* CreatePaintDC( wxPaintDC *owner, wxWindow *window );
     virtual wxDCImpl* CreateMemoryDC( wxMemoryDC *owner );
     virtual wxDCImpl* CreateMemoryDC( wxMemoryDC *owner, wxBitmap &bitmap );
     virtual wxDCImpl* CreatePaintDC( wxPaintDC *owner, wxWindow *window );
     virtual wxDCImpl* CreateMemoryDC( wxMemoryDC *owner );
     virtual wxDCImpl* CreateMemoryDC( wxMemoryDC *owner, wxBitmap &bitmap );


@@ -169,7 +163,7 @@ class WXDLLIMPEXP_CORE wxDCImpl: public wxObject
 {
 public:
     wxDCImpl( wxDC *owner );
 {
 public:
     wxDCImpl( wxDC *owner );

-    ~wxDCImpl();
+    virtual ~wxDCImpl();

 
     wxDC *GetOwner() const { return m_owner; }
 
 
     wxDC *GetOwner() const { return m_owner; }
 


@@ -182,6 +176,12 @@ public:
     virtual bool CanDrawBitmap() const = 0;
     virtual bool CanGetTextExtent() const = 0;
 
     virtual bool CanDrawBitmap() const = 0;
     virtual bool CanGetTextExtent() const = 0;
 

+    // get Cairo context
+    virtual void* GetCairoContext() const
+    {
+        return NULL;
+    }
+

     // query dimension, colour deps, resolution
 
     virtual void DoGetSize(int *width, int *height) const = 0;
     // query dimension, colour deps, resolution
 
     virtual void DoGetSize(int *width, int *height) const = 0;


@@ -255,32 +255,41 @@ public:
     // setters and getters
 
     virtual void SetFont(const wxFont& font) = 0;
     // setters and getters
 
     virtual void SetFont(const wxFont& font) = 0;

-    virtual const wxFont&   GetFont() const { return m_font; }
+    virtual const wxFont& GetFont() const { return m_font; }

 
     virtual void SetPen(const wxPen& pen) = 0;
 
     virtual void SetPen(const wxPen& pen) = 0;

-    virtual const wxPen&    GetPen() const { return m_pen; }
+    virtual const wxPen& GetPen() const { return m_pen; }

 
     virtual void SetBrush(const wxBrush& brush) = 0;
 
     virtual void SetBrush(const wxBrush& brush) = 0;

-    virtual const wxBrush&  GetBrush() const { return m_brush; }
+    virtual const wxBrush& GetBrush() const { return m_brush; }

 
     virtual void SetBackground(const wxBrush& brush) = 0;
 
     virtual void SetBackground(const wxBrush& brush) = 0;

-    virtual const wxBrush&  GetBackground() const { return m_backgroundBrush; }
+    virtual const wxBrush& GetBackground() const { return m_backgroundBrush; }

 
     virtual void SetBackgroundMode(int mode) = 0;
     virtual int GetBackgroundMode() const { return m_backgroundMode; }
 
     virtual void SetTextForeground(const wxColour& colour)
         { m_textForegroundColour = colour; }
 
     virtual void SetBackgroundMode(int mode) = 0;
     virtual int GetBackgroundMode() const { return m_backgroundMode; }
 
     virtual void SetTextForeground(const wxColour& colour)
         { m_textForegroundColour = colour; }

-    virtual const wxColour& GetTextForeground() const { return m_textForegroundColour; }
+    virtual const wxColour& GetTextForeground() const
+        { return m_textForegroundColour; }

 
     virtual void SetTextBackground(const wxColour& colour)
         { m_textBackgroundColour = colour; }
 
     virtual void SetTextBackground(const wxColour& colour)
         { m_textBackgroundColour = colour; }

-    virtual const wxColour& GetTextBackground() const { return m_textBackgroundColour; }
+    virtual const wxColour& GetTextBackground() const
+        { return m_textBackgroundColour; }

 
 #if wxUSE_PALETTE
     virtual void SetPalette(const wxPalette& palette) = 0;
 #endif // wxUSE_PALETTE
 
 
 #if wxUSE_PALETTE
     virtual void SetPalette(const wxPalette& palette) = 0;
 #endif // wxUSE_PALETTE
 

+    // inherit the DC attributes (font and colours) from the given window
+    //
+    // this is called automatically when a window, client or paint DC is
+    // created
+    virtual void InheritAttributes(wxWindow *win);
+
+

     // logical functions
 
     virtual void SetLogicalFunction(int function) = 0;
     // logical functions
 
     virtual void SetLogicalFunction(int function) = 0;


@@ -310,7 +319,9 @@ public:
 
     virtual void DoSetClippingRegion(wxCoord x, wxCoord y,
                                      wxCoord width, wxCoord height) = 0;
 
     virtual void DoSetClippingRegion(wxCoord x, wxCoord y,
                                      wxCoord width, wxCoord height) = 0;

-    virtual void DoSetClippingRegionAsRegion(const wxRegion& region) = 0;
+
+    // NB: this function works with device coordinates, not the logical ones!
+    virtual void DoSetDeviceClippingRegion(const wxRegion& region) = 0;

 
     virtual void DoGetClippingBox(wxCoord *x, wxCoord *y,
                                   wxCoord *w, wxCoord *h) const
 
     virtual void DoGetClippingBox(wxCoord *x, wxCoord *y,
                                   wxCoord *w, wxCoord *h) const


@@ -463,8 +474,12 @@ public:
 
 
 #if wxUSE_SPLINES
 
 
 #if wxUSE_SPLINES

-    virtual void DoDrawSpline(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2, wxCoord x3, wxCoord y3);
-    virtual void DoDrawSpline(int n, wxPoint points[]);
+    void DrawSpline(wxCoord x1, wxCoord y1,
+                            wxCoord x2, wxCoord y2,
+                            wxCoord x3, wxCoord y3);
+    void DrawSpline(int n, wxPoint points[]);
+    void DrawSpline(const wxPointList *points) { DoDrawSpline(points); }
+

     virtual void DoDrawSpline(const wxPointList *points);
 #endif
 
     virtual void DoDrawSpline(const wxPointList *points);
 #endif
 


@@ -786,8 +801,21 @@ public:
         { m_pimpl->DoSetClippingRegion(pt.x, pt.y, sz.x, sz.y); }
     void SetClippingRegion(const wxRect& rect)
         { m_pimpl->DoSetClippingRegion(rect.x, rect.y, rect.width, rect.height); }
         { m_pimpl->DoSetClippingRegion(pt.x, pt.y, sz.x, sz.y); }
     void SetClippingRegion(const wxRect& rect)
         { m_pimpl->DoSetClippingRegion(rect.x, rect.y, rect.width, rect.height); }

-    void SetClippingRegion(const wxRegion& region)
-        { m_pimpl->DoSetClippingRegionAsRegion(region); }
+
+    // unlike the functions above, the coordinates of the region used in this
+    // one are in device coordinates, not the logical ones
+    void SetDeviceClippingRegion(const wxRegion& region)
+        { m_pimpl->DoSetDeviceClippingRegion(region); }
+
+    // this function is deprecated because its name is confusing: you may
+    // expect it to work with logical coordinates but, in fact, it does exactly
+    // the same thing as SetDeviceClippingRegion()
+    //
+    // please review the code using it and either replace it with calls to
+    // SetDeviceClippingRegion() or correct it if it was [wrongly] passing
+    // logical coordinates to this function
+    wxDEPRECATED_INLINE(void SetClippingRegion(const wxRegion& region),
+                        SetDeviceClippingRegion(region); )

 
     void DestroyClippingRegion()
         { m_pimpl->DestroyClippingRegion(); }
 
     void DestroyClippingRegion()
         { m_pimpl->DestroyClippingRegion(); }


@@ -1071,11 +1099,11 @@ public:
     void DrawSpline(wxCoord x1, wxCoord y1,
                     wxCoord x2, wxCoord y2,
                     wxCoord x3, wxCoord y3)
     void DrawSpline(wxCoord x1, wxCoord y1,
                     wxCoord x2, wxCoord y2,
                     wxCoord x3, wxCoord y3)

-        { m_pimpl->DoDrawSpline(x1,y1,x2,y2,x3,y3); }
+        { m_pimpl->DrawSpline(x1,y1,x2,y2,x3,y3); }

     void DrawSpline(int n, wxPoint points[])
     void DrawSpline(int n, wxPoint points[])

-        { m_pimpl->DoDrawSpline(n,points); }
+        { m_pimpl->DrawSpline(n,points); }

     void DrawSpline(const wxPointList *points)
     void DrawSpline(const wxPointList *points)

-        { m_pimpl->DoDrawSpline(points); }
+        { m_pimpl->DrawSpline(points); }

 #endif // wxUSE_SPLINES
 
 
 #endif // wxUSE_SPLINES
 
 


@@ -1202,7 +1230,7 @@ class WXDLLIMPEXP_CORE wxDCClipper
 {
 public:
     wxDCClipper(wxDC& dc, const wxRegion& r) : m_dc(dc)
 {
 public:
     wxDCClipper(wxDC& dc, const wxRegion& r) : m_dc(dc)

-        { dc.SetClippingRegion(r); }
+        { dc.SetClippingRegion(r.GetBox()); }

     wxDCClipper(wxDC& dc, const wxRect& r) : m_dc(dc)
         { dc.SetClippingRegion(r.x, r.y, r.width, r.height); }
     wxDCClipper(wxDC& dc, wxCoord x, wxCoord y, wxCoord w, wxCoord h) : m_dc(dc)
     wxDCClipper(wxDC& dc, const wxRect& r) : m_dc(dc)
         { dc.SetClippingRegion(r.x, r.y, r.width, r.height); }
     wxDCClipper(wxDC& dc, wxCoord x, wxCoord y, wxCoord w, wxCoord h) : m_dc(dc)