]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/gdicmn.h
Wrappers for *ToText
[wxWidgets.git] / include / wx / gdicmn.h
index 0e197f0482cfe8ee380c128c63c60855ce7d4230..4147c63074bf1be5e9740b14d04a392e123e8017 100644 (file)
 // headers
 // ---------------------------------------------------------------------------
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
     #pragma interface "gdicmn.h"
 #endif
 
-#include "wx/object.h"
+#include "wx/setup.h"
 #include "wx/list.h"
-#include "wx/hash.h"
 #include "wx/string.h"
-#include "wx/setup.h"
-#include "wx/colour.h"
+#include "wx/fontenc.h"
+#include "wx/hashmap.h"
 
 // ---------------------------------------------------------------------------
 // forward declarations
 // ---------------------------------------------------------------------------
 
-class WXDLLEXPORT wxBitmap;
-class WXDLLEXPORT wxBrush;
-class WXDLLEXPORT wxColour;
-class WXDLLEXPORT wxCursor;
-class WXDLLEXPORT wxFont;
-class WXDLLEXPORT wxIcon;
-class WXDLLEXPORT wxPalette;
-class WXDLLEXPORT wxPen;
-class WXDLLEXPORT wxRegion;
-class WXDLLEXPORT wxString;
+class WXDLLIMPEXP_CORE wxBitmap;
+class WXDLLIMPEXP_CORE wxBrush;
+class WXDLLIMPEXP_CORE wxColour;
+class WXDLLIMPEXP_CORE wxCursor;
+class WXDLLIMPEXP_CORE wxFont;
+class WXDLLIMPEXP_CORE wxIcon;
+class WXDLLIMPEXP_CORE wxPalette;
+class WXDLLIMPEXP_CORE wxPen;
+class WXDLLIMPEXP_CORE wxRegion;
+class WXDLLIMPEXP_BASE wxString;
 
 // ---------------------------------------------------------------------------
 // constants
 // ---------------------------------------------------------------------------
 
 // 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,
@@ -68,6 +68,18 @@ enum
     wxBITMAP_TYPE_PNG_RESOURCE,
     wxBITMAP_TYPE_JPEG,
     wxBITMAP_TYPE_JPEG_RESOURCE,
+    wxBITMAP_TYPE_PNM,
+    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
 };
 
@@ -76,6 +88,7 @@ enum wxStockCursor
 {
     wxCURSOR_NONE,          // should be 0
     wxCURSOR_ARROW,
+    wxCURSOR_RIGHT_ARROW,
     wxCURSOR_BULLSEYE,
     wxCURSOR_CHAR,
     wxCURSOR_CROSS,
@@ -103,6 +116,9 @@ enum wxStockCursor
 #ifdef __WXGTK__
     wxCURSOR_DEFAULT, // standard X11 cursor
 #endif
+#ifdef __WXMAC__
+       wxCURSOR_COPY_ARROW , // MacOS Theme Plus arrow
+#endif
 #ifdef __X__
     // Not yet implemented for Windows
     wxCURSOR_CROSS_REVERSE,
@@ -111,9 +127,15 @@ enum wxStockCursor
     wxCURSOR_BASED_ARROW_DOWN,
 #endif // X11
 
+    wxCURSOR_ARROWWAIT,
+
     wxCURSOR_MAX
 };
 
+#ifndef __WXGTK__
+    #define wxCURSOR_DEFAULT wxCURSOR_ARROW
+#endif
+
 // ---------------------------------------------------------------------------
 // macros
 // ---------------------------------------------------------------------------
@@ -130,16 +152,46 @@ enum wxStockCursor
 
 #ifdef __WXMSW__
     // Load from a resource
-    #define wxICON(X) wxIcon("" #X "")
+    #define wxICON(X) wxIcon(wxT(#X))
+#elif defined(__WXPM__)
+    // Load from a resource
+    #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(__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(__WXX11__)
+    // Initialize from an included XPM
+    #define wxICON(X) wxIcon( X##_xpm )
 #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__)   || \
+      defined(__WXCOCOA__)
+    // 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
 
 // ===========================================================================
@@ -149,37 +201,54 @@ enum wxStockCursor
 // ---------------------------------------------------------------------------
 // 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)
-    long x;
-    long y;
+    // members are public for compatibility, don't use them directly.
+    int x, y;
 
     // 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
+
     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); }
 
+    void IncTo(const wxSize& sz)
+        { if ( sz.x > x ) x = sz.x; if ( sz.y > y ) y = sz.y; }
+    void DecTo(const wxSize& sz)
+        { if ( sz.x < x ) x = sz.x; if ( sz.y < y ) 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; }
+
+    bool IsFullySpecified() const { return x != -1 && y != -1; }
+
+    // combine this size with the other one replacing the default (i.e. equal
+    // to -1) components of this object with those of the other
+    void SetDefaults(const wxSize& size)
+    {
+        if ( x == -1 )
+            x = size.x;
+        if ( y == -1 )
+            y = size.y;
+    }
 
     // compatibility
-    long GetX() const { return x; }
-    long GetY() const { return y; }
+    int GetX() const { return x; }
+    int GetY() const { return y; }
 };
 
 // ---------------------------------------------------------------------------
@@ -192,28 +261,23 @@ public:
     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; }
 };
 
 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
 
@@ -222,17 +286,18 @@ public:
     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; }
-};
 
-#if WXWIN_COMPATIBILITY
-    #define wxIntPoint wxPoint
-    #define wxRectangle wxRect
-#endif // WXWIN_COMPATIBILITY
+    wxPoint& operator+=(const wxSize& s) { x += s.GetWidth(); y += s.GetHeight(); return *this; }
+    wxPoint& operator-=(const wxSize& s) { x -= s.GetWidth(); y -= s.GetHeight(); return *this; }
+
+    wxPoint operator+(const wxSize& s) const { return wxPoint(x + s.GetWidth(), y + s.GetHeight()); }
+    wxPoint operator-(const wxSize& s) const { return wxPoint(x - s.GetWidth(), y - s.GetHeight()); }
+};
 
 // ---------------------------------------------------------------------------
 // wxRect
@@ -241,60 +306,111 @@ 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
 
-    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); }
-    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(); }
+
+    wxPoint GetTopLeft() const { return GetPosition(); }
+    wxPoint GetLeftTop() const { return GetTopLeft(); }
+    void SetTopLeft(const wxPoint &p) { SetPosition(p); }
+    void SetLeftTop(const wxPoint &p) { SetTopLeft(p); }
+
+    wxPoint GetBottomRight() const { return wxPoint(GetRight(), GetBottom()); }
+    wxPoint GetRightBottom() const { return GetBottomRight(); }
+    void SetBottomRight(const wxPoint &p) { SetRight(p.x); SetBottom(p.y); }
+    void SetRightBottom(const wxPoint &p) { SetBottomRight(p); }
+
+    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 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:
-    long x, y, width, height;
+    int x, y, width, height;
 };
 
 // ---------------------------------------------------------------------------
 // Management of pens, brushes and fonts
 // ---------------------------------------------------------------------------
 
+typedef wxInt8 wxDash;
+
 class WXDLLEXPORT wxPenList : public wxList
 {
-    DECLARE_DYNAMIC_CLASS(wxPenList)
-
 public:
     wxPenList() { }
     ~wxPenList();
@@ -306,8 +422,6 @@ public:
 
 class WXDLLEXPORT wxBrushList : public wxList
 {
-    DECLARE_DYNAMIC_CLASS(wxBrushList)
-
 public:
     wxBrushList() { }
     ~wxBrushList();
@@ -317,12 +431,8 @@ public:
     wxBrush *FindOrCreateBrush(const wxColour& colour, int style);
 };
 
-WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
-
 class WXDLLEXPORT wxFontList : public wxList
 {
-    DECLARE_DYNAMIC_CLASS(wxFontList)
-
 public:
     wxFontList() { }
     ~wxFontList();
@@ -331,27 +441,45 @@ public:
     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
-{
-    DECLARE_CLASS(wxColourDatabase)
+WX_DECLARE_STRING_HASH_MAP( wxColour *, wxStringToColourHashMap );
 
+class WXDLLEXPORT wxColourDatabase
+{
 public:
-    wxColourDatabase(int type);
-    ~wxColourDatabase() ;
+    wxColourDatabase();
+    ~wxColourDatabase();
 
-    // Not const because it may add a name to the database
-    wxColour *FindColour(const wxString& colour) ;
+    // find colour by name or name for the given colour
+    wxColour Find(const wxString& name) const;
     wxString FindName(const wxColour& colour) const;
+
+    // add a new colour to the database
+    void AddColour(const wxString& name, const wxColour& colour);
+
+    // deprecated, use Find() instead
+    wxDEPRECATED( wxColour *FindColour(const wxString& name) );
+
+
+#ifdef __WXPM__
+    // PM keeps its own type of colour table
+    long*                           m_palTable;
+    size_t                          m_nSize;
+#endif
+
+private:
+    // load the database with the built in colour values when called for the
+    // first time, do nothing after this
     void Initialize();
+
+    wxStringToColourHashMap *m_map;
 };
 
 class WXDLLEXPORT wxBitmapList : public wxList
 {
-    DECLARE_DYNAMIC_CLASS(wxBitmapList)
-
 public:
     wxBitmapList();
     ~wxBitmapList();
@@ -364,11 +492,10 @@ class WXDLLEXPORT wxResourceCache: public wxList
 {
 public:
     wxResourceCache() { }
+#if !wxUSE_STL
     wxResourceCache(const unsigned int keyType) : wxList(keyType) { }
+#endif
     ~wxResourceCache();
-
-private:
-    DECLARE_DYNAMIC_CLASS(wxResourceCache)
 };
 
 // ---------------------------------------------------------------------------
@@ -459,9 +586,15 @@ extern bool WXDLLEXPORT wxColourDisplay();
 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 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);