fix the signature of the documented functions and document some (relatively) new...

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

diff --git a/include/wx/brush.h b/include/wx/brush.h
index 06e9290a89182e614410ed24120897cd10ab3f10..a999ffa2bd0cfc8c6bdf0a89ff22262fae31f176 100644 (file)
--- a/include/wx/brush.h
+++ b/include/wx/brush.h
@@ -1,9 +1,42 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        wx/brush.h
+// Purpose:     Includes platform-specific wxBrush file
+// Author:      Julian Smart
+// Modified by:
+// Created:
+// RCS-ID:      $Id$
+// Copyright:   Julian Smart
+// Licence:     wxWindows Licence
+/////////////////////////////////////////////////////////////////////////////
+

 #ifndef _WX_BRUSH_H_BASE_
 #define _WX_BRUSH_H_BASE_
 
 #include "wx/defs.h"
 #include "wx/object.h"
 #include "wx/gdiobj.h"
 #ifndef _WX_BRUSH_H_BASE_
 #define _WX_BRUSH_H_BASE_
 
 #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
+{
+    wxBRUSHSTYLE_INVALID = -1,
+
+    wxBRUSHSTYLE_SOLID = wxSOLID,
+    wxBRUSHSTYLE_TRANSPARENT = wxTRANSPARENT,
+    wxBRUSHSTYLE_STIPPLE_MASK_OPAQUE = wxSTIPPLE_MASK_OPAQUE,
+    wxBRUSHSTYLE_STIPPLE_MASK = wxSTIPPLE_MASK,
+    wxBRUSHSTYLE_STIPPLE = wxSTIPPLE,
+    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,
+};
+

 
 // wxBrushBase
 class WXDLLEXPORT wxBrushBase: public wxGDIObject
 
 // wxBrushBase
 class WXDLLEXPORT wxBrushBase: public wxGDIObject


@@ -11,10 +44,15 @@ class WXDLLEXPORT wxBrushBase: public wxGDIObject
 public:
     virtual ~wxBrushBase() { }
 
 public:
     virtual ~wxBrushBase() { }
 

-    virtual int GetStyle() const = 0;
+    virtual wxBrushStyle GetStyle() const = 0;

 
     virtual bool IsHatch() const
 
     virtual bool IsHatch() const

-        { return (GetStyle()>=wxFIRST_HATCH) && (GetStyle()<=wxLAST_HATCH); }
+        { return (GetStyle()>=wxBRUSHSTYLE_FIRST_HATCH) && (GetStyle()<=wxBRUSHSTYLE_LAST_HATCH); }
+
+#if FUTURE_WXWIN_COMPATIBILITY_3_0
+    wxDEPRECATED_FUTURE( void SetStyle(int style) )
+        { SetStyle((wxBrushStyle)style); }
+#endif

 };
 
 #if defined(__WXPALMOS__)
 };
 
 #if defined(__WXPALMOS__)


@@ -23,10 +61,14 @@ public:
     #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"

-#elif defined(__WXGTK__)
+#elif defined(__WXGTK20__)

     #include "wx/gtk/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(__WXMGL__)
     #include "wx/mgl/brush.h"

+#elif defined(__WXDFB__)
+    #include "wx/dfb/brush.h"

 #elif defined(__WXMAC__)
     #include "wx/mac/brush.h"
 #elif defined(__WXCOCOA__)
 #elif defined(__WXMAC__)
     #include "wx/mac/brush.h"
 #elif defined(__WXCOCOA__)


@@ -35,5 +77,17 @@ public:
     #include "wx/os2/brush.h"
 #endif
 
     #include "wx/os2/brush.h"
 #endif
 

+class WXDLLIMPEXP_CORE wxBrushList: public wxGDIObjListBase
+{
+public:
+    wxBrush *FindOrCreateBrush(const wxColour& colour, wxBrushStyle style = wxBRUSHSTYLE_SOLID);
+#if WXWIN_COMPATIBILITY_2_6
+    wxDEPRECATED( void AddBrush(wxBrush*) );
+    wxDEPRECATED( void RemoveBrush(wxBrush*) );
+#endif
+};
+
+extern WXDLLEXPORT_DATA(wxBrushList*)   wxTheBrushList;
+

 #endif
     // _WX_BRUSH_H_BASE_
 #endif
     // _WX_BRUSH_H_BASE_