Uranium
Application Framework
UM.OutputDevice.OutputDevicePlugin.OutputDevicePlugin Class Reference
Inheritance diagram for UM.OutputDevice.OutputDevicePlugin.OutputDevicePlugin:
UM.PluginObject.PluginObject

Public Member Functions

def __init__ (self)
 
def getOutputDeviceManager (self)
 
def start (self)
 
def stop (self)
 
def canAddManualDevice
 
def addManualDevice
 
def removeManualDevice
 
def startDiscovery (self)
 
def refreshConnections (self)
 
- 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

Base class for output device plugins.

This class provides the base for any output device plugin that should be
registered with the OutputDeviceManager. Each OutputDevicePlugin should
implement device detection and add/remove devices as needed.

For example, the Removable Device plugin searches for removable devices
that have been plugged in and creates new OutputDevice objects for each.
Additionally, whenever a removable device has been removed, it will remove
the OutputDevice object from the OutputDeviceManager.

:sa OutputDeviceManager

Member Function Documentation

◆ getOutputDeviceManager()

def UM.OutputDevice.OutputDevicePlugin.OutputDevicePlugin.getOutputDeviceManager (   self)
Convenience method to get the Application's OutputDeviceManager.

◆ refreshConnections()

def UM.OutputDevice.OutputDevicePlugin.OutputDevicePlugin.refreshConnections (   self,
  None 
)
Refresh the available/discovered printers for an output device that handles network printers.

◆ start()

def UM.OutputDevice.OutputDevicePlugin.OutputDevicePlugin.start (   self,
  None 
)
Called by OutputDeviceManager to indicate the plugin should start its device detection.

◆ startDiscovery()

def UM.OutputDevice.OutputDevicePlugin.OutputDevicePlugin.startDiscovery (   self,
  None 
)
Starts to discovery network devices that can be handled by this plugin.

◆ stop()

def UM.OutputDevice.OutputDevicePlugin.OutputDevicePlugin.stop (   self,
  None 
)
Called by OutputDeviceManager to indicate the plugin should stop its device detection.

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