editor.py
Others:
Bases: umbra.ui.widgets.codeEditor_QPlainTextEdit.CodeEditor_QPlainTextEdit
This class defines the default editor used by the umbra.components.factory.scriptEditor.scriptEditor.ScriptEditor Component Interface class.
Parameters: |
|
---|
This signal is emited by the Editor class when the current title is changed. ( pyqtSignal )
This signal is emited by the Editor class when the current file is loaded. ( pyqtSignal )
This signal is emited by the Editor class when the current file is reloaded. ( pyqtSignal )
This signal is emited by the Editor class when the current file is closed. ( pyqtSignal )
This signal is emited by the Editor class when the current editor document content has changed. ( pyqtSignal )
This signal is emited by the Editor class when the current editor document content has been modified. ( pyqtSignal )
This method is the property for self.__file attribute.
Returns: | self.__file. ( String ) |
---|
This method is the property for self.__defaultFontsSettings attribute.
Returns: | self.__defaultFontsSettings. ( Dictionary ) |
---|
This method is the property for self.__tabWidth attribute.
Returns: | self.__tabWidth. ( Integer ) |
---|
This method is the property for self.__title attribute.
Returns: | self.__title. ( String ) |
---|
This method is the property for self.__isUntitled attribute.
Returns: | self.__isUntitled. ( Boolean ) |
---|
This method is the property for self.__defaultFileName attribute.
Returns: | self.__defaultFileName. ( String ) |
---|
This method is the property for self.__defaultFileExtension attribute.
Returns: | self.__defaultFileExtension. ( String ) |
---|
This method sets the editor title.
Parameters: | title – Editor title. ( String ) |
---|---|
Returns: | Method success. ( Boolean ) |
This method sets the editor file.
Parameters: |
|
---|---|
Returns: | Method success. ( Boolean ) |
This method returns the current editor file short name.
Returns: | File short name. ( String ) |
---|
This method returns an untitled editor file name.
Returns: | Untitled file name. ( String ) |
---|
This method loads given document into the editor.
Parameters: |
|
---|---|
Returns: | Method success. ( Boolean ) |
This method reads and loads given file into the editor.
Parameters: | File – File to load. ( String ) |
---|---|
Returns: | Method success. ( Boolean ) |
This method reloads the current editor file.
Parameters: | isModified – File modified state. ( Boolean ) |
---|---|
Returns: | Method success. ( Boolean ) |
This method saves the editor file content either using given file or user chosen file.
Returns: | Method success. ( Boolean ) |
---|---|
Note : | This method may require user interaction. |