include/wx/generic/dataview.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/generic/dataview.h
   3 // Purpose:     wxDataViewCtrl generic implementation header
   4 // Author:      Robert Roebling
   5 // Modified By: Bo Yang
   6 // Id:          $Id$
   7 // Copyright:   (c) 1998 Robert Roebling
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef __GENERICDATAVIEWCTRLH__
  12 #define __GENERICDATAVIEWCTRLH__
  13
  14 #include "wx/defs.h"
  15 #include "wx/object.h"
  16 #include "wx/list.h"
  17 #include "wx/control.h"
  18 #include "wx/scrolwin.h"
  19 #include "wx/icon.h"
  20
  21 class WXDLLIMPEXP_FWD_ADV wxDataViewMainWindow;
  22 class WXDLLIMPEXP_FWD_ADV wxDataViewHeaderWindow;
  23
  24 // ---------------------------------------------------------
  25 // wxDataViewColumn
  26 // ---------------------------------------------------------
  27
  28 class WXDLLIMPEXP_ADV wxDataViewColumn : public wxDataViewColumnBase
  29 {
  30 public:
  31     wxDataViewColumn(const wxString& title,
  32                      wxDataViewRenderer *renderer,
  33                      unsigned int model_column,
  34                      int width = wxDVC_DEFAULT_WIDTH,
  35                      wxAlignment align = wxALIGN_CENTER,
  36                      int flags = wxDATAVIEW_COL_RESIZABLE)
  37         : wxDataViewColumnBase(renderer, model_column),
  38           m_title(title)
  39     {
  40         Init(width, align, flags);
  41     }
  42
  43     wxDataViewColumn(const wxBitmap& bitmap,
  44                      wxDataViewRenderer *renderer,
  45                      unsigned int model_column,
  46                      int width = wxDVC_DEFAULT_WIDTH,
  47                      wxAlignment align = wxALIGN_CENTER,
  48                      int flags = wxDATAVIEW_COL_RESIZABLE)
  49         : wxDataViewColumnBase(bitmap, renderer, model_column)
  50     {
  51         Init(width, align, flags);
  52     }
  53
  54     // implement wxHeaderColumnBase methods
  55     virtual void SetTitle(const wxString& title) { m_title = title; UpdateDisplay(); }
  56     virtual wxString GetTitle() const { return m_title; }
  57
  58     virtual void SetWidth(int width) { m_width = width; UpdateDisplay(); }
  59     virtual int GetWidth() const { return m_width; }
  60
  61     virtual void SetMinWidth(int minWidth) { m_minWidth = minWidth; UpdateDisplay(); }
  62     virtual int GetMinWidth() const { return m_minWidth; }
  63
  64     virtual void SetAlignment(wxAlignment align) { m_align = align; UpdateDisplay(); }
  65     virtual wxAlignment GetAlignment() const { return m_align; }
  66
  67     virtual void SetFlags(int flags) { m_flags = flags; UpdateDisplay(); }
  68     virtual int GetFlags() const { return m_flags; }
  69
  70     virtual void SetAsSortKey(bool sort = true) { m_sort = sort; UpdateDisplay(); }
  71     virtual bool IsSortKey() const { return m_sort; }
  72
  73     virtual void SetSortOrder(bool ascending) { m_sortAscending = ascending; UpdateDisplay(); }
  74     virtual bool IsSortOrderAscending() const { return m_sortAscending; }
  75
  76     virtual void SetBitmap( const wxBitmap& bitmap ) { wxDataViewColumnBase::SetBitmap(bitmap); UpdateDisplay(); }
  77
  78
  79 private:
  80     // common part of all ctors
  81     void Init(int width, wxAlignment align, int flags);
  82
  83     void UpdateDisplay();
  84
  85     wxString m_title;
  86     int m_width,
  87         m_minWidth;
  88     wxAlignment m_align;
  89     int m_flags;
  90     bool m_sort,
  91          m_sortAscending;
  92
  93     friend class wxDataViewHeaderWindowBase;
  94     friend class wxDataViewHeaderWindow;
  95     friend class wxDataViewHeaderWindowMSW;
  96 };
  97
  98 // ---------------------------------------------------------
  99 // wxDataViewCtrl
 100 // ---------------------------------------------------------
 101
 102 WX_DECLARE_LIST_WITH_DECL(wxDataViewColumn, wxDataViewColumnList,
 103                           class WXDLLIMPEXP_ADV);
 104
 105 class WXDLLIMPEXP_ADV wxDataViewCtrl : public wxDataViewCtrlBase,
 106                                        public wxScrollHelper
 107 {
 108     friend class wxDataViewMainWindow;
 109     friend class wxDataViewHeaderWindowBase;
 110     friend class wxDataViewHeaderWindow;
 111     friend class wxDataViewHeaderWindowMSW;
 112     friend class wxDataViewColumn;
 113
 114 public:
 115     wxDataViewCtrl() : wxScrollHelper(this)
 116     {
 117         Init();
 118     }
 119
 120     wxDataViewCtrl( wxWindow *parent, wxWindowID id,
 121            const wxPoint& pos = wxDefaultPosition,
 122            const wxSize& size = wxDefaultSize, long style = 0,
 123            const wxValidator& validator = wxDefaultValidator,
 124            const wxString& name = wxDataViewCtrlNameStr )
 125              : wxScrollHelper(this)
 126     {
 127         Create(parent, id, pos, size, style, validator, name);
 128     }
 129
 130     virtual ~wxDataViewCtrl();
 131
 132     void Init();
 133
 134     bool Create(wxWindow *parent, wxWindowID id,
 135                 const wxPoint& pos = wxDefaultPosition,
 136                 const wxSize& size = wxDefaultSize, long style = 0,
 137                 const wxValidator& validator = wxDefaultValidator,
 138                 const wxString& name = wxDataViewCtrlNameStr);
 139
 140     virtual bool AssociateModel( wxDataViewModel *model );
 141
 142     virtual bool AppendColumn( wxDataViewColumn *col );
 143     virtual bool PrependColumn( wxDataViewColumn *col );
 144     virtual bool InsertColumn( unsigned int pos, wxDataViewColumn *col );
 145
 146     virtual void DoSetExpanderColumn();
 147     virtual void DoSetIndent();
 148
 149     virtual unsigned int GetColumnCount() const;
 150     virtual wxDataViewColumn* GetColumn( unsigned int pos ) const;
 151     virtual bool DeleteColumn( wxDataViewColumn *column );
 152     virtual bool ClearColumns();
 153     virtual int GetColumnPosition( const wxDataViewColumn *column ) const;
 154
 155     virtual wxDataViewColumn *GetSortingColumn() const;
 156
 157     virtual wxDataViewItem GetSelection() const;
 158     virtual int GetSelections( wxDataViewItemArray & sel ) const;
 159     virtual void SetSelections( const wxDataViewItemArray & sel );
 160     virtual void Select( const wxDataViewItem & item );
 161     virtual void Unselect( const wxDataViewItem & item );
 162     virtual bool IsSelected( const wxDataViewItem & item ) const;
 163
 164     virtual void SelectAll();
 165     virtual void UnselectAll();
 166
 167     virtual void EnsureVisible( const wxDataViewItem & item,
 168                                 const wxDataViewColumn *column = NULL );
 169     virtual void HitTest( const wxPoint & point, wxDataViewItem & item,
 170                           wxDataViewColumn* &column ) const;
 171     virtual wxRect GetItemRect( const wxDataViewItem & item,
 172                                 const wxDataViewColumn *column = NULL ) const;
 173
 174     virtual void Expand( const wxDataViewItem & item );
 175     virtual void Collapse( const wxDataViewItem & item );
 176     virtual bool IsExpanded( const wxDataViewItem & item ) const;
 177
 178     virtual void SetFocus();
 179
 180 #if wxUSE_DRAG_AND_DROP
 181     virtual bool EnableDragSource( const wxDataFormat &format );
 182     virtual bool EnableDropTarget( const wxDataFormat &format );
 183 #endif // wxUSE_DRAG_AND_DROP
 184
 185     virtual wxBorder GetDefaultBorder() const;
 186
 187     void StartEditor( const wxDataViewItem & item, unsigned int column );
 188
 189 protected:
 190     virtual int GetSelections( wxArrayInt & sel ) const;
 191     virtual void SetSelections( const wxArrayInt & sel );
 192     virtual void Select( int row );
 193     virtual void Unselect( int row );
 194     virtual bool IsSelected( int row ) const;
 195     virtual void SelectRange( int from, int to );
 196     virtual void UnselectRange( int from, int to );
 197
 198     virtual void EnsureVisible( int row, int column );
 199
 200     virtual wxDataViewItem GetItemByRow( unsigned int row ) const;
 201     virtual int GetRowByItem( const wxDataViewItem & item ) const;
 202
 203     int GetSortingColumnIndex() const { return m_sortingColumnIdx; }
 204     void SetSortingColumnIndex(int idx) { m_sortingColumnIdx = idx; }
 205
 206 public:     // utility functions not part of the API
 207
 208     // returns the "best" width for the idx-th column
 209     unsigned int GetBestColumnWidth(int WXUNUSED(idx)) const
 210     {
 211         return GetClientSize().GetWidth() / GetColumnCount();
 212     }
 213
 214     // called by header window after reorder
 215     void ColumnMoved( wxDataViewColumn* col, unsigned int new_pos );
 216
 217     // update the display after a change to an individual column
 218     void OnColumnChange(unsigned int idx);
 219
 220     // update after a change to the number of columns
 221     void OnColumnsCountChanged();
 222
 223     wxWindow *GetMainWindow() { return (wxWindow*) m_clientArea; }
 224
 225     // return the index of the given column in m_cols
 226     int GetColumnIndex(const wxDataViewColumn *column) const;
 227
 228     // return the column displayed at the given position in the control
 229     wxDataViewColumn *GetColumnAt(unsigned int pos) const;
 230
 231 private:
 232     virtual wxDataViewItem DoGetCurrentItem() const;
 233     virtual void DoSetCurrentItem(const wxDataViewItem& item);
 234
 235     wxDataViewColumnList      m_cols;
 236     wxDataViewModelNotifier  *m_notifier;
 237     wxDataViewMainWindow     *m_clientArea;
 238     wxDataViewHeaderWindow   *m_headerArea;
 239
 240     // the index of the column currently used for sorting or -1
 241     int m_sortingColumnIdx;
 242
 243 private:
 244     void OnSize( wxSizeEvent &event );
 245     virtual wxSize GetSizeAvailableForScrollTarget(const wxSize& size);
 246
 247     // we need to return a special WM_GETDLGCODE value to process just the
 248     // arrows but let the other navigation characters through
 249 #ifdef __WXMSW__
 250     virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
 251 #endif // __WXMSW__
 252
 253     WX_FORWARD_TO_SCROLL_HELPER()
 254
 255 private:
 256     DECLARE_DYNAMIC_CLASS(wxDataViewCtrl)
 257     wxDECLARE_NO_COPY_CLASS(wxDataViewCtrl);
 258     DECLARE_EVENT_TABLE()
 259 };
 260
 261
 262 #endif // __GENERICDATAVIEWCTRLH__