access TLS cache variable directly and not via a helper function when using compiler...

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

diff --git a/include/wx/dc.h b/include/wx/dc.h
index 90e878d4b186041aeb8dce407cdda82ac51870de..10e091b2289f53cbd5c036c06529b27d2eb51257 100644 (file)
--- a/include/wx/dc.h
+++ b/include/wx/dc.h
@@ -1,7 +1,7 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        wx/dc.h
 // Purpose:     wxDC class
 /////////////////////////////////////////////////////////////////////////////
 // Name:        wx/dc.h
 // Purpose:     wxDC class

-// Author:      Vadim Zeitlin
+// Author:      Vadim Zeitlin 

 // Modified by:
 // Created:     05/25/99
 // RCS-ID:      $Id$
 // Modified by:
 // Created:     05/25/99
 // RCS-ID:      $Id$


@@ -40,12 +40,13 @@ class WXDLLIMPEXP_FWD_CORE wxWindowDC;
 class WXDLLIMPEXP_FWD_CORE wxScreenDC;
 class WXDLLIMPEXP_FWD_CORE wxMemoryDC;
 class WXDLLIMPEXP_FWD_CORE wxPrinterDC;
 class WXDLLIMPEXP_FWD_CORE wxScreenDC;
 class WXDLLIMPEXP_FWD_CORE wxMemoryDC;
 class WXDLLIMPEXP_FWD_CORE wxPrinterDC;

+class WXDLLIMPEXP_FWD_CORE wxPrintData;

 
 //-----------------------------------------------------------------------------
 // wxDrawObject helper class
 //-----------------------------------------------------------------------------
 
 
 //-----------------------------------------------------------------------------
 // wxDrawObject helper class
 //-----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxDrawObject
+class WXDLLIMPEXP_CORE wxDrawObject

 {
 public:
 
 {
 public:
 


@@ -115,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;


@@ -145,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 );


@@ -168,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; }
 


@@ -181,9 +176,28 @@ 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;

+    void GetSize(int *width, int *height) const
+    {
+        DoGetSize(width, height);
+        return ;
+    }
+
+    wxSize GetSize() const
+    {
+        int w, h;
+        DoGetSize(&w, &h);
+        return wxSize(w, h);
+    }
+

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


@@ -241,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;


@@ -296,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


@@ -449,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
 


@@ -486,6 +515,54 @@ protected:
         m_clipX1 = m_clipX2 = m_clipY1 = m_clipY2 = 0;
     }
 
         m_clipX1 = m_clipX2 = m_clipY1 = m_clipY2 = 0;
     }
 

+#ifdef __WXWINCE__
+    //! Generic method to draw ellipses, circles and arcs with current pen and brush.
+    /*! \param x Upper left corner of bounding box.
+     *  \param y Upper left corner of bounding box.
+     *  \param w Width of bounding box.
+     *  \param h Height of bounding box.
+     *  \param sa Starting angle of arc
+     *            (counterclockwise, start at 3 o'clock, 360 is full circle).
+     *  \param ea Ending angle of arc.
+     *  \param angle Rotation angle, the Arc will be rotated after
+     *               calculating begin and end.
+     */
+    void DrawEllipticArcRot( wxCoord x, wxCoord y,
+                             wxCoord width, wxCoord height,
+                             double sa = 0, double ea = 0, double angle = 0 )
+    { DoDrawEllipticArcRot( x, y, width, height, sa, ea, angle ); }
+
+    void DrawEllipticArcRot( const wxPoint& pt,
+                             const wxSize& sz,
+                             double sa = 0, double ea = 0, double angle = 0 )
+    { DoDrawEllipticArcRot( pt.x, pt.y, sz.x, sz.y, sa, ea, angle ); }
+
+    void DrawEllipticArcRot( const wxRect& rect,
+                             double sa = 0, double ea = 0, double angle = 0 )
+    { DoDrawEllipticArcRot( rect.x, rect.y, rect.width, rect.height, sa, ea, angle ); }
+
+    virtual void DoDrawEllipticArcRot( wxCoord x, wxCoord y,
+                                       wxCoord w, wxCoord h,
+                                       double sa = 0, double ea = 0, double angle = 0 );
+
+    //! Rotates points around center.
+    /*! This is a quite straight method, it calculates in pixels
+     *  and so it produces rounding errors.
+     *  \param points The points inside will be rotated.
+     *  \param angle Rotating angle (counterclockwise, start at 3 o'clock, 360 is full circle).
+     *  \param center Center of rotation.
+     */
+    void Rotate( wxPointList* points, double angle, wxPoint center = wxPoint(0,0) );
+
+    // used by DrawEllipticArcRot
+    // Careful: wxList gets filled with points you have to delete later.
+    void CalculateEllipticPoints( wxPointList* points,
+                                  wxCoord xStart, wxCoord yStart,
+                                  wxCoord w, wxCoord h,
+                                  double sa, double ea );
+#endif // __WXWINCE__
+
+

     // window on which the DC draws or NULL
     wxWindow   *m_window;
 
     // window on which the DC draws or NULL
     wxWindow   *m_window;
 


@@ -552,7 +629,7 @@ public:
     const wxDCImpl *GetImpl() const
         { return m_pimpl; }
 
     const wxDCImpl *GetImpl() const
         { return m_pimpl; }
 

-    wxWindow *GetWindow()
+    wxWindow *GetWindow() const

         { return m_pimpl->GetWindow(); }
 
     bool IsOk() const
         { return m_pimpl->GetWindow(); }
 
     bool IsOk() const


@@ -569,13 +646,8 @@ public:
 
     void GetSize(int *width, int *height) const
         { m_pimpl->DoGetSize(width, height); }
 
     void GetSize(int *width, int *height) const
         { m_pimpl->DoGetSize(width, height); }

-

     wxSize GetSize() const
     wxSize GetSize() const

-    {
-        int w, h;
-        m_pimpl->DoGetSize(&w, &h);
-        return wxSize(w, h);
-    }
+        { return m_pimpl->GetSize(); }

 
     void GetSizeMM(int* width, int* height) const
         { m_pimpl->DoGetSizeMM(width, height); }
 
     void GetSizeMM(int* width, int* height) const
         { m_pimpl->DoGetSizeMM(width, height); }


@@ -729,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(); }


@@ -1014,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
 
 


@@ -1051,7 +1136,7 @@ private:
 // restore it automatically when the object goes out of scope
 // ----------------------------------------------------------------------------
 
 // restore it automatically when the object goes out of scope
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxDCTextColourChanger
+class WXDLLIMPEXP_CORE wxDCTextColourChanger

 {
 public:
     wxDCTextColourChanger(wxDC& dc) : m_dc(dc), m_colFgOld() { }
 {
 public:
     wxDCTextColourChanger(wxDC& dc) : m_dc(dc), m_colFgOld() { }


@@ -1087,7 +1172,7 @@ private:
 // restore it automatically when the object goes out of scope
 // ----------------------------------------------------------------------------
 
 // restore it automatically when the object goes out of scope
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxDCPenChanger
+class WXDLLIMPEXP_CORE wxDCPenChanger

 {
 public:
     wxDCPenChanger(wxDC& dc, const wxPen& pen) : m_dc(dc), m_penOld(dc.GetPen())
 {
 public:
     wxDCPenChanger(wxDC& dc, const wxPen& pen) : m_dc(dc), m_penOld(dc.GetPen())


@@ -1114,7 +1199,7 @@ private:
 // restore it automatically when the object goes out of scope
 // ----------------------------------------------------------------------------
 
 // restore it automatically when the object goes out of scope
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxDCBrushChanger
+class WXDLLIMPEXP_CORE wxDCBrushChanger

 {
 public:
     wxDCBrushChanger(wxDC& dc, const wxBrush& brush) : m_dc(dc), m_brushOld(dc.GetBrush())
 {
 public:
     wxDCBrushChanger(wxDC& dc, const wxBrush& brush) : m_dc(dc), m_brushOld(dc.GetBrush())


@@ -1141,11 +1226,11 @@ private:
 // destroys it in the dtor
 // ----------------------------------------------------------------------------
 
 // destroys it in the dtor
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxDCClipper
+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)