Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/dc.h b/include/wx/dc.h
index 5734cde4380d22e550315db576d405e06dce957f..031afde7c7712650e6920bdd75007f613e719b2a 100644 (file)
--- a/include/wx/dc.h
+++ b/include/wx/dc.h
@@ -43,6 +43,10 @@ class WXDLLIMPEXP_FWD_CORE wxMemoryDC;
 class WXDLLIMPEXP_FWD_CORE wxPrinterDC;
 class WXDLLIMPEXP_FWD_CORE wxPrintData;
 
 class WXDLLIMPEXP_FWD_CORE wxPrinterDC;
 class WXDLLIMPEXP_FWD_CORE wxPrintData;
 

+#if wxUSE_GRAPHICS_CONTEXT
+class WXDLLIMPEXP_FWD_CORE wxGraphicsContext;
+#endif
+

 //  Logical ops
 enum wxRasterOperationMode
 {
 //  Logical ops
 enum wxRasterOperationMode
 {


@@ -279,6 +283,8 @@ public:
         return NULL;
     }
 
         return NULL;
     }
 

+    virtual void* GetHandle() 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;


@@ -427,8 +433,12 @@ public:
 
     // clipping
 
 
     // clipping
 

+    // Note that this pure virtual method has an implementation that updates
+    // the values returned by DoGetClippingBox() and so can be called from the
+    // derived class overridden version if it makes sense (i.e. if the clipping
+    // box coordinates are not already updated in some other way).

     virtual void DoSetClippingRegion(wxCoord x, wxCoord y,
     virtual void DoSetClippingRegion(wxCoord x, wxCoord y,

-                                     wxCoord width, wxCoord height) = 0;
+                                     wxCoord w, wxCoord h) = 0;

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


@@ -471,7 +481,7 @@ public:
     }
 
     virtual void SetLogicalScale(double x, double y);
     }
 
     virtual void SetLogicalScale(double x, double y);

-    virtual void GetLogicalScale(double *x, double *y)
+    virtual void GetLogicalScale(double *x, double *y) const

     {
         if ( x ) *x = m_logicalScaleX;
         if ( y ) *y = m_logicalScaleY;
     {
         if ( x ) *x = m_logicalScaleX;
         if ( y ) *y = m_logicalScaleY;


@@ -511,6 +521,21 @@ public:
 
     // this needs to overidden if the axis is inverted
     virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp);
 
     // this needs to overidden if the axis is inverted
     virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp);

+    
+    virtual double GetContentScaleFactor() const { return m_contentScaleFactor; }
+
+#ifdef __WXMSW__
+    // Native Windows functions using the underlying HDC don't honour GDI+
+    // transformations which may be applied to it. Using this function we can
+    // transform the coordinates manually before passing them to such functions
+    // (as in e.g. wxRendererMSW code). It doesn't do anything if this is not a
+    // wxGCDC.
+    virtual wxRect MSWApplyGDIPlusTransform(const wxRect& r) const
+    {
+        return r;
+    }
+#endif // __WXMSW__
+

 
     // ---------------------------------------------------------
     // the actual drawing API
 
     // ---------------------------------------------------------
     // the actual drawing API


@@ -581,15 +606,15 @@ public:
         { return wxNullBitmap; }
 
 
         { return wxNullBitmap; }
 
 

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

                              wxCoord xoffset, wxCoord yoffset ) = 0;
     virtual void DrawLines(const wxPointList *list,
                            wxCoord xoffset, wxCoord yoffset );
 
                              wxCoord xoffset, wxCoord yoffset ) = 0;
     virtual void DrawLines(const wxPointList *list,
                            wxCoord xoffset, wxCoord yoffset );
 

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

                            wxCoord xoffset, wxCoord yoffset,
                            wxPolygonFillMode fillStyle = wxODDEVEN_RULE) = 0;
                            wxCoord xoffset, wxCoord yoffset,
                            wxPolygonFillMode fillStyle = wxODDEVEN_RULE) = 0;

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

                                wxCoord xoffset, wxCoord yoffset,
                                wxPolygonFillMode fillStyle);
     void DrawPolygon(const wxPointList *list,
                                wxCoord xoffset, wxCoord yoffset,
                                wxPolygonFillMode fillStyle);
     void DrawPolygon(const wxPointList *list,


@@ -601,7 +626,7 @@ 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);

-    void DrawSpline(int n, wxPoint points[]);
+    void DrawSpline(int n, const wxPoint points[]);

     void DrawSpline(const wxPointList *points) { DoDrawSpline(points); }
 
     virtual void DoDrawSpline(const wxPointList *points);
     void DrawSpline(const wxPointList *points) { DoDrawSpline(points); }
 
     virtual void DoDrawSpline(const wxPointList *points);


@@ -627,6 +652,13 @@ public:
     virtual int GetResolution() const
         { return -1; }
 
     virtual int GetResolution() const
         { return -1; }
 

+#if wxUSE_GRAPHICS_CONTEXT
+    virtual wxGraphicsContext* GetGraphicsContext() const
+        { return NULL; }
+    virtual void SetGraphicsContext( wxGraphicsContext* WXUNUSED(ctx) )
+        {}
+#endif
+

 private:
     wxDC       *m_owner;
 
 private:
     wxDC       *m_owner;
 


@@ -717,6 +749,8 @@ protected:
     double m_scaleX, m_scaleY;  // calculated from logical scale and user scale
 
     int m_signX, m_signY;  // Used by SetAxisOrientation() to invert the axes
     double m_scaleX, m_scaleY;  // calculated from logical scale and user scale
 
     int m_signX, m_signY;  // Used by SetAxisOrientation() to invert the axes

+    
+    double m_contentScaleFactor; // used by high resolution displays (retina)

 
     // what is a mm on a screen you don't know the size of?
     double       m_mm_to_pix_x,
 
     // what is a mm on a screen you don't know the size of?
     double       m_mm_to_pix_x,


@@ -763,6 +797,9 @@ public:
     wxWindow *GetWindow() const
         { return m_pimpl->GetWindow(); }
 
     wxWindow *GetWindow() const
         { return m_pimpl->GetWindow(); }
 

+    void *GetHandle() const
+        { return m_pimpl->GetHandle(); }
+

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


@@ -797,6 +834,9 @@ public:
     virtual int GetResolution() const
         { return m_pimpl->GetResolution(); }
 
     virtual int GetResolution() const
         { return m_pimpl->GetResolution(); }
 

+    double GetContentScaleFactor() const
+        { return m_pimpl->GetContentScaleFactor(); }
+

     // Right-To-Left (RTL) modes
 
     void SetLayoutDirection(wxLayoutDirection dir)
     // Right-To-Left (RTL) modes
 
     void SetLayoutDirection(wxLayoutDirection dir)


@@ -996,7 +1036,7 @@ public:
 
     void SetLogicalScale(double x, double y)
         { m_pimpl->SetLogicalScale( x, y ); }
 
     void SetLogicalScale(double x, double y)
         { m_pimpl->SetLogicalScale( x, y ); }

-    void GetLogicalScale(double *x, double *y)
+    void GetLogicalScale(double *x, double *y) const

         { m_pimpl->GetLogicalScale( x, y ); }
 
     void SetLogicalOrigin(wxCoord x, wxCoord y)
         { m_pimpl->GetLogicalScale( x, y ); }
 
     void SetLogicalOrigin(wxCoord x, wxCoord y)


@@ -1106,7 +1146,7 @@ public:
     void DrawPoint(const wxPoint& pt)
         { m_pimpl->DoDrawPoint(pt.x, pt.y); }
 
     void DrawPoint(const wxPoint& pt)
         { m_pimpl->DoDrawPoint(pt.x, pt.y); }
 

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

                    wxCoord xoffset = 0, wxCoord yoffset = 0)
         { m_pimpl->DoDrawLines(n, points, xoffset, yoffset); }
     void DrawLines(const wxPointList *list,
                    wxCoord xoffset = 0, wxCoord yoffset = 0)
         { m_pimpl->DoDrawLines(n, points, xoffset, yoffset); }
     void DrawLines(const wxPointList *list,


@@ -1117,7 +1157,7 @@ public:
                                  wxCoord xoffset = 0, wxCoord yoffset = 0) );
 #endif  // WXWIN_COMPATIBILITY_2_8
 
                                  wxCoord xoffset = 0, wxCoord yoffset = 0) );
 #endif  // WXWIN_COMPATIBILITY_2_8
 

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

                      wxCoord xoffset = 0, wxCoord yoffset = 0,
                      wxPolygonFillMode fillStyle = wxODDEVEN_RULE)
         { m_pimpl->DoDrawPolygon(n, points, xoffset, yoffset, fillStyle); }
                      wxCoord xoffset = 0, wxCoord yoffset = 0,
                      wxPolygonFillMode fillStyle = wxODDEVEN_RULE)
         { m_pimpl->DoDrawPolygon(n, points, xoffset, yoffset, fillStyle); }


@@ -1125,7 +1165,7 @@ public:
                      wxCoord xoffset = 0, wxCoord yoffset = 0,
                      wxPolygonFillMode fillStyle = wxODDEVEN_RULE)
         { m_pimpl->DrawPolygon( list, xoffset, yoffset, fillStyle ); }
                      wxCoord xoffset = 0, wxCoord yoffset = 0,
                      wxPolygonFillMode fillStyle = wxODDEVEN_RULE)
         { m_pimpl->DrawPolygon( list, xoffset, yoffset, fillStyle ); }

-    void DrawPolyPolygon(int n, int count[], wxPoint points[],
+    void DrawPolyPolygon(int n, const int count[], const wxPoint points[],

                          wxCoord xoffset = 0, wxCoord yoffset = 0,
                          wxPolygonFillMode fillStyle = wxODDEVEN_RULE)
         { m_pimpl->DoDrawPolyPolygon(n, count, points, xoffset, yoffset, fillStyle); }
                          wxCoord xoffset = 0, wxCoord yoffset = 0,
                          wxPolygonFillMode fillStyle = wxODDEVEN_RULE)
         { m_pimpl->DoDrawPolyPolygon(n, count, points, xoffset, yoffset, fillStyle); }


@@ -1248,7 +1288,7 @@ public:
                     wxCoord x2, wxCoord y2,
                     wxCoord x3, wxCoord y3)
         { m_pimpl->DrawSpline(x1,y1,x2,y2,x3,y3); }
                     wxCoord x2, wxCoord y2,
                     wxCoord x3, wxCoord y3)
         { m_pimpl->DrawSpline(x1,y1,x2,y2,x3,y3); }

-    void DrawSpline(int n, wxPoint points[])
+    void DrawSpline(int n, const wxPoint points[])

         { m_pimpl->DrawSpline(n,points); }
     void DrawSpline(const wxPointList *points)
         { m_pimpl->DrawSpline(points); }
         { m_pimpl->DrawSpline(n,points); }
     void DrawSpline(const wxPointList *points)
         { m_pimpl->DrawSpline(points); }


@@ -1316,6 +1356,17 @@ public:
     TempHDC GetTempHDC() { return TempHDC(*this); }
 #endif // __WXMSW__
 
     TempHDC GetTempHDC() { return TempHDC(*this); }
 #endif // __WXMSW__
 

+#if wxUSE_GRAPHICS_CONTEXT
+    virtual wxGraphicsContext* GetGraphicsContext() const
+    {
+        return m_pimpl->GetGraphicsContext();
+    }
+    virtual void SetGraphicsContext( wxGraphicsContext* ctx )
+    {
+        m_pimpl->SetGraphicsContext(ctx);
+    }
+#endif
+

 protected:
     // ctor takes ownership of the pointer
     wxDC(wxDCImpl *pimpl) : m_pimpl(pimpl) { }
 protected:
     // ctor takes ownership of the pointer
     wxDC(wxDCImpl *pimpl) : m_pimpl(pimpl) { }


@@ -1344,13 +1395,13 @@ public:
 
     ~wxDCTextColourChanger()
     {
 
     ~wxDCTextColourChanger()
     {

-        if ( m_colFgOld.Ok() )
+        if ( m_colFgOld.IsOk() )

             m_dc.SetTextForeground(m_colFgOld);
     }
 
     void Set(const wxColour& col)
     {
             m_dc.SetTextForeground(m_colFgOld);
     }
 
     void Set(const wxColour& col)
     {

-        if ( !m_colFgOld.Ok() )
+        if ( !m_colFgOld.IsOk() )

             m_colFgOld = m_dc.GetTextForeground();
         m_dc.SetTextForeground(col);
     }
             m_colFgOld = m_dc.GetTextForeground();
         m_dc.SetTextForeground(col);
     }


@@ -1378,7 +1429,7 @@ public:
 
     ~wxDCPenChanger()
     {
 
     ~wxDCPenChanger()
     {

-        if ( m_penOld.Ok() )
+        if ( m_penOld.IsOk() )

             m_dc.SetPen(m_penOld);
     }
 
             m_dc.SetPen(m_penOld);
     }
 


@@ -1405,7 +1456,7 @@ public:
 
     ~wxDCBrushChanger()
     {
 
     ~wxDCBrushChanger()
     {

-        if ( m_brushOld.Ok() )
+        if ( m_brushOld.IsOk() )

             m_dc.SetBrush(m_brushOld);
     }
 
             m_dc.SetBrush(m_brushOld);
     }
 


@@ -1461,14 +1512,14 @@ public:
 
     void Set(const wxFont& font)
     {
 
     void Set(const wxFont& font)
     {

-        if ( !m_fontOld.Ok() )
+        if ( !m_fontOld.IsOk() )

             m_fontOld = m_dc.GetFont();
         m_dc.SetFont(font);
     }
 
     ~wxDCFontChanger()
     {
             m_fontOld = m_dc.GetFont();
         m_dc.SetFont(font);
     }
 
     ~wxDCFontChanger()
     {

-        if ( m_fontOld.Ok() )
+        if ( m_fontOld.IsOk() )

             m_dc.SetFont(m_fontOld);
     }
 
             m_dc.SetFont(m_fontOld);
     }