Uranium
Application Framework
|
Base class for output devices. More...
Public Member Functions | |
None | __init__ (self, str device_id, **str kwargs) |
str | getId (self) |
Get the device id. | |
str | getName (self) |
Get a human-readable name for this device. | |
None | setName (self, str name) |
Set the human-readable name of this device. More... | |
str | getShortDescription (self) |
Get a short description for this device. More... | |
None | setShortDescription (self, str description) |
Set the short description for this device. More... | |
str | getDescription (self) |
Get a full description for this device. More... | |
None | setDescription (self, str description) |
Set the full description for this device. More... | |
str | getIconName (self) |
Get the name of an icon that can be used to identify this device. More... | |
None | setIconName (self, str name) |
Set the name of an icon to identify this device. More... | |
int | getPriority (self) |
The priority of this device. More... | |
None | setPriority (self, int priority) |
Set the priority of this device. More... | |
None | requestWrite (self, List[SceneNode] nodes, Optional[str] file_name=None, bool limit_mimetypes=False, Optional[FileHandler] file_handler=None, bool filter_by_machine=False, **str 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.
str 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".
str 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.
int 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.
str 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".
None UM.OutputDevice.OutputDevice.OutputDevice.requestWrite | ( | self, | |
List[SceneNode] | nodes, | ||
Optional[str] | file_name = None , |
||
bool | limit_mimetypes = False , |
||
Optional[FileHandler] | file_handler = None , |
||
bool | filter_by_machine = False , |
||
**str | 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 | 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 |
None UM.OutputDevice.OutputDevice.OutputDevice.setDescription | ( | self, | |
str | description | ||
) |
Set the full description for this device.
description | The description of this device. |
None UM.OutputDevice.OutputDevice.OutputDevice.setIconName | ( | self, | |
str | name | ||
) |
Set the name of an icon to identify this device.
name | The name of the icon to use. |
None UM.OutputDevice.OutputDevice.OutputDevice.setName | ( | self, | |
str | name | ||
) |
Set the human-readable name of this device.
name | The new name of this device. |
None UM.OutputDevice.OutputDevice.OutputDevice.setPriority | ( | self, | |
int | priority | ||
) |
Set the priority of this device.
priority | The priority to use. |
None UM.OutputDevice.OutputDevice.OutputDevice.setShortDescription | ( | self, | |
str | description | ||
) |
Set the short description for this device.
description | The new short description to set. |