Allow customizing AUI tab colours in wxAuiTabArt.

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

diff --git a/include/wx/pen.h b/include/wx/pen.h
index 9f4f0d99a5634a1f215cb890169e9ec25126e79e..f6e745bd81a2c29a82d0dbfd199c65e7e73759cc 100644 (file)
--- a/include/wx/pen.h
+++ b/include/wx/pen.h
@@ -49,7 +49,7 @@ enum wxPenJoin
 
     wxJOIN_BEVEL = 120,
     wxJOIN_MITER,
-    wxJOIN_ROUND,
+    wxJOIN_ROUND
 };
 
 enum wxPenCap
@@ -62,7 +62,7 @@ enum wxPenCap
 };
 
 
-class WXDLLEXPORT wxPenBase : public wxGDIObject
+class WXDLLIMPEXP_CORE wxPenBase : public wxGDIObject
 {
 public:
     virtual ~wxPenBase() { }
@@ -77,7 +77,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;
@@ -85,38 +85,48 @@ public:
     virtual int GetWidth() const = 0;
     virtual int GetDashes(wxDash **ptr) const = 0;
 
-#if FUTURE_WXWIN_COMPATIBILITY_3_0
-    wxDEPRECATED_FUTURE( void SetStyle(int 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"
+    #include "wx/palmos/pen.h"
 #elif defined(__WXMSW__)
-#include "wx/msw/pen.h"
+    #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"
+    #include "wx/gtk1/pen.h"
 #elif defined(__WXMGL__)
-#include "wx/mgl/pen.h"
+    #include "wx/mgl/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)
@@ -128,7 +138,33 @@ public:
 #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<int>(s) == static_cast<int>(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_