include/wx/os2/pen.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/os2/pen.h
   3 // Purpose:     wxPen class
   4 // Author:      David Webster
   5 // Modified by:
   6 // Created:     10/10/99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) David Webster
   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/bitmap.h"
  17
  18 typedef long wxPMDash;
  19
  20 class WXDLLIMPEXP_FWD_CORE wxPen;
  21
  22 class WXDLLEXPORT wxPenRefData: public wxGDIRefData
  23 {
  24     friend class WXDLLIMPEXP_FWD_CORE wxPen;
  25 public:
  26     wxPenRefData();
  27     wxPenRefData(const wxPenRefData& rData);
  28     virtual ~wxPenRefData();
  29
  30     bool operator==(const wxPenRefData& data) const
  31     {
  32         // we intentionally don't compare m_hPen fields here
  33         return m_nStyle == data.m_nStyle &&
  34                m_nWidth == data.m_nWidth &&
  35                m_nJoin == data.m_nJoin &&
  36                m_nCap == data.m_nCap &&
  37                m_vColour == data.m_vColour &&
  38                (m_nStyle != wxSTIPPLE || m_vStipple.IsSameAs(data.m_vStipple)) &&
  39                (m_nStyle != wxUSER_DASH ||
  40                 (m_dash == data.m_dash &&
  41                     memcmp(m_dash, data.m_dash, m_nbDash*sizeof(wxDash)) == 0));
  42     }
  43
  44 protected:
  45     int                             m_nWidth;
  46     wxPenStyle                      m_nStyle;
  47     wxPenJoin                       m_nJoin;
  48     wxPenCap                        m_nCap;
  49     wxBitmap                        m_vStipple;
  50     int                             m_nbDash;
  51     wxDash *                        m_dash;
  52     wxColour                        m_vColour;
  53     WXHPEN                          m_hPen;// in OS/2 GPI this will be the PS the pen is associated with
  54 };
  55
  56 #define M_PENDATA ((wxPenRefData *)m_refData)
  57
  58 // Pen
  59 class WXDLLEXPORT wxPen : public wxPenBase
  60 {
  61 public:
  62     wxPen();
  63     wxPen( const wxColour& rColour
  64           ,int             nWidth = 1
  65           ,wxPenStyle      nStyle = wxPENSTYLE_SOLID
  66          );
  67 #if FUTURE_WXWIN_COMPATIBILITY_3_0
  68     wxDEPRECATED_FUTURE( wxPen(const wxColour& col, int width, int style) );
  69 #endif
  70
  71     wxPen( const wxBitmap& rStipple
  72           ,int             nWidth
  73          );
  74     virtual ~wxPen();
  75
  76     inline bool   operator == (const wxPen& rPen) const
  77     {
  78         const wxPenRefData *penData = (wxPenRefData *)rPen.m_refData;
  79
  80         // an invalid pen is only equal to another invalid pen
  81         return m_refData ? penData && *M_PENDATA == *penData : !penData;
  82     }
  83
  84     inline bool   operator != (const wxPen& rPen) const
  85         { return !(*this == rPen); }
  86
  87     //
  88     // Override in order to recreate the pen
  89     //
  90     void SetColour(const wxColour& rColour);
  91     void SetColour(unsigned char cRed, unsigned char cGreen, unsigned char cBlue);
  92
  93     void SetWidth(int nWidth);
  94     void SetStyle(wxPenStyle nStyle);
  95     void SetStipple(const wxBitmap& rStipple);
  96     void SetDashes( int           nNbDashes
  97                    ,const wxDash* pDash
  98                   );
  99     void SetJoin(wxPenJoin nJoin);
 100     void SetCap(wxPenCap nCap);
 101     void SetPS(HPS hPS);
 102
 103     inline wxColour& GetColour(void) const { return (M_PENDATA ? M_PENDATA->m_vColour : wxNullColour); };
 104     inline int       GetWidth(void) const { return (M_PENDATA ? M_PENDATA->m_nWidth : 0); };
 105     inline wxPenStyle GetStyle(void) const { return (M_PENDATA ? M_PENDATA->m_nStyle : 0); };
 106     inline wxPenJoin  GetJoin(void) const { return (M_PENDATA ? M_PENDATA->m_nJoin : 0); };
 107     inline wxPenCap   GetCap(void) const { return (M_PENDATA ? M_PENDATA->m_nCap : 0); };
 108     inline int       GetPS(void) const { return (M_PENDATA ? M_PENDATA->m_hPen : 0); };
 109     inline int       GetDashes(wxDash **ptr) const
 110     {
 111         *ptr = (M_PENDATA ? (wxDash*)M_PENDATA->m_dash : (wxDash*) NULL);
 112         return (M_PENDATA ? M_PENDATA->m_nbDash : 0);
 113     }
 114     inline wxDash*   GetDash() const { return (M_PENDATA ? (wxDash*)M_PENDATA->m_dash : (wxDash*)NULL); };
 115     inline int       GetDashCount() const { return (M_PENDATA ? M_PENDATA->m_nbDash : 0); };
 116
 117     inline wxBitmap* GetStipple(void) const { return (M_PENDATA ? (& M_PENDATA->m_vStipple) : (wxBitmap*) NULL); };
 118
 119     //
 120     // Implementation
 121     //
 122
 123     //
 124     // Useful helper: create the brush resource
 125     //
 126     bool     RealizeResource(void);
 127     bool     FreeResource(bool bForce = false);
 128     virtual WXHANDLE GetResourceHandle(void) const;
 129     bool     IsFree(void) const;
 130
 131 private:
 132     LINEBUNDLE                     m_vLineBundle;
 133     AREABUNDLE                     m_vAreaBundle;
 134
 135 protected:
 136     virtual wxGDIRefData* CreateGDIRefData() const;
 137     virtual wxGDIRefData* CloneGDIRefData(const wxGDIRefData* data) const;
 138
 139     // same as FreeResource() + RealizeResource()
 140     bool Recreate();
 141
 142     DECLARE_DYNAMIC_CLASS(wxPen)
 143 }; // end of CLASS wxPen
 144
 145 extern int wx2os2PenStyle(wxPenStyle nWxStyle);
 146
 147 #endif
 148     // _WX_PEN_H_