]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/gdicmn.h
Commited FRM's stockitem patch (empty stock items).
[wxWidgets.git] / include / wx / gdicmn.h
index 83858f5c855a56eac71d56a8883386037c001854..8462c37eb2ffa6ec9766154ba40ca68c3bc4f431 100644 (file)
@@ -1,11 +1,11 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        gdicmn.h
+// Name:        wx/gdicmn.h
 // Purpose:     Common GDI classes, types and declarations
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
-// Copyright:   (c)
+// Copyright:   (c) Julian Smart
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // headers
 // ---------------------------------------------------------------------------
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "gdicmn.h"
-#endif
-
-#include "wx/setup.h"
+#include "wx/defs.h"
 #include "wx/list.h"
 #include "wx/string.h"
 #include "wx/fontenc.h"
 #include "wx/hashmap.h"
+#include "wx/math.h"
 
 // ---------------------------------------------------------------------------
 // forward declarations
@@ -217,15 +214,24 @@ public:
     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); }
+    wxSize operator+(const wxSize& sz) const { return wxSize(x + sz.x, y + sz.y); }
+    wxSize operator-(const wxSize& sz) const { return wxSize(x - sz.x, y - sz.y); }
+    wxSize operator/(int i) const { return wxSize(x / i, y / i); }
+    wxSize operator*(int i) const { return wxSize(x * i, y * i); }
+
+    wxSize& operator+=(const wxSize& sz) { x += sz.x; y += sz.y; return *this; }
+    wxSize& operator-=(const wxSize& sz) { x -= sz.x; y -= sz.y; return *this; }
+    wxSize& operator/=(const int i) { x /= i; y /= i; return *this; }
+    wxSize& operator*=(const int i) { x *= i; y *= i; return *this; }
 
     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; }
 
+    void Scale(float xscale, float yscale)
+        { x = (int)(x*xscale); y = (int)(y*yscale); }
+
     // accessors
     void Set(int xx, int yy) { x = xx; y = yy; }
     void SetWidth(int w) { x = w; }
@@ -267,10 +273,14 @@ public:
     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 wxIsSameDouble(x, pt.x) && wxIsSameDouble(y, pt.y);
+    }
+    bool operator!=(const wxRealPoint& pt) const { return !(*this == pt); }
 };
 
+
 class WXDLLEXPORT wxPoint
 {
 public:
@@ -313,7 +323,12 @@ public:
         : x(xx), y(yy), width(ww), height(hh)
         { }
     wxRect(const wxPoint& topLeft, const wxPoint& bottomRight);
-    wxRect(const wxPoint& pos, const wxSize& size);
+    wxRect(const wxPoint& pt, const wxSize& size)
+        : x(pt.x), y(pt.y), width(size.x), height(size.y)
+        { }
+    wxRect(const wxSize& size)
+        : x(0), y(0), width(size.x), height(size.y)
+        { }
 
     // default copy ctor and assignment operators ok
 
@@ -335,6 +350,8 @@ public:
     wxSize GetSize() const { return wxSize(width, height); }
     void SetSize( const wxSize &s ) { width = s.GetWidth(); height = s.GetHeight(); }
 
+    bool IsEmpty() const { return (width <= 0) || (height <= 0); }
+
     wxPoint GetTopLeft() const { return GetPosition(); }
     wxPoint GetLeftTop() const { return GetTopLeft(); }
     void SetTopLeft(const wxPoint &p) { SetPosition(p); }
@@ -385,8 +402,13 @@ public:
         return r;
     }
 
-    wxRect operator+(const wxRect& rect) const;
-    wxRect& operator+=(const wxRect& rect);
+    wxRect& Union(const wxRect& rect);
+    wxRect Union(const wxRect& rect) const
+    {
+        wxRect r = *this;
+        r.Union(rect);
+        return r;
+    }
 
     // compare rectangles
     bool operator==(const wxRect& rect) const;
@@ -395,10 +417,36 @@ public:
     // 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 rectangle is (not strcitly) inside the rect
+    bool Inside(const wxRect& rect) const;
 
     // return true if the rectangles have a non empty intersection
     bool Intersects(const wxRect& rect) const;
 
+
+    // these are like Union() but don't ignore empty rectangles
+    wxRect operator+(const wxRect& rect) const;
+    wxRect& operator+=(const wxRect& rect)
+    {
+        *this = *this + rect;
+        return *this;
+    }
+
+
+    // centre this rectangle in the given (usually, but not necessarily,
+    // larger) one
+    wxRect CentreIn(const wxRect& r, int dir = wxBOTH) const
+    {
+        return wxRect(dir & wxHORIZONTAL ? r.x + (r.width - width)/2 : x,
+                      dir & wxVERTICAL ? r.y + (r.height - height)/2 : y,
+                      width, height);
+    }
+
+    wxRect CenterIn(const wxRect& r, int dir = wxBOTH) const
+    {
+        return CentreIn(r, dir);
+    }
+
 public:
     int x, y, width, height;
 };
@@ -409,43 +457,49 @@ public:
 
 typedef wxInt8 wxDash;
 
-class WXDLLEXPORT wxPenList : public wxList
-{
+class WXDLLIMPEXP_CORE wxGDIObjListBase {
 public:
-    wxPenList() { }
-    ~wxPenList();
+    wxGDIObjListBase();
+    ~wxGDIObjListBase();
 
-    void AddPen(wxPen *pen);
-    void RemovePen(wxPen *pen);
-    wxPen *FindOrCreatePen(const wxColour& colour, int width, int style);
+protected:
+    wxList list;
 };
 
-class WXDLLEXPORT wxBrushList : public wxList
+class WXDLLIMPEXP_CORE wxPenList: public wxGDIObjListBase
 {
 public:
-    wxBrushList() { }
-    ~wxBrushList();
-
-    void AddBrush(wxBrush *brush);
-    void RemoveBrush(wxBrush *brush);
-    wxBrush *FindOrCreateBrush(const wxColour& colour, int style);
+    wxPen *FindOrCreatePen(const wxColour& colour, int width, int style);
+#if WXWIN_COMPATIBILITY_2_6
+    wxDEPRECATED( void AddPen(wxPen*) );
+    wxDEPRECATED( void RemovePen(wxPen*) );
+#endif
 };
 
-class WXDLLEXPORT wxFontList : public wxList
+class WXDLLIMPEXP_CORE wxBrushList: public wxGDIObjListBase
 {
 public:
-    wxFontList() { }
-    ~wxFontList();
+    wxBrush *FindOrCreateBrush(const wxColour& colour, int style = wxSOLID);
+#if WXWIN_COMPATIBILITY_2_6
+    wxDEPRECATED( void AddBrush(wxBrush*) );
+    wxDEPRECATED( void RemoveBrush(wxBrush*) );
+#endif
+};
 
-    void AddFont(wxFont *font);
-    void RemoveFont(wxFont *font);
+class WXDLLIMPEXP_CORE wxFontList: public wxGDIObjListBase
+{
+public:
     wxFont *FindOrCreateFont(int pointSize, int family, int style, int weight,
                              bool underline = false,
                              const wxString& face = wxEmptyString,
                              wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
+#if WXWIN_COMPATIBILITY_2_6
+    wxDEPRECATED( void AddFont(wxFont*) );
+    wxDEPRECATED( void RemoveFont(wxFont*) );
+#endif
 };
 
-WX_DECLARE_STRING_HASH_MAP( wxColour *, wxStringToColourHashMap );
+WX_DECLARE_STRING_HASH_MAP(wxColour*, wxStringToColourHashMap);
 
 class WXDLLEXPORT wxColourDatabase
 {
@@ -460,8 +514,10 @@ public:
     // add a new colour to the database
     void AddColour(const wxString& name, const wxColour& colour);
 
+#if WXWIN_COMPATIBILITY_2_6
     // deprecated, use Find() instead
     wxDEPRECATED( wxColour *FindColour(const wxString& name) );
+#endif // WXWIN_COMPATIBILITY_2_6
 
 
 #ifdef __WXPM__
@@ -478,16 +534,6 @@ private:
     wxStringToColourHashMap *m_map;
 };
 
-class WXDLLEXPORT wxBitmapList : public wxList
-{
-public:
-    wxBitmapList(){}
-    ~wxBitmapList();
-
-    void AddBitmap(wxBitmap *bitmap);
-    void RemoveBitmap(wxBitmap *bitmap);
-};
-
 class WXDLLEXPORT wxResourceCache: public wxList
 {
 public:
@@ -503,80 +549,144 @@ public:
 // ---------------------------------------------------------------------------
 
 // Lists of GDI objects
-WXDLLEXPORT_DATA(extern wxPenList*)   wxThePenList;
-WXDLLEXPORT_DATA(extern wxBrushList*)   wxTheBrushList;
-WXDLLEXPORT_DATA(extern wxFontList*)    wxTheFontList;
-WXDLLEXPORT_DATA(extern wxBitmapList*)  wxTheBitmapList;
-
-// Stock objects
-WXDLLEXPORT_DATA(extern wxFont*)      wxNORMAL_FONT;
-WXDLLEXPORT_DATA(extern wxFont*)      wxSMALL_FONT;
-WXDLLEXPORT_DATA(extern wxFont*)      wxITALIC_FONT;
-WXDLLEXPORT_DATA(extern wxFont*)      wxSWISS_FONT;
-
-WXDLLEXPORT_DATA(extern wxPen*)      wxRED_PEN;
-WXDLLEXPORT_DATA(extern wxPen*)      wxCYAN_PEN;
-WXDLLEXPORT_DATA(extern wxPen*)      wxGREEN_PEN;
-WXDLLEXPORT_DATA(extern wxPen*)      wxBLACK_PEN;
-WXDLLEXPORT_DATA(extern wxPen*)      wxWHITE_PEN;
-WXDLLEXPORT_DATA(extern wxPen*)      wxTRANSPARENT_PEN;
-WXDLLEXPORT_DATA(extern wxPen*)      wxBLACK_DASHED_PEN;
-WXDLLEXPORT_DATA(extern wxPen*)      wxGREY_PEN;
-WXDLLEXPORT_DATA(extern wxPen*)      wxMEDIUM_GREY_PEN;
-WXDLLEXPORT_DATA(extern wxPen*)      wxLIGHT_GREY_PEN;
-
-WXDLLEXPORT_DATA(extern wxBrush*)    wxBLUE_BRUSH;
-WXDLLEXPORT_DATA(extern wxBrush*)    wxGREEN_BRUSH;
-WXDLLEXPORT_DATA(extern wxBrush*)    wxWHITE_BRUSH;
-WXDLLEXPORT_DATA(extern wxBrush*)    wxBLACK_BRUSH;
-WXDLLEXPORT_DATA(extern wxBrush*)    wxGREY_BRUSH;
-WXDLLEXPORT_DATA(extern wxBrush*)    wxMEDIUM_GREY_BRUSH;
-WXDLLEXPORT_DATA(extern wxBrush*)    wxLIGHT_GREY_BRUSH;
-WXDLLEXPORT_DATA(extern wxBrush*)    wxTRANSPARENT_BRUSH;
-WXDLLEXPORT_DATA(extern wxBrush*)    wxCYAN_BRUSH;
-WXDLLEXPORT_DATA(extern wxBrush*)    wxRED_BRUSH;
-
-WXDLLEXPORT_DATA(extern wxColour*)    wxBLACK;
-WXDLLEXPORT_DATA(extern wxColour*)    wxWHITE;
-WXDLLEXPORT_DATA(extern wxColour*)    wxRED;
-WXDLLEXPORT_DATA(extern wxColour*)    wxBLUE;
-WXDLLEXPORT_DATA(extern wxColour*)    wxGREEN;
-WXDLLEXPORT_DATA(extern wxColour*)    wxCYAN;
-WXDLLEXPORT_DATA(extern wxColour*)    wxLIGHT_GREY;
-
-// 'Null' objects
-WXDLLEXPORT_DATA(extern wxBitmap)     wxNullBitmap;
-WXDLLEXPORT_DATA(extern wxIcon)       wxNullIcon;
-WXDLLEXPORT_DATA(extern wxCursor)     wxNullCursor;
-WXDLLEXPORT_DATA(extern wxPen)        wxNullPen;
-WXDLLEXPORT_DATA(extern wxBrush)      wxNullBrush;
-WXDLLEXPORT_DATA(extern wxPalette)     wxNullPalette;
-WXDLLEXPORT_DATA(extern wxFont)       wxNullFont;
-WXDLLEXPORT_DATA(extern wxColour)     wxNullColour;
+extern WXDLLEXPORT_DATA(wxPenList*)   wxThePenList;
+extern WXDLLEXPORT_DATA(wxBrushList*)   wxTheBrushList;
+extern WXDLLEXPORT_DATA(wxFontList*)    wxTheFontList;
+
+/* Stock objects
+
+  wxStockGDI creates the stock GDI objects on demand.  Pointers to the
+  created objects are stored in the ms_stockObject array, which is indexed
+  by the Item enum values.  Platorm-specific fonts can be created by
+  implementing a derived class with an override for the GetFont function.
+  wxStockGDI operates as a singleton, accessed through the ms_instance
+  pointer.  By default this pointer is set to an instance of wxStockGDI.
+  A derived class must arrange to set this pointer to an instance of itself.
+*/
+class WXDLLIMPEXP_CORE wxStockGDI
+{
+public:
+    enum Item {
+        BRUSH_BLACK,
+        BRUSH_BLUE,
+        BRUSH_CYAN,
+        BRUSH_GREEN,
+        BRUSH_GREY,
+        BRUSH_LIGHTGREY,
+        BRUSH_MEDIUMGREY,
+        BRUSH_RED,
+        BRUSH_TRANSPARENT,
+        BRUSH_WHITE,
+        COLOUR_BLACK,
+        COLOUR_BLUE,
+        COLOUR_CYAN,
+        COLOUR_GREEN,
+        COLOUR_LIGHTGREY,
+        COLOUR_RED,
+        COLOUR_WHITE,
+        CURSOR_CROSS,
+        CURSOR_HOURGLASS,
+        CURSOR_STANDARD,
+        FONT_ITALIC,
+        FONT_NORMAL,
+        FONT_SMALL,
+        FONT_SWISS,
+        PEN_BLACK,
+        PEN_BLACKDASHED,
+        PEN_CYAN,
+        PEN_GREEN,
+        PEN_GREY,
+        PEN_LIGHTGREY,
+        PEN_MEDIUMGREY,
+        PEN_RED,
+        PEN_TRANSPARENT,
+        PEN_WHITE,
+        ITEMCOUNT
+    };
+
+    wxStockGDI();
+    virtual ~wxStockGDI();
+    static void DeleteAll();
+
+    static wxStockGDI& instance() { return *ms_instance; }
+
+    static const wxBrush* GetBrush(Item item);
+    static const wxColour* GetColour(Item item);
+    static const wxCursor* GetCursor(Item item);
+    // Can be overridden by platform-specific derived classes
+    virtual const wxFont* GetFont(Item item);
+    static const wxPen* GetPen(Item item);
+
+protected:
+    static wxStockGDI* ms_instance;
+
+    static wxObject* ms_stockObject[ITEMCOUNT];
+
+    DECLARE_NO_COPY_CLASS(wxStockGDI)
+};
 
-// Stock cursors types
-WXDLLEXPORT_DATA(extern wxCursor*)    wxSTANDARD_CURSOR;
-WXDLLEXPORT_DATA(extern wxCursor*)    wxHOURGLASS_CURSOR;
-WXDLLEXPORT_DATA(extern wxCursor*)    wxCROSS_CURSOR;
+#define wxITALIC_FONT  wxStockGDI::instance().GetFont(wxStockGDI::FONT_ITALIC)
+#define wxNORMAL_FONT  wxStockGDI::instance().GetFont(wxStockGDI::FONT_NORMAL)
+#define wxSMALL_FONT   wxStockGDI::instance().GetFont(wxStockGDI::FONT_SMALL)
+#define wxSWISS_FONT   wxStockGDI::instance().GetFont(wxStockGDI::FONT_SWISS)
+
+#define wxBLACK_DASHED_PEN  wxStockGDI::GetPen(wxStockGDI::PEN_BLACKDASHED)
+#define wxBLACK_PEN         wxStockGDI::GetPen(wxStockGDI::PEN_BLACK)
+#define wxCYAN_PEN          wxStockGDI::GetPen(wxStockGDI::PEN_CYAN)
+#define wxGREEN_PEN         wxStockGDI::GetPen(wxStockGDI::PEN_GREEN)
+#define wxGREY_PEN          wxStockGDI::GetPen(wxStockGDI::PEN_GREY)
+#define wxLIGHT_GREY_PEN    wxStockGDI::GetPen(wxStockGDI::PEN_LIGHTGREY)
+#define wxMEDIUM_GREY_PEN   wxStockGDI::GetPen(wxStockGDI::PEN_MEDIUMGREY)
+#define wxRED_PEN           wxStockGDI::GetPen(wxStockGDI::PEN_RED)
+#define wxTRANSPARENT_PEN   wxStockGDI::GetPen(wxStockGDI::PEN_TRANSPARENT)
+#define wxWHITE_PEN         wxStockGDI::GetPen(wxStockGDI::PEN_WHITE)
+
+#define wxBLACK_BRUSH        wxStockGDI::GetBrush(wxStockGDI::BRUSH_BLACK)
+#define wxBLUE_BRUSH         wxStockGDI::GetBrush(wxStockGDI::BRUSH_BLUE)
+#define wxCYAN_BRUSH         wxStockGDI::GetBrush(wxStockGDI::BRUSH_CYAN)
+#define wxGREEN_BRUSH        wxStockGDI::GetBrush(wxStockGDI::BRUSH_GREEN)
+#define wxGREY_BRUSH         wxStockGDI::GetBrush(wxStockGDI::BRUSH_GREY)
+#define wxLIGHT_GREY_BRUSH   wxStockGDI::GetBrush(wxStockGDI::BRUSH_LIGHTGREY)
+#define wxMEDIUM_GREY_BRUSH  wxStockGDI::GetBrush(wxStockGDI::BRUSH_MEDIUMGREY)
+#define wxRED_BRUSH          wxStockGDI::GetBrush(wxStockGDI::BRUSH_RED)
+#define wxTRANSPARENT_BRUSH  wxStockGDI::GetBrush(wxStockGDI::BRUSH_TRANSPARENT)
+#define wxWHITE_BRUSH        wxStockGDI::GetBrush(wxStockGDI::BRUSH_WHITE)
+
+#define wxBLACK       wxStockGDI::GetColour(wxStockGDI::COLOUR_BLACK)
+#define wxBLUE        wxStockGDI::GetColour(wxStockGDI::COLOUR_BLUE)
+#define wxCYAN        wxStockGDI::GetColour(wxStockGDI::COLOUR_CYAN)
+#define wxGREEN       wxStockGDI::GetColour(wxStockGDI::COLOUR_GREEN)
+#define wxLIGHT_GREY  wxStockGDI::GetColour(wxStockGDI::COLOUR_LIGHTGREY)
+#define wxRED         wxStockGDI::GetColour(wxStockGDI::COLOUR_RED)
+#define wxWHITE       wxStockGDI::GetColour(wxStockGDI::COLOUR_WHITE)
+
+#define wxCROSS_CURSOR      wxStockGDI::GetCursor(wxStockGDI::CURSOR_CROSS)
+#define wxHOURGLASS_CURSOR  wxStockGDI::GetCursor(wxStockGDI::CURSOR_HOURGLASS)
+#define wxSTANDARD_CURSOR   wxStockGDI::GetCursor(wxStockGDI::CURSOR_STANDARD)
 
-WXDLLEXPORT_DATA(extern wxColourDatabase*)  wxTheColourDatabase;
+// 'Null' objects
+extern WXDLLEXPORT_DATA(wxBitmap)     wxNullBitmap;
+extern WXDLLEXPORT_DATA(wxIcon)       wxNullIcon;
+extern WXDLLEXPORT_DATA(wxCursor)     wxNullCursor;
+extern WXDLLEXPORT_DATA(wxPen)        wxNullPen;
+extern WXDLLEXPORT_DATA(wxBrush)      wxNullBrush;
+extern WXDLLEXPORT_DATA(wxPalette)     wxNullPalette;
+extern WXDLLEXPORT_DATA(wxFont)       wxNullFont;
+extern WXDLLEXPORT_DATA(wxColour)     wxNullColour;
 
-WXDLLEXPORT_DATA(extern const wxChar*) wxPanelNameStr;
+extern WXDLLEXPORT_DATA(wxColourDatabase*)  wxTheColourDatabase;
 
-WXDLLEXPORT_DATA(extern const wxSize) wxDefaultSize;
-WXDLLEXPORT_DATA(extern const wxPoint) wxDefaultPosition;
+extern WXDLLEXPORT_DATA(const wxChar) wxPanelNameStr[];
 
-// The list of objects which should be deleted
-WXDLLEXPORT_DATA(extern wxList) wxPendingDelete;
+extern WXDLLEXPORT_DATA(const wxSize) wxDefaultSize;
+extern WXDLLEXPORT_DATA(const wxPoint) wxDefaultPosition;
 
 // ---------------------------------------------------------------------------
 // global functions
 // ---------------------------------------------------------------------------
 
 // resource management
-extern void WXDLLEXPORT wxInitializeStockObjects();
 extern void WXDLLEXPORT wxInitializeStockLists();
-extern void WXDLLEXPORT wxDeleteStockObjects();
 extern void WXDLLEXPORT wxDeleteStockLists();
 
 // is the display colour (or monochrome)?