6.105. sibl_gui.components.addons.rawEditingUtilities.rawEditingUtilities

rawEditingUtilities.py

Platform:
Windows, Linux, Mac Os X.
Description:
This module defines the RawEditingUtilities Component Interface class.

Others:

6.105.1. Module Attributes

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

6.105.2. Classes

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

Bases: manager.qwidgetComponent.QWidgetComponent

This class is the sibl_gui.components.addons.rawEditingUtilities.rawEditingUtilities Component Interface class.
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.
Parameters:
  • parent – Object parent. ( QObject )
  • name – Component name. ( String )
  • *args – Arguments. ( * )
  • **kwargs – Keywords arguments. ( ** )
engine[source]

This method is the property for self.__engine attribute.

Returns:self.__engine. ( QObject )
settings[source]

This method is the property for self.__settings attribute.

Returns:self.__settings. ( QSettings )
settingsSection[source]

This method is the property for self.__settingsSection attribute.

Returns:self.__settingsSection. ( String )
editLayout[source]

This method is the property for self.__editLayout attribute.

Returns:self.__editLayout. ( String )
scriptEditor[source]

This method is the property for self.__scriptEditor attribute.

Returns:self.__scriptEditor. ( QWidget )
preferencesManager[source]

This method is the property for self.__preferencesManager attribute.

Returns:self.__preferencesManager. ( QWidget )
componentsManagerUi[source]

This method is the property for self.__componentsManagerUi attribute.

Returns:self.__componentsManagerUi. ( QWidget )
iblSetsOutliner[source]

This method is the property for self.__iblSetsOutliner attribute.

Returns:self.__iblSetsOutliner. ( QWidget )
inspector[source]

This method is the property for self.__inspector attribute.

Returns:self.__inspector. ( QWidget )
templatesOutliner[source]

This method is the property for self.__templatesOutliner attribute.

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

This method activates the Component.

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

This method deactivates the Component.

Returns:Method success. ( Boolean )
initializeUi()[source]

This method initializes the Component ui.

Returns:Method success. ( Boolean )
uninitializeUi()[source]

This method uninitializes the Component ui.

Returns:Method success. ( Boolean )
addWidget()[source]

This method adds the Component Widget to the engine.

Returns:Method success. ( Boolean )
removeWidget()[source]

This method removes the Component Widget from the engine.

Returns:Method success. ( Boolean )
editIblSetsFilesUi()[source]

This method edits selected Ibl Sets files.

Returns:Method success. ( Boolean )
Note :This method may require user interaction.
editActiveIblSetFileUi()[source]

This method edits sibl_gui.components.core.inspector.inspector Component Ibl Set file.

Returns:Method success. ( Boolean )
Note :This method may require user interaction.
editTemplatesFilesUi()[source]

This method edits selected Templates files.

Returns:Method success. ( Boolean )
Note :This method may require user interaction.
editComponentsUi()[source]

This method edits selected Components packages.

Returns:Method success. ( Boolean )
Note :This method may require user interaction.
getProcessCommand(path, customTextEditor)[source]

This method gets process command.

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

Process command. ( String )

editPath(path, customTextEditor=None)[source]

This method provides editing capability.

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

Method success. ( Boolean )