|
Uranium
Application Framework
|
A Job subclass that performs writing. More...
Public Member Functions | |
| def | __init__ |
| Creates a new job for writing. More... | |
| def | setFileName |
| def | getFileName (self) |
| def | getStream (self) |
| def | setMessage |
| def | getMessage (self) |
| def | setAddToRecentFiles |
| def | getAddToRecentFiles (self) |
| def | run (self) |
Public Member Functions inherited from UM.Job.Job | |
| def | __init__ (self) |
| def | run (self) |
| Perform the actual task of this job. More... | |
| def | getMessage (self) |
| def | setMessage (self, message) |
| def | getResult (self) |
| Get the result of the job. More... | |
| def | setResult |
| Set the result of this job. More... | |
| def | setError |
| Set an exception that was thrown while the job was being executed. More... | |
| def | start (self) |
| Start the job. More... | |
| def | cancel (self) |
| Cancel the job. More... | |
| def | isRunning (self) |
| Check whether the job is currently running. More... | |
| def | isFinished (self) |
| Check whether the job has finished processing. More... | |
| def | hasError (self) |
| Check whether the Job has encountered an error during execution. More... | |
| def | getError (self) |
| Get the error that was encountered during execution. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from UM.Job.Job | |
| def | yieldThread () |
| Utility function that allows us to yield thread processing. More... | |
Static Public Attributes inherited from UM.Job.Job | |
| tuple | finished = Signal() |
| Emitted when the job has finished processing. More... | |
| tuple | progress = Signal() |
| Emitted when the job processing has progressed. More... | |
A Job subclass that performs writing.
The writer defines what the result of this job is.
| def UM.FileHandler.WriteFileJob.WriteFileJob.__init__ | ( | self, | |
| writer | |||
| ) |
Creates a new job for writing.
| writer | The file writer to use, with the correct MIME type. |
| stream | The output stream to write to. |
| data | Whatever it is what we want to write. |
| mode | Additional information to send to the writer, for example: such as whether to write in binary format or in ASCII format. |