include/wx/dataview.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/dataview.h
   3 // Purpose:     wxDataViewCtrl base classes
   4 // Author:      Robert Roebling
   5 // Modified by:
   6 // Created:     08.01.06
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Robert Roebling
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_DATAVIEW_H_BASE_
  13 #define _WX_DATAVIEW_H_BASE_
  14
  15 #include "wx/defs.h"
  16
  17 #if wxUSE_DATAVIEWCTRL
  18
  19 #include "wx/control.h"
  20 #include "wx/textctrl.h"
  21 #include "wx/bitmap.h"
  22 #include "wx/variant.h"
  23
  24 // ----------------------------------------------------------------------------
  25 // wxDataViewCtrl flags
  26 // ----------------------------------------------------------------------------
  27
  28 // ----------------------------------------------------------------------------
  29 // wxDataViewCtrl globals
  30 // ----------------------------------------------------------------------------
  31
  32 class WXDLLIMPEXP_CORE wxDataViewCtrl;
  33 class WXDLLIMPEXP_CORE wxDataViewColumn;
  34 class WXDLLIMPEXP_CORE wxDataViewCell;
  35
  36 extern WXDLLEXPORT_DATA(const wxChar) wxDataViewCtrlNameStr[];
  37
  38 // ---------------------------------------------------------
  39 // wxDataViewModel
  40 // ---------------------------------------------------------
  41
  42 class wxDataViewModel: public wxObject
  43 {
  44 public:
  45     wxDataViewModel() { }
  46     virtual ~wxDataViewModel() { }
  47
  48 protected:
  49     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewModel)
  50 };
  51
  52 // ---------------------------------------------------------
  53 // wxDataViewListModelNotifier
  54 // ---------------------------------------------------------
  55
  56 class wxDataViewListModelNotifier
  57 {
  58 public:
  59     wxDataViewListModelNotifier() { }
  60     virtual ~wxDataViewListModelNotifier() { }
  61
  62     virtual bool RowAppended() = 0;
  63     virtual bool RowPrepended() = 0;
  64     virtual bool RowInserted( size_t before ) = 0;
  65     virtual bool RowDeleted( size_t row ) = 0;
  66     virtual bool RowChanged( size_t row ) = 0;
  67     virtual bool ValueChanged( size_t row, size_t col ) = 0;
  68     virtual bool Cleared() = 0;
  69 };
  70
  71 // ---------------------------------------------------------
  72 // wxDataViewListModel
  73 // ---------------------------------------------------------
  74
  75 class wxDataViewListModel: public wxDataViewModel
  76 {
  77 public:
  78     wxDataViewListModel();
  79     virtual ~wxDataViewListModel();
  80
  81     virtual size_t GetNumberOfRows() = 0;
  82     virtual size_t GetNumberOfCols() = 0;
  83     // return type as reported by wxVariant
  84     virtual wxString GetColType( size_t col ) = 0;
  85     // get value into a wxVariant
  86     virtual wxVariant GetValue( size_t col, size_t row ) = 0;
  87     // set value, call ValueChanged() afterwards!
  88     virtual bool SetValue( wxVariant &variant, size_t col, size_t row ) = 0;
  89
  90     // delegated notifiers
  91     bool RowAppended();
  92     bool RowPrepended();
  93     bool RowInserted( size_t before );
  94     bool RowDeleted( size_t row );
  95     bool RowChanged( size_t row );
  96     bool ValueChanged( size_t col, size_t row );
  97     bool Cleared();
  98
  99     void SetNotifier( wxDataViewListModelNotifier *notifier );
 100     wxDataViewListModelNotifier* GetNotifier();
 101
 102 private:
 103     wxDataViewListModelNotifier *m_notifier;
 104
 105 protected:
 106     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewListModel)
 107 };
 108
 109 // ---------------------------------------------------------
 110 // wxDataViewCellBase
 111 // ---------------------------------------------------------
 112
 113 enum wxDataViewCellMode
 114 {
 115     wxDATAVIEW_CELL_INERT,
 116     wxDATAVIEW_CELL_ACTIVATABLE,
 117     wxDATAVIEW_CELL_EDITABLE
 118 };
 119
 120 enum wxDataViewCellRenderState
 121 {
 122     wxDATAVIEW_CELL_SELECTED    = 1,
 123     wxDATAVIEW_CELL_PRELIT      = 2,
 124     wxDATAVIEW_CELL_INSENSITIVE = 4,
 125     wxDATAVIEW_CELL_FOCUSED     = 8
 126 };
 127
 128 class wxDataViewCellBase: public wxObject
 129 {
 130 public:
 131     wxDataViewCellBase( const wxString &varianttype, wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
 132
 133     virtual bool SetValue( const wxVariant &value ) { return true; }
 134     virtual bool GetValue( wxVariant &value )       { return true; }
 135     virtual bool Validate( wxVariant &value )       { return true; }
 136     virtual bool BeginEdit()    { return true; }
 137     virtual bool EndEdit()      { return true; }
 138
 139     wxString GetVariantType()   { return m_variantType; }
 140
 141     void SetOwner( wxDataViewColumn *owner )    { m_owner = owner; }
 142     wxDataViewColumn* GetOwner()                { return m_owner; }
 143
 144 protected:
 145     wxDataViewCellMode      m_mode;
 146     wxString                m_variantType;
 147     wxDataViewColumn       *m_owner;
 148
 149 protected:
 150     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCellBase)
 151 };
 152
 153 // ---------------------------------------------------------
 154 // wxDataViewColumnBase
 155 // ---------------------------------------------------------
 156
 157 enum wxDataViewColumnFlags
 158 {
 159     wxDATAVIEW_COL_RESIZABLE  = 1,
 160     wxDATAVIEW_COL_SORTABLE   = 2,
 161     wxDATAVIEW_COL_HIDDEN     = 4
 162 };
 163
 164 class wxDataViewColumnBase: public wxObject
 165 {
 166 public:
 167     wxDataViewColumnBase( const wxString &title, wxDataViewCell *cell, size_t model_column, int flags = 0 );
 168     ~wxDataViewColumnBase();
 169
 170     virtual void SetTitle( const wxString &title );
 171     virtual wxString GetTitle();
 172
 173     wxDataViewCell* GetCell()               { return m_cell; }
 174
 175     size_t GetModelColumn()                 { return m_model_column; }
 176
 177     void SetOwner( wxDataViewCtrl *owner )  { m_owner = owner; }
 178     wxDataViewCtrl *GetOwner()              { return m_owner; }
 179
 180 private:
 181     wxDataViewCtrl          *m_ctrl;
 182     wxDataViewCell          *m_cell;
 183     int                      m_model_column;
 184     int                      m_flags;
 185     wxString                 m_title;
 186     wxDataViewCtrl          *m_owner;
 187
 188 protected:
 189     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewColumnBase)
 190 };
 191
 192 // ---------------------------------------------------------
 193 // wxDataViewCtrlBase
 194 // ---------------------------------------------------------
 195
 196 class wxDataViewCtrlBase: public wxControl
 197 {
 198 public:
 199     wxDataViewCtrlBase();
 200     ~wxDataViewCtrlBase();
 201
 202     virtual bool AssociateModel( wxDataViewListModel *model );
 203     wxDataViewListModel* GetModel();
 204
 205     virtual bool AppendTextColumn( const wxString &label, size_t model_column );
 206     virtual bool AppendToggleColumn( const wxString &label, size_t model_column );
 207     virtual bool AppendProgressColumn( const wxString &label, size_t model_column );
 208     virtual bool AppendColumn( wxDataViewColumn *col );
 209     virtual size_t GetNumberOfColumns();
 210     virtual bool DeleteColumn( size_t pos );
 211     virtual bool ClearColumns();
 212     virtual wxDataViewColumn* GetColumn( size_t pos );
 213
 214 private:
 215     wxDataViewListModel    *m_model;
 216     wxList                  m_cols;
 217
 218 protected:
 219     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCtrlBase)
 220 };
 221
 222 #if defined(__WXGTK20__)
 223     #include "wx/gtk/dataview.h"
 224 #elif defined(__WXMAC__)
 225     #include "wx/mac/dataview.h"
 226 #else
 227     #include "wx/generic/dataview.h"
 228 #endif
 229
 230 #endif // wxUSE_DATAVIEWCTRL
 231
 232 #endif
 233     // _WX_DATAVIEW_H_BASE_