include/wx/gtk/pen.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/gtk/pen.h
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Copyright:   (c) 1998 Robert Roebling
   6 // Licence:     wxWindows licence
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 #ifndef _WX_GTK_PEN_H_
  10 #define _WX_GTK_PEN_H_
  11
  12 typedef signed char wxGTKDash;
  13
  14 //-----------------------------------------------------------------------------
  15 // wxPen
  16 //-----------------------------------------------------------------------------
  17
  18 class WXDLLIMPEXP_CORE wxPen: public wxPenBase
  19 {
  20 public:
  21     wxPen() { }
  22
  23     wxPen( const wxColour &colour, int width = 1, wxPenStyle style = wxPENSTYLE_SOLID );
  24 #if FUTURE_WXWIN_COMPATIBILITY_3_0
  25     wxDEPRECATED_FUTURE( wxPen(const wxColour& col, int width, int style) );
  26 #endif
  27
  28     virtual ~wxPen();
  29
  30     bool operator==(const wxPen& pen) const;
  31     bool operator!=(const wxPen& pen) const { return !(*this == pen); }
  32
  33     void SetColour( const wxColour &colour );
  34     void SetColour( unsigned char red, unsigned char green, unsigned char blue );
  35     void SetCap( wxPenCap capStyle );
  36     void SetJoin( wxPenJoin joinStyle );
  37     void SetStyle( wxPenStyle style );
  38     void SetWidth( int width );
  39     void SetDashes( int number_of_dashes, const wxDash *dash );
  40     void SetStipple(const wxBitmap& stipple);
  41
  42     wxColour GetColour() const;
  43     wxPenCap GetCap() const;
  44     wxPenJoin GetJoin() const;
  45     wxPenStyle GetStyle() const;
  46     int GetWidth() const;
  47     int GetDashes(wxDash **ptr) const;
  48     int GetDashCount() const;
  49     wxDash* GetDash() const;
  50     wxBitmap *GetStipple() const;
  51
  52 #if FUTURE_WXWIN_COMPATIBILITY_3_0
  53     wxDEPRECATED_FUTURE( void SetStyle(int style) )
  54         { SetStyle((wxPenStyle)style); }
  55 #endif
  56
  57 protected:
  58     virtual wxGDIRefData *CreateGDIRefData() const;
  59     virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
  60
  61     DECLARE_DYNAMIC_CLASS(wxPen)
  62 };
  63
  64 #endif // _WX_GTK_PEN_H_