no changes, just corrected the comment for wxConvLocal

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

diff --git a/include/wx/dc.h b/include/wx/dc.h
index 747915383babd71742c543eeea075bc62cdd5179..af5ebf450131ac6b574dae56652d8d06c00cc7ef 100644 (file)
--- a/include/wx/dc.h
+++ b/include/wx/dc.h
@@ -6,16 +6,12 @@
 // Created:     05/25/99
 // RCS-ID:      $Id$
 // Copyright:   (c) wxWidgets team
 // Created:     05/25/99
 // RCS-ID:      $Id$
 // Copyright:   (c) wxWidgets team

-// Licence:     wxWidgets licence
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_DC_H_BASE_
 #define _WX_DC_H_BASE_
 
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_DC_H_BASE_
 #define _WX_DC_H_BASE_
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "dcbase.h"
-#endif
-

 // ----------------------------------------------------------------------------
 // headers which we must include here
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // headers which we must include here
 // ----------------------------------------------------------------------------


@@ -25,11 +21,13 @@
 #include "wx/cursor.h"          // we have member variables of these classes
 #include "wx/font.h"            // so we can't do without them
 #include "wx/colour.h"
 #include "wx/cursor.h"          // we have member variables of these classes
 #include "wx/font.h"            // so we can't do without them
 #include "wx/colour.h"

+#include "wx/bitmap.h"          // for wxNullBitmap

 #include "wx/brush.h"
 #include "wx/pen.h"
 #include "wx/palette.h"
 #include "wx/list.h"            // we use wxList in inline functions
 #include "wx/dynarray.h"
 #include "wx/brush.h"
 #include "wx/pen.h"
 #include "wx/palette.h"
 #include "wx/list.h"            // we use wxList in inline functions
 #include "wx/dynarray.h"

+#include "wx/math.h"

 
 class WXDLLEXPORT wxDC;
 class WXDLLEXPORT wxDCBase;
 
 class WXDLLEXPORT wxDC;
 class WXDLLEXPORT wxDCBase;


@@ -39,7 +37,7 @@ class WXDLLEXPORT wxDrawObject
 public:
 
     wxDrawObject()
 public:
 
     wxDrawObject()

-        : m_isBBoxValid(FALSE)
+        : m_isBBoxValid(false)

         , m_minX(0), m_minY(0), m_maxX(0), m_maxY(0)
     { }
 
         , m_minX(0), m_minY(0), m_maxX(0), m_maxY(0)
     { }
 


@@ -58,7 +56,7 @@ public:
       }
       else
       {
       }
       else
       {

-         m_isBBoxValid = TRUE;
+         m_isBBoxValid = true;

 
          m_minX = x;
          m_minY = y;
 
          m_minX = x;
          m_minY = y;


@@ -69,7 +67,7 @@ public:
 
     void ResetBoundingBox()
     {
 
     void ResetBoundingBox()
     {

-        m_isBBoxValid = FALSE;
+        m_isBBoxValid = false;

 
         m_minX = m_maxX = m_minY = m_maxY = 0;
     }
 
         m_minX = m_maxX = m_minY = m_maxY = 0;
     }


@@ -95,7 +93,7 @@ protected:
 // global variables
 // ---------------------------------------------------------------------------
 
 // global variables
 // ---------------------------------------------------------------------------
 

-WXDLLEXPORT_DATA(extern int) wxPageNumber;
+extern WXDLLEXPORT_DATA(int) wxPageNumber;

 
 // ---------------------------------------------------------------------------
 // wxDC is the device context - object on which any drawing is done
 
 // ---------------------------------------------------------------------------
 // wxDC is the device context - object on which any drawing is done


@@ -106,10 +104,10 @@ class WXDLLEXPORT wxDCBase : public wxObject
 public:
     wxDCBase()
         : m_colour(wxColourDisplay())
 public:
     wxDCBase()
         : m_colour(wxColourDisplay())

-        , m_ok(TRUE)
-        , m_clipping(FALSE)
+        , m_ok(true)
+        , m_clipping(false)

         , m_isInteractive(0)
         , m_isInteractive(0)

-        , m_isBBoxValid(FALSE)
+        , m_isBBoxValid(false)

         , m_logicalOriginX(0), m_logicalOriginY(0)
         , m_deviceOriginX(0), m_deviceOriginY(0)
         , m_logicalScaleX(1.0), m_logicalScaleY(1.0)
         , m_logicalOriginX(0), m_logicalOriginY(0)
         , m_deviceOriginX(0), m_deviceOriginY(0)
         , m_logicalScaleX(1.0), m_logicalScaleY(1.0)


@@ -129,7 +127,7 @@ public:
         , m_font()
 #if wxUSE_PALETTE
         , m_palette()
         , m_font()
 #if wxUSE_PALETTE
         , m_palette()

-        , m_hasCustomPalette(FALSE)
+        , m_hasCustomPalette(false)

 #endif // wxUSE_PALETTE
     {
         ResetBoundingBox();
 #endif // wxUSE_PALETTE
     {
         ResetBoundingBox();


@@ -138,8 +136,10 @@ public:
 
     ~wxDCBase() { }
 
 
     ~wxDCBase() { }
 

-    virtual void BeginDrawing() { }
-    virtual void EndDrawing() { }
+#if WXWIN_COMPATIBILITY_2_6
+    wxDEPRECATED( virtual void BeginDrawing() );
+    wxDEPRECATED( virtual void EndDrawing() );
+#endif // WXWIN_COMPATIBILITY_2_6

 
     // graphic primitives
     // ------------------
 
     // graphic primitives
     // ------------------


@@ -158,6 +158,27 @@ public:
                    int style = wxFLOOD_SURFACE)
         { return DoFloodFill(pt.x, pt.y, col, style); }
 
                    int style = wxFLOOD_SURFACE)
         { return DoFloodFill(pt.x, pt.y, col, style); }
 

+    // fill the area specified by rect with a radial gradient, starting from
+    // initialColour in the centre of the cercle and fading to destColour.
+    void GradientFillConcentric(const wxRect& rect,
+                                const wxColour& initialColour, 
+                                const wxColour& destColour)
+        { GradientFillConcentric(rect, initialColour, destColour,
+                                 wxPoint(rect.GetWidth() / 2,
+                                         rect.GetHeight() / 2)); }
+
+    void GradientFillConcentric(const wxRect& rect,
+                                const wxColour& initialColour, 
+                                const wxColour& destColour,
+                                const wxPoint& circleCenter);
+
+    // fill the area specified by rect with a linear gradient
+    void GradientFillLinear(const wxRect& rect,
+                            const wxColour& initialColour, 
+                            const wxColour& destColour,
+                            wxDirection nDirection = wxEAST)
+        { DoGradientFillLinear(rect, initialColour, destColour, nDirection); }
+

     bool GetPixel(wxCoord x, wxCoord y, wxColour *col) const
         { return DoGetPixel(x, y, col); }
     bool GetPixel(const wxPoint& pt, wxColour *col) const
     bool GetPixel(wxCoord x, wxCoord y, wxColour *col) const
         { return DoGetPixel(x, y, col); }
     bool GetPixel(const wxPoint& pt, wxColour *col) const


@@ -251,10 +272,10 @@ public:
         { DoDrawIcon(icon, pt.x, pt.y); }
 
     void DrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y,
         { DoDrawIcon(icon, pt.x, pt.y); }
 
     void DrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y,

-                    bool useMask = FALSE)
+                    bool useMask = false)

         { DoDrawBitmap(bmp, x, y, useMask); }
     void DrawBitmap(const wxBitmap &bmp, const wxPoint& pt,
         { DoDrawBitmap(bmp, x, y, useMask); }
     void DrawBitmap(const wxBitmap &bmp, const wxPoint& pt,

-                    bool useMask = FALSE)
+                    bool useMask = false)

         { DoDrawBitmap(bmp, pt.x, pt.y, useMask); }
 
     void DrawText(const wxString& text, wxCoord x, wxCoord y)
         { DoDrawBitmap(bmp, pt.x, pt.y, useMask); }
 
     void DrawText(const wxString& text, wxCoord x, wxCoord y)


@@ -285,14 +306,14 @@ public:
 
     bool Blit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
               wxDC *source, wxCoord xsrc, wxCoord ysrc,
 
     bool Blit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
               wxDC *source, wxCoord xsrc, wxCoord ysrc,

-              int rop = wxCOPY, bool useMask = FALSE, wxCoord xsrcMask = -1, wxCoord ysrcMask = -1)
+              int rop = wxCOPY, bool useMask = false, wxCoord xsrcMask = wxDefaultCoord, wxCoord ysrcMask = wxDefaultCoord)

     {
         return DoBlit(xdest, ydest, width, height,
                       source, xsrc, ysrc, rop, useMask, xsrcMask, ysrcMask);
     }
     bool Blit(const wxPoint& destPt, const wxSize& sz,
               wxDC *source, const wxPoint& srcPt,
     {
         return DoBlit(xdest, ydest, width, height,
                       source, xsrc, ysrc, rop, useMask, xsrcMask, ysrcMask);
     }
     bool Blit(const wxPoint& destPt, const wxSize& sz,
               wxDC *source, const wxPoint& srcPt,

-              int rop = wxCOPY, bool useMask = FALSE, const wxPoint& srcPtMask = wxPoint(-1, -1))
+              int rop = wxCOPY, bool useMask = false, const wxPoint& srcPtMask = wxDefaultPosition)

     {
         return DoBlit(destPt.x, destPt.y, sz.x, sz.y,
                       source, srcPt.x, srcPt.y, rop, useMask, srcPtMask.x, srcPtMask.y);
     {
         return DoBlit(destPt.x, destPt.y, sz.x, sz.y,
                       source, srcPt.x, srcPt.y, rop, useMask, srcPtMask.x, srcPtMask.y);


@@ -346,7 +367,7 @@ public:
      *  \param angle Rotating angle (counterclockwise, start at 3 o'clock, 360 is full circle).
      *  \param center Center of rotation.
      */
      *  \param angle Rotating angle (counterclockwise, start at 3 o'clock, 360 is full circle).
      *  \param center Center of rotation.
      */

-    void Rotate( wxList* points, double angle, wxPoint center = wxPoint() );
+    void Rotate( wxList* points, double angle, wxPoint center = wxPoint(0,0) );

 
     // used by DrawEllipticArcRot
     // Careful: wxList gets filled with points you have to delete later.
 
     // used by DrawEllipticArcRot
     // Careful: wxList gets filled with points you have to delete later.


@@ -361,7 +382,7 @@ public:
 
     virtual void Clear() = 0;
 
 
     virtual void Clear() = 0;
 

-    virtual bool StartDoc(const wxString& WXUNUSED(message)) { return TRUE; }
+    virtual bool StartDoc(const wxString& WXUNUSED(message)) { return true; }

     virtual void EndDoc() { }
 
     virtual void StartPage() { }
     virtual void EndDoc() { }
 
     virtual void StartPage() { }


@@ -528,17 +549,17 @@ public:
         { wxCoord x, y; DoGetDeviceOrigin(&x, &y); return wxPoint(x, y); }
     virtual void SetDeviceOrigin(wxCoord x, wxCoord y) = 0;
 
         { wxCoord x, y; DoGetDeviceOrigin(&x, &y); return wxPoint(x, y); }
     virtual void SetDeviceOrigin(wxCoord x, wxCoord y) = 0;
 

+    virtual void ComputeScaleAndOrigin() {}
+

     virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp) = 0;
 
     int GetLogicalFunction() const { return m_logicalFunction; }
     virtual void SetLogicalFunction(int function) = 0;
 
     virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp) = 0;
 
     int GetLogicalFunction() const { return m_logicalFunction; }
     virtual void SetLogicalFunction(int function) = 0;
 

-    // Sometimes we need to override optimization, e.g. if other software is
-    // drawing onto our surface and we can't be sure of who's done what.
-    //
-    // FIXME: is this (still) used?
+#if WXWIN_COMPATIBILITY_2_4

     virtual void SetOptimization(bool WXUNUSED(opt)) { }
     virtual void SetOptimization(bool WXUNUSED(opt)) { }

-    virtual bool GetOptimization() { return FALSE; }
+    virtual bool GetOptimization() { return false; }
+#endif

 
     // bounding box
     // ------------
 
     // bounding box
     // ------------


@@ -554,7 +575,7 @@ public:
       }
       else
       {
       }
       else
       {

-         m_isBBoxValid = TRUE;
+         m_isBBoxValid = true;

 
          m_minX = x;
          m_minY = y;
 
          m_minX = x;
          m_minY = y;


@@ -565,7 +586,7 @@ public:
 
     void ResetBoundingBox()
     {
 
     void ResetBoundingBox()
     {

-        m_isBBoxValid = FALSE;
+        m_isBBoxValid = false;

 
         m_minX = m_maxX = m_minY = m_maxY = 0;
     }
 
         m_minX = m_maxX = m_minY = m_maxY = 0;
     }


@@ -634,6 +655,11 @@ protected:
     virtual bool DoFloodFill(wxCoord x, wxCoord y, const wxColour& col,
                              int style = wxFLOOD_SURFACE) = 0;
 
     virtual bool DoFloodFill(wxCoord x, wxCoord y, const wxColour& col,
                              int style = wxFLOOD_SURFACE) = 0;
 

+    virtual void DoGradientFillLinear(const wxRect& rect,
+                                      const wxColour& initialColour,
+                                      const wxColour& destColour,
+                                      wxDirection nDirection = wxEAST);
+    

     virtual bool DoGetPixel(wxCoord x, wxCoord y, wxColour *col) const = 0;
 
     virtual void DoDrawPoint(wxCoord x, wxCoord y) = 0;
     virtual bool DoGetPixel(wxCoord x, wxCoord y, wxColour *col) const = 0;
 
     virtual void DoDrawPoint(wxCoord x, wxCoord y) = 0;


@@ -658,7 +684,7 @@ protected:
 
     virtual void DoDrawIcon(const wxIcon& icon, wxCoord x, wxCoord y) = 0;
     virtual void DoDrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y,
 
     virtual void DoDrawIcon(const wxIcon& icon, wxCoord x, wxCoord y) = 0;
     virtual void DoDrawBitmap(const wxBitmap &bmp, wxCoord x, wxCoord y,

-                              bool useMask = FALSE) = 0;
+                              bool useMask = false) = 0;

 
     virtual void DoDrawText(const wxString& text, wxCoord x, wxCoord y) = 0;
     virtual void DoDrawRotatedText(const wxString& text,
 
     virtual void DoDrawText(const wxString& text, wxCoord x, wxCoord y) = 0;
     virtual void DoDrawRotatedText(const wxString& text,


@@ -667,7 +693,7 @@ protected:
     virtual bool DoBlit(wxCoord xdest, wxCoord ydest,
                         wxCoord width, wxCoord height,
                         wxDC *source, wxCoord xsrc, wxCoord ysrc,
     virtual bool DoBlit(wxCoord xdest, wxCoord ydest,
                         wxCoord width, wxCoord height,
                         wxDC *source, wxCoord xsrc, wxCoord ysrc,

-                        int rop = wxCOPY, bool useMask = FALSE, wxCoord xsrcMask = -1, wxCoord ysrcMask = -1) = 0;
+                        int rop = wxCOPY, bool useMask = false, wxCoord xsrcMask = wxDefaultCoord, wxCoord ysrcMask = wxDefaultCoord) = 0;

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


@@ -685,10 +711,13 @@ protected:
     virtual void DoSetClippingRegion(wxCoord x, wxCoord y,
                                      wxCoord width, wxCoord height) = 0;
 
     virtual void DoSetClippingRegion(wxCoord x, wxCoord y,
                                      wxCoord width, wxCoord height) = 0;
 

-    // FIXME are these functions really different?
+#if WXWIN_COMPATIBILITY_2_4
+    // this was only for confusing people, use DoGetClippingBox only

     virtual void DoGetClippingRegion(wxCoord *x, wxCoord *y,
                                      wxCoord *w, wxCoord *h)
         { DoGetClippingBox(x, y, w, h); }
     virtual void DoGetClippingRegion(wxCoord *x, wxCoord *y,
                                      wxCoord *w, wxCoord *h)
         { DoGetClippingBox(x, y, w, h); }

+#endif
+

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


@@ -786,12 +815,16 @@ private:
 // now include the declaration of wxDC class
 // ----------------------------------------------------------------------------
 
 // now include the declaration of wxDC class
 // ----------------------------------------------------------------------------
 

-#if defined(__WXMSW__)
+#if defined(__WXPALMOS__)
+    #include "wx/palmos/dc.h"
+#elif defined(__WXMSW__)

     #include "wx/msw/dc.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/dc.h"
     #include "wx/msw/dc.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/dc.h"

-#elif defined(__WXGTK__)
+#elif defined(__WXGTK20__)

     #include "wx/gtk/dc.h"
     #include "wx/gtk/dc.h"

+#elif defined(__WXGTK__)
+    #include "wx/gtk1/dc.h"

 #elif defined(__WXX11__)
     #include "wx/x11/dc.h"
 #elif defined(__WXMGL__)
 #elif defined(__WXX11__)
     #include "wx/x11/dc.h"
 #elif defined(__WXMGL__)


@@ -843,6 +876,8 @@ private:
 class WXDLLEXPORT wxDCClipper
 {
 public:
 class WXDLLEXPORT wxDCClipper
 {
 public:

+    wxDCClipper(wxDC& dc, const wxRegion& r) : m_dc(dc)
+        { dc.SetClippingRegion(r); }

     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)