+class WXDLLIMPEXP_FWD_ADV wxDataViewModel;
+class WXDLLIMPEXP_FWD_ADV wxDataViewCtrl;
+class WXDLLIMPEXP_FWD_ADV wxDataViewColumn;
+class WXDLLIMPEXP_FWD_ADV wxDataViewRenderer;
+class WXDLLIMPEXP_FWD_ADV wxDataViewModelNotifier;
+
+extern WXDLLIMPEXP_DATA_ADV(const char) wxDataViewCtrlNameStr[];
+
+// ----------------------------------------------------------------------------
+// wxDataViewCtrl flags
+// ----------------------------------------------------------------------------
+
+// size of a wxDataViewRenderer without contents:
+#define wxDVC_DEFAULT_RENDERER_SIZE 20
+
+// the default width of new (text) columns:
+#define wxDVC_DEFAULT_WIDTH 80
+
+// the default width of new toggle columns:
+#define wxDVC_TOGGLE_DEFAULT_WIDTH 30
+
+// the default minimal width of the columns:
+#define wxDVC_DEFAULT_MINWIDTH 30
+
+// The default alignment of wxDataViewRenderers is to take
+// the alignment from the column it owns.
+#define wxDVR_DEFAULT_ALIGNMENT -1
+
+
+// ---------------------------------------------------------
+// wxDataViewItem
+// ---------------------------------------------------------
+
+// Make it a class and not a typedef to allow forward declaring it.
+class wxDataViewItem : public wxItemId<void*>
+{
+public:
+ wxDataViewItem() : wxItemId<void*>() { }
+ wxEXPLICIT wxDataViewItem(void* pItem) : wxItemId<void*>(pItem) { }
+};
+
+WX_DEFINE_ARRAY(wxDataViewItem, wxDataViewItemArray);
+
+// ---------------------------------------------------------
+// wxDataViewModelNotifier
+// ---------------------------------------------------------
+
+class WXDLLIMPEXP_ADV wxDataViewModelNotifier
+{
+public:
+ wxDataViewModelNotifier() { m_owner = NULL; }
+ virtual ~wxDataViewModelNotifier() { m_owner = NULL; }
+
+ virtual bool ItemAdded( const wxDataViewItem &parent, const wxDataViewItem &item ) = 0;
+ virtual bool ItemDeleted( const wxDataViewItem &parent, const wxDataViewItem &item ) = 0;
+ virtual bool ItemChanged( const wxDataViewItem &item ) = 0;
+ virtual bool ItemsAdded( const wxDataViewItem &parent, const wxDataViewItemArray &items );
+ virtual bool ItemsDeleted( const wxDataViewItem &parent, const wxDataViewItemArray &items );
+ virtual bool ItemsChanged( const wxDataViewItemArray &items );
+ virtual bool ValueChanged( const wxDataViewItem &item, unsigned int col ) = 0;
+ virtual bool Cleared() = 0;
+
+ // some platforms, such as GTK+, may need a two step procedure for ::Reset()
+ virtual bool BeforeReset() { return true; }
+ virtual bool AfterReset() { return Cleared(); }
+
+ virtual void Resort() = 0;
+
+ void SetOwner( wxDataViewModel *owner ) { m_owner = owner; }
+ wxDataViewModel *GetOwner() const { return m_owner; }
+
+private:
+ wxDataViewModel *m_owner;
+};
+
+
+
+// ----------------------------------------------------------------------------
+// wxDataViewItemAttr: a structure containing the visual attributes of an item
+// ----------------------------------------------------------------------------
+
+// TODO: this should be renamed to wxItemAttr or something general like this
+
+class WXDLLIMPEXP_ADV wxDataViewItemAttr
+{
+public:
+ // ctors
+ wxDataViewItemAttr()
+ {
+ m_bold = false;
+ m_italic = false;
+ }
+
+ // setters
+ void SetColour(const wxColour& colour) { m_colour = colour; }
+ void SetBold( bool set ) { m_bold = set; }
+ void SetItalic( bool set ) { m_italic = set; }
+ void SetBackgroundColour(const wxColour& colour) { m_bgColour = colour; }
+
+ // accessors
+ bool HasColour() const { return m_colour.IsOk(); }
+ const wxColour& GetColour() const { return m_colour; }
+
+ bool HasFont() const { return m_bold || m_italic; }
+ bool GetBold() const { return m_bold; }
+ bool GetItalic() const { return m_italic; }
+
+ bool HasBackgroundColour() const { return m_bgColour.IsOk(); }
+ const wxColour& GetBackgroundColour() const { return m_bgColour; }
+
+ bool IsDefault() const { return !(HasColour() || HasFont() || HasBackgroundColour()); }
+
+ // Return the font based on the given one with this attribute applied to it.
+ wxFont GetEffectiveFont(const wxFont& font) const;
+
+private:
+ wxColour m_colour;
+ bool m_bold;
+ bool m_italic;
+ wxColour m_bgColour;
+};
+
+
+// ---------------------------------------------------------
+// wxDataViewModel
+// ---------------------------------------------------------
+
+WX_DECLARE_LIST_WITH_DECL(wxDataViewModelNotifier, wxDataViewModelNotifiers,
+ class WXDLLIMPEXP_ADV);
+
+class WXDLLIMPEXP_ADV wxDataViewModel: public wxRefCounter
+{
+public:
+ wxDataViewModel();
+
+ virtual unsigned int GetColumnCount() const = 0;
+
+ // return type as reported by wxVariant
+ virtual wxString GetColumnType( unsigned int col ) const = 0;
+
+ // get value into a wxVariant
+ virtual void GetValue( wxVariant &variant,
+ const wxDataViewItem &item, unsigned int col ) const = 0;
+
+ // return true if the given item has a value to display in the given
+ // column: this is always true except for container items which by default
+ // only show their label in the first column (but see HasContainerColumns())
+ bool HasValue(const wxDataViewItem& item, unsigned col) const
+ {
+ return col == 0 || !IsContainer(item) || HasContainerColumns(item);
+ }
+
+ // usually ValueChanged() should be called after changing the value in the
+ // model to update the control, ChangeValue() does it on its own while
+ // SetValue() does not -- so while you will override SetValue(), you should
+ // be usually calling ChangeValue()
+ virtual bool SetValue(const wxVariant &variant,
+ const wxDataViewItem &item,
+ unsigned int col) = 0;
+
+ bool ChangeValue(const wxVariant& variant,
+ const wxDataViewItem& item,
+ unsigned int col)
+ {
+ return SetValue(variant, item, col) && ValueChanged(item, col);
+ }
+
+ // Get text attribute, return false of default attributes should be used
+ virtual bool GetAttr(const wxDataViewItem &WXUNUSED(item),
+ unsigned int WXUNUSED(col),
+ wxDataViewItemAttr &WXUNUSED(attr)) const
+ {
+ return false;
+ }
+
+ // Override this if you want to disable specific items
+ virtual bool IsEnabled(const wxDataViewItem &WXUNUSED(item),
+ unsigned int WXUNUSED(col)) const
+ {
+ return true;
+ }
+
+ // define hierachy
+ virtual wxDataViewItem GetParent( const wxDataViewItem &item ) const = 0;
+ virtual bool IsContainer( const wxDataViewItem &item ) const = 0;
+ // Is the container just a header or an item with all columns
+ virtual bool HasContainerColumns(const wxDataViewItem& WXUNUSED(item)) const
+ { return false; }
+ virtual unsigned int GetChildren( const wxDataViewItem &item, wxDataViewItemArray &children ) const = 0;
+
+ // delegated notifiers
+ bool ItemAdded( const wxDataViewItem &parent, const wxDataViewItem &item );
+ bool ItemsAdded( const wxDataViewItem &parent, const wxDataViewItemArray &items );
+ bool ItemDeleted( const wxDataViewItem &parent, const wxDataViewItem &item );
+ bool ItemsDeleted( const wxDataViewItem &parent, const wxDataViewItemArray &items );
+ bool ItemChanged( const wxDataViewItem &item );
+ bool ItemsChanged( const wxDataViewItemArray &items );
+ bool ValueChanged( const wxDataViewItem &item, unsigned int col );
+ bool Cleared();
+
+ // some platforms, such as GTK+, may need a two step procedure for ::Reset()
+ bool BeforeReset();
+ bool AfterReset();
+
+
+ // delegated action
+ virtual void Resort();
+
+ void AddNotifier( wxDataViewModelNotifier *notifier );
+ void RemoveNotifier( wxDataViewModelNotifier *notifier );
+
+ // default compare function
+ virtual int Compare( const wxDataViewItem &item1, const wxDataViewItem &item2,
+ unsigned int column, bool ascending ) const;
+ virtual bool HasDefaultCompare() const { return false; }
+
+ // internal
+ virtual bool IsListModel() const { return false; }
+ virtual bool IsVirtualListModel() const { return false; }
+
+protected:
+ // the user should not delete this class directly: he should use DecRef() instead!
+ virtual ~wxDataViewModel() { }
+
+ wxDataViewModelNotifiers m_notifiers;
+};
+
+// ----------------------------------------------------------------------------
+// wxDataViewListModel: a model of a list, i.e. flat data structure without any
+// branches/containers, used as base class by wxDataViewIndexListModel and
+// wxDataViewVirtualListModel
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_ADV wxDataViewListModel : public wxDataViewModel
+{
+public:
+ // derived classes should override these methods instead of
+ // {Get,Set}Value() and GetAttr() inherited from the base class
+
+ virtual void GetValueByRow(wxVariant &variant,
+ unsigned row, unsigned col) const = 0;
+
+ virtual bool SetValueByRow(const wxVariant &variant,
+ unsigned row, unsigned col) = 0;
+
+ virtual bool
+ GetAttrByRow(unsigned WXUNUSED(row), unsigned WXUNUSED(col),
+ wxDataViewItemAttr &WXUNUSED(attr)) const
+ {
+ return false;
+ }
+
+ virtual bool IsEnabledByRow(unsigned int WXUNUSED(row),
+ unsigned int WXUNUSED(col)) const
+ {
+ return true;
+ }
+
+
+ // helper methods provided by list models only
+ virtual unsigned GetRow( const wxDataViewItem &item ) const = 0;
+
+ // returns the number of rows
+ virtual unsigned int GetCount() const = 0;
+
+ // implement some base class pure virtual directly
+ virtual wxDataViewItem
+ GetParent( const wxDataViewItem & WXUNUSED(item) ) const
+ {
+ // items never have valid parent in this model
+ return wxDataViewItem();
+ }
+
+ virtual bool IsContainer( const wxDataViewItem &item ) const
+ {
+ // only the invisible (and invalid) root item has children
+ return !item.IsOk();
+ }
+
+ // and implement some others by forwarding them to our own ones
+ virtual void GetValue( wxVariant &variant,
+ const wxDataViewItem &item, unsigned int col ) const
+ {
+ GetValueByRow(variant, GetRow(item), col);
+ }
+
+ virtual bool SetValue( const wxVariant &variant,
+ const wxDataViewItem &item, unsigned int col )
+ {
+ return SetValueByRow( variant, GetRow(item), col );
+ }
+
+ virtual bool GetAttr(const wxDataViewItem &item, unsigned int col,
+ wxDataViewItemAttr &attr) const
+ {
+ return GetAttrByRow( GetRow(item), col, attr );
+ }
+
+ virtual bool IsEnabled(const wxDataViewItem &item, unsigned int col) const
+ {
+ return IsEnabledByRow( GetRow(item), col );
+ }
+
+
+ virtual bool IsListModel() const { return true; }
+};
+
+// ---------------------------------------------------------
+// wxDataViewIndexListModel
+// ---------------------------------------------------------
+
+class WXDLLIMPEXP_ADV wxDataViewIndexListModel: public wxDataViewListModel
+{
+public:
+ wxDataViewIndexListModel( unsigned int initial_size = 0 );
+
+ void RowPrepended();
+ void RowInserted( unsigned int before );
+ void RowAppended();
+ void RowDeleted( unsigned int row );
+ void RowsDeleted( const wxArrayInt &rows );
+ void RowChanged( unsigned int row );
+ void RowValueChanged( unsigned int row, unsigned int col );
+ void Reset( unsigned int new_size );
+
+ // convert to/from row/wxDataViewItem
+
+ virtual unsigned GetRow( const wxDataViewItem &item ) const;
+ wxDataViewItem GetItem( unsigned int row ) const;
+
+ // compare based on index
+
+ virtual int Compare( const wxDataViewItem &item1, const wxDataViewItem &item2,
+ unsigned int column, bool ascending ) const;
+ virtual bool HasDefaultCompare() const;
+
+ // implement base methods
+ virtual unsigned int GetChildren( const wxDataViewItem &item, wxDataViewItemArray &children ) const;
+
+ unsigned int GetCount() const { return m_hash.GetCount(); }
+
+private:
+ wxDataViewItemArray m_hash;
+ unsigned int m_nextFreeID;
+ bool m_ordered;
+};
+
+// ---------------------------------------------------------
+// wxDataViewVirtualListModel
+// ---------------------------------------------------------
+
+#ifdef __WXMAC__
+// better than nothing
+typedef wxDataViewIndexListModel wxDataViewVirtualListModel;
+#else
+
+class WXDLLIMPEXP_ADV wxDataViewVirtualListModel: public wxDataViewListModel
+{
+public:
+ wxDataViewVirtualListModel( unsigned int initial_size = 0 );
+
+ void RowPrepended();
+ void RowInserted( unsigned int before );
+ void RowAppended();
+ void RowDeleted( unsigned int row );
+ void RowsDeleted( const wxArrayInt &rows );
+ void RowChanged( unsigned int row );
+ void RowValueChanged( unsigned int row, unsigned int col );
+ void Reset( unsigned int new_size );
+
+ // convert to/from row/wxDataViewItem
+
+ virtual unsigned GetRow( const wxDataViewItem &item ) const;
+ wxDataViewItem GetItem( unsigned int row ) const;
+
+ // compare based on index
+
+ virtual int Compare( const wxDataViewItem &item1, const wxDataViewItem &item2,
+ unsigned int column, bool ascending ) const;
+ virtual bool HasDefaultCompare() const;
+
+ // implement base methods
+ virtual unsigned int GetChildren( const wxDataViewItem &item, wxDataViewItemArray &children ) const;
+
+ unsigned int GetCount() const { return m_size; }
+
+ // internal
+ virtual bool IsVirtualListModel() const { return true; }
+
+private:
+ unsigned int m_size;
+ bool m_ordered;
+};
+#endif
+
+// ----------------------------------------------------------------------------
+// wxDataViewRenderer and related classes
+// ----------------------------------------------------------------------------
+
+#include "wx/dvrenderers.h"
+
+// ---------------------------------------------------------
+// wxDataViewColumnBase
+// ---------------------------------------------------------
+
+// for compatibility only, do not use
+enum wxDataViewColumnFlags
+{
+ wxDATAVIEW_COL_RESIZABLE = wxCOL_RESIZABLE,
+ wxDATAVIEW_COL_SORTABLE = wxCOL_SORTABLE,
+ wxDATAVIEW_COL_REORDERABLE = wxCOL_REORDERABLE,
+ wxDATAVIEW_COL_HIDDEN = wxCOL_HIDDEN
+};
+
+class WXDLLIMPEXP_ADV wxDataViewColumnBase : public wxSettableHeaderColumn
+{
+public:
+ // ctor for the text columns: takes ownership of renderer
+ wxDataViewColumnBase(wxDataViewRenderer *renderer,
+ unsigned int model_column)
+ {
+ Init(renderer, model_column);
+ }
+
+ // ctor for the bitmap columns
+ wxDataViewColumnBase(const wxBitmap& bitmap,
+ wxDataViewRenderer *renderer,
+ unsigned int model_column)
+ : m_bitmap(bitmap)
+ {
+ Init(renderer, model_column);
+ }
+
+ virtual ~wxDataViewColumnBase();
+
+ // setters:
+ virtual void SetOwner( wxDataViewCtrl *owner )
+ { m_owner = owner; }
+
+ // getters:
+ unsigned int GetModelColumn() const { return static_cast<unsigned int>(m_model_column); }
+ wxDataViewCtrl *GetOwner() const { return m_owner; }
+ wxDataViewRenderer* GetRenderer() const { return m_renderer; }
+
+ // implement some of base class pure virtuals (the rest is port-dependent
+ // and done differently in generic and native versions)
+ virtual void SetBitmap( const wxBitmap& bitmap ) { m_bitmap = bitmap; }
+ virtual wxBitmap GetBitmap() const { return m_bitmap; }
+
+protected:
+ wxDataViewRenderer *m_renderer;
+ int m_model_column;
+ wxBitmap m_bitmap;
+ wxDataViewCtrl *m_owner;
+
+private:
+ // common part of all ctors
+ void Init(wxDataViewRenderer *renderer, unsigned int model_column);
+};
+
+// ---------------------------------------------------------
+// wxDataViewCtrlBase
+// ---------------------------------------------------------
+
+#define wxDV_SINGLE 0x0000 // for convenience
+#define wxDV_MULTIPLE 0x0001 // can select multiple items
+
+#define wxDV_NO_HEADER 0x0002 // column titles not visible
+#define wxDV_HORIZ_RULES 0x0004 // light horizontal rules between rows
+#define wxDV_VERT_RULES 0x0008 // light vertical rules between columns
+
+#define wxDV_ROW_LINES 0x0010 // alternating colour in rows
+#define wxDV_VARIABLE_LINE_HEIGHT 0x0020 // variable line height
+
+class WXDLLIMPEXP_ADV wxDataViewCtrlBase: public wxControl
+{
+public:
+ wxDataViewCtrlBase();
+ virtual ~wxDataViewCtrlBase();
+
+ // model
+ // -----
+
+ virtual bool AssociateModel( wxDataViewModel *model );
+ wxDataViewModel* GetModel();
+ const wxDataViewModel* GetModel() const;
+
+
+ // column management
+ // -----------------
+
+ wxDataViewColumn *PrependTextColumn( const wxString &label, unsigned int model_column,
+ wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
+ wxAlignment align = wxALIGN_NOT,
+ int flags = wxDATAVIEW_COL_RESIZABLE );
+ wxDataViewColumn *PrependIconTextColumn( const wxString &label, unsigned int model_column,
+ wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
+ wxAlignment align = wxALIGN_NOT,
+ int flags = wxDATAVIEW_COL_RESIZABLE );
+ wxDataViewColumn *PrependToggleColumn( const wxString &label, unsigned int model_column,
+ wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_TOGGLE_DEFAULT_WIDTH,
+ wxAlignment align = wxALIGN_CENTER,
+ int flags = wxDATAVIEW_COL_RESIZABLE );
+ wxDataViewColumn *PrependProgressColumn( const wxString &label, unsigned int model_column,
+ wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_DEFAULT_WIDTH,
+ wxAlignment align = wxALIGN_CENTER,
+ int flags = wxDATAVIEW_COL_RESIZABLE );
+ wxDataViewColumn *PrependDateColumn( const wxString &label, unsigned int model_column,
+ wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE, int width = -1,
+ wxAlignment align = wxALIGN_NOT,
+ int flags = wxDATAVIEW_COL_RESIZABLE );
+ wxDataViewColumn *PrependBitmapColumn( const wxString &label, unsigned int model_column,
+ wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
+ wxAlignment align = wxALIGN_CENTER,
+ int flags = wxDATAVIEW_COL_RESIZABLE );
+ wxDataViewColumn *PrependTextColumn( const wxBitmap &label, unsigned int model_column,
+ wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
+ wxAlignment align = wxALIGN_NOT,
+ int flags = wxDATAVIEW_COL_RESIZABLE );
+ wxDataViewColumn *PrependIconTextColumn( const wxBitmap &label, unsigned int model_column,
+ wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
+ wxAlignment align = wxALIGN_NOT,
+ int flags = wxDATAVIEW_COL_RESIZABLE );
+ wxDataViewColumn *PrependToggleColumn( const wxBitmap &label, unsigned int model_column,
+ wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_TOGGLE_DEFAULT_WIDTH,
+ wxAlignment align = wxALIGN_CENTER,
+ int flags = wxDATAVIEW_COL_RESIZABLE );
+ wxDataViewColumn *PrependProgressColumn( const wxBitmap &label, unsigned int model_column,
+ wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_DEFAULT_WIDTH,
+ wxAlignment align = wxALIGN_CENTER,
+ int flags = wxDATAVIEW_COL_RESIZABLE );
+ wxDataViewColumn *PrependDateColumn( const wxBitmap &label, unsigned int model_column,
+ wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE, int width = -1,
+ wxAlignment align = wxALIGN_NOT,
+ int flags = wxDATAVIEW_COL_RESIZABLE );
+ wxDataViewColumn *PrependBitmapColumn( const wxBitmap &label, unsigned int model_column,
+ wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
+ wxAlignment align = wxALIGN_CENTER,
+ int flags = wxDATAVIEW_COL_RESIZABLE );
projects / wxWidgets.git / blobdiff