Uranium
Application Framework
UM.OutputDevice.OutputDevicePlugin.OutputDevicePlugin Class Reference

Base class for output device plugins. More...

Inheritance diagram for UM.OutputDevice.OutputDevicePlugin.OutputDevicePlugin:
UM.PluginObject.PluginObject

Public Member Functions

def __init__ (self)
 
def getOutputDeviceManager (self)
 Convenience method to get the Application's OutputDeviceManager. More...
 
def start (self)
 Called by OutputDeviceManager to indicate the plugin should start its device detection. More...
 
def stop (self)
 Called by OutputDeviceManager to indicate the plugin should stop its device detection. More...
 
def canAddManualDevice
 Used to check if this adress makes sense to this plugin w.r.t. More...
 
def addManualDevice
 Add a manual device by the specified address (for example, an IP). More...
 
def removeManualDevice
 Remove a manual device by either the name and/or the specified address. More...
 
def startDiscovery (self)
 Starts to discovery network devices that can be handled by this plugin. More...
 
def refreshConnections (self)
 Refresh the available/discovered printers for an output device that handles network printers. More...
 
- 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.

See also
OutputDeviceManager

Member Function Documentation

def UM.OutputDevice.OutputDevicePlugin.OutputDevicePlugin.addManualDevice (   self,
  address 
)

Add a manual device by the specified address (for example, an IP).

The optional callback is a function with signature func(success: bool, address: str) -> None, where

  • success is a bool that indicates if the manual device's information was successfully retrieved.
  • address is the address of the manual device.
def UM.OutputDevice.OutputDevicePlugin.OutputDevicePlugin.canAddManualDevice (   self,
  address 
)

Used to check if this adress makes sense to this plugin w.r.t.

adding(/removing) a manual device. /return 'No', 'possible', or 'priority' (in the last case this plugin takes precedence, use with care).

def UM.OutputDevice.OutputDevicePlugin.OutputDevicePlugin.getOutputDeviceManager (   self)

Convenience method to get the Application's OutputDeviceManager.

def UM.OutputDevice.OutputDevicePlugin.OutputDevicePlugin.refreshConnections (   self,
  None 
)

Refresh the available/discovered printers for an output device that handles network printers.

def UM.OutputDevice.OutputDevicePlugin.OutputDevicePlugin.removeManualDevice (   self,
  key 
)

Remove a manual device by either the name and/or the specified address.

Since this may be asynchronous, use the 'removeDeviceSignal' when the machine actually has been added.

def UM.OutputDevice.OutputDevicePlugin.OutputDevicePlugin.start (   self,
  None 
)

Called by OutputDeviceManager to indicate the plugin should start its device detection.

def UM.OutputDevice.OutputDevicePlugin.OutputDevicePlugin.startDiscovery (   self,
  None 
)

Starts to discovery network devices that can be handled by this plugin.

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: