include/wx/gtk1/pen.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/gtk1/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 __GTKPENH__
  11 #define __GTKPENH__
  12
  13 #include "wx/defs.h"
  14 #include "wx/object.h"
  15 #include "wx/string.h"
  16 #include "wx/gdiobj.h"
  17 #include "wx/gdicmn.h"
  18
  19 //-----------------------------------------------------------------------------
  20 // classes
  21 //-----------------------------------------------------------------------------
  22
  23 class WXDLLIMPEXP_FWD_CORE wxPen;
  24
  25 #if defined(__WXGTK127__)
  26 typedef    gint8 wxGTKDash;
  27 #else
  28 typedef    gchar wxGTKDash;
  29 #endif
  30
  31 //-----------------------------------------------------------------------------
  32 // wxPen
  33 //-----------------------------------------------------------------------------
  34
  35 class WXDLLIMPEXP_CORE wxPen: public wxPenBase
  36 {
  37 public:
  38     wxPen() { }
  39
  40     wxPen( const wxColour &colour, int width = 1, wxPenStyle style = wxPENSTYLE_SOLID );
  41 #if FUTURE_WXWIN_COMPATIBILITY_3_0
  42     wxDEPRECATED_FUTURE( wxPen(const wxColour& col, int width, int style) );
  43 #endif
  44
  45     bool operator==(const wxPen& pen) const;
  46     bool operator!=(const wxPen& pen) const { return !(*this == pen); }
  47
  48     void SetColour( const wxColour &colour );
  49     void SetColour( unsigned char red, unsigned char green, unsigned char blue );
  50     void SetCap( wxPenCap capStyle );
  51     void SetJoin( wxPenJoin joinStyle );
  52     void SetStyle( wxPenStyle style );
  53     void SetWidth( int width );
  54     void SetDashes( int number_of_dashes, const wxDash *dash );
  55     void SetStipple(const wxBitmap& stipple);
  56
  57     wxColour GetColour() const;
  58     wxPenCap GetCap() const;
  59     wxPenJoin GetJoin() const;
  60     wxPenStyle GetStyle() const;
  61     int GetWidth() const;
  62     int GetDashes(wxDash **ptr) const;
  63     int GetDashCount() const;
  64     wxDash* GetDash() const;
  65     wxBitmap *GetStipple() const;
  66
  67 #if FUTURE_WXWIN_COMPATIBILITY_3_0
  68     wxDEPRECATED_FUTURE( void SetStyle(int style) )
  69         { SetStyle((wxPenStyle)style); }
  70 #endif
  71
  72 private:
  73     virtual wxGDIRefData *CreateGDIRefData() const;
  74     virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
  75
  76     DECLARE_DYNAMIC_CLASS(wxPen)
  77 };
  78
  79 #endif // __GTKPENH__