6.112. sibl_gui.components.addons.rawEditingUtilities.rawEditingUtilities

rawEditingUtilities.py

Platform:
Windows, Linux, Mac Os X.
Description:
Defines the RawEditingUtilities Component Interface class.

Others:

6.112.1. Module Attributes

sibl_gui.components.addons.rawEditingUtilities.rawEditingUtilities.LOGGER
sibl_gui.components.addons.rawEditingUtilities.rawEditingUtilities.COMPONENT_UI_FILE

6.112.2. Classes

class sibl_gui.components.addons.rawEditingUtilities.rawEditingUtilities.RawEditingUtilities(parent=None, name=None, *args, **kwargs)[source]

Bases: manager.qwidgetComponent.QWidgetComponent

It provides methods to edit Application related text files.
By default the Component will use the factory.scriptEditor Component but the user can define a custom file editor through options exposed in the sibl_gui.components.core.preferencesManager.preferencesManager Component ui.

Initializes the class.

Parameters:
  • parent (QObject) – Object parent.
  • name (unicode) – Component name.
  • *args (*) – Arguments.
  • **kwargs (**) – Keywords arguments.
engine[source]

Property for self.__engine attribute.

Returns:self.__engine.
Return type:QObject
settings[source]

Property for self.__settings attribute.

Returns:self.__settings.
Return type:QSettings
settingsSection[source]

Property for self.__settingsSection attribute.

Returns:self.__settingsSection.
Return type:unicode
scriptEditor[source]

Property for self.__scriptEditor attribute.

Returns:self.__scriptEditor.
Return type:QWidget
preferencesManager[source]

Property for self.__preferencesManager attribute.

Returns:self.__preferencesManager.
Return type:QWidget
componentsManagerUi[source]

Property for self.__componentsManagerUi attribute.

Returns:self.__componentsManagerUi.
Return type:QWidget
iblSetsOutliner[source]

Property for self.__iblSetsOutliner attribute.

Returns:self.__iblSetsOutliner.
Return type:QWidget
inspector[source]

Property for self.__inspector attribute.

Returns:self.__inspector.
Return type:QWidget
templatesOutliner[source]

Property for self.__templatesOutliner attribute.

Returns:self.__templatesOutliner.
Return type:QWidget
activate(engine)[source]

Activates the Component.

Parameters:engine (QObject) – Engine to attach the Component to.
Returns:Method success.
Return type:bool
deactivate()[source]

Deactivates the Component.

Returns:Method success.
Return type:bool
initializeUi()[source]

Initializes the Component ui.

Returns:Method success.
Return type:bool
uninitializeUi()[source]

Uninitializes the Component ui.

Returns:Method success.
Return type:bool
addWidget()[source]

Adds the Component Widget to the engine.

Returns:Method success.
Return type:bool
removeWidget()[source]

Removes the Component Widget from the engine.

Returns:Method success.
Return type:bool
editIblSetsFilesUi()[source]

Edits selected Ibl Sets files.

Returns:Method success.
Return type:bool
Note:May require user interaction.
editActiveIblSetFileUi()[source]

Edits sibl_gui.components.core.inspector.inspector Component Ibl Set file.

Returns:Method success.
Return type:bool
Note:May require user interaction.
editTemplatesFilesUi()[source]

Edits selected Templates files.

Returns:Method success.
Return type:bool
Note:May require user interaction.
editComponentsUi()[source]

Edits selected Components packages.

Returns:Method success.
Return type:bool
Note:May require user interaction.
getProcessCommand(path, customTextEditor)[source]

Gets process command.

Parameters:
  • path (unicode) – Path to edit.
  • customTextEditor (unicode) – Custom text editor.
Returns:

Process command.

Return type:

unicode

editPath(path, customTextEditor=None)[source]

Provides editing capability.

Parameters:
  • path (unicode) – Path to edit.
  • customTextEditor (unicode) – Custom text editor.
Returns:

Method success.

Return type:

bool