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.
 
def start (self)
 Called by OutputDeviceManager to indicate the plugin should start its device detection.
 
def stop (self)
 Called by OutputDeviceManager to indicate the plugin should stop its device detection.
 
- Public Member Functions inherited from UM.PluginObject.PluginObject
def getPluginId (self)
 
def setPluginId (self, plugin_id)
 

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

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