include/wx/mac/carbon/pen.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/mac/carbon/pen.h
   3 // Purpose:     wxPen class
   4 // Author:      Stefan Csomor
   5 // Modified by:
   6 // Created:     1998-01-01
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Stefan Csomor
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_PEN_H_
  13 #define _WX_PEN_H_
  14
  15 #include "wx/gdiobj.h"
  16 #include "wx/colour.h"
  17 #include "wx/bitmap.h"
  18
  19 class WXDLLEXPORT wxPen;
  20
  21 class WXDLLEXPORT wxPenRefData: public wxGDIRefData
  22 {
  23     friend class WXDLLEXPORT wxPen;
  24 public:
  25     wxPenRefData();
  26     wxPenRefData(const wxPenRefData& data);
  27     virtual ~wxPenRefData();
  28
  29     wxPenRefData& operator=(const wxPenRefData& data);
  30
  31     bool operator==(const wxPenRefData& data) const
  32     {
  33         // we intentionally don't compare m_hPen fields here
  34         return m_style == data.m_style &&
  35                m_width == data.m_width &&
  36                m_join == data.m_join &&
  37                m_cap == data.m_cap &&
  38                m_colour == data.m_colour &&
  39                (m_style != wxSTIPPLE || m_stipple.IsSameAs(data.m_stipple)) &&
  40                (m_style != wxUSER_DASH ||
  41                 (m_nbDash == data.m_nbDash &&
  42                     memcmp(m_dash, data.m_dash, m_nbDash*sizeof(wxDash)) == 0));
  43     }
  44
  45 protected:
  46     virtual wxObjectRefData* CreateRefData() const;
  47     virtual wxObjectRefData* CloneRefData(const wxObjectRefData* data) const;
  48
  49   int           m_width;
  50   int           m_style;
  51   int           m_join ;
  52   int           m_cap ;
  53   wxBitmap      m_stipple ;
  54   int           m_nbDash ;
  55   wxDash *      m_dash ;
  56   wxColour      m_colour;
  57 /* TODO: implementation
  58   WXHPEN        m_hPen;
  59 */
  60 };
  61
  62 #define M_PENDATA ((wxPenRefData *)m_refData)
  63
  64 // Pen
  65 class WXDLLEXPORT wxPen: public wxGDIObject
  66 {
  67   DECLARE_DYNAMIC_CLASS(wxPen)
  68 public:
  69   wxPen();
  70   wxPen(const wxColour& col, int width = 1, int style = wxSOLID);
  71   wxPen(const wxBitmap& stipple, int width);
  72   virtual ~wxPen();
  73
  74   inline bool operator == (const wxPen& pen) const
  75   {
  76     const wxPenRefData *penData = (wxPenRefData *)pen.m_refData;
  77
  78     // an invalid pen is only equal to another invalid pen
  79     return m_refData ? penData && *M_PENDATA == *penData : !penData;
  80   }
  81
  82   inline bool operator != (const wxPen& pen) const { return !(*this == pen); }
  83
  84   virtual bool Ok() const { return IsOk(); }
  85   virtual bool IsOk() const { return (m_refData != NULL) ; }
  86
  87   // Override in order to recreate the pen
  88   void SetColour(const wxColour& col) ;
  89   void SetColour(unsigned char r, unsigned char g, unsigned char b) ;
  90
  91   void SetWidth(int width)  ;
  92   void SetStyle(int style)  ;
  93   void SetStipple(const wxBitmap& stipple)  ;
  94   void SetDashes(int nb_dashes, const wxDash *dash)  ;
  95   void SetJoin(int join)  ;
  96   void SetCap(int cap)  ;
  97
  98   inline wxColour& GetColour() const { return (M_PENDATA ? M_PENDATA->m_colour : wxNullColour); };
  99   inline int GetWidth() const { return (M_PENDATA ? M_PENDATA->m_width : 0); };
 100   inline int GetStyle() const { return (M_PENDATA ? M_PENDATA->m_style : 0); };
 101   inline int GetJoin() const { return (M_PENDATA ? M_PENDATA->m_join : 0); };
 102   inline int GetCap() const { return (M_PENDATA ? M_PENDATA->m_cap : 0); };
 103   inline int GetDashes(wxDash **ptr) const {
 104      *ptr = (M_PENDATA ? M_PENDATA->m_dash : (wxDash*) NULL); return (M_PENDATA ? M_PENDATA->m_nbDash : 0);
 105   }
 106
 107   inline wxBitmap *GetStipple() const { return (M_PENDATA ? (& M_PENDATA->m_stipple) : (wxBitmap*) NULL); };
 108
 109 // Implementation
 110
 111   // Useful helper: create the brush resource
 112   bool RealizeResource();
 113
 114   // When setting properties, we must make sure we're not changing
 115   // another object
 116   void Unshare();
 117 };
 118
 119 #endif
 120     // _WX_PEN_H_