UM.Workspace.WorkspaceFileHandler.WorkspaceFileHandler Class Reference

Central class for reading and writing workspaces. More...

Inheritance diagram for UM.Workspace.WorkspaceFileHandler.WorkspaceFileHandler:

Public Member Functions
None	__init__ (self, "QtApplication" application, str writer_type="workspace_writer", str reader_type="workspace_reader", QObject parent=None)
None	setEnabled (self, bool enabled)
	enabled (self)
	readerRead (self, WorkspaceReader reader, str file_name, **kwargs)
Public Member Functions inherited from UM.FileHandler.FileHandler.FileHandler
None	__init__ (self, "QtApplication" application, str writer_type="unknown_file_writer", str reader_type="unknown_file_reader", QObject parent=None)
List[str]	supportedReadFileTypes (self)
List[str]	supportedWriteFileTypes (self)
None	readLocalFile (self, QUrl file, bool add_to_recent_files_hint=True)
List[Dict[str, Union[str, int]]]	getSupportedFileTypesWrite (self)
Dict[str, str]	getSupportedFileTypesRead (self)
None	addReader (self, "FileReader" reader)
None	addWriter (self, "FileWriter" writer)
	readerRead (self, reader, str file_name, **Any kwargs)
Optional["FileWriter"]	getWriterByMimeType (self, str mime)
Optional["FileWriter"]	getWriter (self, str writer_id)
Optional["FileReader"]	getReaderForFile (self, str file_name)
"FileHandler"	getInstance (cls, *args, **kwargs)

Public Attributes
	workspace_reader
Public Attributes inherited from UM.FileHandler.FileHandler.FileHandler
	addWriter
	addReader

Static Public Attributes
	enabledChanged = pyqtSignal()

Protected Member Functions
None	_readLocalFile (self, QUrl file, bool add_to_recent_files_hint=True)
None	_readWorkspaceFinished (self, ReadFileJob job)
None	_readLocalFile (self, QUrl file, bool add_to_recent_files_hint=True)

Protected Attributes
	_enabled
	_readWorkspaceFinished
Protected Attributes inherited from UM.FileHandler.FileHandler.FileHandler
	_application
	_readers
	_writers
	_writer_type
	_reader_type
	_add_to_recent_files_hints

Detailed Description

Central class for reading and writing workspaces.

This class is created by Application and handles reading and writing workspace files.

Constructor & Destructor Documentation

__init__()

None UM.Workspace.WorkspaceFileHandler.WorkspaceFileHandler.__init__	(		self,
		"QtApplication"	application,
		str	writer_type = "workspace_writer",
		str	reader_type = "workspace_reader",
		QObject	parent = None
	)

Reimplemented from UM.FileHandler.FileHandler.FileHandler.

Member Function Documentation

_readLocalFile()

None UM.Workspace.WorkspaceFileHandler.WorkspaceFileHandler._readLocalFile (   self, QUrl  file, bool   add_to_recent_files_hint = True  )

protected

Reimplemented from UM.FileHandler.FileHandler.FileHandler.

readerRead()

UM.Workspace.WorkspaceFileHandler.WorkspaceFileHandler.readerRead	(		self,
		WorkspaceReader	reader,
		str	file_name,
		**	kwargs
	)

Reimplemented from UM.FileHandler.FileHandler.FileHandler.

---

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

• UM/Workspace/WorkspaceFileHandler.py