Make wxGCDC::GetGraphicsContext() const.

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

diff --git a/include/wx/brush.h b/include/wx/brush.h
index 201e53e91a904abbd9111fa07959f62bbe2fd73d..89ae912fa1cba1152a9846585203600ffb04c2d2 100644 (file)
--- a/include/wx/brush.h
+++ b/include/wx/brush.h
@@ -15,26 +15,12 @@
 #include "wx/defs.h"
 #include "wx/object.h"
 #include "wx/gdiobj.h"
+#include "wx/gdicmn.h"      // for wxGDIObjListBase
 
 // NOTE: these values cannot be combined together!
 enum wxBrushStyle
 {
-#if WXWIN_COMPATIBILITY_2_8
-    /* start of deprecated values */
-    wxSOLID = 100,
-    wxTRANSPARENT = 106,
-    wxSTIPPLE_MASK_OPAQUE = 107,
-    wxSTIPPLE_MASK = 108,
-    wxSTIPPLE = 109,
-    wxBDIAGONAL_HATCH = 110,
-    wxCROSSDIAG_HATCH = 111,
-    wxFDIAGONAL_HATCH = 112,
-    wxCROSS_HATCH = 113,
-    wxHORIZONTAL_HATCH = 114,
-    wxVERTICAL_HATCH = 115,
-    wxFIRST_HATCH = wxBDIAGONAL_HATCH,
-    wxLAST_HATCH = wxVERTICAL_HATCH,
-    /* end of deprecated values */
+    wxBRUSHSTYLE_INVALID = -1,
 
     wxBRUSHSTYLE_SOLID = wxSOLID,
     wxBRUSHSTYLE_TRANSPARENT = wxTRANSPARENT,
@@ -48,52 +34,40 @@ enum wxBrushStyle
     wxBRUSHSTYLE_HORIZONTAL_HATCH = wxHORIZONTAL_HATCH,
     wxBRUSHSTYLE_VERTICAL_HATCH = wxVERTICAL_HATCH,
     wxBRUSHSTYLE_FIRST_HATCH = wxFIRST_HATCH,
-    wxBRUSHSTYLE_LAST_HATCH = wxLAST_HATCH,
-    wxBRUSHSTYLE_MAX
-#else
-    wxBRUSHSTYLE_SOLID,
-    wxBRUSHSTYLE_TRANSPARENT,
-
-    /*  Brush Stippling. */
-
-    wxBRUSHSTYLE_STIPPLE_MASK_OPAQUE,
-        /* mask is used for blitting monochrome using text fore and back ground colors */
-
-    wxBRUSHSTYLE_STIPPLE_MASK,
-        /* mask is used for masking areas in the stipple bitmap (TO DO) */
-
-    wxBRUSHSTYLE_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.            */
-    wxBRUSHSTYLE_BDIAGONAL_HATCH,
-    wxBRUSHSTYLE_CROSSDIAG_HATCH,
-    wxBRUSHSTYLE_FDIAGONAL_HATCH,
-    wxBRUSHSTYLE_CROSS_HATCH,
-    wxBRUSHSTYLE_HORIZONTAL_HATCH,
-    wxBRUSHSTYLE_VERTICAL_HATCH,
-
-    wxBRUSHSTYLE_FIRST_HATCH = wxBRUSHSTYLE_BDIAGONAL_HATCH,
-    wxBRUSHSTYLE_LAST_HATCH = wxBRUSHSTYLE_VERTICAL_HATCH,
-
-    wxBRUSHSTYLE_MAX
-#endif
+    wxBRUSHSTYLE_LAST_HATCH = wxLAST_HATCH
 };
 
 
 // wxBrushBase
-class WXDLLEXPORT wxBrushBase: public wxGDIObject
+class WXDLLIMPEXP_CORE wxBrushBase: public wxGDIObject
 {
 public:
     virtual ~wxBrushBase() { }
 
+    virtual void SetColour(const wxColour& col) = 0;
+    virtual void SetColour(unsigned char r, unsigned char g, unsigned char b) = 0;
+    virtual void SetStyle(wxBrushStyle style) = 0;
+    virtual void SetStipple(const wxBitmap& stipple) = 0;
+
+    virtual wxColour GetColour() const = 0;
     virtual wxBrushStyle GetStyle() const = 0;
+    virtual wxBitmap *GetStipple() const = 0;
 
     virtual bool IsHatch() const
         { return (GetStyle()>=wxBRUSHSTYLE_FIRST_HATCH) && (GetStyle()<=wxBRUSHSTYLE_LAST_HATCH); }
+
+    // Convenient helpers for testing whether the brush is a transparent one:
+    // unlike GetStyle() == wxBRUSHSTYLE_TRANSPARENT, they work correctly even
+    // if the brush is invalid (they both return false in this case).
+    bool IsTransparent() const
+    {
+        return IsOk() && GetStyle() == wxBRUSHSTYLE_TRANSPARENT;
+    }
+
+    bool IsNonTransparent() const
+    {
+        return IsOk() && GetStyle() != wxBRUSHSTYLE_TRANSPARENT;
+    }
 };
 
 #if defined(__WXPALMOS__)
@@ -111,7 +85,7 @@ public:
 #elif defined(__WXDFB__)
     #include "wx/dfb/brush.h"
 #elif defined(__WXMAC__)
-    #include "wx/mac/brush.h"
+    #include "wx/osx/brush.h"
 #elif defined(__WXCOCOA__)
     #include "wx/cocoa/brush.h"
 #elif defined(__WXPM__)
@@ -121,14 +95,47 @@ public:
 class WXDLLIMPEXP_CORE wxBrushList: public wxGDIObjListBase
 {
 public:
-    wxBrush *FindOrCreateBrush(const wxColour& colour, wxBrushStyle style = wxBRUSHSTYLE_SOLID);
+    wxBrush *FindOrCreateBrush(const wxColour& colour,
+                               wxBrushStyle style = wxBRUSHSTYLE_SOLID);
+
+#if FUTURE_WXWIN_COMPATIBILITY_3_0
+    wxBrush *FindOrCreateBrush(const wxColour& colour, int style)
+        { return FindOrCreateBrush(colour, (wxBrushStyle)style); }
+#endif
+
 #if WXWIN_COMPATIBILITY_2_6
     wxDEPRECATED( void AddBrush(wxBrush*) );
     wxDEPRECATED( void RemoveBrush(wxBrush*) );
 #endif
 };
 
-extern WXDLLEXPORT_DATA(wxBrushList*)   wxTheBrushList;
+extern WXDLLIMPEXP_DATA_CORE(wxBrushList*)   wxTheBrushList;
 
-#endif
-    // _WX_BRUSH_H_BASE_
+// provide comparison operators to allow code such as
+//
+//      if ( brush.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==(wxBrushStyle s, wxDeprecatedGUIConstants t)
+{
+    return static_cast<int>(s) == static_cast<int>(t);
+}
+
+inline bool operator!=(wxBrushStyle s, wxDeprecatedGUIConstants t)
+{
+    return !(s == t);
+}
+
+#endif // wxCOMPILER_NO_OVERLOAD_ON_ENUM
+
+#endif // FUTURE_WXWIN_COMPATIBILITY_3_0
+
+#endif // _WX_BRUSH_H_BASE_