Uranium
Application Framework
 All Classes Namespaces Files Functions Variables Pages
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

def __init__
 
def rowCount
 Reimplemented from QAbstractListModel.
 
def addRoleName
 
def roleNames
 
def data
 Reimplemented from QAbstractListModel.
 
def getItem
 Get an item from the list.
 
def items
 The list of items in this model. More...
 
def setItems
 Replace all items at once. More...
 
def appendItem
 Add an item to the list. More...
 
def insertItem
 Insert an item into the list at an index. More...
 
def removeItem
 Remove an item from the list. More...
 
def clear
 Clear the list. More...
 
def setProperty
 
def sort
 Sort the list. More...
 
def find
 Find a entry by key value pair. More...
 

Static Public Attributes

tuple itemsChanged = pyqtSignal()
 

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

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

Add an item to the list.

Parameters
itemThe item to add.
def UM.Qt.ListModel.ListModel.clear (   self)

Clear the list.

def 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
def 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.
def UM.Qt.ListModel.ListModel.items (   self)

The list of items in this model.

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

Remove an item from the list.

Parameters
indexThe index of the item to remove.
def UM.Qt.ListModel.ListModel.setItems (   self,
  items 
)

Replace all items at once.

Parameters
itemsThe new list of items.
def 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: