include/wx/gtk/pen.h

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