// 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/list.h"
#include "wx/control.h"
#include "wx/scrolwin.h"
+#include "wx/icon.h"
-// ---------------------------------------------------------
+// ---------------------------------------------------------
// classes
-// ---------------------------------------------------------
+// ---------------------------------------------------------
-class WXDLLIMPEXP_CORE wxDataViewCtrl;
-class WXDLLIMPEXP_CORE wxDataViewMainWindow;
-class WXDLLIMPEXP_CORE wxDataViewHeaderWindow;
+class WXDLLIMPEXP_FWD_ADV wxDataViewCtrl;
+class WXDLLIMPEXP_FWD_ADV wxDataViewMainWindow;
+class WXDLLIMPEXP_FWD_ADV wxDataViewHeaderWindow;
-// ---------------------------------------------------------
-// wxDataViewCell
-// ---------------------------------------------------------
+// ---------------------------------------------------------
+// wxDataViewRenderer
+// ---------------------------------------------------------
-class wxDataViewCell: public wxDataViewCellBase
+class WXDLLIMPEXP_ADV wxDataViewRenderer: public wxDataViewRendererBase
{
public:
- wxDataViewCell( const wxString &varianttype, wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
+ wxDataViewRenderer( const wxString &varianttype,
+ wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
+ int align = wxDVR_DEFAULT_ALIGNMENT );
+ virtual ~wxDataViewRenderer();
+
+ virtual bool Render( wxRect cell, wxDC *dc, int state ) = 0;
+ virtual wxSize GetSize() const = 0;
+
+ virtual void SetAlignment( int align );
+ virtual int GetAlignment() const;
+
+ virtual void SetMode( wxDataViewCellMode mode )
+ { m_mode=mode; }
+ virtual wxDataViewCellMode GetMode() const
+ { return m_mode; }
+
+ virtual bool Activate( wxRect WXUNUSED(cell),
+ wxDataViewModel *WXUNUSED(model),
+ const wxDataViewItem & WXUNUSED(item),
+ unsigned int WXUNUSED(col) )
+ { return false; }
+
+ virtual bool LeftClick( wxPoint WXUNUSED(cursor),
+ wxRect WXUNUSED(cell),
+ wxDataViewModel *WXUNUSED(model),
+ const wxDataViewItem & WXUNUSED(item),
+ unsigned int WXUNUSED(col) )
+ { return false; }
+ virtual bool RightClick( wxPoint WXUNUSED(cursor),
+ wxRect WXUNUSED(cell),
+ wxDataViewModel *WXUNUSED(model),
+ const wxDataViewItem & WXUNUSED(item),
+ unsigned int WXUNUSED(col) )
+ { return false; }
+ virtual bool StartDrag( wxPoint WXUNUSED(cursor),
+ wxRect WXUNUSED(cell),
+ wxDataViewModel *WXUNUSED(model),
+ const wxDataViewItem & WXUNUSED(item),
+ unsigned int WXUNUSED(col) )
+ { return false; }
+
+ // Create DC on request
+ virtual wxDC *GetDC();
+
+ void SetHasAttr( bool set ) { m_hasAttr = set; }
+ void SetAttr( const wxDataViewItemAttr &attr ) { m_attr = attr; }
+ bool GetWantsAttr() { return m_wantsAttr; }
+
+ // implementation
+ int CalculateAlignment() const;
+
+private:
+ wxDC *m_dc;
+ int m_align;
+ wxDataViewCellMode m_mode;
+
+protected:
+ bool m_wantsAttr;
+ bool m_hasAttr;
+ wxDataViewItemAttr m_attr;
+
+protected:
+ DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRenderer)
+};
+
+// ---------------------------------------------------------
+// wxDataViewCustomRenderer
+// ---------------------------------------------------------
+
+class WXDLLIMPEXP_ADV wxDataViewCustomRenderer: public wxDataViewRenderer
+{
+public:
+ wxDataViewCustomRenderer( const wxString &varianttype = wxT("string"),
+ wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
+ int align = wxDVR_DEFAULT_ALIGNMENT );
+
+ void RenderText( const wxString &text, int xoffset, wxRect cell, wxDC *dc, int state );
protected:
- DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCell)
+ DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCustomRenderer)
};
-
-// ---------------------------------------------------------
-// wxDataViewTextCell
-// ---------------------------------------------------------
-class wxDataViewTextCell: public wxDataViewCell
+
+// ---------------------------------------------------------
+// wxDataViewTextRenderer
+// ---------------------------------------------------------
+
+class WXDLLIMPEXP_ADV wxDataViewTextRenderer: public wxDataViewCustomRenderer
{
public:
- wxDataViewTextCell( const wxString &varianttype = wxT("string"),
- wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
+ wxDataViewTextRenderer( const wxString &varianttype = wxT("string"),
+ wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
+ int align = wxDVR_DEFAULT_ALIGNMENT );
bool SetValue( const wxVariant &value );
- bool GetValue( wxVariant &value );
-
+ bool GetValue( wxVariant &value ) const;
+
+ bool Render( wxRect cell, wxDC *dc, int state );
+ wxSize GetSize() const;
+
+ // in-place editing
+ virtual bool HasEditorCtrl();
+ virtual wxControl* CreateEditorCtrl( wxWindow *parent, wxRect labelRect, const wxVariant &value );
+ virtual bool GetValueFromEditorCtrl( wxControl* editor, wxVariant &value );
+
+protected:
+ wxString m_text;
+
protected:
- DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewTextCell)
+ DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewTextRenderer)
};
-
-// ---------------------------------------------------------
-// wxDataViewToggleCell
-// ---------------------------------------------------------
-class wxDataViewToggleCell: public wxDataViewCell
+// ---------------------------------------------------------
+// wxDataViewTextRendererAttr
+// ---------------------------------------------------------
+
+class WXDLLIMPEXP_ADV wxDataViewTextRendererAttr: public wxDataViewTextRenderer
{
public:
- wxDataViewToggleCell( const wxString &varianttype = wxT("bool"),
- wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
+ wxDataViewTextRendererAttr( const wxString &varianttype = wxT("string"),
+ wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
+ int align = wxDVR_DEFAULT_ALIGNMENT );
+
+ bool Render( wxRect cell, wxDC *dc, int state );
+
+protected:
+ DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewTextRendererAttr)
+};
+
+// ---------------------------------------------------------
+// wxDataViewBitmapRenderer
+// ---------------------------------------------------------
+
+class WXDLLIMPEXP_ADV wxDataViewBitmapRenderer: public wxDataViewCustomRenderer
+{
+public:
+ wxDataViewBitmapRenderer( const wxString &varianttype = wxT("wxBitmap"),
+ wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
+ int align = wxDVR_DEFAULT_ALIGNMENT );
bool SetValue( const wxVariant &value );
- bool GetValue( wxVariant &value );
-
+ bool GetValue( wxVariant &value ) const;
+
+ bool Render( wxRect cell, wxDC *dc, int state );
+ wxSize GetSize() const;
+
+private:
+ wxIcon m_icon;
+ wxBitmap m_bitmap;
+
protected:
- DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewToggleCell)
+ DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewBitmapRenderer)
};
-
-// ---------------------------------------------------------
-// wxDataViewCustomCell
-// ---------------------------------------------------------
-class wxDataViewCustomCell: public wxDataViewCell
+// ---------------------------------------------------------
+// wxDataViewToggleRenderer
+// ---------------------------------------------------------
+
+class WXDLLIMPEXP_ADV wxDataViewToggleRenderer: public wxDataViewCustomRenderer
{
public:
- wxDataViewCustomCell( const wxString &varianttype = wxT("string"),
- wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
- ~wxDataViewCustomCell();
- bool Init();
-
- virtual bool Render( wxRect cell, wxDC *dc, int state ) = 0;
- virtual wxSize GetSize() = 0;
-
- virtual bool Activate( wxRect cell,
- wxDataViewListModel *model, size_t col, size_t row )
- { return false; }
-
- virtual bool LeftClick( wxPoint cursor, wxRect cell,
- wxDataViewListModel *model, size_t col, size_t row )
- { return false; }
- virtual bool RightClick( wxPoint cursor, wxRect cell,
- wxDataViewListModel *model, size_t col, size_t row )
- { return false; }
- virtual bool StartDrag( wxPoint cursor, wxRect cell,
- wxDataViewListModel *model, size_t col, size_t row )
- { return false; }
-
- // Create DC on request
- virtual wxDC *GetDC();
-
+ wxDataViewToggleRenderer( const wxString &varianttype = wxT("bool"),
+ wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
+ int align = wxDVR_DEFAULT_ALIGNMENT );
+
+ bool SetValue( const wxVariant &value );
+ bool GetValue( wxVariant &value ) const;
+
+ bool Render( wxRect cell, wxDC *dc, int state );
+ bool Activate( wxRect cell, wxDataViewModel *model, const wxDataViewItem & item,
+ unsigned int col );
+ wxSize GetSize() const;
+
private:
- wxDC *m_dc;
-
+ bool m_toggle;
+
protected:
- DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCustomCell)
+ DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewToggleRenderer)
};
-
-// ---------------------------------------------------------
-// wxDataViewProgressCell
-// ---------------------------------------------------------
-class wxDataViewProgressCell: public wxDataViewCustomCell
+// ---------------------------------------------------------
+// wxDataViewProgressRenderer
+// ---------------------------------------------------------
+
+class WXDLLIMPEXP_ADV wxDataViewProgressRenderer: public wxDataViewCustomRenderer
{
public:
- wxDataViewProgressCell( const wxString &label = wxEmptyString,
- const wxString &varianttype = wxT("long"),
- wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
- ~wxDataViewProgressCell();
-
+ wxDataViewProgressRenderer( const wxString &label = wxEmptyString,
+ const wxString &varianttype = wxT("long"),
+ wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
+ int align = wxDVR_DEFAULT_ALIGNMENT );
+ virtual ~wxDataViewProgressRenderer();
+
bool SetValue( const wxVariant &value );
-
+ bool GetValue( wxVariant& value ) const;
+
virtual bool Render( wxRect cell, wxDC *dc, int state );
- virtual wxSize GetSize();
-
+ virtual wxSize GetSize() const;
+
private:
wxString m_label;
int m_value;
-
+
protected:
- DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewProgressCell)
+ DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewProgressRenderer)
};
-
-// ---------------------------------------------------------
-// wxDataViewDateCell
-// ---------------------------------------------------------
-class wxDataViewDateCell: public wxDataViewCustomCell
+// ---------------------------------------------------------
+// wxDataViewIconTextRenderer
+// ---------------------------------------------------------
+
+class WXDLLIMPEXP_ADV wxDataViewIconTextRenderer: public wxDataViewCustomRenderer
{
public:
- wxDataViewDateCell( const wxString &varianttype = wxT("datetime"),
- wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE );
-
+ wxDataViewIconTextRenderer( const wxString &varianttype = wxT("wxDataViewIconText"),
+ wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
+ int align = wxDVR_DEFAULT_ALIGNMENT );
+ virtual ~wxDataViewIconTextRenderer();
+
bool SetValue( const wxVariant &value );
-
+ bool GetValue( wxVariant &value ) const;
+
virtual bool Render( wxRect cell, wxDC *dc, int state );
- virtual wxSize GetSize();
+ virtual wxSize GetSize() const;
+
+ virtual bool HasEditorCtrl() { return true; }
+ virtual wxControl* CreateEditorCtrl( wxWindow *parent, wxRect labelRect, const wxVariant &value );
+ virtual bool GetValueFromEditorCtrl( wxControl* editor, wxVariant &value );
+
+private:
+ wxDataViewIconText m_value;
+
+protected:
+ DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewIconTextRenderer)
+};
+
+// ---------------------------------------------------------
+// wxDataViewDateRenderer
+// ---------------------------------------------------------
+
+class WXDLLIMPEXP_ADV wxDataViewDateRenderer: public wxDataViewCustomRenderer
+{
+public:
+ wxDataViewDateRenderer( const wxString &varianttype = wxT("datetime"),
+ wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE,
+ int align = wxDVR_DEFAULT_ALIGNMENT );
+
+ bool SetValue( const wxVariant &value );
+ bool GetValue( wxVariant& value ) const;
+
+ virtual bool Render( wxRect cell, wxDC *dc, int state );
+ virtual wxSize GetSize() const;
virtual bool Activate( wxRect cell,
- wxDataViewListModel *model, size_t col, size_t row );
-
+ wxDataViewModel *model, const wxDataViewItem & item, unsigned int col );
+
private:
wxDateTime m_date;
-
+
protected:
- DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewDateCell)
+ DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewDateRenderer)
};
-
-// ---------------------------------------------------------
+
+// ---------------------------------------------------------
// wxDataViewColumn
-// ---------------------------------------------------------
+// ---------------------------------------------------------
-class WXDLLIMPEXP_CORE wxDataViewColumn: public wxDataViewColumnBase
+class WXDLLIMPEXP_ADV wxDataViewColumn : public wxDataViewColumnBase
{
public:
- wxDataViewColumn( const wxString &title, wxDataViewCell *cell, size_t model_column, int flags = 0 );
- virtual ~wxDataViewColumn();
-
- virtual void SetTitle( const wxString &title );
-
- void SetWidth( int width ) { m_width = width; }
- int GetWidth() { return m_width; }
-
+ 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);
+ }
+
+ 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);
+ }
+
+ // implement wxHeaderColumnBase methods
+ virtual void SetTitle(const wxString& title) { m_title = title; }
+ virtual wxString GetTitle() const { return m_title; }
+
+ virtual void SetWidth(int width) { m_width = width; }
+ virtual int GetWidth() const { return m_width; }
+
+ virtual void SetMinWidth(int minWidth) { m_minWidth = minWidth; }
+ virtual int GetMinWidth() const { return m_minWidth; }
+
+ virtual void SetAlignment(wxAlignment align) { m_align = align; }
+ virtual wxAlignment GetAlignment() const { return m_align; }
+
+ virtual void SetFlags(int flags) { m_flags = flags; }
+ virtual int GetFlags() const { return m_flags; }
+
+ virtual void SetAsSortKey(bool sort = true) { m_sort = sort; }
+ virtual bool IsSortKey() const { return m_sort; }
+
+ virtual void SetSortOrder(bool ascending) { m_sortAscending = ascending; }
+ virtual bool IsSortOrderAscending() const { return m_sortAscending; }
+
private:
- int m_width;
+ // common part of all ctors
+ void Init(int width, wxAlignment align, int flags)
+ {
+ m_width = width == wxCOL_WIDTH_DEFAULT ? wxDVC_DEFAULT_WIDTH : width;
+ m_minWidth = 0;
+ m_align = align;
+ m_flags = flags;
+ m_sort = false;
+ m_sortAscending = true;
+ }
-protected:
- DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewColumn)
+ wxString m_title;
+ int m_width,
+ m_minWidth;
+ wxAlignment m_align;
+ int m_flags;
+ bool m_sort,
+ m_sortAscending;
+
+ friend class wxDataViewHeaderWindowBase;
+ friend class wxDataViewHeaderWindow;
+ friend class wxDataViewHeaderWindowMSW;
};
-// ---------------------------------------------------------
+// ---------------------------------------------------------
// wxDataViewCtrl
-// ---------------------------------------------------------
+// ---------------------------------------------------------
-class WXDLLIMPEXP_CORE wxDataViewCtrl: public wxDataViewCtrlBase,
+WX_DECLARE_LIST_WITH_DECL(wxDataViewColumn, wxDataViewColumnList,
+ class WXDLLIMPEXP_ADV);
+
+class WXDLLIMPEXP_ADV wxDataViewCtrl: public wxDataViewCtrlBase,
public wxScrollHelperNative
{
+ friend class wxDataViewMainWindow;
+ friend class wxDataViewHeaderWindowBase;
+ friend class wxDataViewHeaderWindow;
+ friend class wxDataViewHeaderWindowMSW;
+ friend class wxDataViewColumn;
+
public:
wxDataViewCtrl() : wxScrollHelperNative(this)
{
Init();
}
-
+
wxDataViewCtrl( wxWindow *parent, wxWindowID id,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize, long style = 0,
- const wxValidator& validator = wxDefaultValidator )
+ const wxValidator& validator = wxDefaultValidator )
: wxScrollHelperNative(this)
{
Create(parent, id, pos, size, style, validator );
const wxSize& size = wxDefaultSize, long style = 0,
const wxValidator& validator = wxDefaultValidator );
- virtual bool AssociateModel( wxDataViewListModel *model );
+ virtual bool AssociateModel( wxDataViewModel *model );
+
virtual bool AppendColumn( wxDataViewColumn *col );
-
+ virtual bool PrependColumn( wxDataViewColumn *col );
+ virtual bool InsertColumn( unsigned int pos, wxDataViewColumn *col );
+
+ virtual void DoSetExpanderColumn();
+ virtual void DoSetIndent();
+
+ 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;
+
+ virtual wxDataViewColumn *GetSortingColumn() const;
+
+ virtual wxDataViewItem GetSelection() 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;
+
+ virtual void SelectAll();
+ virtual void UnselectAll();
+
+ 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 void Expand( const wxDataViewItem & item );
+ virtual void Collapse( const wxDataViewItem & item );
+ virtual bool IsExpanded( const wxDataViewItem & item ) const;
+
+ virtual void SetFocus();
+
+protected:
+ virtual int GetSelections( wxArrayInt & sel ) const;
+ virtual void SetSelections( const wxArrayInt & sel );
+ virtual void Select( int row );
+ virtual void Unselect( int row );
+ virtual bool IsSelected( int row ) const;
+ virtual void SelectRange( int from, int to );
+ virtual void UnselectRange( int from, int to );
+
+ virtual void EnsureVisible( int row, int column );
+
+ virtual wxDataViewItem GetItemByRow( unsigned int row ) const;
+ virtual int GetRowByItem( const wxDataViewItem & item ) const;
+
+ int GetSortingColumnIndex() const { return m_sortingColumnIdx; }
+ void SetSortingColumnIndex(int idx) { m_sortingColumnIdx = idx; }
+
+public: // utility functions not part of the API
+
+ // returns the "best" width for the idx-th column
+ unsigned int GetBestColumnWidth(int WXUNUSED(idx)) const
+ {
+ return GetClientSize().GetWidth() / GetColumnCount();
+ }
+
+ // called by header window after reorder
+ void ColumnMoved( wxDataViewColumn* col, unsigned int new_pos );
+
+ // update the display after a change to an individual column
+ void OnColumnChange(unsigned int idx);
+
+ // update after a change to the number of columns
+ void OnColumnsCountChanged();
+
+ wxWindow *GetMainWindow() { return (wxWindow*) m_clientArea; }
+
+ // return the index of the given column in m_cols
+ int GetColumnIndex(const wxDataViewColumn *column) const;
+
+ // return the column displayed at the given position in the control
+ wxDataViewColumn *GetColumnAt(unsigned int pos) const;
+
private:
- friend class wxDataViewMainWindow;
- wxDataViewListModelNotifier *m_notifier;
- wxDataViewMainWindow *m_clientArea;
- wxDataViewHeaderWindow *m_headerArea;
-
+ wxDataViewColumnList m_cols;
+ wxDataViewModelNotifier *m_notifier;
+ wxDataViewMainWindow *m_clientArea;
+ wxDataViewHeaderWindow *m_headerArea;
+
+ // 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
#ifdef __WXMSW__
projects / wxWidgets.git / blobdiff