X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/eddf46fea787f245c2b92a02f9777c597e1d9687..32485259c1342115488d219776dfebeb3d4d81b1:/include/wx/gdicmn.h diff --git a/include/wx/gdicmn.h b/include/wx/gdicmn.h index 15a0c8d25b..f04d644dba 100644 --- a/include/wx/gdicmn.h +++ b/include/wx/gdicmn.h @@ -5,7 +5,7 @@ // Modified by: // Created: 01/02/97 // RCS-ID: $Id$ -// Copyright: (c) +// Copyright: (c) Julian Smart // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// @@ -16,32 +16,30 @@ // headers // --------------------------------------------------------------------------- -#ifdef __GNUG__ +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #pragma interface "gdicmn.h" #endif -#include "wx/object.h" +#include "wx/defs.h" #include "wx/list.h" -#include "wx/hash.h" #include "wx/string.h" -#include "wx/setup.h" -#include "wx/colour.h" -#include "wx/font.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 @@ -90,6 +88,7 @@ enum wxStockCursor { wxCURSOR_NONE, // should be 0 wxCURSOR_ARROW, + wxCURSOR_RIGHT_ARROW, wxCURSOR_BULLSEYE, wxCURSOR_CHAR, wxCURSOR_CROSS, @@ -117,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, @@ -150,10 +152,10 @@ 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("" #X "") + #define wxICON(X) wxIcon(wxT(#X)) #elif defined(__WXMGL__) // Initialize from an included XPM #define wxICON(X) wxIcon( (const char**) X##_xpm ) @@ -171,7 +173,7 @@ enum wxStockCursor #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 @@ -179,8 +181,13 @@ enum wxStockCursor */ #if defined(__WXMSW__) || defined(__WXPM__) - #define wxBITMAP(name) wxBitmap(#name, wxBITMAP_TYPE_RESOURCE) -#elif defined(__WXGTK__) || defined(__WXMOTIF__) || defined(__WXX11__) || defined(__WXMAC__) || defined(__WXMGL__) + #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 @@ -198,23 +205,32 @@ enum wxStockCursor 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) + // members are public for compatibility, don't use them directly. int x, y; // constructors - wxSize() { x = y = 0; } - wxSize(int xx, int 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); } + 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) { 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; } // accessors void Set(int xx, int yy) { x = xx; y = yy; } @@ -224,6 +240,18 @@ public: int GetWidth() const { return x; } int GetHeight() const { return y; } + bool IsFullySpecified() const { return x != wxDefaultCoord && y != wxDefaultCoord; } + + // combine this size with the other one replacing the default (i.e. equal + // to wxDefaultCoord) components of this object with those of the other + void SetDefaults(const wxSize& size) + { + if ( x == wxDefaultCoord ) + x = size.x; + if ( y == wxDefaultCoord ) + y = size.y; + } + // compatibility int GetX() const { return x; } int GetY() const { return y; } @@ -239,13 +267,14 @@ 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) 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 @@ -253,8 +282,8 @@ class WXDLLEXPORT wxPoint public: int x, y; - wxPoint() { x = y = 0; }; - wxPoint(int xx, int 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 @@ -268,12 +297,13 @@ public: 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 @@ -282,11 +312,19 @@ public: class WXDLLEXPORT wxRect { public: - wxRect() { x = y = width = height = 0; } + 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; } + : 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 @@ -303,7 +341,22 @@ public: void SetHeight(int h) { height = h; } wxPoint GetPosition() const { return wxPoint(x, y); } + 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(); } + + 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); } + 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; } @@ -345,20 +398,35 @@ 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; bool operator!=(const wxRect& rect) const { return !(*this == rect); } - // return TRUE if the point is (not strcitly) inside the 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 + // 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; + } + + public: int x, y, width, height; }; @@ -371,8 +439,6 @@ typedef wxInt8 wxDash; class WXDLLEXPORT wxPenList : public wxList { - DECLARE_DYNAMIC_CLASS(wxPenList) - public: wxPenList() { } ~wxPenList(); @@ -384,23 +450,17 @@ public: class WXDLLEXPORT wxBrushList : public wxList { - DECLARE_DYNAMIC_CLASS(wxBrushList) - public: wxBrushList() { } ~wxBrushList(); void AddBrush(wxBrush *brush); void RemoveBrush(wxBrush *brush); - wxBrush *FindOrCreateBrush(const wxColour& colour, int style); + wxBrush *FindOrCreateBrush(const wxColour& colour, int style = wxSOLID); }; -WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString; - class WXDLLEXPORT wxFontList : public wxList { - DECLARE_DYNAMIC_CLASS(wxFontList) - public: wxFontList() { } ~wxFontList(); @@ -408,36 +468,48 @@ public: void AddFont(wxFont *font); void RemoveFont(wxFont *font); wxFont *FindOrCreateFont(int pointSize, int family, int style, int weight, - bool underline = FALSE, + bool underline = false, 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; - void Initialize(); + + // 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(){} ~wxBitmapList(); void AddBitmap(wxBitmap *bitmap); @@ -448,11 +520,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) }; // --------------------------------------------------------------------------- @@ -460,71 +531,71 @@ private: // --------------------------------------------------------------------------- // Lists of GDI objects -WXDLLEXPORT_DATA(extern wxPenList*) wxThePenList; -WXDLLEXPORT_DATA(extern wxBrushList*) wxTheBrushList; -WXDLLEXPORT_DATA(extern wxFontList*) wxTheFontList; -WXDLLEXPORT_DATA(extern wxBitmapList*) wxTheBitmapList; +extern WXDLLEXPORT_DATA(wxPenList*) wxThePenList; +extern WXDLLEXPORT_DATA(wxBrushList*) wxTheBrushList; +extern WXDLLEXPORT_DATA(wxFontList*) wxTheFontList; +extern WXDLLEXPORT_DATA(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; +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; // '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(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; // Stock cursors types -WXDLLEXPORT_DATA(extern wxCursor*) wxSTANDARD_CURSOR; -WXDLLEXPORT_DATA(extern wxCursor*) wxHOURGLASS_CURSOR; -WXDLLEXPORT_DATA(extern wxCursor*) wxCROSS_CURSOR; +extern WXDLLEXPORT_DATA(wxCursor*) wxSTANDARD_CURSOR; +extern WXDLLEXPORT_DATA(wxCursor*) wxHOURGLASS_CURSOR; +extern WXDLLEXPORT_DATA(wxCursor*) wxCROSS_CURSOR; -WXDLLEXPORT_DATA(extern wxColourDatabase*) wxTheColourDatabase; +extern WXDLLEXPORT_DATA(wxColourDatabase*) wxTheColourDatabase; -WXDLLEXPORT_DATA(extern const wxChar*) wxPanelNameStr; +extern WXDLLEXPORT_DATA(const wxChar*) wxPanelNameStr; -WXDLLEXPORT_DATA(extern const wxSize) wxDefaultSize; -WXDLLEXPORT_DATA(extern const wxPoint) wxDefaultPosition; +extern WXDLLEXPORT_DATA(const wxSize) wxDefaultSize; +extern WXDLLEXPORT_DATA(const wxPoint) wxDefaultPosition; // The list of objects which should be deleted -WXDLLEXPORT_DATA(extern wxList) wxPendingDelete; +extern WXDLLEXPORT_DATA(wxList) wxPendingDelete; // --------------------------------------------------------------------------- // global functions