scripter.documentcontroller.DocumentController Class Reference

Inheritance diagram for scripter.documentcontroller.DocumentController:

Public Member Functions
	__init__ (self)
	activeDocument (self)
	clearActiveDocument (self)
	openDocument (self, filePath)
	saveDocument (self, data, filePath, save_as=False)

Protected Attributes
	_activeDocument

Detailed Description

Definition at line 9 of file documentcontroller.py.

Constructor & Destructor Documentation

__init__()

scripter.documentcontroller.DocumentController.__init__

(

self

)

Definition at line 11 of file documentcontroller.py.

    def __init__(self):
        self._activeDocument = None
 

Member Function Documentation

activeDocument()

scripter.documentcontroller.DocumentController.activeDocument

(

self

)

Definition at line 15 of file documentcontroller.py.

    def activeDocument(self):
        return self._activeDocument
 

References scripter.documentcontroller.DocumentController._activeDocument.

clearActiveDocument()

scripter.documentcontroller.DocumentController.clearActiveDocument

(

self

)

Definition at line 44 of file documentcontroller.py.

    def clearActiveDocument(self):
        self._activeDocument = None

References scripter.documentcontroller.DocumentController._activeDocument.

openDocument()

scripter.documentcontroller.DocumentController.openDocument	(		self,
			filePath )

Definition at line 18 of file documentcontroller.py.

    def openDocument(self, filePath):
        if filePath:
            newDocument = document.Document(filePath)
            newDocument.open()
            self._activeDocument = newDocument
            return newDocument
 

References scripter.documentcontroller.DocumentController._activeDocument.

saveDocument()

scripter.documentcontroller.DocumentController.saveDocument	(		self,
			data,
			filePath,
			save_as = False )

data - data to be written
filePath - file path to write data to
save_as = boolean, is this call made from save_as functionality. If so, do not compare data
against existing document before save.

Definition at line 25 of file documentcontroller.py.

    def saveDocument(self, data, filePath, save_as=False):
        """
        data - data to be written
        filePath - file path to write data to
        save_as = boolean, is this call made from save_as functionality. If so, do not compare data
        against existing document before save.
        """
 
        if save_as or not self._activeDocument:
            self._activeDocument = document.Document(filePath)
 
        text = str(data)
        if save_as or not self._activeDocument.compare(text):
            # compare is not evaluated if save_as is True
            self._activeDocument.data = text
            self._activeDocument.save()
 
        return self._activeDocument
 

References scripter.documentcontroller.DocumentController._activeDocument.

Member Data Documentation

_activeDocument

scripter.documentcontroller.DocumentController._activeDocument

protected

Definition at line 12 of file documentcontroller.py.

---

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

• plugins/python/scripter/documentcontroller.py