include/wx/pen.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/pen.h
   3 // Purpose:     Base header for wxPen
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows Licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_PEN_H_BASE_
  13 #define _WX_PEN_H_BASE_
  14
  15 #include "wx/gdiobj.h"
  16 #include "wx/gdicmn.h"
  17
  18 enum wxPenStyle
  19 {
  20     wxPENSTYLE_INVALID = -1,
  21
  22     wxPENSTYLE_SOLID = wxSOLID,
  23     wxPENSTYLE_DOT = wxDOT,
  24     wxPENSTYLE_LONG_DASH = wxLONG_DASH,
  25     wxPENSTYLE_SHORT_DASH = wxSHORT_DASH,
  26     wxPENSTYLE_DOT_DASH = wxDOT_DASH,
  27     wxPENSTYLE_USER_DASH = wxUSER_DASH,
  28
  29     wxPENSTYLE_TRANSPARENT = wxTRANSPARENT,
  30
  31     wxPENSTYLE_STIPPLE_MASK_OPAQUE = wxSTIPPLE_MASK_OPAQUE,
  32     wxPENSTYLE_STIPPLE_MASK = wxSTIPPLE_MASK,
  33     wxPENSTYLE_STIPPLE = wxSTIPPLE,
  34
  35     wxPENSTYLE_BDIAGONAL_HATCH = wxBDIAGONAL_HATCH,
  36     wxPENSTYLE_CROSSDIAG_HATCH = wxCROSSDIAG_HATCH,
  37     wxPENSTYLE_FDIAGONAL_HATCH = wxFDIAGONAL_HATCH,
  38     wxPENSTYLE_CROSS_HATCH = wxCROSS_HATCH,
  39     wxPENSTYLE_HORIZONTAL_HATCH = wxHORIZONTAL_HATCH,
  40     wxPENSTYLE_VERTICAL_HATCH = wxVERTICAL_HATCH,
  41
  42     wxPENSTYLE_FIRST_HATCH = wxFIRST_HATCH,
  43     wxPENSTYLE_LAST_HATCH = wxLAST_HATCH
  44 };
  45
  46 enum wxPenJoin
  47 {
  48     wxJOIN_INVALID = -1,
  49
  50     wxJOIN_BEVEL = 120,
  51     wxJOIN_MITER,
  52     wxJOIN_ROUND
  53 };
  54
  55 enum wxPenCap
  56 {
  57     wxCAP_INVALID = -1,
  58
  59     wxCAP_ROUND = 130,
  60     wxCAP_PROJECTING,
  61     wxCAP_BUTT
  62 };
  63
  64
  65 class WXDLLIMPEXP_CORE wxPenBase : public wxGDIObject
  66 {
  67 public:
  68     virtual ~wxPenBase() { }
  69
  70     virtual void SetColour(const wxColour& col) = 0;
  71     virtual void SetColour(unsigned char r, unsigned char g, unsigned char b) = 0;
  72
  73     virtual void SetWidth(int width) = 0;
  74     virtual void SetStyle(wxPenStyle style) = 0;
  75     virtual void SetStipple(const wxBitmap& stipple) = 0;
  76     virtual void SetDashes(int nb_dashes, const wxDash *dash) = 0;
  77     virtual void SetJoin(wxPenJoin join) = 0;
  78     virtual void SetCap(wxPenCap cap) = 0;
  79
  80     virtual wxColour GetColour() const = 0;
  81     virtual wxBitmap *GetStipple() const = 0;
  82     virtual wxPenStyle GetStyle() const = 0;
  83     virtual wxPenJoin GetJoin() const = 0;
  84     virtual wxPenCap GetCap() const = 0;
  85     virtual int GetWidth() const = 0;
  86     virtual int GetDashes(wxDash **ptr) const = 0;
  87
  88     // Convenient helpers for testing whether the pen is a transparent one:
  89     // unlike GetStyle() == wxPENSTYLE_TRANSPARENT, they work correctly even if
  90     // the pen is invalid (they both return false in this case).
  91     bool IsTransparent() const
  92     {
  93         return IsOk() && GetStyle() == wxPENSTYLE_TRANSPARENT;
  94     }
  95
  96     bool IsNonTransparent() const
  97     {
  98         return IsOk() && GetStyle() != wxPENSTYLE_TRANSPARENT;
  99     }
 100 };
 101
 102 #if defined(__WXMSW__)
 103     #include "wx/msw/pen.h"
 104 #elif defined(__WXMOTIF__) || defined(__WXX11__)
 105     #include "wx/x11/pen.h"
 106 #elif defined(__WXGTK20__)
 107     #include "wx/gtk/pen.h"
 108 #elif defined(__WXGTK__)
 109     #include "wx/gtk1/pen.h"
 110 #elif defined(__WXDFB__)
 111     #include "wx/dfb/pen.h"
 112 #elif defined(__WXMAC__)
 113     #include "wx/osx/pen.h"
 114 #elif defined(__WXCOCOA__)
 115     #include "wx/cocoa/pen.h"
 116 #elif defined(__WXPM__)
 117     #include "wx/os2/pen.h"
 118 #endif
 119
 120 class WXDLLIMPEXP_CORE wxPenList: public wxGDIObjListBase
 121 {
 122 public:
 123     wxPen *FindOrCreatePen(const wxColour& colour,
 124                            int width = 1,
 125                            wxPenStyle style = wxPENSTYLE_SOLID);
 126
 127 #if FUTURE_WXWIN_COMPATIBILITY_3_0
 128     wxPen *FindOrCreatePen(const wxColour& colour, int width, int style)
 129         { return FindOrCreatePen(colour, width, (wxPenStyle)style); }
 130 #endif
 131 #if WXWIN_COMPATIBILITY_2_6
 132     wxDEPRECATED( void AddPen(wxPen*) );
 133     wxDEPRECATED( void RemovePen(wxPen*) );
 134 #endif
 135 };
 136
 137 extern WXDLLIMPEXP_DATA_CORE(wxPenList*)   wxThePenList;
 138
 139 // provide comparison operators to allow code such as
 140 //
 141 //      if ( pen.GetStyle() == wxTRANSPARENT )
 142 //
 143 // to compile without warnings which it would otherwise provoke from some
 144 // compilers as it compares elements of different enums
 145 #if FUTURE_WXWIN_COMPATIBILITY_3_0
 146
 147 // Unfortunately some compilers have ambiguity issues when enum comparisons are
 148 // overloaded so we have to disable the overloads in this case, see
 149 // wxCOMPILER_NO_OVERLOAD_ON_ENUM definition in wx/platform.h for more details.
 150 #ifndef wxCOMPILER_NO_OVERLOAD_ON_ENUM
 151
 152 inline bool operator==(wxPenStyle s, wxDeprecatedGUIConstants t)
 153 {
 154     return static_cast<int>(s) == static_cast<int>(t);
 155 }
 156
 157 inline bool operator!=(wxPenStyle s, wxDeprecatedGUIConstants t)
 158 {
 159     return !(s == t);
 160 }
 161
 162 #endif // wxCOMPILER_NO_OVERLOAD_ON_ENUM
 163
 164 #endif // FUTURE_WXWIN_COMPATIBILITY_3_0
 165
 166 #endif // _WX_PEN_H_BASE_