#include "wx/textctrl.h"
#include "wx/headercol.h"
#include "wx/variant.h"
+#include "wx/dnd.h" // For wxDragResult declaration only.
#include "wx/dynarray.h"
#include "wx/icon.h"
+#include "wx/itemid.h"
#include "wx/weakref.h"
#include "wx/vector.h"
#include "wx/dataobj.h"
+#include "wx/withimages.h"
class WXDLLIMPEXP_FWD_CORE wxImageList;
// wxDataViewCtrl globals
// ----------------------------------------------------------------------------
-class WXDLLIMPEXP_FWD_ADV wxDataViewItem;
class WXDLLIMPEXP_FWD_ADV wxDataViewModel;
class WXDLLIMPEXP_FWD_ADV wxDataViewCtrl;
class WXDLLIMPEXP_FWD_ADV wxDataViewColumn;
// wxDataViewItem
// ---------------------------------------------------------
-class WXDLLIMPEXP_ADV wxDataViewItem
+// Make it a class and not a typedef to allow forward declaring it.
+class wxDataViewItem : public wxItemId<void*>
{
public:
- wxDataViewItem( void* id = NULL )
- { m_id = id; }
- wxDataViewItem( const wxDataViewItem &item )
- { m_id = item.m_id; }
- bool IsOk() const { return m_id != NULL; }
- void* GetID() const { return m_id; }
- operator const void* () const { return m_id; }
-
-private:
- void* m_id;
+ wxDataViewItem() : wxItemId<void*>() { }
+ wxEXPLICIT wxDataViewItem(void* pItem) : wxItemId<void*>(pItem) { }
};
-inline
-bool operator==(const wxDataViewItem& left, const wxDataViewItem& right)
-{
- return left.GetID() == right.GetID();
-}
-
-inline
-bool operator!=(const wxDataViewItem& left, const wxDataViewItem& right)
-{
- return !(left == right);
-}
-
WX_DEFINE_ARRAY(wxDataViewItem, wxDataViewItemArray);
// ---------------------------------------------------------
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; }
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.Ok(); }
+ 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 IsDefault() const { return !(HasColour() || HasFont()); }
+ 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;
};
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;
virtual unsigned int GetChildren( const wxDataViewItem &item, wxDataViewItemArray &children ) const = 0;
// delegated notifiers
- virtual bool ItemAdded( const wxDataViewItem &parent, const wxDataViewItem &item );
- virtual bool ItemsAdded( const wxDataViewItem &parent, const wxDataViewItemArray &items );
- virtual bool ItemDeleted( const wxDataViewItem &parent, const wxDataViewItem &item );
- virtual bool ItemsDeleted( const wxDataViewItem &parent, const wxDataViewItemArray &items );
- virtual bool ItemChanged( const wxDataViewItem &item );
- virtual bool ItemsChanged( const wxDataViewItemArray &items );
- virtual bool ValueChanged( const wxDataViewItem &item, unsigned int col );
- virtual bool Cleared();
+ 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();
- // delegatd action
+ // 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 );
virtual bool HasDefaultCompare() const { return false; }
// internal
+ virtual bool IsListModel() const { return false; }
virtual bool IsVirtualListModel() const { return false; }
protected:
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
{
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; }
};
// ---------------------------------------------------------
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;
int GetIndent() const
{ return m_indent; }
- virtual wxDataViewItem GetSelection() const = 0;
+ // Current item is the one used by the keyboard navigation, it is the same
+ // as the (unique) selected item in single selection mode so these
+ // functions are mostly useful for controls with wxDV_MULTIPLE style.
+ wxDataViewItem GetCurrentItem() const;
+ void SetCurrentItem(const wxDataViewItem& item);
+
+ // Currently focused column of the current item or NULL if no column has focus
+ virtual wxDataViewColumn *GetCurrentColumn() const = 0;
+
+ // Selection: both GetSelection() and GetSelections() can be used for the
+ // controls both with and without wxDV_MULTIPLE style. For single selection
+ // controls GetSelections() is not very useful however. And for multi
+ // selection controls GetSelection() returns an invalid item if more than
+ // one item is selected. Use GetSelectedItemsCount() or HasSelection() to
+ // check if any items are selected at all.
+ virtual int GetSelectedItemsCount() const = 0;
+ bool HasSelection() const { return GetSelectedItemsCount() != 0; }
+ wxDataViewItem GetSelection() const;
virtual int GetSelections( wxDataViewItemArray & sel ) const = 0;
virtual void SetSelections( const wxDataViewItemArray & sel ) = 0;
virtual void Select( const wxDataViewItem & item ) = 0;
virtual void HitTest( const wxPoint & point, wxDataViewItem &item, wxDataViewColumn* &column ) const = 0;
virtual wxRect GetItemRect( const wxDataViewItem & item, const wxDataViewColumn *column = NULL ) const = 0;
+ virtual bool SetRowHeight( int WXUNUSED(rowHeight) ) { return false; }
+
+ virtual void EditItem(const wxDataViewItem& item, const wxDataViewColumn *column) = 0;
+
+ // Use EditItem() instead
+ wxDEPRECATED( void StartEditor(const wxDataViewItem& item, unsigned int column) );
+
#if wxUSE_DRAG_AND_DROP
virtual bool EnableDragSource(const wxDataFormat& WXUNUSED(format))
{ return false; }
virtual void DoSetIndent() = 0;
private:
+ // Implementation of the public Set/GetCurrentItem() methods which are only
+ // called in multi selection case (for single selection controls their
+ // implementation is trivial and is done in the base class itself).
+ virtual wxDataViewItem DoGetCurrentItem() const = 0;
+ virtual void DoSetCurrentItem(const wxDataViewItem& item) = 0;
+
wxDataViewModel *m_model;
wxDataViewColumn *m_expander_column;
int m_indent ;
m_column(NULL),
m_pos(-1,-1),
m_cacheFrom(0),
- m_cacheTo(0)
+ m_cacheTo(0),
+ m_editCancelled(false)
#if wxUSE_DRAG_AND_DROP
, m_dataObject(NULL),
m_dataBuffer(NULL),
- m_dataSize(0)
+ m_dataSize(0),
+ m_dragFlags(0),
+ m_dropEffect(wxDragNone)
#endif
{ }
m_model(event.m_model),
m_value(event.m_value),
m_column(event.m_column),
- m_pos(m_pos),
+ m_pos(event.m_pos),
m_cacheFrom(event.m_cacheFrom),
- m_cacheTo(event.m_cacheTo)
+ m_cacheTo(event.m_cacheTo),
+ m_editCancelled(event.m_editCancelled)
#if wxUSE_DRAG_AND_DROP
, m_dataObject(event.m_dataObject),
m_dataFormat(event.m_dataFormat),
m_dataBuffer(event.m_dataBuffer),
- m_dataSize(event.m_dataSize)
+ m_dataSize(event.m_dataSize),
+ m_dragFlags(event.m_dragFlags),
+ m_dropEffect(event.m_dropEffect)
#endif
{ }
const wxVariant &GetValue() const { return m_value; }
void SetValue( const wxVariant &value ) { m_value = value; }
+ // for wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_DONE only
+ bool IsEditCancelled() const { return m_editCancelled; }
+ void SetEditCanceled(bool editCancelled) { m_editCancelled = editCancelled; }
+
// for wxEVT_DATAVIEW_COLUMN_HEADER_CLICKED only
void SetDataViewColumn( wxDataViewColumn *col ) { m_column = col; }
wxDataViewColumn *GetDataViewColumn() const { return m_column; }
size_t GetDataSize() const { return m_dataSize; }
void SetDataBuffer( void* buf ) { m_dataBuffer = buf;}
void *GetDataBuffer() const { return m_dataBuffer; }
+ void SetDragFlags( int flags ) { m_dragFlags = flags; }
+ int GetDragFlags() const { return m_dragFlags; }
+ void SetDropEffect( wxDragResult effect ) { m_dropEffect = effect; }
+ wxDragResult GetDropEffect() const { return m_dropEffect; }
#endif // wxUSE_DRAG_AND_DROP
virtual wxEvent *Clone() const { return new wxDataViewEvent(*this); }
wxPoint m_pos;
int m_cacheFrom;
int m_cacheTo;
+ bool m_editCancelled;
#if wxUSE_DRAG_AND_DROP
wxDataObject *m_dataObject;
wxDataFormat m_dataFormat;
void* m_dataBuffer;
size_t m_dataSize;
+
+ int m_dragFlags;
+ wxDragResult m_dropEffect;
#endif // wxUSE_DRAG_AND_DROP
private:
class WXDLLIMPEXP_ADV wxDataViewListStoreLine
{
public:
- wxDataViewListStoreLine( wxClientData *data = NULL )
+ wxDataViewListStoreLine( wxUIntPtr data = NULL )
{
m_data = data;
}
- virtual ~wxDataViewListStoreLine()
- {
- delete m_data;
- }
- void SetData( wxClientData *data )
- { if (m_data) delete m_data; m_data = data; }
- wxClientData *GetData() const
+ void SetData( wxUIntPtr data )
+ { m_data = data; }
+ wxUIntPtr GetData() const
{ return m_data; }
wxVector<wxVariant> m_values;
private:
- wxClientData *m_data;
+ wxUIntPtr m_data;
};
void InsertColumn( unsigned int pos, const wxString &varianttype );
void AppendColumn( const wxString &varianttype );
- void AppendItem( const wxVector<wxVariant> &values, wxClientData *data = NULL );
- void PrependItem( const wxVector<wxVariant> &values, wxClientData *data = NULL );
- void InsertItem( unsigned int row, const wxVector<wxVariant> &values, wxClientData *data = NULL );
+ void AppendItem( const wxVector<wxVariant> &values, wxUIntPtr data = NULL );
+ void PrependItem( const wxVector<wxVariant> &values, wxUIntPtr data = NULL );
+ void InsertItem( unsigned int row, const wxVector<wxVariant> &values, wxUIntPtr data = NULL );
void DeleteItem( unsigned int pos );
void DeleteAllItems();
+ unsigned int GetItemCount() const;
+
+ void SetItemData( const wxDataViewItem& item, wxUIntPtr data );
+ wxUIntPtr GetItemData( const wxDataViewItem& item ) const;
+
// override base virtuals
virtual unsigned int GetColumnCount() const;
const wxDataViewListStore *GetStore() const
{ return (const wxDataViewListStore*) GetModel(); }
+ int ItemToRow(const wxDataViewItem &item) const
+ { return item.IsOk() ? (int)GetStore()->GetRow(item) : wxNOT_FOUND; }
+ wxDataViewItem RowToItem(int row) const
+ { return row == wxNOT_FOUND ? wxDataViewItem() : GetStore()->GetItem(row); }
+
+ int GetSelectedRow() const
+ { return ItemToRow(GetSelection()); }
+ void SelectRow(unsigned row)
+ { Select(RowToItem(row)); }
+ void UnselectRow(unsigned row)
+ { Unselect(RowToItem(row)); }
+ bool IsRowSelected(unsigned row) const
+ { return IsSelected(RowToItem(row)); }
+
bool AppendColumn( wxDataViewColumn *column, const wxString &varianttype );
bool PrependColumn( wxDataViewColumn *column, const wxString &varianttype );
bool InsertColumn( unsigned int pos, wxDataViewColumn *column, const wxString &varianttype );
wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
int width = -1, wxAlignment align = wxALIGN_LEFT, int flags = wxDATAVIEW_COL_RESIZABLE );
- void AppendItem( const wxVector<wxVariant> &values, wxClientData *data = NULL )
+ void AppendItem( const wxVector<wxVariant> &values, wxUIntPtr data = NULL )
{ GetStore()->AppendItem( values, data ); }
- void PrependItem( const wxVector<wxVariant> &values, wxClientData *data = NULL )
+ void PrependItem( const wxVector<wxVariant> &values, wxUIntPtr data = NULL )
{ GetStore()->PrependItem( values, data ); }
- void InsertItem( unsigned int row, const wxVector<wxVariant> &values, wxClientData *data = NULL )
+ void InsertItem( unsigned int row, const wxVector<wxVariant> &values, wxUIntPtr data = NULL )
{ GetStore()->InsertItem( row, values, data ); }
void DeleteItem( unsigned row )
{ GetStore()->DeleteItem( row ); }
bool GetToggleValue( unsigned int row, unsigned int col ) const
{ wxVariant value; GetStore()->GetValueByRow( value, row, col ); return value.GetBool(); }
+ void SetItemData( const wxDataViewItem& item, wxUIntPtr data )
+ { GetStore()->SetItemData( item, data ); }
+ wxUIntPtr GetItemData( const wxDataViewItem& item ) const
+ { return GetStore()->GetItemData( item ); }
+
+ int GetItemCount() const
+ { return GetStore()->GetItemCount(); }
+
void OnSize( wxSizeEvent &event );
private:
wxDataViewItem GetNthChild( const wxDataViewItem& parent, unsigned int pos ) const;
int GetChildCount( const wxDataViewItem& parent ) const;
-
+
void SetItemText( const wxDataViewItem& item, const wxString &text );
wxString GetItemText( const wxDataViewItem& item ) const;
void SetItemIcon( const wxDataViewItem& item, const wxIcon &icon );
virtual bool HasDefaultCompare() const
{ return true; }
virtual unsigned int GetColumnCount() const
- { return 1; };
+ { return 1; }
virtual wxString GetColumnType( unsigned int WXUNUSED(col) ) const
{ return wxT("wxDataViewIconText"); }
//-----------------------------------------------------------------------------
-class WXDLLIMPEXP_ADV wxDataViewTreeCtrl: public wxDataViewCtrl
+class WXDLLIMPEXP_ADV wxDataViewTreeCtrl: public wxDataViewCtrl,
+ public wxWithImages
{
public:
- wxDataViewTreeCtrl() { Init(); }
+ wxDataViewTreeCtrl() { }
wxDataViewTreeCtrl(wxWindow *parent,
wxWindowID id,
const wxPoint& pos = wxDefaultPosition,
long style = wxDV_NO_HEADER | wxDV_ROW_LINES,
const wxValidator& validator = wxDefaultValidator)
{
- Init();
-
Create(parent, id, pos, size, style, validator);
}
- virtual ~wxDataViewTreeCtrl();
-
bool Create(wxWindow *parent,
wxWindowID id,
const wxPoint& pos = wxDefaultPosition,
bool IsContainer( const wxDataViewItem& item ) const
{ return GetStore()->IsContainer(item); }
- void SetImageList( wxImageList *imagelist );
- wxImageList* GetImageList() { return m_imageList; }
-
wxDataViewItem AppendItem( const wxDataViewItem& parent,
- const wxString &text, int icon = -1, wxClientData *data = NULL );
+ const wxString &text, int icon = NO_IMAGE, wxClientData *data = NULL );
wxDataViewItem PrependItem( const wxDataViewItem& parent,
- const wxString &text, int icon = -1, wxClientData *data = NULL );
+ const wxString &text, int icon = NO_IMAGE, wxClientData *data = NULL );
wxDataViewItem InsertItem( const wxDataViewItem& parent, const wxDataViewItem& previous,
- const wxString &text, int icon = -1, wxClientData *data = NULL );
+ const wxString &text, int icon = NO_IMAGE, wxClientData *data = NULL );
wxDataViewItem PrependContainer( const wxDataViewItem& parent,
- const wxString &text, int icon = -1, int expanded = -1,
+ const wxString &text, int icon = NO_IMAGE, int expanded = NO_IMAGE,
wxClientData *data = NULL );
wxDataViewItem AppendContainer( const wxDataViewItem& parent,
- const wxString &text, int icon = -1, int expanded = -1,
+ const wxString &text, int icon = NO_IMAGE, int expanded = NO_IMAGE,
wxClientData *data = NULL );
wxDataViewItem InsertContainer( const wxDataViewItem& parent, const wxDataViewItem& previous,
- const wxString &text, int icon = -1, int expanded = -1,
+ const wxString &text, int icon = NO_IMAGE, int expanded = NO_IMAGE,
wxClientData *data = NULL );
wxDataViewItem GetNthChild( const wxDataViewItem& parent, unsigned int pos ) const
void OnCollapsed( wxDataViewEvent &event );
void OnSize( wxSizeEvent &event );
-private:
- void Init()
- {
- m_imageList = NULL;
- }
-
- wxImageList *m_imageList;
-
private:
DECLARE_EVENT_TABLE()
DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDataViewTreeCtrl)
projects / wxWidgets.git / blobdiff