Uranium
Application Framework
 All Classes Namespaces Files Functions Variables Pages
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__
 
def getOutputDeviceManager
 Convenience method to get the Application's OutputDeviceManager. More...
 
def start
 Called by OutputDeviceManager to indicate the plugin should start its device detection. More...
 
def stop
 Called by OutputDeviceManager to indicate the plugin should stop its device detection. More...
 
- Public Member Functions inherited from UM.PluginObject.PluginObject
def __init__
 
def getPluginId
 
def setPluginId
 
def setVersion
 
def getVersion
 

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.getOutputDeviceManager (   self)

Convenience method to get the Application's OutputDeviceManager.

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

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

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

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


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