]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/brush.h
Clarified wxPropertyGrid::HitTest() docs
[wxWidgets.git] / include / wx / brush.h
... / ...
CommitLineData
1/////////////////////////////////////////////////////////////////////////////
2// Name: wx/brush.h
3// Purpose: Includes platform-specific wxBrush file
4// Author: Julian Smart
5// Modified by:
6// Created:
7// RCS-ID: $Id$
8// Copyright: Julian Smart
9// Licence: wxWindows Licence
10/////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_BRUSH_H_BASE_
13#define _WX_BRUSH_H_BASE_
14
15#include "wx/defs.h"
16#include "wx/object.h"
17#include "wx/gdiobj.h"
18#include "wx/gdicmn.h" // for wxGDIObjListBase
19
20// NOTE: these values cannot be combined together!
21enum wxBrushStyle
22{
23 wxBRUSHSTYLE_INVALID = -1,
24
25 wxBRUSHSTYLE_SOLID = wxSOLID,
26 wxBRUSHSTYLE_TRANSPARENT = wxTRANSPARENT,
27 wxBRUSHSTYLE_STIPPLE_MASK_OPAQUE = wxSTIPPLE_MASK_OPAQUE,
28 wxBRUSHSTYLE_STIPPLE_MASK = wxSTIPPLE_MASK,
29 wxBRUSHSTYLE_STIPPLE = wxSTIPPLE,
30 wxBRUSHSTYLE_BDIAGONAL_HATCH = wxBDIAGONAL_HATCH,
31 wxBRUSHSTYLE_CROSSDIAG_HATCH = wxCROSSDIAG_HATCH,
32 wxBRUSHSTYLE_FDIAGONAL_HATCH = wxFDIAGONAL_HATCH,
33 wxBRUSHSTYLE_CROSS_HATCH = wxCROSS_HATCH,
34 wxBRUSHSTYLE_HORIZONTAL_HATCH = wxHORIZONTAL_HATCH,
35 wxBRUSHSTYLE_VERTICAL_HATCH = wxVERTICAL_HATCH,
36 wxBRUSHSTYLE_FIRST_HATCH = wxFIRST_HATCH,
37 wxBRUSHSTYLE_LAST_HATCH = wxLAST_HATCH
38};
39
40
41// wxBrushBase
42class WXDLLIMPEXP_CORE wxBrushBase: public wxGDIObject
43{
44public:
45 virtual ~wxBrushBase() { }
46
47 virtual void SetColour(const wxColour& col) = 0;
48 virtual void SetColour(unsigned char r, unsigned char g, unsigned char b) = 0;
49 virtual void SetStyle(wxBrushStyle style) = 0;
50 virtual void SetStipple(const wxBitmap& stipple) = 0;
51
52 virtual wxColour GetColour() const = 0;
53 virtual wxBrushStyle GetStyle() const = 0;
54 virtual wxBitmap *GetStipple() const = 0;
55
56 virtual bool IsHatch() const
57 { return (GetStyle()>=wxBRUSHSTYLE_FIRST_HATCH) && (GetStyle()<=wxBRUSHSTYLE_LAST_HATCH); }
58};
59
60#if defined(__WXPALMOS__)
61 #include "wx/palmos/brush.h"
62#elif defined(__WXMSW__)
63 #include "wx/msw/brush.h"
64#elif defined(__WXMOTIF__) || defined(__WXX11__)
65 #include "wx/x11/brush.h"
66#elif defined(__WXGTK20__)
67 #include "wx/gtk/brush.h"
68#elif defined(__WXGTK__)
69 #include "wx/gtk1/brush.h"
70#elif defined(__WXMGL__)
71 #include "wx/mgl/brush.h"
72#elif defined(__WXDFB__)
73 #include "wx/dfb/brush.h"
74#elif defined(__WXMAC__)
75 #include "wx/osx/brush.h"
76#elif defined(__WXCOCOA__)
77 #include "wx/cocoa/brush.h"
78#elif defined(__WXPM__)
79 #include "wx/os2/brush.h"
80#endif
81
82class WXDLLIMPEXP_CORE wxBrushList: public wxGDIObjListBase
83{
84public:
85 wxBrush *FindOrCreateBrush(const wxColour& colour,
86 wxBrushStyle style = wxBRUSHSTYLE_SOLID);
87
88#if FUTURE_WXWIN_COMPATIBILITY_3_0
89 wxBrush *FindOrCreateBrush(const wxColour& colour, int style)
90 { return FindOrCreateBrush(colour, (wxBrushStyle)style); }
91#endif
92
93#if WXWIN_COMPATIBILITY_2_6
94 wxDEPRECATED( void AddBrush(wxBrush*) );
95 wxDEPRECATED( void RemoveBrush(wxBrush*) );
96#endif
97};
98
99extern WXDLLIMPEXP_DATA_CORE(wxBrushList*) wxTheBrushList;
100
101// provide comparison operators to allow code such as
102//
103// if ( brush.GetStyle() == wxTRANSPARENT )
104//
105// to compile without warnings which it would otherwise provoke from some
106// compilers as it compares elements of different enums
107#if FUTURE_WXWIN_COMPATIBILITY_3_0
108
109inline bool operator==(wxBrushStyle s, wxDeprecatedGUIConstants t)
110{
111 return static_cast<int>(s) == static_cast<int>(t);
112}
113
114inline bool operator!=(wxBrushStyle s, wxDeprecatedGUIConstants t)
115{
116 return !(s == t);
117}
118
119#endif // FUTURE_WXWIN_COMPATIBILITY_3_0
120
121#endif // _WX_BRUSH_H_BASE_