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 #if defined(__WXGTK20__)
  26     // for testing
  27     #define wxUSE_GENERICDATAVIEWCTRL 1
  28 #elif defined(__WXMAC__)
  29     #define wxUSE_GENERICDATAVIEWCTRL 1
  30 #else
  31     #define wxUSE_GENERICDATAVIEWCTRL 1
  32 #endif
  33
  34 // ----------------------------------------------------------------------------
  35 // wxDataViewCtrl flags
  36 // ----------------------------------------------------------------------------
  37
  38 // ----------------------------------------------------------------------------
  39 // wxDataViewCtrl globals
  40 // ----------------------------------------------------------------------------
  41
  42 class WXDLLIMPEXP_ADV wxDataViewModel;
  43 class WXDLLIMPEXP_ADV wxDataViewListModel;
  44 class WXDLLIMPEXP_ADV wxDataViewCtrl;
  45 class WXDLLIMPEXP_ADV wxDataViewColumn;
  46 class WXDLLIMPEXP_ADV wxDataViewRenderer;
  47
  48 extern WXDLLIMPEXP_DATA_ADV(const wxChar) wxDataViewCtrlNameStr[];
  49
  50 // ---------------------------------------------------------
  51 // wxDataViewModel
  52 // ---------------------------------------------------------
  53
  54 class WXDLLIMPEXP_ADV wxDataViewModel: public wxObject
  55 {
  56 public:
  57     wxDataViewModel() { }
  58     virtual ~wxDataViewModel() { }
  59
  60 protected:
  61     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewModel)
  62 };
  63
  64 // ---------------------------------------------------------
  65 // wxDataViewListModelNotifier
  66 // ---------------------------------------------------------
  67
  68
  69 class WXDLLIMPEXP_ADV wxDataViewListModelNotifier: public wxObject
  70 {
  71 public:
  72     wxDataViewListModelNotifier() { }
  73     virtual ~wxDataViewListModelNotifier() { }
  74
  75     virtual bool RowAppended() = 0;
  76     virtual bool RowPrepended() = 0;
  77     virtual bool RowInserted( unsigned int before ) = 0;
  78     virtual bool RowDeleted( unsigned int row ) = 0;
  79     virtual bool RowChanged( unsigned int row ) = 0;
  80     virtual bool ValueChanged( unsigned int col, unsigned int row ) = 0;
  81     virtual bool RowsReordered( unsigned int *new_order ) = 0;
  82     virtual bool Cleared() = 0;
  83
  84     void SetOwner( wxDataViewListModel *owner ) { m_owner = owner; }
  85     wxDataViewListModel *GetOwner()             { return m_owner; }
  86
  87 private:
  88     wxDataViewListModel *m_owner;
  89 };
  90
  91 // ---------------------------------------------------------
  92 // wxDataViewListModel
  93 // ---------------------------------------------------------
  94
  95 class WXDLLIMPEXP_ADV wxDataViewViewingColumn: public wxObject
  96 {
  97 public:
  98     wxDataViewViewingColumn( wxDataViewColumn *view_column, unsigned int model_column )
  99     {
 100         m_viewColumn = view_column;
 101         m_modelColumn = model_column;
 102     }
 103
 104     wxDataViewColumn   *m_viewColumn;
 105     unsigned int        m_modelColumn;
 106 };
 107
 108 class WXDLLIMPEXP_ADV wxDataViewListModel: public wxDataViewModel
 109 {
 110 public:
 111     wxDataViewListModel();
 112     virtual ~wxDataViewListModel();
 113
 114     virtual unsigned int GetNumberOfRows() = 0;
 115     virtual unsigned int GetNumberOfCols() = 0;
 116     // return type as reported by wxVariant
 117     virtual wxString GetColType( unsigned int col ) = 0;
 118     // get value into a wxVariant
 119     virtual void GetValue( wxVariant &variant, unsigned int col, unsigned int row ) = 0;
 120     // set value, call ValueChanged() afterwards!
 121     virtual bool SetValue( wxVariant &variant, unsigned int col, unsigned int row ) = 0;
 122
 123     // delegated notifiers
 124     virtual bool RowAppended();
 125     virtual bool RowPrepended();
 126     virtual bool RowInserted( unsigned int before );
 127     virtual bool RowDeleted( unsigned int row );
 128     virtual bool RowChanged( unsigned int row );
 129     virtual bool ValueChanged( unsigned int col, unsigned int row );
 130     virtual bool RowsReordered( unsigned int *new_order );
 131     virtual bool Cleared();
 132
 133     // Used internally
 134     virtual void AddViewingColumn( wxDataViewColumn *view_column, unsigned int model_column );
 135     virtual void RemoveViewingColumn( wxDataViewColumn *column );
 136
 137     virtual void AddNotifier( wxDataViewListModelNotifier *notifier );
 138     virtual void RemoveNotifier( wxDataViewListModelNotifier *notifier );
 139
 140     wxList                      m_notifiers;
 141     wxList                      m_viewingColumns;
 142
 143 protected:
 144     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewListModel)
 145 };
 146
 147 // ---------------------------------------------------------
 148 // wxDataViewSortedListModel
 149 // ---------------------------------------------------------
 150
 151 typedef int (wxCALLBACK *wxDataViewListModelCompare)
 152     (unsigned int row1, unsigned int row2, unsigned int col, wxDataViewListModel* model );
 153
 154 WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_SIZE_T(unsigned int, wxDataViewSortedIndexArray, WXDLLIMPEXP_ADV);
 155
 156 class WXDLLIMPEXP_ADV wxDataViewSortedListModel: public wxDataViewListModel
 157 {
 158 public:
 159     wxDataViewSortedListModel( wxDataViewListModel *child );
 160     virtual ~wxDataViewSortedListModel();
 161
 162     virtual unsigned int GetNumberOfRows();
 163     virtual unsigned int GetNumberOfCols();
 164     // return type as reported by wxVariant
 165     virtual wxString GetColType( unsigned int col );
 166     // get value into a wxVariant
 167     virtual void GetValue( wxVariant &variant, unsigned int col, unsigned int row );
 168     // set value, call ValueChanged() afterwards!
 169     virtual bool SetValue( wxVariant &variant, unsigned int col, unsigned int row );
 170
 171     // called from user
 172     virtual bool RowAppended();
 173     virtual bool RowPrepended();
 174     virtual bool RowInserted( unsigned int before );
 175     virtual bool RowDeleted( unsigned int row );
 176     virtual bool RowChanged( unsigned int row );
 177     virtual bool ValueChanged( unsigned int col, unsigned int row );
 178     virtual bool RowsReordered( unsigned int *new_order );
 179     virtual bool Cleared();
 180
 181     // called if child's notifiers are called
 182     bool ChildRowAppended();
 183     bool ChildRowPrepended();
 184     bool ChildRowInserted( unsigned int before );
 185     bool ChildRowDeleted( unsigned int row );
 186     bool ChildRowChanged( unsigned int row );
 187     bool ChildValueChanged( unsigned int col, unsigned int row );
 188     bool ChildRowsReordered( unsigned int *new_order );
 189     bool ChildCleared();
 190
 191     virtual void Resort();
 192
 193 private:
 194     wxDataViewListModel             *m_child;
 195     wxDataViewSortedIndexArray       m_array;
 196     wxDataViewListModelNotifier     *m_notifierOnChild;
 197
 198 protected:
 199     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewSortedListModel)
 200 };
 201
 202 // ---------------------------------------------------------
 203 // wxDataViewRendererBase
 204 // ---------------------------------------------------------
 205
 206 enum wxDataViewCellMode
 207 {
 208     wxDATAVIEW_CELL_INERT,
 209     wxDATAVIEW_CELL_ACTIVATABLE,
 210     wxDATAVIEW_CELL_EDITABLE
 211 };
 212
 213 enum wxDataViewCellRenderState
 214 {
 215     wxDATAVIEW_CELL_SELECTED    = 1,
 216     wxDATAVIEW_CELL_PRELIT      = 2,
 217     wxDATAVIEW_CELL_INSENSITIVE = 4,
 218     wxDATAVIEW_CELL_FOCUSED     = 8
 219 };
 220
 221 class WXDLLIMPEXP_ADV wxDataViewRendererBase: public wxObject
 222 {
 223 public:
 224     wxDataViewRendererBase( const wxString &varianttype, wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
 225
 226     virtual bool SetValue( const wxVariant& WXUNUSED(value) ) { return true; }
 227     virtual bool GetValue( wxVariant& WXUNUSED(value) )       { return true; }
 228     virtual bool Validate( wxVariant& WXUNUSED(value) )       { return true; }
 229
 230     wxString GetVariantType()       { return m_variantType; }
 231     wxDataViewCellMode GetMode()    { return m_mode; }
 232
 233     void SetOwner( wxDataViewColumn *owner )    { m_owner = owner; }
 234     wxDataViewColumn* GetOwner()                { return m_owner; }
 235
 236 protected:
 237     wxDataViewCellMode      m_mode;
 238     wxString                m_variantType;
 239     wxDataViewColumn       *m_owner;
 240
 241 protected:
 242     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRendererBase)
 243 };
 244
 245 // ---------------------------------------------------------
 246 // wxDataViewColumnBase
 247 // ---------------------------------------------------------
 248
 249 enum wxDataViewColumnFlags
 250 {
 251     wxDATAVIEW_COL_RESIZABLE  = 1,
 252     wxDATAVIEW_COL_SORTABLE   = 2,
 253     wxDATAVIEW_COL_HIDDEN     = 4
 254 };
 255
 256 class WXDLLIMPEXP_ADV wxDataViewColumnBase: public wxObject
 257 {
 258 public:
 259     wxDataViewColumnBase( const wxString &title, wxDataViewRenderer *renderer, unsigned int model_column,
 260         int width = 80, int flags = wxDATAVIEW_COL_RESIZABLE );
 261     wxDataViewColumnBase( const wxBitmap &bitmap, wxDataViewRenderer *renderer, unsigned int model_column,
 262         int width = 80, int flags = wxDATAVIEW_COL_RESIZABLE );
 263     virtual ~wxDataViewColumnBase();
 264
 265     virtual void SetTitle( const wxString &title );
 266     virtual wxString GetTitle();
 267
 268     virtual void SetBitmap( const wxBitmap &bitmap );
 269     virtual const wxBitmap &GetBitmap();
 270
 271     virtual void SetAlignment( wxAlignment align ) = 0;
 272     virtual void SetSortOrder( bool ascending ) = 0;
 273
 274     wxDataViewRenderer* GetRenderer()       { return m_renderer; }
 275
 276     unsigned int GetModelColumn()           { return m_model_column; }
 277
 278     void SetOwner( wxDataViewCtrl *owner )  { m_owner = owner; }
 279     wxDataViewCtrl *GetOwner()              { return m_owner; }
 280
 281     virtual int GetWidth() = 0;
 282
 283 private:
 284     wxDataViewCtrl          *m_ctrl;
 285     wxDataViewRenderer      *m_renderer;
 286     int                      m_model_column;
 287     int                      m_flags;
 288     wxString                 m_title;
 289     wxBitmap                 m_bitmap;
 290     wxDataViewCtrl          *m_owner;
 291
 292 protected:
 293     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewColumnBase)
 294 };
 295
 296 // ---------------------------------------------------------
 297 // wxDataViewCtrlBase
 298 // ---------------------------------------------------------
 299
 300 #define wxDV_SINGLE                  0x0000     // for convenience
 301 #define wxDV_MULTIPLE                0x0020     // can select multiple items
 302
 303 class WXDLLIMPEXP_ADV wxDataViewCtrlBase: public wxControl
 304 {
 305 public:
 306     wxDataViewCtrlBase();
 307     virtual ~wxDataViewCtrlBase();
 308
 309     virtual bool AssociateModel( wxDataViewListModel *model );
 310     wxDataViewListModel* GetModel();
 311
 312     // short cuts
 313     virtual bool AppendTextColumn( const wxString &label, unsigned int model_column );
 314     virtual bool AppendToggleColumn( const wxString &label, unsigned int model_column );
 315     virtual bool AppendProgressColumn( const wxString &label, unsigned int model_column );
 316     virtual bool AppendDateColumn( const wxString &label, unsigned int model_column );
 317     virtual bool AppendBitmapColumn( const wxString &label, unsigned int model_column );
 318     virtual bool AppendTextColumn( const wxBitmap &label, unsigned int model_column );
 319     virtual bool AppendToggleColumn( const wxBitmap &label, unsigned int model_column );
 320     virtual bool AppendProgressColumn( const wxBitmap &label, unsigned int model_column );
 321     virtual bool AppendDateColumn( const wxBitmap &label, unsigned int model_column );
 322     virtual bool AppendBitmapColumn( const wxBitmap &label, unsigned int model_column );
 323
 324     virtual bool AppendColumn( wxDataViewColumn *col );
 325     virtual unsigned int GetNumberOfColumns();
 326     virtual bool DeleteColumn( unsigned int pos );
 327     virtual bool ClearColumns();
 328     virtual wxDataViewColumn* GetColumn( unsigned int pos );
 329
 330     virtual void SetSelection( int row ) = 0; // -1 for unselect
 331     inline void ClearSelection() { SetSelection( -1 ); }
 332     virtual void Unselect( unsigned int row ) = 0;
 333     virtual void SetSelectionRange( unsigned int from, unsigned int to ) = 0;
 334     virtual void SetSelections( const wxArrayInt& aSelections) = 0;
 335
 336     virtual bool IsSelected( unsigned int row ) const = 0;
 337     virtual int GetSelection() const = 0;
 338     virtual int GetSelections(wxArrayInt& aSelections) const = 0;
 339
 340 private:
 341     wxDataViewListModel    *m_model;
 342     wxList                  m_cols;
 343
 344 protected:
 345     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCtrlBase)
 346 };
 347
 348
 349 // ----------------------------------------------------------------------------
 350 // wxDataViewEvent - the event class for the wxDataViewCtrl notifications
 351 // ----------------------------------------------------------------------------
 352
 353 class WXDLLIMPEXP_ADV wxDataViewEvent : public wxNotifyEvent
 354 {
 355 public:
 356     wxDataViewEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
 357         : wxNotifyEvent(commandType, winid),
 358         m_col(-1),
 359         m_row(-1),
 360         m_model(NULL),
 361         m_value(wxNullVariant),
 362         m_editCancelled(false)
 363         { }
 364
 365     wxDataViewEvent(const wxDataViewEvent& event)
 366         : wxNotifyEvent(event),
 367         m_col(event.m_col),
 368         m_row(event.m_col),
 369         m_model(event.m_model),
 370         m_value(event.m_value),
 371         m_editCancelled(event.m_editCancelled)
 372         { }
 373
 374     int GetColumn() const { return m_col; }
 375     void SetColumn( int col ) { m_col = col; }
 376     int GetRow() const { return m_row; }
 377     void SetRow( int row ) { m_row = row; }
 378     wxDataViewModel* GetModel() const { return m_model; }
 379     void SetModel( wxDataViewModel *model ) { m_model = model; }
 380     const wxVariant &GetValue() const { return m_value; }
 381     void SetValue( const wxVariant &value ) { m_value = value; }
 382
 383     // was label editing canceled? (for wxEVT_COMMAND_DATVIEW_END_LABEL_EDIT only)
 384     bool IsEditCancelled() const { return m_editCancelled; }
 385     void SetEditCanceled(bool editCancelled) { m_editCancelled = editCancelled; }
 386
 387     virtual wxEvent *Clone() const { return new wxDataViewEvent(*this); }
 388
 389 protected:
 390     int                 m_col;
 391     int                 m_row;
 392     wxDataViewModel    *m_model;
 393     wxVariant           m_value;
 394     bool                m_editCancelled;
 395
 396 private:
 397     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDataViewEvent)
 398 };
 399
 400 BEGIN_DECLARE_EVENT_TYPES()
 401     DECLARE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_ROW_SELECTED, -1)
 402     DECLARE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_ROW_ACTIVATED, -1)
 403 END_DECLARE_EVENT_TYPES()
 404
 405 typedef void (wxEvtHandler::*wxDataViewEventFunction)(wxDataViewEvent&);
 406
 407 #define wxDataViewEventHandler(func) \
 408     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxDataViewEventFunction, &func)
 409
 410 #define wx__DECLARE_DATAVIEWEVT(evt, id, fn) \
 411     wx__DECLARE_EVT1(wxEVT_COMMAND_DATAVIEW_ ## evt, id, wxDataViewEventHandler(fn))
 412
 413 #define EVT_DATAVIEW_ROW_SELECTED(id, fn) wx__DECLARE_DATAVIEWEVT(ROW_SELECTED, id, fn)
 414 #define EVT_DATAVIEW_ROW_ACTIVATED(id, fn) wx__DECLARE_DATAVIEWEVT(ROW_ACTIVATED, id, fn)
 415
 416
 417 #if defined(wxUSE_GENERICDATAVIEWCTRL)
 418     #include "wx/generic/dataview.h"
 419 #elif defined(__WXGTK20__)
 420     #include "wx/gtk/dataview.h"
 421 #elif defined(__WXMAC__)
 422     // TODO
 423     // #include "wx/mac/dataview.h"
 424 #else
 425     #include "wx/generic/dataview.h"
 426 #endif
 427
 428 #endif // wxUSE_DATAVIEWCTRL
 429
 430 #endif
 431     // _WX_DATAVIEW_H_BASE_