Uranium
Application Framework
UM.Settings.Models.InstanceContainersModel.InstanceContainersModel Class Reference

Model that holds instance containers. More...

Inheritance diagram for UM.Settings.Models.InstanceContainersModel.InstanceContainersModel:
UM.Qt.ListModel.ListModel

Public Member Functions

def __init__ (self, parent=None)
 
def setSectionProperty (self, property_name)
 
def sectionProperty (self)
 
None setFilter (self, Dict[str, str] filter_dict)
 Set the filter of this model based on a string. More...
 
Dict[str, str] filter (self)
 
def setFilterList (self, filter_list)
 Set a list of filters to use when fetching containers. More...
 
def filterList (self)
 
def rename (self, instance_id, new_name)
 
def getFileNameFilters (self, io_type)
 Gets a list of the possible file filters that the plugins have registered they can read or write. More...
 
def getDefaultPath (self)
 
def exportProfile (self, instance_id, file_url, file_type)
 
def importProfile (self, file_url)
 
- Public Member Functions inherited from UM.Qt.ListModel.ListModel
def rowCount (self, parent=None)
 Reimplemented from QAbstractListModel.
 
def addRoleName (self, role, name)
 
def roleNames (self)
 
def data (self, index, role)
 Reimplemented from QAbstractListModel.
 
def getItem (self, index)
 Get an item from the list.
 
def items (self)
 The list of items in this model.
 
def setItems (self, items)
 Replace all items at once. More...
 
def appendItem (self, item)
 Add an item to the list. More...
 
def insertItem (self, index, item)
 Insert an item into the list at an index. More...
 
def removeItem (self, index)
 Remove an item from the list. More...
 
def clear (self)
 Clear the list.
 
def setProperty (self, index, property, value)
 
def sort (self, fun)
 Sort the list. More...
 
def find (self, key, value)
 Find a entry by key value pair. More...
 

Static Public Attributes

int NameRole = Qt.UserRole + 1
 
int IdRole = Qt.UserRole + 2
 
int MetaDataRole = Qt.UserRole + 3
 
int ReadOnlyRole = Qt.UserRole + 4
 
int SectionRole = Qt.UserRole + 5
 
 sectionPropertyChanged = pyqtSignal()
 
 filterChanged = pyqtSignal()
 
- Static Public Attributes inherited from UM.Qt.ListModel.ListModel
 itemsChanged = pyqtSignal()
 

Detailed Description

Model that holds instance containers.

By setting the filter property the instances held by this model can be changed.

Member Function Documentation

◆ getFileNameFilters()

def UM.Settings.Models.InstanceContainersModel.InstanceContainersModel.getFileNameFilters (   self,
  io_type 
)

Gets a list of the possible file filters that the plugins have registered they can read or write.

The convenience meta-filters "All Supported Types" and "All Files" are added when listing readers, but not when listing writers.

Parameters
io_typestr name of the needed IO type
Returns
A list of strings indicating file name filters for a file dialog.

◆ setFilter()

None UM.Settings.Models.InstanceContainersModel.InstanceContainersModel.setFilter (   self,
Dict[str, str]  filter_dict 
)

Set the filter of this model based on a string.

Parameters
filter_dictDict Dictionary to do the filtering by.

◆ setFilterList()

def UM.Settings.Models.InstanceContainersModel.InstanceContainersModel.setFilterList (   self,
  filter_list 
)

Set a list of filters to use when fetching containers.

Parameters
filter_listList[Dict] List of filter dicts to fetch multiple sets of containers. The final result is the union of these sets.

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