Use wxClientDataDictionary for client data.

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

diff --git a/include/wx/gdicmn.h b/include/wx/gdicmn.h
index 236479a457790b75e98908e14aa3897f3535fa6e..3cd8a18402c172002f2aaf31131663073e7320df 100644 (file)
--- a/include/wx/gdicmn.h
+++ b/include/wx/gdicmn.h
@@ -16,7 +16,7 @@
 // headers
 // ---------------------------------------------------------------------------
 
 // headers
 // ---------------------------------------------------------------------------
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(__APPLE__)

     #pragma interface "gdicmn.h"
 #endif
 
     #pragma interface "gdicmn.h"
 #endif
 


@@ -26,6 +26,7 @@
 #include "wx/string.h"
 #include "wx/setup.h"
 #include "wx/colour.h"
 #include "wx/string.h"
 #include "wx/setup.h"
 #include "wx/colour.h"

+#include "wx/font.h"

 
 // ---------------------------------------------------------------------------
 // forward declarations
 
 // ---------------------------------------------------------------------------
 // forward declarations


@@ -47,9 +48,10 @@ class WXDLLEXPORT wxString;
 // ---------------------------------------------------------------------------
 
 // Bitmap flags
 // ---------------------------------------------------------------------------
 
 // Bitmap flags

-enum
+enum wxBitmapType

 {
 {

-    wxBITMAP_TYPE_BMP = 1,
+    wxBITMAP_TYPE_INVALID,          // should be == 0 for compatibility!
+    wxBITMAP_TYPE_BMP,

     wxBITMAP_TYPE_BMP_RESOURCE,
     wxBITMAP_TYPE_RESOURCE = wxBITMAP_TYPE_BMP_RESOURCE,
     wxBITMAP_TYPE_ICO,
     wxBITMAP_TYPE_BMP_RESOURCE,
     wxBITMAP_TYPE_RESOURCE = wxBITMAP_TYPE_BMP_RESOURCE,
     wxBITMAP_TYPE_ICO,


@@ -72,6 +74,14 @@ enum
     wxBITMAP_TYPE_PNM_RESOURCE,
     wxBITMAP_TYPE_PCX,
     wxBITMAP_TYPE_PCX_RESOURCE,
     wxBITMAP_TYPE_PNM_RESOURCE,
     wxBITMAP_TYPE_PCX,
     wxBITMAP_TYPE_PCX_RESOURCE,

+    wxBITMAP_TYPE_PICT,
+    wxBITMAP_TYPE_PICT_RESOURCE,
+    wxBITMAP_TYPE_ICON,
+    wxBITMAP_TYPE_ICON_RESOURCE,
+    wxBITMAP_TYPE_ANI,
+    wxBITMAP_TYPE_IFF,
+    wxBITMAP_TYPE_MACCURSOR,
+    wxBITMAP_TYPE_MACCURSOR_RESOURCE,

     wxBITMAP_TYPE_ANY = 50
 };
 
     wxBITMAP_TYPE_ANY = 50
 };
 


@@ -80,6 +90,7 @@ enum wxStockCursor
 {
     wxCURSOR_NONE,          // should be 0
     wxCURSOR_ARROW,
 {
     wxCURSOR_NONE,          // should be 0
     wxCURSOR_ARROW,

+    wxCURSOR_RIGHT_ARROW,

     wxCURSOR_BULLSEYE,
     wxCURSOR_CHAR,
     wxCURSOR_CROSS,
     wxCURSOR_BULLSEYE,
     wxCURSOR_CHAR,
     wxCURSOR_CROSS,


@@ -115,9 +126,15 @@ enum wxStockCursor
     wxCURSOR_BASED_ARROW_DOWN,
 #endif // X11
 
     wxCURSOR_BASED_ARROW_DOWN,
 #endif // X11
 

+    wxCURSOR_ARROWWAIT,
+

     wxCURSOR_MAX
 };
 
     wxCURSOR_MAX
 };
 

+#ifndef __WXGTK__
+    #define wxCURSOR_DEFAULT wxCURSOR_ARROW
+#endif
+

 // ---------------------------------------------------------------------------
 // macros
 // ---------------------------------------------------------------------------
 // ---------------------------------------------------------------------------
 // macros
 // ---------------------------------------------------------------------------


@@ -134,19 +151,41 @@ enum wxStockCursor
 
 #ifdef __WXMSW__
     // Load from a resource
 
 #ifdef __WXMSW__
     // Load from a resource

-    #define wxICON(X) wxIcon("" #X "")
+    #define wxICON(X) wxIcon(wxT(#X))

 #elif defined(__WXPM__)
     // Load from a resource
 #elif defined(__WXPM__)
     // Load from a resource

-    #define wxICON(X) wxIcon("" #X "")
+    #define wxICON(X) wxIcon(wxT(#X))
+#elif defined(__WXMGL__)
+    // Initialize from an included XPM
+    #define wxICON(X) wxIcon( (const char**) X##_xpm )

 #elif defined(__WXGTK__)
     // Initialize from an included XPM
     #define wxICON(X) wxIcon( (const char**) X##_xpm )
 #elif defined(__WXGTK__)
     // Initialize from an included XPM
     #define wxICON(X) wxIcon( (const char**) X##_xpm )

+#elif defined(__WXMAC__)
+    // Initialize from an included XPM
+    #define wxICON(X) wxIcon( (const char**) X##_xpm )

 #elif defined(__WXMOTIF__)
     // Initialize from an included XPM
     #define wxICON(X) wxIcon( X##_xpm )
 #elif defined(__WXMOTIF__)
     // Initialize from an included XPM
     #define wxICON(X) wxIcon( X##_xpm )

+#elif defined(__WXX11__)
+    // Initialize from an included XPM
+    #define wxICON(X) wxIcon( X##_xpm )

 #else
     // This will usually mean something on any platform
 #else
     // This will usually mean something on any platform

-    #define wxICON(X) wxIcon("" #X "")
+    #define wxICON(X) wxIcon(wxT(#X))
+#endif // platform
+
+/* Another macro: this one is for portable creation of bitmaps. We assume that
+   under Unix bitmaps live in XPMs and under Windows they're in ressources.
+ */
+
+#if defined(__WXMSW__) || defined(__WXPM__)
+    #define wxBITMAP(name) wxBitmap(wxT(#name), wxBITMAP_TYPE_RESOURCE)
+#elif defined(__WXGTK__) || defined(__WXMOTIF__) || defined(__WXX11__) || defined(__WXMAC__) || defined(__WXMGL__)
+    // Initialize from an included XPM
+    #define wxBITMAP(name) wxBitmap( (const char**) name##_xpm )
+#else // other platforms
+    #define wxBITMAP(name) wxBitmap(name##_xpm, wxBITMAP_TYPE_XPM)

 #endif // platform
 
 // ===========================================================================
 #endif // platform
 
 // ===========================================================================


@@ -156,37 +195,39 @@ enum wxStockCursor
 // ---------------------------------------------------------------------------
 // wxSize
 // ---------------------------------------------------------------------------
 // ---------------------------------------------------------------------------
 // wxSize
 // ---------------------------------------------------------------------------

+

 class WXDLLEXPORT wxSize
 {
 public:
     // members are public for compatibility (don't use them directly,
     // especially that there names were chosen very unfortunately - they should
     // have been called width and height)
 class WXDLLEXPORT wxSize
 {
 public:
     // members are public for compatibility (don't use them directly,
     // especially that there names were chosen very unfortunately - they should
     // have been called width and height)

-    long x;
-    long y;
+    int x, y;

 
     // constructors
 
     // constructors

-    wxSize() { x = y = 0; }
-    wxSize(long xx, long yy) { Set(xx, yy); }
+    wxSize() : x(0), y(0) { }
+    wxSize(int xx, int yy) : x(xx), y(yy) { }

 
     // no copy ctor or assignment operator - the defaults are ok
 
     // no copy ctor or assignment operator - the defaults are ok

+

     bool operator==(const wxSize& sz) const { return x == sz.x && y == sz.y; }
     bool operator==(const wxSize& sz) const { return x == sz.x && y == sz.y; }

+    bool operator!=(const wxSize& sz) const { return x != sz.x || y != sz.y; }

 
     // FIXME are these really useful? If they're, we should have += &c as well
     wxSize operator+(const wxSize& sz) { return wxSize(x + sz.x, y + sz.y); }
     wxSize operator-(const wxSize& sz) { return wxSize(x - sz.x, y - sz.y); }
 
     // accessors
 
     // FIXME are these really useful? If they're, we should have += &c as well
     wxSize operator+(const wxSize& sz) { return wxSize(x + sz.x, y + sz.y); }
     wxSize operator-(const wxSize& sz) { return wxSize(x - sz.x, y - sz.y); }
 
     // accessors

-    void Set(long xx, long yy) { x = xx; y = yy; }
-    void SetWidth(long w) { x = w; }
-    void SetHeight(long h) { y = h; }
+    void Set(int xx, int yy) { x = xx; y = yy; }
+    void SetWidth(int w) { x = w; }
+    void SetHeight(int h) { y = h; }

 
 

-    long GetWidth() const { return x; }
-    long GetHeight() const { return y; }
+    int GetWidth() const { return x; }
+    int GetHeight() const { return y; }

 
     // compatibility
 
     // compatibility

-    long GetX() const { return x; }
-    long GetY() const { return y; }
+    int GetX() const { return x; }
+    int GetY() const { return y; }

 };
 
 // ---------------------------------------------------------------------------
 };
 
 // ---------------------------------------------------------------------------


@@ -199,28 +240,23 @@ public:
     double x;
     double y;
 
     double x;
     double y;
 

-    wxRealPoint() { x = y = 0.0; };
-    wxRealPoint(double xx, double yy) { x = xx; y = yy; };
+    wxRealPoint() : x(0.0), y(0.0) { }
+    wxRealPoint(double xx, double yy) : x(xx), y(yy) { }

 
 

-    wxRealPoint operator+(const wxRealPoint& pt) { return wxRealPoint(x + pt.x, y + pt.y); }
-    wxRealPoint operator-(const wxRealPoint& pt) { return wxRealPoint(x - pt.x, y - pt.y); }
+    wxRealPoint operator+(const wxRealPoint& pt) const { return wxRealPoint(x + pt.x, y + pt.y); }
+    wxRealPoint operator-(const wxRealPoint& pt) const { return wxRealPoint(x - pt.x, y - pt.y); }

 
     bool operator==(const wxRealPoint& pt) const { return x == pt.x && y == pt.y; }
 
     bool operator==(const wxRealPoint& pt) const { return x == pt.x && y == pt.y; }

+    bool operator!=(const wxRealPoint& pt) const { return x != pt.x || y != pt.y; }

 };
 
 class WXDLLEXPORT wxPoint
 {
 public:
 };
 
 class WXDLLEXPORT wxPoint
 {
 public:

-#if defined(__WXMSW__) && !defined(__WIN32__)
-    int x;
-    int y;
-#else
-    long x;
-    long y;
-#endif
+    int x, y;

 
 

-    wxPoint() { x = y = 0; };
-    wxPoint(long xx, long yy) { x = xx; y = yy; };
+    wxPoint() : x(0), y(0) { }
+    wxPoint(int xx, int yy) : x(xx), y(yy) { }

 
     // no copy ctor or assignment operator - the defaults are ok
 
 
     // no copy ctor or assignment operator - the defaults are ok
 


@@ -229,8 +265,8 @@ public:
     bool operator!=(const wxPoint& p) const { return !(*this == p); }
 
     // arithmetic operations (component wise)
     bool operator!=(const wxPoint& p) const { return !(*this == p); }
 
     // arithmetic operations (component wise)

-    wxPoint operator+(const wxPoint& p) { return wxPoint(x + p.x, y + p.y); }
-    wxPoint operator-(const wxPoint& p) { return wxPoint(x - p.x, y - p.y); }
+    wxPoint operator+(const wxPoint& p) const { return wxPoint(x + p.x, y + p.y); }
+    wxPoint operator-(const wxPoint& p) const { return wxPoint(x - p.x, y - p.y); }

 
     wxPoint& operator+=(const wxPoint& p) { x += p.x; y += p.y; return *this; }
     wxPoint& operator-=(const wxPoint& p) { x -= p.x; y -= p.y; return *this; }
 
     wxPoint& operator+=(const wxPoint& p) { x += p.x; y += p.y; return *this; }
     wxPoint& operator-=(const wxPoint& p) { x -= p.x; y -= p.y; return *this; }


@@ -248,56 +284,99 @@ public:
 class WXDLLEXPORT wxRect
 {
 public:
 class WXDLLEXPORT wxRect
 {
 public:

-    wxRect() { x = y = width = height = 0; }
-    wxRect(long xx, long yy, long ww, long hh)
-        { x = xx; y = yy; width = ww; height = hh; }
+    wxRect()
+        : x(0), y(0), width(0), height(0)
+        { }
+    wxRect(int xx, int yy, int ww, int hh)
+        : x(xx), y(yy), width(ww), height(hh)
+        { }

     wxRect(const wxPoint& topLeft, const wxPoint& bottomRight);
     wxRect(const wxPoint& pos, const wxSize& size);
 
     // default copy ctor and assignment operators ok
 
     wxRect(const wxPoint& topLeft, const wxPoint& bottomRight);
     wxRect(const wxPoint& pos, const wxSize& size);
 
     // default copy ctor and assignment operators ok
 

-    long GetX() const { return x; }
-    void SetX(long xx) { x = xx; }
+    int GetX() const { return x; }
+    void SetX(int xx) { x = xx; }

 
 

-    long GetY() const { return y; }
-    void SetY(long yy) { y = yy; }
+    int GetY() const { return y; }
+    void SetY(int yy) { y = yy; }

 
 

-    long GetWidth() const { return width; }
-    void SetWidth(long w) { width = w; }
+    int GetWidth() const { return width; }
+    void SetWidth(int w) { width = w; }

 
 

-    long GetHeight() const { return height; }
-    void SetHeight(long h) { height = h; }
+    int GetHeight() const { return height; }
+    void SetHeight(int h) { height = h; }

 
     wxPoint GetPosition() const { return wxPoint(x, y); }
 
     wxPoint GetPosition() const { return wxPoint(x, y); }

-    wxSize GetSize() const { return wxSize(width, height); }
-
-    // MFC-like functions
-
-    long GetLeft()   const { return x; }
-    long GetTop()    const { return y; }
-    long GetBottom() const { return y + height - 1; }
-    long GetRight()  const { return x + width - 1; }
-
-    void SetLeft(long left) { x = left; }
-    void SetRight(long right) { width = right - x + 1; }
-    void SetTop(long top) { y = top; }
-    void SetBottom(long bottom) { height = bottom - y + 1; }
+    void SetPosition( const wxPoint &p ) { x = p.x; y = p.y; }

 
 

+    wxSize GetSize() const { return wxSize(width, height); }
+    void SetSize( const wxSize &s ) { width = s.GetWidth(); height = s.GetHeight(); }
+
+    int GetLeft()   const { return x; }
+    int GetTop()    const { return y; }
+    int GetBottom() const { return y + height - 1; }
+    int GetRight()  const { return x + width - 1; }
+
+    void SetLeft(int left) { x = left; }
+    void SetRight(int right) { width = right - x + 1; }
+    void SetTop(int top) { y = top; }
+    void SetBottom(int bottom) { height = bottom - y + 1; }
+
+    // operations with rect
+    wxRect& Inflate(wxCoord dx, wxCoord dy);
+    wxRect& Inflate(wxCoord d) { return Inflate(d, d); }
+    wxRect Inflate(wxCoord dx, wxCoord dy) const
+    {
+        wxRect r = *this;
+        r.Inflate(dx, dy);
+        return r;
+    }
+
+    wxRect& Deflate(wxCoord dx, wxCoord dy) { return Inflate(-dx, -dy); }
+    wxRect& Deflate(wxCoord d) { return Inflate(-d); }
+    wxRect Deflate(wxCoord dx, wxCoord dy) const
+    {
+        wxRect r = *this;
+        r.Deflate(dx, dy);
+        return r;
+    }
+
+    void Offset(wxCoord dx, wxCoord dy) { x += dx; y += dy; }
+    void Offset(const wxPoint& pt) { Offset(pt.x, pt.y); }
+
+    wxRect& Intersect(const wxRect& rect);
+    wxRect Intersect(const wxRect& rect) const
+    {
+        wxRect r = *this;
+        r.Intersect(rect);
+        return r;
+    }
+
+    wxRect operator+(const wxRect& rect) const;
+    wxRect& operator+=(const wxRect& rect);
+
+    // compare rectangles

     bool operator==(const wxRect& rect) const;
     bool operator!=(const wxRect& rect) const { return !(*this == rect); }
 
     bool operator==(const wxRect& rect) const;
     bool operator!=(const wxRect& rect) const { return !(*this == rect); }
 

-    bool Inside(int cx, int cy) const;
-    wxRect operator + (const wxRect& rect) const;
-    const wxRect& operator += (const wxRect& rect);
-    
+    // return TRUE if the point is (not strcitly) inside the rect
+    bool Inside(int x, int y) const;
+    bool Inside(const wxPoint& pt) const { return Inside(pt.x, pt.y); }
+
+    // return TRUE if the rectangles have a non empty intersection
+    bool Intersects(const wxRect& rect) const;
+

 public:
 public:

-    long x, y, width, height;
+    int x, y, width, height;

 };
 
 // ---------------------------------------------------------------------------
 // Management of pens, brushes and fonts
 // ---------------------------------------------------------------------------
 
 };
 
 // ---------------------------------------------------------------------------
 // Management of pens, brushes and fonts
 // ---------------------------------------------------------------------------
 

+typedef wxInt8 wxDash;
+

 class WXDLLEXPORT wxPenList : public wxList
 {
     DECLARE_DYNAMIC_CLASS(wxPenList)
 class WXDLLEXPORT wxPenList : public wxList
 {
     DECLARE_DYNAMIC_CLASS(wxPenList)


@@ -338,7 +417,8 @@ public:
     void RemoveFont(wxFont *font);
     wxFont *FindOrCreateFont(int pointSize, int family, int style, int weight,
                              bool underline = FALSE,
     void RemoveFont(wxFont *font);
     wxFont *FindOrCreateFont(int pointSize, int family, int style, int weight,
                              bool underline = FALSE,

-                             const wxString& face = wxEmptyString);
+                             const wxString& face = wxEmptyString,
+                             wxFontEncoding encoding = wxFONTENCODING_DEFAULT);

 };
 
 class WXDLLEXPORT wxColourDatabase : public wxList
 };
 
 class WXDLLEXPORT wxColourDatabase : public wxList


@@ -353,6 +433,11 @@ public:
     wxColour *FindColour(const wxString& colour) ;
     wxString FindName(const wxColour& colour) const;
     void Initialize();
     wxColour *FindColour(const wxString& colour) ;
     wxString FindName(const wxColour& colour) const;
     void Initialize();

+#ifdef __WXPM__
+    // PM keeps its own type of colour table
+    long*                           m_palTable;
+    size_t                          m_nSize;
+#endif

 };
 
 class WXDLLEXPORT wxBitmapList : public wxList
 };
 
 class WXDLLEXPORT wxBitmapList : public wxList


@@ -466,9 +551,15 @@ extern bool WXDLLEXPORT wxColourDisplay();
 extern int WXDLLEXPORT wxDisplayDepth();
 #define wxGetDisplayDepth wxDisplayDepth
 
 extern int WXDLLEXPORT wxDisplayDepth();
 #define wxGetDisplayDepth wxDisplayDepth
 

-// get the diaplay size
+// get the display size

 extern void WXDLLEXPORT wxDisplaySize(int *width, int *height);
 extern wxSize WXDLLEXPORT wxGetDisplaySize();
 extern void WXDLLEXPORT wxDisplaySize(int *width, int *height);
 extern wxSize WXDLLEXPORT wxGetDisplaySize();

+extern void WXDLLEXPORT wxDisplaySizeMM(int *width, int *height);
+extern wxSize WXDLLEXPORT wxGetDisplaySizeMM();
+
+// Get position and size of the display workarea
+extern void WXDLLEXPORT wxClientDisplayRect(int *x, int *y, int *width, int *height);
+extern wxRect WXDLLEXPORT wxGetClientDisplayRect();

 
 // set global cursor
 extern void WXDLLEXPORT wxSetCursor(const wxCursor& cursor);
 
 // set global cursor
 extern void WXDLLEXPORT wxSetCursor(const wxCursor& cursor);