Phoenix Logo

phoenix_title wx.dataview.DataViewListStore

wx.dataview.DataViewListStore is a specialised wx.dataview.DataViewModel for storing a simple table of data.

Since it derives from wx.dataview.DataViewIndexListModel its data is be accessed by row (i.e. by index) instead of only by wx.dataview.DataViewItem.

This class actually stores the values (therefore its name) and implements all virtual methods from the base classes so it can be used directly without having to derive any class from it, but it is mostly used from within wx.dataview.DataViewListCtrl.


class_hierarchy Class Hierarchy

Inheritance diagram for class DataViewListStore:


method_summary Methods Summary

__init__ Constructor.
AppendColumn Appends a data column.
AppendItem Appends an item (=row) and fills it with values.
DeleteAllItems Delete all item (=all rows) in the store.
DeleteItem Delete the item (=row) at position pos.
GetColumnCount Overridden from wx.dataview.DataViewModel.
GetColumnType Overridden from wx.dataview.DataViewModel.
GetItemCount Returns the number of items (=rows) in the control.
GetItemData Returns the client data associated with the item.
GetValueByRow Overridden from wx.dataview.DataViewIndexListModel.
InsertColumn Inserts a data column before pos.
InsertItem Inserts an item (=row) and fills it with values.
PrependColumn Prepends a data column.
PrependItem Prepends an item (=row) and fills it with values.
SetItemData Sets the client data associated with the item.
SetValueByRow Overridden from wx.dataview.DataViewIndexListModel.

property_summary Properties Summary

ColumnCount See GetColumnCount
ItemCount See GetItemCount

api Class API



class wx.dataview.DataViewListStore(DataViewIndexListModel)

Possible constructors:

DataViewListStore()

DataViewListStore is a specialised DataViewModel for storing a simple table of data.


Methods



__init__(self)

Constructor.



AppendColumn(self, varianttype)

Appends a data column.

variantype indicates the type of values store in the column.

This does not automatically fill in any (default) values in rows which exist in the store already.

Parameters:varianttype (string) –


AppendItem(self, values, data=None)

Appends an item (=row) and fills it with values.

The values must match the values specifies in the column in number and type. No (default) values are filled in automatically.

Parameters:
  • values (VariantVector) –
  • data (wx.UIntPtr) –


DeleteAllItems(self)

Delete all item (=all rows) in the store.



DeleteItem(self, pos)

Delete the item (=row) at position pos.

Parameters:pos


GetColumnCount(self)

Overridden from wx.dataview.DataViewModel.

Return type:int


GetColumnType(self, col)

Overridden from wx.dataview.DataViewModel.

Parameters:col (int) –
Return type:string


GetItemCount(self)

Returns the number of items (=rows) in the control.

Return type:int

New in version 2.9.4.



GetItemData(self, item)

Returns the client data associated with the item.

Parameters:item (wx.dataview.DataViewItem) –
Return type:wx.UIntPtr

New in version 2.9.4.

See also

SetItemData



GetValueByRow(self, row, col)

Overridden from wx.dataview.DataViewIndexListModel.

Parameters:
  • row (int) –
  • col (int) –
Return type:

value



InsertColumn(self, pos, varianttype)

Inserts a data column before pos.

variantype indicates the type of values store in the column.

This does not automatically fill in any (default) values in rows which exist in the store already.

Parameters:
  • pos (int) –
  • varianttype (string) –


InsertItem(self, row, values, data=None)

Inserts an item (=row) and fills it with values.

The values must match the values specifies in the column in number and type. No (default) values are filled in automatically.

Parameters:
  • row (int) –
  • values (VariantVector) –
  • data (wx.UIntPtr) –


PrependColumn(self, varianttype)

Prepends a data column.

variantype indicates the type of values store in the column.

This does not automatically fill in any (default) values in rows which exist in the store already.

Parameters:varianttype (string) –


PrependItem(self, values, data=None)

Prepends an item (=row) and fills it with values.

The values must match the values specifies in the column in number and type. No (default) values are filled in automatically.

Parameters:
  • values (VariantVector) –
  • data (wx.UIntPtr) –


SetItemData(self, item, data)

Sets the client data associated with the item.

Notice that this class does not take ownership of the passed in pointer and will not delete it.

Parameters:

New in version 2.9.4.

See also

GetItemData



SetValueByRow(self, value, row, col)

Overridden from wx.dataview.DataViewIndexListModel.

Parameters:
  • value (DVCVariant) –
  • row (int) –
  • col (int) –
Return type:

bool


Properties



ColumnCount

See GetColumnCount



ItemCount

See GetItemCount