Uranium
Application Framework
UM.Settings.ContainerProvider.ContainerProvider Class Reference
Inheritance diagram for UM.Settings.ContainerProvider.ContainerProvider:
UM.PluginObject.PluginObject

Public Member Functions

def __init__ (self)
 
def __getitem__
 
def __lt__
 
def __eq__
 
def addMetadata
 
def getMetadata
 
def getContainerFilePathById
 
def getLastModifiedTime
 
def getAllIds (self)
 
def isReadOnly
 
def loadContainer
 
def loadMetadata
 
def metadata (self)
 
def removeContainer
 
- Public Member Functions inherited from UM.PluginObject.PluginObject
def __init__ (self, args, kwags)
 
def getId (self)
 
def setPluginId
 
def setMetaData
 
def getMetaData (self)
 
def getPluginId (self)
 
def setVersion
 
def getVersion (self)
 

Detailed Description

This class serves as a database for containers.

A plug-in can define a new source for containers by implementing the
``getAllIds``, ``loadMetadata`` and ``loadContainer`` methods.

Constructor & Destructor Documentation

◆ __init__()

def UM.Settings.ContainerProvider.ContainerProvider.__init__ (   self,
  None 
)
Initialises the provider, which creates a few empty fields.

Member Function Documentation

◆ getAllIds()

def UM.Settings.ContainerProvider.ContainerProvider.getAllIds (   self,
  Iterable,
  str 
)
Gets a list of IDs of all containers this provider provides.

:return: A list of all container IDs.

◆ metadata()

def UM.Settings.ContainerProvider.ContainerProvider.metadata (   self,
  Dict,
  str,
  Dict,
  str,
  Any 
)
Gets a dictionary of metadata of all containers, indexed by ID.

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