6.97. sibl_gui.components.addons.locationsBrowser.locationsBrowser

locationsBrowser.py

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

Others:

6.97.1. Module Attributes

sibl_gui.components.addons.locationsBrowser.locationsBrowser.LOGGER
sibl_gui.components.addons.locationsBrowser.locationsBrowser.COMPONENT_UI_FILE

6.97.2. Classes

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

Bases: manager.qwidgetComponent.QWidgetComponent

This class is the sibl_gui.components.addons.locationsBrowser.locationsBrowser Component Interface class.
It provides methods to explore operating system directories.
By default the Component will use current operating system file browsers but the user can define a custom file browser through options exposed in the sibl_gui.components.core.preferencesManager.preferencesManager Component ui.

Defaults file browsers:

  • Windows:

    • Explorer
  • Mac Os X:

    • Finder
  • Linux:

    • Nautilus
    • Dolphin
    • Konqueror
    • Thunar
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 )
componentsManagerUi[source]

This method is the property for self.__componentsManagerUi attribute.

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

This method is the property for self.__preferencesManager attribute.

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

This method is the property for self.__iblSetsOutliner attribute.

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

This method is the property for self.__templatesOutliner attribute.

Returns:self.__templatesOutliner. ( QWidget )
loaderScript[source]

This method is the property for self.__loaderScript attribute.

Returns:self.__loaderScript. ( QWidget )
Open_Output_Directory_pushButton[source]

This method is the property for self.__Open_Output_Directory_pushButton attribute.

Returns:self.__Open_Output_Directory_pushButton. ( QPushButton )
linuxBrowsers[source]

This method is the property for self.__linuxBrowsers attribute.

Returns:self.__linuxBrowsers. ( QObject )
activate(engine)[source]

This method Engine the Component.

Parameters:engine – Container 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 )
openIblSetsLocationsUi()[source]

This method open selected Ibl Sets directories.

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

This method opens sibl_gui.components.core.inspector.inspector Component Ibl Set directory.

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

This method opens selected Components directories.

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

This method opens selected Templates directories.

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

This method opens output directory.

Returns:Method success. ( Boolean )
Note :This method may require user interaction.
getProcessCommand(directory, customBrowser=None)[source]

This method gets process command.

Parameters:
  • directory – Directory to explore. ( String )
  • customBrowser – Custom browser. ( String )
Returns:

Process command. ( String )

exploreDirectory(directory, customBrowser=None)[source]

This method provides directory exploring capability.

Parameters:
  • directory – Directory to explore. ( String )
  • customBrowser – Custom browser. ( String )
Returns:

Method success. ( Boolean )