6.104. sibl_gui.components.addons.locationsBrowser.locationsBrowser
locationsBrowser.py
- Platform:
- Windows, Linux, Mac Os X.
- Description:
- Defines the LocationsBrowser Component Interface class.
Others:
6.104.1. Module Attributes
-
sibl_gui.components.addons.locationsBrowser.locationsBrowser.LOGGER
-
sibl_gui.components.addons.locationsBrowser.locationsBrowser.COMPONENT_UI_FILE
6.104.2. Classes
-
class sibl_gui.components.addons.locationsBrowser.locationsBrowser.LocationsBrowser(parent=None, name=None, *args, **kwargs)[source]
Bases: manager.qwidgetComponent.QWidgetComponent
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:
Mac Os X:
Linux:
- Nautilus
- Dolphin
- Konqueror
- Thunar
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 |
-
componentsManagerUi[source]
Property for self.__componentsManagerUi attribute.
| Returns: | self.__componentsManagerUi. |
| Return type: | QWidget |
-
preferencesManager[source]
Property for self.__preferencesManager attribute.
| Returns: | self.__preferencesManager. |
| Return type: | QWidget |
-
iblSetsOutliner[source]
Property for self.__iblSetsOutliner attribute.
| Returns: | self.__iblSetsOutliner. |
| Return type: | QWidget |
-
templatesOutliner[source]
Property for self.__templatesOutliner attribute.
| Returns: | self.__templatesOutliner. |
| Return type: | QWidget |
-
loaderScript[source]
Property for self.__loaderScript attribute.
| Returns: | self.__loaderScript. |
| Return type: | QWidget |
-
Open_Output_Directory_pushButton[source]
Property for self.__Open_Output_Directory_pushButton attribute.
| Returns: | self.__Open_Output_Directory_pushButton. |
| Return type: | QPushButton |
-
linuxBrowsers[source]
Property for self.__linuxBrowsers attribute.
| Returns: | self.__linuxBrowsers. |
| Return type: | QObject |
-
activate(engine)[source]
Activates the Component.
| Parameters: | engine (QObject) – Container 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 |
-
openIblSetsLocationsUi()[source]
Open selected Ibl Sets directories.
| Returns: | Method success. |
| Return type: | bool |
| Note: | May require user interaction. |
-
openActiveIblSetLocationUi()[source]
Opens sibl_gui.components.core.inspector.inspector Component Ibl Set directory.
| Returns: | Method success. |
| Return type: | bool |
| Note: | May require user interaction. |
-
openComponentsLocationsUi()[source]
Opens selected Components directories.
| Returns: | Method success. |
| Return type: | bool |
| Note: | May require user interaction. |
-
openTemplatesLocationsUi()[source]
Opens selected Templates directories.
| Returns: | Method success. |
| Return type: | bool |
| Note: | May require user interaction. |
-
openOutputDirectoryUi()[source]
Opens output directory.
| Returns: | Method success. |
| Return type: | bool |
| Note: | May require user interaction. |
-
getProcessCommand(directory, customBrowser=None)[source]
Gets process command.
| Parameters: |
- directory (unicode) – Directory to explore.
- customBrowser (unicode) – Custom browser.
|
| Returns: | Process command.
|
| Return type: | unicode
|
-
exploreDirectory(directory, customBrowser=None)[source]
Provides directory exploring capability.
| Parameters: |
- directory (unicode) – Directory to explore.
- customBrowser (unicode) – Custom browser.
|
| Returns: | Method success.
|
| Return type: | bool
|