// Name: wx/generic/dataview.h
// Purpose: wxDataViewCtrl generic implementation header
// Author: Robert Roebling
+// Modified By: Bo Yang
// Id: $Id$
// Copyright: (c) 1998 Robert Roebling
// Licence: wxWindows licence
#include "wx/control.h"
#include "wx/scrolwin.h"
#include "wx/icon.h"
+#include "wx/vector.h"
-// ---------------------------------------------------------
-// classes
-// ---------------------------------------------------------
-
-class WXDLLIMPEXP_ADV wxDataViewCtrl;
-class WXDLLIMPEXP_ADV wxDataViewMainWindow;
-class WXDLLIMPEXP_ADV wxDataViewHeaderWindow;
+class WXDLLIMPEXP_FWD_ADV wxDataViewMainWindow;
+class WXDLLIMPEXP_FWD_ADV wxDataViewHeaderWindow;
// ---------------------------------------------------------
-// wxDataViewRenderer
+// wxDataViewColumn
// ---------------------------------------------------------
-class WXDLLIMPEXP_ADV wxDataViewRenderer: public wxDataViewRendererBase
+class WXDLLIMPEXP_ADV wxDataViewColumn : public wxDataViewColumnBase
{
public:
- wxDataViewRenderer( const wxString &varianttype,
- wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
- virtual ~wxDataViewRenderer();
-
- virtual bool Render( wxRect cell, wxDC *dc, int state ) = 0;
- virtual wxSize GetSize() = 0;
-
- virtual bool Activate( wxRect WXUNUSED(cell),
- wxDataViewListModel *WXUNUSED(model),
- unsigned int WXUNUSED(col),
- unsigned int WXUNUSED(row) )
- { return false; }
-
- virtual bool LeftClick( wxPoint WXUNUSED(cursor),
- wxRect WXUNUSED(cell),
- wxDataViewListModel *WXUNUSED(model),
- unsigned int WXUNUSED(col),
- unsigned int WXUNUSED(row) )
- { return false; }
- virtual bool RightClick( wxPoint WXUNUSED(cursor),
- wxRect WXUNUSED(cell),
- wxDataViewListModel *WXUNUSED(model),
- unsigned int WXUNUSED(col),
- unsigned int WXUNUSED(row) )
- { return false; }
- virtual bool StartDrag( wxPoint WXUNUSED(cursor),
- wxRect WXUNUSED(cell),
- wxDataViewListModel *WXUNUSED(model),
- unsigned int WXUNUSED(col),
- unsigned int WXUNUSED(row) )
- { return false; }
-
- // Create DC on request
- virtual wxDC *GetDC();
-
-private:
- wxDC *m_dc;
+ wxDataViewColumn(const wxString& title,
+ wxDataViewRenderer *renderer,
+ unsigned int model_column,
+ int width = wxDVC_DEFAULT_WIDTH,
+ wxAlignment align = wxALIGN_CENTER,
+ int flags = wxDATAVIEW_COL_RESIZABLE)
+ : wxDataViewColumnBase(renderer, model_column),
+ m_title(title)
+ {
+ Init(width, align, flags);
+ }
-protected:
- DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRenderer)
-};
+ wxDataViewColumn(const wxBitmap& bitmap,
+ wxDataViewRenderer *renderer,
+ unsigned int model_column,
+ int width = wxDVC_DEFAULT_WIDTH,
+ wxAlignment align = wxALIGN_CENTER,
+ int flags = wxDATAVIEW_COL_RESIZABLE)
+ : wxDataViewColumnBase(bitmap, renderer, model_column)
+ {
+ Init(width, align, flags);
+ }
-// ---------------------------------------------------------
-// wxDataViewCustomRenderer
-// ---------------------------------------------------------
+ // implement wxHeaderColumnBase methods
+ virtual void SetTitle(const wxString& title) { m_title = title; UpdateDisplay(); }
+ virtual wxString GetTitle() const { return m_title; }
-class WXDLLIMPEXP_ADV wxDataViewCustomRenderer: public wxDataViewRenderer
-{
-public:
- wxDataViewCustomRenderer( const wxString &varianttype = wxT("string"),
- wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
+ virtual void SetWidth(int width) { m_width = width; UpdateDisplay(); }
+ virtual int GetWidth() const;
-protected:
- DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCustomRenderer)
-};
+ virtual void SetMinWidth(int minWidth) { m_minWidth = minWidth; UpdateDisplay(); }
+ virtual int GetMinWidth() const { return m_minWidth; }
-// ---------------------------------------------------------
-// wxDataViewTextRenderer
-// ---------------------------------------------------------
+ virtual void SetAlignment(wxAlignment align) { m_align = align; UpdateDisplay(); }
+ virtual wxAlignment GetAlignment() const { return m_align; }
-class WXDLLIMPEXP_ADV wxDataViewTextRenderer: public wxDataViewCustomRenderer
-{
-public:
- wxDataViewTextRenderer( const wxString &varianttype = wxT("string"),
- wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
+ virtual void SetFlags(int flags) { m_flags = flags; UpdateDisplay(); }
+ virtual int GetFlags() const { return m_flags; }
- bool SetValue( const wxVariant &value );
- bool GetValue( wxVariant &value );
+ virtual bool IsSortKey() const { return m_sort; }
- bool Render( wxRect cell, wxDC *dc, int state );
- wxSize GetSize();
+ virtual void UnsetAsSortKey() { m_sort = false; UpdateDisplay(); }
-private:
- wxString m_text;
+ virtual void SetSortOrder(bool ascending);
-protected:
- DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewTextRenderer)
-};
+ virtual bool IsSortOrderAscending() const { return m_sortAscending; }
-// ---------------------------------------------------------
-// wxDataViewBitmapRenderer
-// ---------------------------------------------------------
+ virtual void SetBitmap( const wxBitmap& bitmap ) { wxDataViewColumnBase::SetBitmap(bitmap); UpdateDisplay(); }
-class WXDLLIMPEXP_ADV wxDataViewBitmapRenderer: public wxDataViewCustomRenderer
-{
-public:
- wxDataViewBitmapRenderer( const wxString &varianttype = wxT("wxBitmap"),
- wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
- bool SetValue( const wxVariant &value );
- bool GetValue( wxVariant &value );
+private:
+ // common part of all ctors
+ void Init(int width, wxAlignment align, int flags);
- bool Render( wxRect cell, wxDC *dc, int state );
- wxSize GetSize();
+ void UpdateDisplay();
-private:
- wxIcon m_icon;
- wxBitmap m_bitmap;
+ wxString m_title;
+ int m_width,
+ m_minWidth;
+ wxAlignment m_align;
+ int m_flags;
+ bool m_sort,
+ m_sortAscending;
-protected:
- DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewBitmapRenderer)
+ friend class wxDataViewHeaderWindowBase;
+ friend class wxDataViewHeaderWindow;
+ friend class wxDataViewHeaderWindowMSW;
};
// ---------------------------------------------------------
-// wxDataViewToggleRenderer
+// wxDataViewCtrl
// ---------------------------------------------------------
-class WXDLLIMPEXP_ADV wxDataViewToggleRenderer: public wxDataViewCustomRenderer
+WX_DECLARE_LIST_WITH_DECL(wxDataViewColumn, wxDataViewColumnList,
+ class WXDLLIMPEXP_ADV);
+
+class WXDLLIMPEXP_ADV wxDataViewCtrl : public wxDataViewCtrlBase,
+ public wxScrollHelper
{
-public:
- wxDataViewToggleRenderer( const wxString &varianttype = wxT("bool"),
- wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
+ friend class wxDataViewMainWindow;
+ friend class wxDataViewHeaderWindowBase;
+ friend class wxDataViewHeaderWindow;
+ friend class wxDataViewHeaderWindowMSW;
+ friend class wxDataViewColumn;
- bool SetValue( const wxVariant &value );
- bool GetValue( wxVariant &value );
+public:
+ wxDataViewCtrl() : wxScrollHelper(this)
+ {
+ Init();
+ }
- bool Render( wxRect cell, wxDC *dc, int state );
- bool Activate( wxRect cell, wxDataViewListModel *model, unsigned int col,
- unsigned int row );
- wxSize GetSize();
+ wxDataViewCtrl( wxWindow *parent, wxWindowID id,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize, long style = 0,
+ const wxValidator& validator = wxDefaultValidator,
+ const wxString& name = wxDataViewCtrlNameStr )
+ : wxScrollHelper(this)
+ {
+ Create(parent, id, pos, size, style, validator, name);
+ }
-private:
- bool m_toggle;
+ virtual ~wxDataViewCtrl();
-protected:
- DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewToggleRenderer)
-};
+ void Init();
-// ---------------------------------------------------------
-// wxDataViewProgressRenderer
-// ---------------------------------------------------------
+ bool Create(wxWindow *parent, wxWindowID id,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize, long style = 0,
+ const wxValidator& validator = wxDefaultValidator,
+ const wxString& name = wxDataViewCtrlNameStr);
-class WXDLLIMPEXP_ADV wxDataViewProgressRenderer: public wxDataViewCustomRenderer
-{
-public:
- wxDataViewProgressRenderer( const wxString &label = wxEmptyString,
- const wxString &varianttype = wxT("long"),
- wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
- virtual ~wxDataViewProgressRenderer();
+ virtual bool AssociateModel( wxDataViewModel *model );
- bool SetValue( const wxVariant &value );
+ virtual bool AppendColumn( wxDataViewColumn *col );
+ virtual bool PrependColumn( wxDataViewColumn *col );
+ virtual bool InsertColumn( unsigned int pos, wxDataViewColumn *col );
- virtual bool Render( wxRect cell, wxDC *dc, int state );
- virtual wxSize GetSize();
+ virtual void DoSetExpanderColumn();
+ virtual void DoSetIndent();
-private:
- wxString m_label;
- int m_value;
+ virtual unsigned int GetColumnCount() const;
+ virtual wxDataViewColumn* GetColumn( unsigned int pos ) const;
+ virtual bool DeleteColumn( wxDataViewColumn *column );
+ virtual bool ClearColumns();
+ virtual int GetColumnPosition( const wxDataViewColumn *column ) const;
-protected:
- DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewProgressRenderer)
-};
+ virtual wxDataViewColumn *GetSortingColumn() const;
-// ---------------------------------------------------------
-// wxDataViewDateRenderer
-// ---------------------------------------------------------
+ virtual int GetSelectedItemsCount() const;
+ virtual int GetSelections( wxDataViewItemArray & sel ) const;
+ virtual void SetSelections( const wxDataViewItemArray & sel );
+ virtual void Select( const wxDataViewItem & item );
+ virtual void Unselect( const wxDataViewItem & item );
+ virtual bool IsSelected( const wxDataViewItem & item ) const;
-class WXDLLIMPEXP_ADV wxDataViewDateRenderer: public wxDataViewCustomRenderer
-{
-public:
- wxDataViewDateRenderer( const wxString &varianttype = wxT("datetime"),
- wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE );
+ virtual void SelectAll();
+ virtual void UnselectAll();
- bool SetValue( const wxVariant &value );
+ virtual void EnsureVisible( const wxDataViewItem & item,
+ const wxDataViewColumn *column = NULL );
+ virtual void HitTest( const wxPoint & point, wxDataViewItem & item,
+ wxDataViewColumn* &column ) const;
+ virtual wxRect GetItemRect( const wxDataViewItem & item,
+ const wxDataViewColumn *column = NULL ) const;
- virtual bool Render( wxRect cell, wxDC *dc, int state );
- virtual wxSize GetSize();
- virtual bool Activate( wxRect cell,
- wxDataViewListModel *model, unsigned int col, unsigned int row );
+ virtual bool SetRowHeight( int rowHeight );
-private:
- wxDateTime m_date;
+ virtual void Expand( const wxDataViewItem & item );
+ virtual void Collapse( const wxDataViewItem & item );
+ virtual bool IsExpanded( const wxDataViewItem & item ) const;
-protected:
- DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewDateRenderer)
-};
+ virtual void SetFocus();
-// ---------------------------------------------------------
-// wxDataViewColumn
-// ---------------------------------------------------------
+#if wxUSE_DRAG_AND_DROP
+ virtual bool EnableDragSource( const wxDataFormat &format );
+ virtual bool EnableDropTarget( const wxDataFormat &format );
+#endif // wxUSE_DRAG_AND_DROP
-class WXDLLIMPEXP_ADV wxDataViewColumn: public wxDataViewColumnBase
-{
- friend class wxDataViewHeaderWindowBase;
- friend class wxDataViewHeaderWindow;
- friend class wxDataViewHeaderWindowMSW;
+ virtual wxBorder GetDefaultBorder() const;
-public:
- wxDataViewColumn( const wxString &title, wxDataViewRenderer *renderer,
- unsigned int model_column, int width = wxDVC_DEFAULT_WIDTH,
- wxAlignment align = wxALIGN_CENTER,
- int flags = wxDATAVIEW_COL_RESIZABLE );
- wxDataViewColumn( const wxBitmap &bitmap, wxDataViewRenderer *renderer,
- unsigned int model_column, int width = wxDVC_DEFAULT_WIDTH,
- wxAlignment align = wxALIGN_CENTER,
- int flags = wxDATAVIEW_COL_RESIZABLE );
- virtual ~wxDataViewColumn();
-
- virtual void SetTitle( const wxString &title );
- virtual void SetBitmap( const wxBitmap &bitmap );
-
- virtual void SetAlignment( wxAlignment align )
- { m_align=align; }
- wxAlignment GetAlignment() const
- { return m_align; }
-
- virtual void SetSortable( bool sortable );
- virtual void SetSortOrder( bool ascending );
- virtual bool IsSortOrderAscending() const;
+ virtual void EditItem(const wxDataViewItem& item, const wxDataViewColumn *column);
- virtual int GetWidth() const;
+ // These methods are specific to generic wxDataViewCtrl implementation and
+ // should not be used in portable code.
+ wxColour GetAlternateRowColour() const { return m_alternateRowColour; }
+ void SetAlternateRowColour(const wxColour& colour);
protected:
+ virtual void EnsureVisible( int row, int column );
- void SetWidth(int w)
- { m_width=w; }
+ // Notice that row here may be invalid (i.e. >= GetRowCount()), this is not
+ // an error and this function simply returns an invalid item in this case.
+ virtual wxDataViewItem GetItemByRow( unsigned int row ) const;
+ virtual int GetRowByItem( const wxDataViewItem & item ) const;
-private:
- int m_width;
- int m_fixedWidth;
- wxAlignment m_align;
+ int GetSortingColumnIndex() const { return m_sortingColumnIdx; }
+ void SetSortingColumnIndex(int idx) { m_sortingColumnIdx = idx; }
- void Init(int width);
+public: // utility functions not part of the API
-protected:
- DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewColumn)
-};
-
-// ---------------------------------------------------------
-// wxDataViewCtrl
-// ---------------------------------------------------------
+ // returns the "best" width for the idx-th column
+ unsigned int GetBestColumnWidth(int idx) const;
-class WXDLLIMPEXP_ADV wxDataViewCtrl: public wxDataViewCtrlBase,
- public wxScrollHelperNative
-{
- friend class wxDataViewMainWindow;
- friend class wxDataViewHeaderWindowBase;
- friend class wxDataViewHeaderWindow;
- friend class wxDataViewHeaderWindowMSW;
+ // called by header window after reorder
+ void ColumnMoved( wxDataViewColumn* col, unsigned int new_pos );
-public:
- wxDataViewCtrl() : wxScrollHelperNative(this)
- {
- Init();
- }
+ // update the display after a change to an individual column
+ void OnColumnChange(unsigned int idx);
- wxDataViewCtrl( wxWindow *parent, wxWindowID id,
- const wxPoint& pos = wxDefaultPosition,
- const wxSize& size = wxDefaultSize, long style = 0,
- const wxValidator& validator = wxDefaultValidator )
- : wxScrollHelperNative(this)
- {
- Create(parent, id, pos, size, style, validator );
- }
+ // update after a change to the number of columns
+ void OnColumnsCountChanged();
- virtual ~wxDataViewCtrl();
+ wxWindow *GetMainWindow() { return (wxWindow*) m_clientArea; }
- void Init();
+ // return the index of the given column in m_cols
+ int GetColumnIndex(const wxDataViewColumn *column) const;
- bool Create(wxWindow *parent, wxWindowID id,
- const wxPoint& pos = wxDefaultPosition,
- const wxSize& size = wxDefaultSize, long style = 0,
- const wxValidator& validator = wxDefaultValidator );
+ // return the column displayed at the given position in the control
+ wxDataViewColumn *GetColumnAt(unsigned int pos) const;
- virtual bool AssociateModel( wxDataViewListModel *model );
- virtual bool AppendColumn( wxDataViewColumn *col );
+ virtual wxDataViewColumn *GetCurrentColumn() const;
- virtual void SetSelection( int row ); // -1 for unselect
- virtual void SetSelectionRange( unsigned int from, unsigned int to );
- virtual void SetSelections( const wxArrayInt& aSelections);
- virtual void Unselect( unsigned int row );
-
- virtual bool IsSelected( unsigned int row ) const;
- virtual int GetSelection() const;
- virtual int GetSelections(wxArrayInt& aSelections) const;
+ virtual void OnInternalIdle();
- // returns the "best" width for the idx-th column
- unsigned int GetBestColumnWidth(int WXUNUSED(idx))
- {
- return GetClientSize().GetWidth() / GetNumberOfColumns();
- }
+private:
+ virtual wxDataViewItem DoGetCurrentItem() const;
+ virtual void DoSetCurrentItem(const wxDataViewItem& item);
+ void InvalidateColBestWidths();
+ void InvalidateColBestWidth(int idx);
+ void UpdateColWidths();
-private:
- wxDataViewListModelNotifier *m_notifier;
- wxDataViewMainWindow *m_clientArea;
- wxDataViewHeaderWindow *m_headerArea;
+ wxDataViewColumnList m_cols;
+ // cached column best widths information, values are for
+ // respective columns from m_cols and the arrays have same size
+ struct CachedColWidthInfo
+ {
+ CachedColWidthInfo() : width(0), dirty(true) {}
+ int width; // cached width or 0 if not computed
+ bool dirty; // column was invalidated, header needs updating
+ };
+ wxVector<CachedColWidthInfo> m_colsBestWidths;
+ // This indicates that at least one entry in m_colsBestWidths has 'dirty'
+ // flag set. It's cheaper to check one flag in OnInternalIdle() than to
+ // iterate over m_colsBestWidths to check if anything needs to be done.
+ bool m_colsDirty;
+
+ wxDataViewModelNotifier *m_notifier;
+ wxDataViewMainWindow *m_clientArea;
+ wxDataViewHeaderWindow *m_headerArea;
+
+ // user defined color to draw row lines, may be invalid
+ wxColour m_alternateRowColour;
+
+ // the index of the column currently used for sorting or -1
+ int m_sortingColumnIdx;
private:
void OnSize( wxSizeEvent &event );
+ virtual wxSize GetSizeAvailableForScrollTarget(const wxSize& size);
// we need to return a special WM_GETDLGCODE value to process just the
// arrows but let the other navigation characters through
private:
DECLARE_DYNAMIC_CLASS(wxDataViewCtrl)
- DECLARE_NO_COPY_CLASS(wxDataViewCtrl)
+ wxDECLARE_NO_COPY_CLASS(wxDataViewCtrl);
DECLARE_EVENT_TABLE()
};
projects / wxWidgets.git / blobdiff