Uranium
Application Framework
|
Base class for output devices. More...
Public Member Functions | |
def | __init__ (self, device_id, kwargs) |
def | getId (self) |
Get the device id. | |
def | getName (self) |
Get a human-readable name for this device. More... | |
def | setName (self, name) |
Set the human-readable name of this device. More... | |
def | getShortDescription (self) |
Get a short description for this device. More... | |
def | setShortDescription (self, description) |
Set the short description for this device. More... | |
def | getDescription (self) |
Get a full description for this device. More... | |
def | setDescription (self, description) |
Set the full description for this device. More... | |
def | getIconName (self) |
Get the name of an icon that can be used to identify this device. More... | |
def | setIconName (self, name) |
Set the name of an icon to identify this device. More... | |
def | getPriority (self) |
The priority of this device. More... | |
def | setPriority (self, priority) |
Set the priority of this device. More... | |
def | requestWrite (self, nodes, file_name=None, limit_mimetypes=False, file_handler=None, kwargs) |
Request performing a write operation on this device. More... | |
Static Public Attributes | |
metaDataChanged = Signal() | |
writeStarted = Signal() | |
writeProgress = Signal() | |
writeFinished = Signal() | |
writeError = Signal() | |
writeSuccess = Signal() | |
Base class for output devices.
This class provides a base class for output devices. An output device can be anything we want to output to, like a local file, an USB connected printer but also an HTTP web service.
Each subclass must implement requestWrite(). requestWrite() is expected to raise errors from OutputDeviceError when certain conditions occur, like insufficient permissions. For the rest, output device subclasses are completely free to implement writing however they want, though you should emit writeStarted and related signals whenever certain events happen related to the write process.
For example, when implementing a web service as output device, it would be completely acceptable to show a login dialog when calling requestWrite() if there are no saved login credentials.
def UM.OutputDevice.OutputDevice.OutputDevice.getDescription | ( | self | ) |
Get a full description for this device.
The full description describes what would happen when writing to this device. For example, "Save to Removable Drive /media/sdcard", "Upload to YouMagine with account User".
def UM.OutputDevice.OutputDevice.OutputDevice.getIconName | ( | self | ) |
Get the name of an icon that can be used to identify this device.
This icon should be available in the theme.
def UM.OutputDevice.OutputDevice.OutputDevice.getName | ( | self | ) |
Get a human-readable name for this device.
def UM.OutputDevice.OutputDevice.OutputDevice.getPriority | ( | self | ) |
The priority of this device.
Priority indicates which device is most likely to be used as the default device to write to. It should be a number and higher numbers indicate that the device should be preferred over devices with lower numbers.
def UM.OutputDevice.OutputDevice.OutputDevice.getShortDescription | ( | self | ) |
Get a short description for this device.
The short description can be used as a button label or similar and should thus be only a few words at most. For example, "Save to File", "Print with USB".
def UM.OutputDevice.OutputDevice.OutputDevice.requestWrite | ( | self, | |
nodes, | |||
file_name = None , |
|||
limit_mimetypes = False , |
|||
file_handler = None , |
|||
kwargs | |||
) |
Request performing a write operation on this device.
This method should be implemented by subclasses. It should write the given SceneNode forest to a destination relevant for the device. It is recommended to perform the actual writing asynchronously and rely on the write signals to properly indicate state.
nodes | A collection of scene nodes that should be written to the device. |
file_name | string A suggestion for the file name to write to. Can be freely ignored if providing a file name makes no sense. |
limit_mimetype | Limit output to these mime types. |
file_handler | The filehandler to use to write the file with. |
kwargs | Keyword arguments. |
OutputDeviceError.WriteRequestFailedError |
def UM.OutputDevice.OutputDevice.OutputDevice.setDescription | ( | self, | |
description | |||
) |
Set the full description for this device.
description | The description of this device. |
def UM.OutputDevice.OutputDevice.OutputDevice.setIconName | ( | self, | |
name | |||
) |
Set the name of an icon to identify this device.
name | The name of the icon to use. |
def UM.OutputDevice.OutputDevice.OutputDevice.setName | ( | self, | |
name | |||
) |
Set the human-readable name of this device.
name | The new name of this device. |
def UM.OutputDevice.OutputDevice.OutputDevice.setPriority | ( | self, | |
priority | |||
) |
Set the priority of this device.
priority | int The priority to use. |
def UM.OutputDevice.OutputDevice.OutputDevice.setShortDescription | ( | self, | |
description | |||
) |
Set the short description for this device.
description | The new short description to set. |