include/wx/msw/pen.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        pen.h
   3 // Purpose:     wxPen class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_PEN_H_
  13 #define _WX_PEN_H_
  14
  15 #ifdef __GNUG__
  16 #pragma interface "pen.h"
  17 #endif
  18
  19 #include "wx/gdiobj.h"
  20 #include "wx/bitmap.h"
  21
  22 typedef    WXDWORD  wxDash ;
  23
  24 class WXDLLEXPORT wxPen;
  25
  26 class WXDLLEXPORT wxPenRefData: public wxGDIRefData
  27 {
  28     friend class WXDLLEXPORT wxPen;
  29 public:
  30     wxPenRefData();
  31     wxPenRefData(const wxPenRefData& data);
  32     ~wxPenRefData();
  33
  34 protected:
  35   int           m_width;
  36   int           m_style;
  37   int           m_join ;
  38   int           m_cap ;
  39   wxBitmap      m_stipple ;
  40   int           m_nbDash ;
  41   wxDash *      m_dash ;
  42   wxColour      m_colour;
  43   WXHPEN        m_hPen;
  44 };
  45
  46 #define M_PENDATA ((wxPenRefData *)m_refData)
  47
  48 // Pen
  49 class WXDLLEXPORT wxPen: public wxGDIObject
  50 {
  51   DECLARE_DYNAMIC_CLASS(wxPen)
  52 public:
  53   wxPen();
  54   wxPen(const wxColour& col, int width, int style);
  55   wxPen(const wxBitmap& stipple, int width);
  56   inline wxPen(const wxPen& pen) { Ref(pen); }
  57   ~wxPen();
  58
  59   inline wxPen& operator = (const wxPen& pen) { if (*this == pen) return (*this); Ref(pen); return *this; }
  60   inline bool operator == (const wxPen& pen) { return m_refData == pen.m_refData; }
  61   inline bool operator != (const wxPen& pen) { return m_refData != pen.m_refData; }
  62
  63   virtual bool Ok() const { return (m_refData != NULL) ; }
  64
  65   // Override in order to recreate the pen
  66   void SetColour(const wxColour& col) ;
  67   void SetColour(unsigned char r, unsigned char g, unsigned char b);
  68
  69   void SetWidth(int width)  ;
  70   void SetStyle(int style)  ;
  71   void SetStipple(const wxBitmap& stipple)  ;
  72   void SetDashes(int nb_dashes, const wxDash *dash)  ;
  73   void SetJoin(int join)  ;
  74   void SetCap(int cap)  ;
  75
  76   inline wxColour& GetColour() const { return (M_PENDATA ? M_PENDATA->m_colour : wxNullColour); };
  77   inline int GetWidth() const { return (M_PENDATA ? M_PENDATA->m_width : 0); };
  78   inline int GetStyle() const { return (M_PENDATA ? M_PENDATA->m_style : 0); };
  79   inline int GetJoin() const { return (M_PENDATA ? M_PENDATA->m_join : 0); };
  80   inline int GetCap() const { return (M_PENDATA ? M_PENDATA->m_cap : 0); };
  81   inline int GetDashes(wxDash **ptr) const {
  82      *ptr = (M_PENDATA ? M_PENDATA->m_dash : NULL); return (M_PENDATA ? M_PENDATA->m_nbDash : 0);
  83   }
  84
  85   inline wxBitmap *GetStipple() const { return (M_PENDATA ? (& M_PENDATA->m_stipple) : NULL); };
  86
  87   // Internal
  88   bool RealizeResource();
  89   bool FreeResource(bool force = FALSE);
  90   WXHANDLE GetResourceHandle() ;
  91   bool IsFree() const;
  92   void Unshare();
  93 };
  94
  95 int wx2msPenStyle(int wx_style);
  96
  97 #endif
  98     // _WX_PEN_H_