Helper for clipping to range.

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

diff --git a/include/wx/gdicmn.h b/include/wx/gdicmn.h
index 968feded8829599274169eb1782dac932d6dc368..b1e5d72c182367316f3e1ba7bb949b3943954d2d 100644 (file)
--- a/include/wx/gdicmn.h
+++ b/include/wx/gdicmn.h
@@ -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$
 // 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
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 


@@ -16,15 +16,12 @@
 // headers
 // ---------------------------------------------------------------------------
 
 // 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/list.h"
 #include "wx/string.h"
 #include "wx/fontenc.h"
 #include "wx/hashmap.h"

+#include "wx/math.h"

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


@@ -217,10 +214,10 @@ 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; }
 
     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; }
 

-    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 int i) { return wxSize(x / i, y / i); }
-    wxSize operator*(const int i) { return wxSize(x * i, y * i); }
+    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 wxSize& sz) { x += sz.x; y += sz.y; return *this; }
     wxSize& operator-=(const wxSize& sz) { x -= sz.x; y -= sz.y; return *this; }


@@ -273,10 +270,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); }
 
     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:
 class WXDLLEXPORT wxPoint
 {
 public:


@@ -427,6 +428,20 @@ public:
     }
 
 
     }
 
 

+    // 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;
 };
 public:
     int x, y, width, height;
 };


@@ -437,40 +452,46 @@ public:
 
 typedef wxInt8 wxDash;
 
 
 typedef wxInt8 wxDash;
 

-class WXDLLEXPORT wxPenList : public wxList
-{
+class WXDLLIMPEXP_CORE wxGDIObjListBase {

 public:
 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:
 {
 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:
 {
 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);
     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 );


@@ -488,8 +509,10 @@ public:
     // add a new colour to the database
     void AddColour(const wxString& name, const wxColour& colour);
 
     // 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) );
     // deprecated, use Find() instead
     wxDEPRECATED( wxColour *FindColour(const wxString& name) );

+#endif // WXWIN_COMPATIBILITY_2_6

 
 
 #ifdef __WXPM__
 
 
 #ifdef __WXPM__


@@ -506,16 +529,6 @@ private:
     wxStringToColourHashMap *m_map;
 };
 
     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:
 class WXDLLEXPORT wxResourceCache: public wxList
 {
 public:


@@ -534,43 +547,117 @@ public:
 extern WXDLLEXPORT_DATA(wxPenList*)   wxThePenList;
 extern WXDLLEXPORT_DATA(wxBrushList*)   wxTheBrushList;
 extern WXDLLEXPORT_DATA(wxFontList*)    wxTheFontList;
 extern WXDLLEXPORT_DATA(wxPenList*)   wxThePenList;
 extern WXDLLEXPORT_DATA(wxBrushList*)   wxTheBrushList;
 extern WXDLLEXPORT_DATA(wxFontList*)    wxTheFontList;

-extern WXDLLEXPORT_DATA(wxBitmapList*)  wxTheBitmapList;
-
-// Stock objects
-extern WXDLLEXPORT_DATA(wxFont*)      wxNORMAL_FONT;
-extern WXDLLEXPORT_DATA(wxFont*)      wxSMALL_FONT;
-extern WXDLLEXPORT_DATA(wxFont*)      wxITALIC_FONT;
-extern WXDLLEXPORT_DATA(wxFont*)      wxSWISS_FONT;
-
-extern WXDLLEXPORT_DATA(wxPen*)      wxRED_PEN;
-extern WXDLLEXPORT_DATA(wxPen*)      wxCYAN_PEN;
-extern WXDLLEXPORT_DATA(wxPen*)      wxGREEN_PEN;
-extern WXDLLEXPORT_DATA(wxPen*)      wxBLACK_PEN;
-extern WXDLLEXPORT_DATA(wxPen*)      wxWHITE_PEN;
-extern WXDLLEXPORT_DATA(wxPen*)      wxTRANSPARENT_PEN;
-extern WXDLLEXPORT_DATA(wxPen*)      wxBLACK_DASHED_PEN;
-extern WXDLLEXPORT_DATA(wxPen*)      wxGREY_PEN;
-extern WXDLLEXPORT_DATA(wxPen*)      wxMEDIUM_GREY_PEN;
-extern WXDLLEXPORT_DATA(wxPen*)      wxLIGHT_GREY_PEN;
-
-extern WXDLLEXPORT_DATA(wxBrush*)    wxBLUE_BRUSH;
-extern WXDLLEXPORT_DATA(wxBrush*)    wxGREEN_BRUSH;
-extern WXDLLEXPORT_DATA(wxBrush*)    wxWHITE_BRUSH;
-extern WXDLLEXPORT_DATA(wxBrush*)    wxBLACK_BRUSH;
-extern WXDLLEXPORT_DATA(wxBrush*)    wxGREY_BRUSH;
-extern WXDLLEXPORT_DATA(wxBrush*)    wxMEDIUM_GREY_BRUSH;
-extern WXDLLEXPORT_DATA(wxBrush*)    wxLIGHT_GREY_BRUSH;
-extern WXDLLEXPORT_DATA(wxBrush*)    wxTRANSPARENT_BRUSH;
-extern WXDLLEXPORT_DATA(wxBrush*)    wxCYAN_BRUSH;
-extern WXDLLEXPORT_DATA(wxBrush*)    wxRED_BRUSH;
-
-extern WXDLLEXPORT_DATA(wxColour*)    wxBLACK;
-extern WXDLLEXPORT_DATA(wxColour*)    wxWHITE;
-extern WXDLLEXPORT_DATA(wxColour*)    wxRED;
-extern WXDLLEXPORT_DATA(wxColour*)    wxBLUE;
-extern WXDLLEXPORT_DATA(wxColour*)    wxGREEN;
-extern WXDLLEXPORT_DATA(wxColour*)    wxCYAN;
-extern WXDLLEXPORT_DATA(wxColour*)    wxLIGHT_GREY;
+
+/* 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)
+};
+
+#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)

 
 // 'Null' objects
 extern WXDLLEXPORT_DATA(wxBitmap)     wxNullBitmap;
 
 // 'Null' objects
 extern WXDLLEXPORT_DATA(wxBitmap)     wxNullBitmap;


@@ -582,14 +669,9 @@ extern WXDLLEXPORT_DATA(wxPalette)     wxNullPalette;
 extern WXDLLEXPORT_DATA(wxFont)       wxNullFont;
 extern WXDLLEXPORT_DATA(wxColour)     wxNullColour;
 
 extern WXDLLEXPORT_DATA(wxFont)       wxNullFont;
 extern WXDLLEXPORT_DATA(wxColour)     wxNullColour;
 

-// Stock cursors types
-extern WXDLLEXPORT_DATA(wxCursor*)    wxSTANDARD_CURSOR;
-extern WXDLLEXPORT_DATA(wxCursor*)    wxHOURGLASS_CURSOR;
-extern WXDLLEXPORT_DATA(wxCursor*)    wxCROSS_CURSOR;
-

 extern WXDLLEXPORT_DATA(wxColourDatabase*)  wxTheColourDatabase;
 
 extern WXDLLEXPORT_DATA(wxColourDatabase*)  wxTheColourDatabase;
 

-extern WXDLLEXPORT_DATA(const wxChar*) wxPanelNameStr;
+extern WXDLLEXPORT_DATA(const wxChar) wxPanelNameStr[];

 
 extern WXDLLEXPORT_DATA(const wxSize) wxDefaultSize;
 extern WXDLLEXPORT_DATA(const wxPoint) wxDefaultPosition;
 
 extern WXDLLEXPORT_DATA(const wxSize) wxDefaultSize;
 extern WXDLLEXPORT_DATA(const wxPoint) wxDefaultPosition;


@@ -602,9 +684,7 @@ extern WXDLLEXPORT_DATA(wxList) wxPendingDelete;
 // ---------------------------------------------------------------------------
 
 // resource management
 // ---------------------------------------------------------------------------
 
 // resource management

-extern void WXDLLEXPORT wxInitializeStockObjects();

 extern void WXDLLEXPORT wxInitializeStockLists();
 extern void WXDLLEXPORT wxInitializeStockLists();

-extern void WXDLLEXPORT wxDeleteStockObjects();

 extern void WXDLLEXPORT wxDeleteStockLists();
 
 // is the display colour (or monochrome)?
 extern void WXDLLEXPORT wxDeleteStockLists();
 
 // is the display colour (or monochrome)?