introduce wxBrushStyle enum and replace 'int style' occurrences in wxBrush code with...

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

diff --git a/include/wx/brush.h b/include/wx/brush.h
index 0c862b7e756fc1bc6d080b63a1bd5117113c426b..69b187b7dc16cead096b4e1dc5550c8026eac6cd 100644 (file)
--- a/include/wx/brush.h
+++ b/include/wx/brush.h
@@ -16,16 +16,114 @@
 #include "wx/object.h"
 #include "wx/gdiobj.h"
 
+// NOTE: these values cannot be combined together!
+enum wxBrushStyle
+{
+#ifdef WXWIN_COMPATIBILITY_2_8
+    /* start of deprecated values */
+    wxSOLID      =   100,
+    wxDOT,
+    wxLONG_DASH,
+    wxSHORT_DASH,
+    wxDOT_DASH,
+    wxUSER_DASH,
+    wxTRANSPARENT,
+    wxSTIPPLE_MASK_OPAQUE,
+    wxSTIPPLE_MASK,
+    wxSTIPPLE,
+    wxBDIAGONAL_HATCH,
+    wxCROSSDIAG_HATCH,
+    wxFDIAGONAL_HATCH,
+    wxCROSS_HATCH,
+    wxHORIZONTAL_HATCH,
+    wxVERTICAL_HATCH,
+    wxFIRST_HATCH = wxBDIAGONAL_HATCH,
+    wxLAST_HATCH = wxVERTICAL_HATCH,
+    /* end of deprecated values */
+
+    wxBRUSHSTYLE_SOLID = wxSOLID,
+    wxBRUSHSTYLE_DOT = wxDOT,
+    wxBRUSHSTYLE_LONG_DASH = wxLONG_DASH,
+    wxBRUSHSTYLE_SHORT_DASH = wxSHORT_DASH,
+    wxBRUSHSTYLE_DOT_DASH = wxDOT_DASH,
+    wxBRUSHSTYLE_USER_DOT = wxUSER_DASH,
+
+    wxBRUSHSTYLE_TRANSPARENT = wxTRANSPARENT,
+
+    /*  Brush Stippling. */
+    wxBRUSHSTYLE_STIPPLE_MASK_OPAQUE = wxSTIPPLE_MASK_OPAQUE,
+        /* mask is used for blitting monochrome using text fore and back ground colors */
+
+    wxBRUSHSTYLE_STIPPLE_MASK = wxSTIPPLE_MASK,
+        /* mask is used for masking areas in the stipple bitmap (TO DO) */
+
+    wxBRUSHSTYLE_STIPPLE = wxSTIPPLE,
+        /*  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 = wxBDIAGONAL_HATCH,
+    wxBRUSHSTYLE_CROSSDIAG_HATCH = wxCROSSDIAG_HATCH,
+    wxBRUSHSTYLE_FDIAGONAL_HATCH = wxFDIAGONAL_HATCH,
+    wxBRUSHSTYLE_CROSS_HATCH = wxCROSS_HATCH,
+    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_DOT,
+    wxBRUSHSTYLE_LONG_DASH,
+    wxBRUSHSTYLE_SHORT_DASH,
+    wxBRUSHSTYLE_DOT_DASH,
+    wxBRUSHSTYLE_USER_DOT,
+
+    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
+};
+
+
 // wxBrushBase
 class WXDLLEXPORT wxBrushBase: public wxGDIObject
 {
 public:
     virtual ~wxBrushBase() { }
 
-    virtual int GetStyle() const = 0;
+    virtual wxBrushStyle GetStyle() const = 0;
 
     virtual bool IsHatch() const
-        { return (GetStyle()>=wxFIRST_HATCH) && (GetStyle()<=wxLAST_HATCH); }
+        { return (GetStyle()>=wxBRUSHSTYLE_FIRST_HATCH) && (GetStyle()<=wxBRUSHSTYLE_LAST_HATCH); }
 };
 
 #if defined(__WXPALMOS__)