X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6cef0db28018fd2644ee4e38af715872e5242459..66c2bf7b1d9326fb650acfaae22ec50528cfbf7c:/include/wx/pen.h?ds=sidebyside diff --git a/include/wx/pen.h b/include/wx/pen.h index ae92018255..e55b046eff 100644 --- a/include/wx/pen.h +++ b/include/wx/pen.h @@ -4,7 +4,6 @@ // Author: Julian Smart // Modified by: // Created: -// RCS-ID: $Id$ // Copyright: (c) Julian Smart // Licence: wxWindows Licence ///////////////////////////////////////////////////////////////////////////// @@ -12,23 +11,12 @@ #ifndef _WX_PEN_H_BASE_ #define _WX_PEN_H_BASE_ -#include "wx/defs.h" - -#if WXWIN_COMPATIBILITY_2_8 -#include "wx/brush.h" // needed for some deprecated declarations -#endif +#include "wx/gdiobj.h" +#include "wx/gdicmn.h" enum wxPenStyle { -#if WXWIN_COMPATIBILITY_2_8 - /* start of deprecated values */ - /* wxSOLID, wxTRANSPARENT, wxSTIPPLE are already defined in wxBrushStyle */ - wxDOT = 101, - wxLONG_DASH = 102, - wxSHORT_DASH = 103, - wxDOT_DASH = 104, - wxUSER_DASH = 105, - /* end of deprecated values */ + wxPENSTYLE_INVALID = -1, wxPENSTYLE_SOLID = wxSOLID, wxPENSTYLE_DOT = wxDOT, @@ -43,53 +31,14 @@ enum wxPenStyle wxPENSTYLE_STIPPLE_MASK = wxSTIPPLE_MASK, wxPENSTYLE_STIPPLE = wxSTIPPLE, - wxPENSTYLE_BDIAGONAL_HATCH = wxBDIAGONAL_HATCH, - wxPENSTYLE_CROSSDIAG_HATCH = wxCROSSDIAG_HATCH, - wxPENSTYLE_FDIAGONAL_HATCH = wxFDIAGONAL_HATCH, - wxPENSTYLE_CROSS_HATCH = wxCROSS_HATCH, - wxPENSTYLE_HORIZONTAL_HATCH = wxHORIZONTAL_HATCH, - wxPENSTYLE_VERTICAL_HATCH = wxVERTICAL_HATCH, - - wxPENSTYLE_FIRST_HATCH = wxFIRST_HATCH, - wxPENSTYLE_LAST_HATCH = wxLAST_HATCH, - - wxPENSTYLE_MAX -#else - wxPENSTYLE_SOLID, - wxPENSTYLE_DOT, - wxPENSTYLE_LONG_DASH, - wxPENSTYLE_SHORT_DASH, - wxPENSTYLE_DOT_DASH, - wxPENSTYLE_USER_DASH, - - wxPENSTYLE_TRANSPARENT, - - /* Pen Stippling. */ - wxPENSTYLE_STIPPLE_MASK_OPAQUE, - /* mask is used for blitting monochrome using text fore and back ground colors */ - - wxPENSTYLE_STIPPLE_MASK, - /* mask is used for masking areas in the stipple bitmap (TO DO) */ - - wxPENSTYLE_STIPPLE, - /* drawn with a Pen, and without any Brush -- and it can be stippled. */ - - /* In wxWidgets < 2.6 use WX_HATCH macro */ - /* to verify these wx*_HATCH are in style */ - /* of wxBrush. In wxWidgets >= 2.6 use */ - /* wxBrush::IsHatch() instead. */ - wxPENSTYLE_BDIAGONAL_HATCH, - wxPENSTYLE_CROSSDIAG_HATCH, - wxPENSTYLE_FDIAGONAL_HATCH, - wxPENSTYLE_CROSS_HATCH, - wxPENSTYLE_HORIZONTAL_HATCH, - wxPENSTYLE_VERTICAL_HATCH, - - wxPENSTYLE_FIRST_HATCH = wxPENSTYLE_BDIAGONAL_HATCH, - wxPENSTYLE_LAST_HATCH = wxPENSTYLE_VERTICAL_HATCH, - - wxPENSTYLE_MAX -#endif + wxPENSTYLE_BDIAGONAL_HATCH = wxHATCHSTYLE_BDIAGONAL, + wxPENSTYLE_CROSSDIAG_HATCH = wxHATCHSTYLE_CROSSDIAG, + wxPENSTYLE_FDIAGONAL_HATCH = wxHATCHSTYLE_FDIAGONAL, + wxPENSTYLE_CROSS_HATCH = wxHATCHSTYLE_CROSS, + wxPENSTYLE_HORIZONTAL_HATCH = wxHATCHSTYLE_HORIZONTAL, + wxPENSTYLE_VERTICAL_HATCH = wxHATCHSTYLE_VERTICAL, + wxPENSTYLE_FIRST_HATCH = wxHATCHSTYLE_FIRST, + wxPENSTYLE_LAST_HATCH = wxHATCHSTYLE_LAST }; enum wxPenJoin @@ -98,7 +47,7 @@ enum wxPenJoin wxJOIN_BEVEL = 120, wxJOIN_MITER, - wxJOIN_ROUND, + wxJOIN_ROUND }; enum wxPenCap @@ -111,7 +60,7 @@ enum wxPenCap }; -class WXDLLEXPORT wxPenBase : public wxGDIObject +class WXDLLIMPEXP_CORE wxPenBase : public wxGDIObject { public: virtual ~wxPenBase() { } @@ -126,7 +75,7 @@ public: virtual void SetJoin(wxPenJoin join) = 0; virtual void SetCap(wxPenCap cap) = 0; - virtual wxColour& GetColour() const = 0; + virtual wxColour GetColour() const = 0; virtual wxBitmap *GetStipple() const = 0; virtual wxPenStyle GetStyle() const = 0; virtual wxPenJoin GetJoin() const = 0; @@ -134,45 +83,82 @@ public: virtual int GetWidth() const = 0; virtual int GetDashes(wxDash **ptr) const = 0; -#if WXWIN_COMPATIBILITY_2_8 - void SetStyle(wxBrushStyle style) - { SetStyle((wxPenStyle)style); } -#endif + // Convenient helpers for testing whether the pen is a transparent one: + // unlike GetStyle() == wxPENSTYLE_TRANSPARENT, they work correctly even if + // the pen is invalid (they both return false in this case). + bool IsTransparent() const + { + return IsOk() && GetStyle() == wxPENSTYLE_TRANSPARENT; + } + + bool IsNonTransparent() const + { + return IsOk() && GetStyle() != wxPENSTYLE_TRANSPARENT; + } }; -#if defined(__WXPALMOS__) -#include "wx/palmos/pen.h" -#elif defined(__WXMSW__) -#include "wx/msw/pen.h" +#if defined(__WXMSW__) + #include "wx/msw/pen.h" #elif defined(__WXMOTIF__) || defined(__WXX11__) -#include "wx/x11/pen.h" + #include "wx/x11/pen.h" #elif defined(__WXGTK20__) -#include "wx/gtk/pen.h" + #include "wx/gtk/pen.h" #elif defined(__WXGTK__) -#include "wx/gtk1/pen.h" -#elif defined(__WXMGL__) -#include "wx/mgl/pen.h" + #include "wx/gtk1/pen.h" #elif defined(__WXDFB__) -#include "wx/dfb/pen.h" + #include "wx/dfb/pen.h" #elif defined(__WXMAC__) -#include "wx/mac/pen.h" + #include "wx/osx/pen.h" #elif defined(__WXCOCOA__) -#include "wx/cocoa/pen.h" + #include "wx/cocoa/pen.h" #elif defined(__WXPM__) -#include "wx/os2/pen.h" + #include "wx/os2/pen.h" #endif class WXDLLIMPEXP_CORE wxPenList: public wxGDIObjListBase { public: - wxPen *FindOrCreatePen(const wxColour& colour, int width, wxPenStyle style); + wxPen *FindOrCreatePen(const wxColour& colour, + int width = 1, + wxPenStyle style = wxPENSTYLE_SOLID); + +#if FUTURE_WXWIN_COMPATIBILITY_3_0 + wxPen *FindOrCreatePen(const wxColour& colour, int width, int style) + { return FindOrCreatePen(colour, width, (wxPenStyle)style); } +#endif #if WXWIN_COMPATIBILITY_2_6 wxDEPRECATED( void AddPen(wxPen*) ); wxDEPRECATED( void RemovePen(wxPen*) ); #endif }; -extern WXDLLEXPORT_DATA(wxPenList*) wxThePenList; +extern WXDLLIMPEXP_DATA_CORE(wxPenList*) wxThePenList; -#endif - // _WX_PEN_H_BASE_ +// provide comparison operators to allow code such as +// +// if ( pen.GetStyle() == wxTRANSPARENT ) +// +// to compile without warnings which it would otherwise provoke from some +// compilers as it compares elements of different enums +#if FUTURE_WXWIN_COMPATIBILITY_3_0 + +// Unfortunately some compilers have ambiguity issues when enum comparisons are +// overloaded so we have to disable the overloads in this case, see +// wxCOMPILER_NO_OVERLOAD_ON_ENUM definition in wx/platform.h for more details. +#ifndef wxCOMPILER_NO_OVERLOAD_ON_ENUM + +inline bool operator==(wxPenStyle s, wxDeprecatedGUIConstants t) +{ + return static_cast(s) == static_cast(t); +} + +inline bool operator!=(wxPenStyle s, wxDeprecatedGUIConstants t) +{ + return !(s == t); +} + +#endif // wxCOMPILER_NO_OVERLOAD_ON_ENUM + +#endif // FUTURE_WXWIN_COMPATIBILITY_3_0 + +#endif // _WX_PEN_H_BASE_