Richtext interface fixes and additions for Phoenix

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

diff --git a/include/wx/brush.h b/include/wx/brush.h
index 69b187b7dc16cead096b4e1dc5550c8026eac6cd..47b34619eb5efd5c9b0fd32cb7caaf23e0781e07 100644 (file)
--- a/include/wx/brush.h
+++ b/include/wx/brush.h
@@ -15,120 +15,62 @@
 #include "wx/defs.h"
 #include "wx/object.h"
 #include "wx/gdiobj.h"
 #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
 {
 
 // 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_INVALID = -1,

 
     wxBRUSHSTYLE_SOLID = wxSOLID,
 
     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,
     wxBRUSHSTYLE_TRANSPARENT = wxTRANSPARENT,

-
-    /*  Brush Stippling. */

     wxBRUSHSTYLE_STIPPLE_MASK_OPAQUE = wxSTIPPLE_MASK_OPAQUE,
     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,
     wxBRUSHSTYLE_STIPPLE_MASK = wxSTIPPLE_MASK,

-        /* mask is used for masking areas in the stipple bitmap (TO DO) */
-

     wxBRUSHSTYLE_STIPPLE = wxSTIPPLE,
     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
+    wxBRUSHSTYLE_BDIAGONAL_HATCH = wxHATCHSTYLE_BDIAGONAL,
+    wxBRUSHSTYLE_CROSSDIAG_HATCH = wxHATCHSTYLE_CROSSDIAG,
+    wxBRUSHSTYLE_FDIAGONAL_HATCH = wxHATCHSTYLE_FDIAGONAL,
+    wxBRUSHSTYLE_CROSS_HATCH = wxHATCHSTYLE_CROSS,
+    wxBRUSHSTYLE_HORIZONTAL_HATCH = wxHATCHSTYLE_HORIZONTAL,
+    wxBRUSHSTYLE_VERTICAL_HATCH = wxHATCHSTYLE_VERTICAL,
+    wxBRUSHSTYLE_FIRST_HATCH = wxHATCHSTYLE_FIRST,
+    wxBRUSHSTYLE_LAST_HATCH = wxHATCHSTYLE_LAST

 };
 
 
 // wxBrushBase
 };
 
 
 // wxBrushBase

-class WXDLLEXPORT wxBrushBase: public wxGDIObject
+class WXDLLIMPEXP_CORE wxBrushBase: public wxGDIObject

 {
 public:
     virtual ~wxBrushBase() { }
 
 {
 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 wxBrushStyle GetStyle() const = 0;

+    virtual wxBitmap *GetStipple() const = 0;

 
     virtual bool IsHatch() const
         { return (GetStyle()>=wxBRUSHSTYLE_FIRST_HATCH) && (GetStyle()<=wxBRUSHSTYLE_LAST_HATCH); }
 
     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__)
-    #include "wx/palmos/brush.h"
-#elif defined(__WXMSW__)
+#if defined(__WXMSW__)

     #include "wx/msw/brush.h"
 #elif defined(__WXMOTIF__) || defined(__WXX11__)
     #include "wx/x11/brush.h"
     #include "wx/msw/brush.h"
 #elif defined(__WXMOTIF__) || defined(__WXX11__)
     #include "wx/x11/brush.h"


@@ -136,17 +78,60 @@ public:
     #include "wx/gtk/brush.h"
 #elif defined(__WXGTK__)
     #include "wx/gtk1/brush.h"
     #include "wx/gtk/brush.h"
 #elif defined(__WXGTK__)
     #include "wx/gtk1/brush.h"

-#elif defined(__WXMGL__)
-    #include "wx/mgl/brush.h"

 #elif defined(__WXDFB__)
     #include "wx/dfb/brush.h"
 #elif defined(__WXMAC__)
 #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__)
     #include "wx/os2/brush.h"
 #endif
 
 #elif defined(__WXCOCOA__)
     #include "wx/cocoa/brush.h"
 #elif defined(__WXPM__)
     #include "wx/os2/brush.h"
 #endif
 

+class WXDLLIMPEXP_CORE wxBrushList: public wxGDIObjListBase
+{
+public:
+    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
 #endif

-    // _WX_BRUSH_H_BASE_
+};
+
+extern WXDLLIMPEXP_DATA_CORE(wxBrushList*)   wxTheBrushList;
+
+// 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_