include/wx/generic/dataview.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/generic/dataview.h
   3 // Purpose:     wxDataViewCtrl generic implementation header
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifndef __GENERICDATAVIEWCTRLH__
  11 #define __GENERICDATAVIEWCTRLH__
  12
  13 #include "wx/defs.h"
  14 #include "wx/object.h"
  15 #include "wx/list.h"
  16 #include "wx/control.h"
  17 #include "wx/scrolwin.h"
  18
  19 // ---------------------------------------------------------
  20 // classes
  21 // ---------------------------------------------------------
  22
  23 class WXDLLIMPEXP_CORE wxDataViewCtrl;
  24 class WXDLLIMPEXP_CORE wxDataViewMainWindow;
  25 class WXDLLIMPEXP_CORE wxDataViewHeaderWindow;
  26
  27 // ---------------------------------------------------------
  28 // wxDataViewCell
  29 // ---------------------------------------------------------
  30
  31 class wxDataViewCell: public wxDataViewCellBase
  32 {
  33 public:
  34     wxDataViewCell( const wxString &varianttype, wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
  35     ~wxDataViewCell();
  36
  37     virtual bool Render( wxRect cell, wxDC *dc, int state ) = 0;
  38     virtual wxSize GetSize() = 0;
  39
  40     virtual bool Activate( wxRect WXUNUSED(cell),
  41                            wxDataViewListModel *WXUNUSED(model),
  42                            size_t WXUNUSED(col),
  43                            size_t WXUNUSED(row) )
  44                            { return false; }
  45
  46     virtual bool LeftClick( wxPoint WXUNUSED(cursor),
  47                             wxRect WXUNUSED(cell),
  48                             wxDataViewListModel *WXUNUSED(model),
  49                             size_t WXUNUSED(col),
  50                             size_t WXUNUSED(row) )
  51                             { return false; }
  52     virtual bool RightClick( wxPoint WXUNUSED(cursor),
  53                              wxRect WXUNUSED(cell),
  54                              wxDataViewListModel *WXUNUSED(model),
  55                              size_t WXUNUSED(col),
  56                              size_t WXUNUSED(row) )
  57                              { return false; }
  58     virtual bool StartDrag( wxPoint WXUNUSED(cursor),
  59                             wxRect WXUNUSED(cell),
  60                             wxDataViewListModel *WXUNUSED(model),
  61                             size_t WXUNUSED(col),
  62                             size_t WXUNUSED(row) )
  63                             { return false; }
  64
  65     // Create DC on request
  66     virtual wxDC *GetDC();
  67
  68 private:
  69     wxDC        *m_dc;
  70
  71 protected:
  72     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCell)
  73 };
  74
  75 // ---------------------------------------------------------
  76 // wxDataViewCustomCell
  77 // ---------------------------------------------------------
  78
  79 class wxDataViewCustomCell: public wxDataViewCell
  80 {
  81 public:
  82     wxDataViewCustomCell( const wxString &varianttype = wxT("string"),
  83                           wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
  84
  85 protected:
  86     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCustomCell)
  87 };
  88
  89 // ---------------------------------------------------------
  90 // wxDataViewTextCell
  91 // ---------------------------------------------------------
  92
  93 class wxDataViewTextCell: public wxDataViewCustomCell
  94 {
  95 public:
  96     wxDataViewTextCell( const wxString &varianttype = wxT("string"),
  97                         wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
  98
  99     bool SetValue( const wxVariant &value );
 100     bool GetValue( wxVariant &value );
 101
 102     bool Render( wxRect cell, wxDC *dc, int state );
 103     wxSize GetSize();
 104
 105 private:
 106     wxString m_text;
 107
 108 protected:
 109     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewTextCell)
 110 };
 111
 112 // ---------------------------------------------------------
 113 // wxDataViewToggleCell
 114 // ---------------------------------------------------------
 115
 116 class wxDataViewToggleCell: public wxDataViewCustomCell
 117 {
 118 public:
 119     wxDataViewToggleCell( const wxString &varianttype = wxT("bool"),
 120                         wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
 121
 122     bool SetValue( const wxVariant &value );
 123     bool GetValue( wxVariant &value );
 124
 125     bool Render( wxRect cell, wxDC *dc, int state );
 126     bool Activate( wxRect cell, wxDataViewListModel *model, size_t col, size_t row );
 127     wxSize GetSize();
 128
 129 private:
 130     bool    m_toggle;
 131
 132 protected:
 133     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewToggleCell)
 134 };
 135
 136 // ---------------------------------------------------------
 137 // wxDataViewProgressCell
 138 // ---------------------------------------------------------
 139
 140 class wxDataViewProgressCell: public wxDataViewCustomCell
 141 {
 142 public:
 143     wxDataViewProgressCell( const wxString &label = wxEmptyString,
 144                             const wxString &varianttype = wxT("long"),
 145                             wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
 146     ~wxDataViewProgressCell();
 147
 148     bool SetValue( const wxVariant &value );
 149
 150     virtual bool Render( wxRect cell, wxDC *dc, int state );
 151     virtual wxSize GetSize();
 152
 153 private:
 154     wxString    m_label;
 155     int         m_value;
 156
 157 protected:
 158     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewProgressCell)
 159 };
 160
 161 // ---------------------------------------------------------
 162 // wxDataViewDateCell
 163 // ---------------------------------------------------------
 164
 165 class wxDataViewDateCell: public wxDataViewCustomCell
 166 {
 167 public:
 168     wxDataViewDateCell( const wxString &varianttype = wxT("datetime"),
 169                         wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE );
 170
 171     bool SetValue( const wxVariant &value );
 172
 173     virtual bool Render( wxRect cell, wxDC *dc, int state );
 174     virtual wxSize GetSize();
 175     virtual bool Activate( wxRect cell,
 176                            wxDataViewListModel *model, size_t col, size_t row );
 177
 178 private:
 179     wxDateTime    m_date;
 180
 181 protected:
 182     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewDateCell)
 183 };
 184
 185 // ---------------------------------------------------------
 186 // wxDataViewColumn
 187 // ---------------------------------------------------------
 188
 189 class WXDLLIMPEXP_CORE wxDataViewColumn: public wxDataViewColumnBase
 190 {
 191 public:
 192     wxDataViewColumn( const wxString &title, wxDataViewCell *cell, size_t model_column, int flags = 0 );
 193     virtual ~wxDataViewColumn();
 194
 195     virtual void SetTitle( const wxString &title );
 196
 197     void SetWidth( int width ) { m_width = width; }
 198     int GetWidth() { return m_width; }
 199
 200 private:
 201     int     m_width;
 202
 203 protected:
 204     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewColumn)
 205 };
 206
 207 // ---------------------------------------------------------
 208 // wxDataViewCtrl
 209 // ---------------------------------------------------------
 210
 211 class WXDLLIMPEXP_CORE wxDataViewCtrl: public wxDataViewCtrlBase,
 212                                        public wxScrollHelperNative
 213 {
 214 public:
 215     wxDataViewCtrl() : wxScrollHelperNative(this)
 216     {
 217         Init();
 218     }
 219
 220     wxDataViewCtrl( wxWindow *parent, wxWindowID id,
 221            const wxPoint& pos = wxDefaultPosition,
 222            const wxSize& size = wxDefaultSize, long style = 0,
 223            const wxValidator& validator = wxDefaultValidator )
 224              : wxScrollHelperNative(this)
 225     {
 226         Create(parent, id, pos, size, style, validator );
 227     }
 228
 229     virtual ~wxDataViewCtrl();
 230
 231     void Init();
 232
 233     bool Create(wxWindow *parent, wxWindowID id,
 234            const wxPoint& pos = wxDefaultPosition,
 235            const wxSize& size = wxDefaultSize, long style = 0,
 236            const wxValidator& validator = wxDefaultValidator );
 237
 238     virtual bool AssociateModel( wxDataViewListModel *model );
 239     virtual bool AppendColumn( wxDataViewColumn *col );
 240
 241 private:
 242     friend class wxDataViewMainWindow;
 243     friend class wxDataViewHeaderWindow;
 244     wxDataViewListModelNotifier *m_notifier;
 245     wxDataViewMainWindow        *m_clientArea;
 246     wxDataViewHeaderWindow      *m_headerArea;
 247
 248 private:
 249     void OnSize( wxSizeEvent &event );
 250
 251     // we need to return a special WM_GETDLGCODE value to process just the
 252     // arrows but let the other navigation characters through
 253 #ifdef __WXMSW__
 254     virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
 255 #endif // __WXMSW__
 256
 257     WX_FORWARD_TO_SCROLL_HELPER()
 258
 259 private:
 260     DECLARE_DYNAMIC_CLASS(wxDataViewCtrl)
 261     DECLARE_NO_COPY_CLASS(wxDataViewCtrl)
 262     DECLARE_EVENT_TABLE()
 263 };
 264
 265
 266 #endif // __GENERICDATAVIEWCTRLH__