Uranium
Application Framework
Loading...
Searching...
No Matches
UM.Qt.ListModel.ListModel Class Reference

Convenience base class for models of a list of items. More...

Inheritance diagram for UM.Qt.ListModel.ListModel:
UM.Qt.Bindings.OutputDevicesModel.OutputDevicesModel UM.Qt.Bindings.StageModel.StageModel UM.Settings.Models.ContainerStacksModel.ContainerStacksModel UM.Settings.Models.DefinitionContainersModel.DefinitionContainersModel UM.Settings.Models.InstanceContainersModel.InstanceContainersModel

Public Member Functions

 __init__ (self, parent=None)
 
 rowCount (self, parent=None)
 Reimplemented from QAbstractListModel.
 
 addRoleName (self, role, name)
 
 roleNames (self)
 
 data (self, index, role)
 Reimplemented from QAbstractListModel.
 
 getItem (self, index)
 Get an item from the list.
 
 items (self)
 The list of items in this model.
 
 setItems (self, items)
 Replace all items at once.
 
 appendItem (self, item)
 Add an item to the list.
 
 insertItem (self, index, item)
 Insert an item into the list at an index.
 
 removeItem (self, index)
 Remove an item from the list.
 
 clear (self)
 Clear the list.
 
 setProperty (self, index, property, value)
 
 sort (self, fun)
 Sort the list.
 
 find (self, key, value)
 Find a entry by key value pair.
 

Static Public Attributes

 itemsChanged = pyqtSignal()
 

Protected Attributes

 _items
 
 _role_names
 

Detailed Description

Convenience base class for models of a list of items.

This class represents a list of dictionary objects that can be exposed to QML. It is intended primarily as a read-only convenience class but supports removing elements so can also be used for limited writing.

Member Function Documentation

◆ appendItem()

UM.Qt.ListModel.ListModel.appendItem (   self,
  item 
)

Add an item to the list.

Parameters
itemThe item to add.

◆ find()

UM.Qt.ListModel.ListModel.find (   self,
  key,
  value 
)

Find a entry by key value pair.

Parameters
key
value
Returns
index of setting if found, None otherwise

◆ insertItem()

UM.Qt.ListModel.ListModel.insertItem (   self,
  index,
  item 
)

Insert an item into the list at an index.

Parameters
indexThe index where to insert.
itemThe item to add.

◆ removeItem()

UM.Qt.ListModel.ListModel.removeItem (   self,
  index 
)

Remove an item from the list.

Parameters
indexThe index of the item to remove.

◆ setItems()

UM.Qt.ListModel.ListModel.setItems (   self,
  items 
)

Replace all items at once.

Parameters
itemsThe new list of items.

◆ sort()

UM.Qt.ListModel.ListModel.sort (   self,
  fun 
)

Sort the list.

Parameters
funThe callable to use for determining the sort key.

The documentation for this class was generated from the following file: