From 4770679bef407a2064c80e2488b36cbd420bc741 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Sun, 21 Apr 2013 18:46:37 +0200 Subject: [PATCH 01/54] Update "Crittercism" application id. --- sibl_gui/globals/uiConstants.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sibl_gui/globals/uiConstants.py b/sibl_gui/globals/uiConstants.py index 9849e289..278c4a0f 100644 --- a/sibl_gui/globals/uiConstants.py +++ b/sibl_gui/globals/uiConstants.py @@ -175,6 +175,6 @@ class UiConstants(): thumbnailsCacheDirectory = "thumbnails" """Thumbnails cache directory.""" - crittercismId = "51290b3589ea7429250004fe" + crittercismId = "5075c158d5f9b9796b000002" """Crittercism Id: '**51290b3589ea7429250004fe**' ( String )""" From 59bd5b92113fd797502fe5758bbcaa47034641b6 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Sun, 21 Apr 2013 22:54:48 +0200 Subject: [PATCH 02/54] Implement various unicode support related updates. --- sibl_gui/globals/constants.py | 5 ++++ sibl_gui/launcher.py | 6 +++-- .../testsGlobals/testsConstants.py | 24 +++++++++++++++++++ sibl_gui/ui/common.py | 2 +- 4 files changed, 34 insertions(+), 3 deletions(-) diff --git a/sibl_gui/globals/constants.py b/sibl_gui/globals/constants.py index a338c815..6be29248 100644 --- a/sibl_gui/globals/constants.py +++ b/sibl_gui/globals/constants.py @@ -59,6 +59,11 @@ class Constants(): logger = "sIBL_GUI_Logger" """Package logger name: '**sIBL_GUI_Logger**' ( String )""" + defaultCodec = "utf-8" + """Default codec: '**utf-8**' ( String )""" + codecError = "ignore" + """Default codec error behavior: '**ignore**' ( String )""" + applicationDirectory = os.sep.join(("sIBL_GUI", ".".join((majorVersion, minorVersion)))) """Package Application directory: '**sIBL_GUI**' ( String )""" if platform.system() == "Windows" or platform.system() == "Microsoft" or platform.system() == "Darwin": diff --git a/sibl_gui/launcher.py b/sibl_gui/launcher.py index 3c74af37..dc521fbc 100644 --- a/sibl_gui/launcher.py +++ b/sibl_gui/launcher.py @@ -324,8 +324,10 @@ def main(): (foundations.common.pathExists(path) and not path in componentsPaths) and componentsPaths.append(path) return umbra.engine.run(sIBL_GUI, - commandLineParametersParser.parse_args( - [unicode(argument, umbra.globals.constants.Constants.encodingCodec) for argument in sys.argv]), + commandLineParametersParser.parse_args([unicode(argument, + umbra.globals.constants.Constants.defaultCodec, + umbra.globals.constants.Constants.codecError) \ + for argument in sys.argv]), componentsPaths, ("factory.scriptEditor", "factory.preferencesManager", diff --git a/sibl_gui/tests/testsSibl_gui/testsGlobals/testsConstants.py b/sibl_gui/tests/testsSibl_gui/testsGlobals/testsConstants.py index d9885c59..d03c6112 100644 --- a/sibl_gui/tests/testsSibl_gui/testsGlobals/testsConstants.py +++ b/sibl_gui/tests/testsSibl_gui/testsGlobals/testsConstants.py @@ -64,6 +64,8 @@ def testRequiredAttributes(self): "changeVersion", "releaseVersion", "logger", + "defaultCodec", + "codecError", "applicationDirectory", "providerDirectory", "databaseDirectory", @@ -130,6 +132,28 @@ def testLoggerAttribute(self): self.assertRegexpMatches(Constants.logger, "\w+") + def testDefaultCodecAttribute(self): + """ + This method tests :attr:`umbra.globals.constants.Constants.defaultCodec` attribute. + """ + + validEncodings = ("utf-8", + "cp1252") + + self.assertIn(Constants.defaultCodec, validEncodings) + + def testEncodingErrorAttribute(self): + """ + This method tests :attr:`umbra.globals.constants.Constants.codecError` attribute. + """ + + validEncodingsErrors = ("strict", + "ignore", + "replace", + "xmlcharrefreplace") + + self.assertIn(Constants.codecError, validEncodingsErrors) + def testApplicationDirectoryAttribute(self): """ This method tests :attr:`sibl_gui.globals.constants.Constants.applicationDirectory` attribute. diff --git a/sibl_gui/ui/common.py b/sibl_gui/ui/common.py index 84f2122c..e57df6fd 100644 --- a/sibl_gui/ui/common.py +++ b/sibl_gui/ui/common.py @@ -106,7 +106,7 @@ def getThumbnailPath(path, size, cacheDirectory=None): cacheDirectory = cacheDirectory if cacheDirectory is not None else RuntimeGlobals.thumbnailsCacheDirectory return os.path.join(cacheDirectory, - hashlib.md5("{0}_{1}.png".format(path, size).encode(Constants.encodingCodec)).hexdigest()) + hashlib.md5("{0}_{1}.png".format(path, size).encode(Constants.defaultCodec)).hexdigest()) def extractThumbnail(path, size="Default", From 67eb51fa9fb9d63b103ad5177444d484cb97514c Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Sun, 21 Apr 2013 23:12:00 +0200 Subject: [PATCH 03/54] Update various docstrings. --- utilities/getDependenciesInformations.py | 2 +- utilities/getHDRLabsDocumentation.py | 2 +- utilities/getPackagePath.py | 2 +- utilities/getSphinxDocumentationApi.py | 2 +- utilities/getSphinxDocumentationTocTree.py | 2 +- utilities/listImports.py | 2 +- utilities/reStructuredTextToHtml.py | 2 +- utilities/recursiveRemove.py | 2 +- utilities/sliceDocumentation.py | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) diff --git a/utilities/getDependenciesInformations.py b/utilities/getDependenciesInformations.py index f2a3a182..d6a84d0c 100755 --- a/utilities/getDependenciesInformations.py +++ b/utilities/getDependenciesInformations.py @@ -2,7 +2,7 @@ # -*- coding: utf-8 -*- """ -**getDependenciesInformations.py +**getDependenciesInformations.py** **Platform:** Windows, Linux, Mac Os X. diff --git a/utilities/getHDRLabsDocumentation.py b/utilities/getHDRLabsDocumentation.py index 89bb8ab8..20638818 100644 --- a/utilities/getHDRLabsDocumentation.py +++ b/utilities/getHDRLabsDocumentation.py @@ -2,7 +2,7 @@ # -*- coding: utf-8 -*- """ -**getHDRLabsDocumentation.py +**getHDRLabsDocumentation.py** **Platform:** Windows, Linux, Mac Os X. diff --git a/utilities/getPackagePath.py b/utilities/getPackagePath.py index ef6ae608..1863920f 100755 --- a/utilities/getPackagePath.py +++ b/utilities/getPackagePath.py @@ -2,7 +2,7 @@ # -*- coding: utf-8 -*- """ -**getPackagePath.py +**getPackagePath.py** **Platform:** Windows, Linux, Mac Os X. diff --git a/utilities/getSphinxDocumentationApi.py b/utilities/getSphinxDocumentationApi.py index 198c070f..6133f235 100755 --- a/utilities/getSphinxDocumentationApi.py +++ b/utilities/getSphinxDocumentationApi.py @@ -2,7 +2,7 @@ # -*- coding: utf-8 -*- """ -**getSphinxDocumentationApi.py +**getSphinxDocumentationApi.py** **Platform:** Windows, Linux, Mac Os X. diff --git a/utilities/getSphinxDocumentationTocTree.py b/utilities/getSphinxDocumentationTocTree.py index c95a081e..7b04233d 100644 --- a/utilities/getSphinxDocumentationTocTree.py +++ b/utilities/getSphinxDocumentationTocTree.py @@ -2,7 +2,7 @@ # -*- coding: utf-8 -*- """ -**getSphinxDocumentationTocTree.py +**getSphinxDocumentationTocTree.py** **Platform:** Windows, Linux, Mac Os X. diff --git a/utilities/listImports.py b/utilities/listImports.py index 04161be7..5a8f6365 100644 --- a/utilities/listImports.py +++ b/utilities/listImports.py @@ -2,7 +2,7 @@ # -*- coding: utf-8 -*- """ -**listImports.py +**listImports.py** **Platform:** Windows, Linux, Mac Os X. diff --git a/utilities/reStructuredTextToHtml.py b/utilities/reStructuredTextToHtml.py index cd1a6a93..e6cf6da6 100644 --- a/utilities/reStructuredTextToHtml.py +++ b/utilities/reStructuredTextToHtml.py @@ -2,7 +2,7 @@ # -*- coding: utf-8 -*- """ -**reStructuredTextToHtml.py +**reStructuredTextToHtml.py** **Platform:** Windows, Linux, Mac Os X. diff --git a/utilities/recursiveRemove.py b/utilities/recursiveRemove.py index 6763dcea..f79ae5ba 100644 --- a/utilities/recursiveRemove.py +++ b/utilities/recursiveRemove.py @@ -2,7 +2,7 @@ # -*- coding: utf-8 -*- """ -**recursiveRemove.py +**recursiveRemove.py** **Platform:** Windows, Linux, Mac Os X. diff --git a/utilities/sliceDocumentation.py b/utilities/sliceDocumentation.py index 8ca02fb2..b6136734 100644 --- a/utilities/sliceDocumentation.py +++ b/utilities/sliceDocumentation.py @@ -2,7 +2,7 @@ # -*- coding: utf-8 -*- """ -**sliceDocumentation.py +**sliceDocumentation.py** **Platform:** Windows, Linux, Mac Os X. From 99a98dc1946305d1a77796a73650b9280aa1486c Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Mon, 22 Apr 2013 00:19:01 +0200 Subject: [PATCH 04/54] Update system encoding manipulation. --- setup.py | 4 +- sibl_gui/__init__.py | 45 ++++++++++++++++++++++ sibl_gui/globals/constants.py | 7 +++- sibl_gui/launcher.py | 16 +------- utilities/__init__.py | 45 ++++++++++++++++++++++ utilities/getHDRLabsDocumentation.py | 16 +------- utilities/getSphinxDocumentationApi.py | 18 +-------- utilities/getSphinxDocumentationTocTree.py | 16 +------- utilities/listImports.py | 16 +------- utilities/reStructuredTextToHtml.py | 16 +------- utilities/recursiveRemove.py | 16 +------- utilities/sliceDocumentation.py | 16 +------- 12 files changed, 107 insertions(+), 124 deletions(-) create mode 100644 utilities/__init__.py diff --git a/setup.py b/setup.py index b0696ba3..b66fc478 100644 --- a/setup.py +++ b/setup.py @@ -22,14 +22,14 @@ #********************************************************************************************************************** #*** Encoding manipulations. #********************************************************************************************************************** -import sys - def _setEncoding(): """ This definition sets the Application encoding. """ + import sys reload(sys) + sys.setdefaultencoding("utf-8") _setEncoding() diff --git a/sibl_gui/__init__.py b/sibl_gui/__init__.py index e69de29b..92eabcb4 100644 --- a/sibl_gui/__init__.py +++ b/sibl_gui/__init__.py @@ -0,0 +1,45 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- + +""" +**__init__.py** + +**Platform:** + Windows, Linux, Mac Os X. + +**Description:** + +**Others:** + +""" + +#********************************************************************************************************************** +#*** Module attributes. +#********************************************************************************************************************** +__author__ = "Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__license__ = "GPL V3.0 - http://www.gnu.org/licenses/" +__maintainer__ = "Thomas Mansencal" +__email__ = "thomas.mansencal@gmail.com" +__status__ = "Production" + +__all__ = ["DEFAULT_CODEC"] + +DEFAULT_CODEC = "utf-8" + +#********************************************************************************************************************** +#*** Encoding manipulations. +#********************************************************************************************************************** +def _setEncoding(): + """ + This definition sets the Application encoding. + """ + + import sys + reload(sys) + + sys.setdefaultencoding(DEFAULT_CODEC) + +_setEncoding() + + diff --git a/sibl_gui/globals/constants.py b/sibl_gui/globals/constants.py index 6be29248..7feb9e31 100644 --- a/sibl_gui/globals/constants.py +++ b/sibl_gui/globals/constants.py @@ -25,6 +25,11 @@ import os import platform +#********************************************************************************************************************** +#*** Internal imports. +#********************************************************************************************************************** +import sibl_gui + #********************************************************************************************************************** #*** Module attributes. #********************************************************************************************************************** @@ -59,7 +64,7 @@ class Constants(): logger = "sIBL_GUI_Logger" """Package logger name: '**sIBL_GUI_Logger**' ( String )""" - defaultCodec = "utf-8" + defaultCodec = sibl_gui.DEFAULT_CODEC """Default codec: '**utf-8**' ( String )""" codecError = "ignore" """Default codec error behavior: '**ignore**' ( String )""" diff --git a/sibl_gui/launcher.py b/sibl_gui/launcher.py index dc521fbc..1879a62b 100644 --- a/sibl_gui/launcher.py +++ b/sibl_gui/launcher.py @@ -20,25 +20,11 @@ #********************************************************************************************************************** from __future__ import unicode_literals -#********************************************************************************************************************** -#*** Encoding manipulations. -#********************************************************************************************************************** -import sys - -def _setEncoding(): - """ - This definition sets the Application encoding. - """ - - reload(sys) - sys.setdefaultencoding("utf-8") - -_setEncoding() - #********************************************************************************************************************** #*** External imports. #********************************************************************************************************************** import os +import sys from PyQt4.QtGui import QIcon from PyQt4.QtGui import QImage from PyQt4.QtGui import QPixmap diff --git a/utilities/__init__.py b/utilities/__init__.py new file mode 100644 index 00000000..92eabcb4 --- /dev/null +++ b/utilities/__init__.py @@ -0,0 +1,45 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- + +""" +**__init__.py** + +**Platform:** + Windows, Linux, Mac Os X. + +**Description:** + +**Others:** + +""" + +#********************************************************************************************************************** +#*** Module attributes. +#********************************************************************************************************************** +__author__ = "Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__license__ = "GPL V3.0 - http://www.gnu.org/licenses/" +__maintainer__ = "Thomas Mansencal" +__email__ = "thomas.mansencal@gmail.com" +__status__ = "Production" + +__all__ = ["DEFAULT_CODEC"] + +DEFAULT_CODEC = "utf-8" + +#********************************************************************************************************************** +#*** Encoding manipulations. +#********************************************************************************************************************** +def _setEncoding(): + """ + This definition sets the Application encoding. + """ + + import sys + reload(sys) + + sys.setdefaultencoding(DEFAULT_CODEC) + +_setEncoding() + + diff --git a/utilities/getHDRLabsDocumentation.py b/utilities/getHDRLabsDocumentation.py index 20638818..57d8dec6 100644 --- a/utilities/getHDRLabsDocumentation.py +++ b/utilities/getHDRLabsDocumentation.py @@ -19,25 +19,11 @@ #********************************************************************************************************************** from __future__ import unicode_literals -#********************************************************************************************************************** -#*** Encoding manipulations. -#********************************************************************************************************************** -import sys - -def _setEncoding(): - """ - This definition sets the Application encoding. - """ - - reload(sys) - sys.setdefaultencoding("utf-8") - -_setEncoding() - #********************************************************************************************************************** #*** External imports. #********************************************************************************************************************** import re +import sys #********************************************************************************************************************** #*** Internal imports. diff --git a/utilities/getSphinxDocumentationApi.py b/utilities/getSphinxDocumentationApi.py index 6133f235..5f0fee63 100755 --- a/utilities/getSphinxDocumentationApi.py +++ b/utilities/getSphinxDocumentationApi.py @@ -19,28 +19,14 @@ #********************************************************************************************************************** from __future__ import unicode_literals -#********************************************************************************************************************** -#*** Encoding manipulations. -#********************************************************************************************************************** -import sys - -def _setEncoding(): - """ - This definition sets the Application encoding. - """ - - reload(sys) - sys.setdefaultencoding("utf-8") - -_setEncoding() - #********************************************************************************************************************** #*** External imports. #********************************************************************************************************************** import os import re import shutil -if sys.version_info[:2] <= (2, 6): +import sys +f sys.version_info[:2] <= (2, 6): from ordereddict import OrderedDict else: from collections import OrderedDict diff --git a/utilities/getSphinxDocumentationTocTree.py b/utilities/getSphinxDocumentationTocTree.py index 7b04233d..56bf95a4 100644 --- a/utilities/getSphinxDocumentationTocTree.py +++ b/utilities/getSphinxDocumentationTocTree.py @@ -19,27 +19,13 @@ #********************************************************************************************************************** from __future__ import unicode_literals -#********************************************************************************************************************** -#*** Encoding manipulations. -#********************************************************************************************************************** -import sys - -def _setEncoding(): - """ - This definition sets the Application encoding. - """ - - reload(sys) - sys.setdefaultencoding("utf-8") - -_setEncoding() - #********************************************************************************************************************** #*** External imports. #********************************************************************************************************************** import glob import os import re +import sys if sys.version_info[:2] <= (2, 6): from ordereddict import OrderedDict else: diff --git a/utilities/listImports.py b/utilities/listImports.py index 5a8f6365..5352ebaf 100644 --- a/utilities/listImports.py +++ b/utilities/listImports.py @@ -19,25 +19,11 @@ #********************************************************************************************************************** from __future__ import unicode_literals -#********************************************************************************************************************** -#*** Encoding manipulations. -#********************************************************************************************************************** -import sys - -def _setEncoding(): - """ - This definition sets the Application encoding. - """ - - reload(sys) - sys.setdefaultencoding("utf-8") - -_setEncoding() - #********************************************************************************************************************** #*** External imports. #********************************************************************************************************************** import re +import sys #********************************************************************************************************************** #*** Internal imports. diff --git a/utilities/reStructuredTextToHtml.py b/utilities/reStructuredTextToHtml.py index e6cf6da6..917e04fd 100644 --- a/utilities/reStructuredTextToHtml.py +++ b/utilities/reStructuredTextToHtml.py @@ -19,25 +19,11 @@ #********************************************************************************************************************** from __future__ import unicode_literals -#********************************************************************************************************************** -#*** Encoding manipulations. -#********************************************************************************************************************** -import sys - -def _setEncoding(): - """ - This definition sets the Application encoding. - """ - - reload(sys) - sys.setdefaultencoding("utf-8") - -_setEncoding() - #********************************************************************************************************************** #*** External imports. #********************************************************************************************************************** import os +import sys #********************************************************************************************************************** #*** Internal imports. diff --git a/utilities/recursiveRemove.py b/utilities/recursiveRemove.py index f79ae5ba..4bd329d6 100644 --- a/utilities/recursiveRemove.py +++ b/utilities/recursiveRemove.py @@ -19,25 +19,11 @@ #********************************************************************************************************************** from __future__ import unicode_literals -#********************************************************************************************************************** -#*** Encoding manipulations. -#********************************************************************************************************************** -import sys - -def _setEncoding(): - """ - This definition sets the Application encoding. - """ - - reload(sys) - sys.setdefaultencoding("utf-8") - -_setEncoding() - #********************************************************************************************************************** #*** External imports. #********************************************************************************************************************** import os +import sys #********************************************************************************************************************** #*** Module attributes. diff --git a/utilities/sliceDocumentation.py b/utilities/sliceDocumentation.py index b6136734..3f232420 100644 --- a/utilities/sliceDocumentation.py +++ b/utilities/sliceDocumentation.py @@ -19,26 +19,12 @@ #********************************************************************************************************************** from __future__ import unicode_literals -#********************************************************************************************************************** -#*** Encoding manipulations. -#********************************************************************************************************************** -import sys - -def _setEncoding(): - """ - This definition sets the Application encoding. - """ - - reload(sys) - sys.setdefaultencoding("utf-8") - -_setEncoding() - #********************************************************************************************************************** #*** External imports. #********************************************************************************************************************** import os import re +import sys if sys.version_info[:2] <= (2, 6): from ordereddict import OrderedDict else: From d351faa9c4bfea48a0077b406a3c7a8e0aeb8ea7 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Mon, 22 Apr 2013 00:24:54 +0200 Subject: [PATCH 05/54] Update various docstrings. --- setup.py | 2 +- sibl_gui/__init__.py | 2 +- utilities/__init__.py | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/setup.py b/setup.py index b66fc478..d60237d3 100644 --- a/setup.py +++ b/setup.py @@ -24,7 +24,7 @@ #********************************************************************************************************************** def _setEncoding(): """ - This definition sets the Application encoding. + This definition sets the Package encoding. """ import sys diff --git a/sibl_gui/__init__.py b/sibl_gui/__init__.py index 92eabcb4..410331ef 100644 --- a/sibl_gui/__init__.py +++ b/sibl_gui/__init__.py @@ -32,7 +32,7 @@ #********************************************************************************************************************** def _setEncoding(): """ - This definition sets the Application encoding. + This definition sets the Package encoding. """ import sys diff --git a/utilities/__init__.py b/utilities/__init__.py index 92eabcb4..410331ef 100644 --- a/utilities/__init__.py +++ b/utilities/__init__.py @@ -32,7 +32,7 @@ #********************************************************************************************************************** def _setEncoding(): """ - This definition sets the Application encoding. + This definition sets the Package encoding. """ import sys From 8d04085f2bf9c0607fe3e155785a6c1f02efc776 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Fri, 26 Apr 2013 21:32:44 +0100 Subject: [PATCH 06/54] Refactor various override and settings definition into "sibl_gui.launcher.sIBL_GUI" class methods. --- sibl_gui/launcher.py | 133 +++++++++++++++++++++++++------------------ 1 file changed, 77 insertions(+), 56 deletions(-) diff --git a/sibl_gui/launcher.py b/sibl_gui/launcher.py index 1879a62b..d3822d78 100644 --- a/sibl_gui/launcher.py +++ b/sibl_gui/launcher.py @@ -85,27 +85,18 @@ def _overrideDependenciesGlobals(): _overrideDependenciesGlobals() -import umbra.ui.widgets.application_QToolBar -import sibl_gui.ui.widgets.application_QToolBar - -def _overrideApplicationToolbar(): - """ - This definition overrides Application toolbar. - """ - - umbra.ui.widgets.application_QToolBar.Application_QToolBar = \ - sibl_gui.ui.widgets.application_QToolBar.Application_QToolBar - -_overrideApplicationToolbar() - #********************************************************************************************************************** #*** Internal imports. #********************************************************************************************************************** import foundations.common import foundations.verbose +import sibl_gui.ui.models +import sibl_gui.ui.caches +import sibl_gui.ui.widgets.application_QToolBar import umbra.engine import umbra.ui.common import umbra.ui.models +import umbra.ui.widgets.application_QToolBar #********************************************************************************************************************** #*** Module attributes. @@ -124,45 +115,6 @@ def _overrideApplicationToolbar(): #********************************************************************************************************************** #*** Module classes and definitions. #********************************************************************************************************************** - -#********************************************************************************************************************** -#*** Thumbnails cache settings. -#********************************************************************************************************************** -def _setThumbnailsCache(): - """ - This definition sets the Application thumbnails cache. - """ - - umbra.globals.runtimeGlobals.RuntimeGlobals.thumbnailsCacheDirectory = os.path.join( - foundations.environment.getUserApplicationDataDirectory(), - umbra.globals.constants.Constants.ioDirectory, - umbra.globals.uiConstants.UiConstants.thumbnailsCacheDirectory) - -_setThumbnailsCache() - -#********************************************************************************************************************** -#*** Images caches settings. -#********************************************************************************************************************** -import sibl_gui.ui.caches -import sibl_gui.ui.models - -def _setImagesCaches(): - """ - This definition sets the Application images caches. - """ - - loadingImage = umbra.ui.common.getResourcePath(umbra.globals.uiConstants.UiConstants.loadingImage) - umbra.globals.runtimeGlobals.RuntimeGlobals.imagesCaches = foundations.dataStructures.Structure(**{ - "QImage":sibl_gui.ui.caches.AsynchronousGraphicsItemsCache(type=QImage, placeholder=loadingImage), - "QPixmap":sibl_gui.ui.caches.AsynchronousGraphicsItemsCache(type=QPixmap, placeholder=loadingImage), - "QIcon":sibl_gui.ui.caches.AsynchronousGraphicsItemsCache(type=QIcon, placeholder=loadingImage)}) - - # Override "umbra.ui.models.GraphModel.data" method to use "sibl_gui.ui.models.GraphModel.data" method - # with asynchronous images loading. - setattr(umbra.ui.models.GraphModel, "data", umbra.ui.models.GraphModel.data) - -_setImagesCaches() - class sIBL_GUI(umbra.engine.Umbra): """ This class is the main class of the **sIBL_GUI** package. @@ -187,6 +139,8 @@ def __init__(self, LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) + # --- Setting class attributes. --- + self.__thumbnailsCacheDirectory = None self.__imagesCaches = None umbra.engine.Umbra.__init__(self, @@ -200,12 +154,44 @@ def __init__(self, #****************************************************************************************************************** #*** Attributes properties. #****************************************************************************************************************** + @property + def thumbnailsCacheDirectory(self): + """ + This method is the property for **self.__thumbnailsCacheDirectory** attribute. + + :return: self.__thumbnailsCacheDirectory. ( String ) + """ + + return self.__thumbnailsCacheDirectory + + @thumbnailsCacheDirectory.setter + @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) + def thumbnailsCacheDirectory(self, value): + """ + This method is the setter method for **self.__thumbnailsCacheDirectory** attribute. + + :param value: Attribute value. ( String ) + """ + + raise foundations.exceptions.ProgrammingError( + "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "thumbnailsCacheDirectory")) + + @thumbnailsCacheDirectory.deleter + @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) + def thumbnailsCacheDirectory(self): + """ + This method is the deleter method for **self.__thumbnailsCacheDirectory** attribute. + """ + + raise foundations.exceptions.ProgrammingError( + "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "thumbnailsCacheDirectory")) + @property def imagesCaches(self): """ This method is the property for **self.__imagesCaches** attribute. - :return: self.__imagesCaches. ( Cache ) + :return: self.__imagesCaches. ( Structure ) """ return self.__imagesCaches @@ -216,7 +202,7 @@ def imagesCaches(self, value): """ This method is the setter method for **self.__imagesCaches** attribute. - :param value: Attribute value. ( Cache ) + :param value: Attribute value. ( Structure ) """ raise foundations.exceptions.ProgrammingError( @@ -235,13 +221,48 @@ def imagesCaches(self): #****************************************************************************************************************** #*** Class methods. #****************************************************************************************************************** + def __overrideApplicationToolbar(self): + """ + This method overrides the Application toolbar. + """ + + umbra.ui.widgets.application_QToolBar.Application_QToolBar = \ + sibl_gui.ui.widgets.application_QToolBar.Application_QToolBar + + def __setThumbnailsCacheDirectory(self): + """ + This method sets the Application thumbnails cache directory. + """ + + self.__thumbnailsCacheDirectory = umbra.globals.runtimeGlobals.RuntimeGlobals.thumbnailsCacheDirectory = \ + os.path.join(umbra.globals.runtimeGlobals.RuntimeGlobals.userApplicationDataDirectory, + umbra.globals.constants.Constants.ioDirectory, + umbra.globals.uiConstants.UiConstants.thumbnailsCacheDirectory) + + def __setImagesCaches(self): + """ + This method sets the Application images caches. + """ + + loadingImage = umbra.ui.common.getResourcePath(umbra.globals.uiConstants.UiConstants.loadingImage) + self.__imagesCaches = umbra.globals.runtimeGlobals.RuntimeGlobals.imagesCaches = \ + foundations.dataStructures.Structure(**{ + "QImage":sibl_gui.ui.caches.AsynchronousGraphicsItemsCache(type=QImage, placeholder=loadingImage), + "QPixmap":sibl_gui.ui.caches.AsynchronousGraphicsItemsCache(type=QPixmap, placeholder=loadingImage), + "QIcon":sibl_gui.ui.caches.AsynchronousGraphicsItemsCache(type=QIcon, placeholder=loadingImage)}) + + # Override "umbra.ui.models.GraphModel.data" method to use "sibl_gui.ui.models.GraphModel.data" method + # with asynchronous images loading. + setattr(umbra.ui.models.GraphModel, "data", umbra.ui.models.GraphModel.data) + def onPreInitialisation(self): """ This method is called by the :class:`umbra.engine.Umbra` class before Application main class initialisation. """ - # Binding Application images caches. - self.__imagesCaches = umbra.globals.runtimeGlobals.RuntimeGlobals.imagesCaches + self.__overrideApplicationToolbar() + self.__setThumbnailsCacheDirectory() + self.__setImagesCaches() def onPostInitialisation(self): """ From 3fc5f81c5728a9ec104873f36e5b3b67e48116c5 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Sun, 28 Apr 2013 22:23:26 +0200 Subject: [PATCH 07/54] Update various "umbra.ui.widgets.messageBox.messageBox" definition calls. --- sibl_gui/resources/patches/001_migrate_3-x-x_to_4-0-0.py | 6 +++--- sibl_gui/resources/patches/003_migrate_4-x-x_to_4-0-3.py | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/sibl_gui/resources/patches/001_migrate_3-x-x_to_4-0-0.py b/sibl_gui/resources/patches/001_migrate_3-x-x_to_4-0-0.py index bf69bf2e..f78fa511 100644 --- a/sibl_gui/resources/patches/001_migrate_3-x-x_to_4-0-0.py +++ b/sibl_gui/resources/patches/001_migrate_3-x-x_to_4-0-0.py @@ -96,7 +96,7 @@ def apply(): message = "A previous sIBL_GUI database file has been found: '{0}'!\n\n\ Would you like to migrate it toward sIBL_GUI 4.0.0?".format( legacyDatabaseFile) - if umbra.ui.widgets.messageBox.messageBox("Question", "sIBL_GUI | Question", + if umbra.ui.widgets.messageBox.messageBox("Question", "Question", message, buttons=QMessageBox.Yes | QMessageBox.No) == QMessageBox.Yes: try: @@ -107,14 +107,14 @@ def apply(): except: message = "{0} | Critical exception raised while copying '{1}' database file to '{2}' destination!\n\n\ sIBL_GUI will now exit!".format(__name__, legacyDatabaseFile, databaseFile) - umbra.ui.widgets.messageBox.messageBox("Critical", "sIBL_GUI | Critical", message) + umbra.ui.widgets.messageBox.messageBox("Critical", "Critical", message) foundations.core.exit(1) if RuntimeGlobals.parameters.databaseDirectory: deprecatedDatabaseDirectory = os.path.join(databaseDirectory, "backup", "deprecated") message = "The previous sIBL_GUI database file will be backuped into the following directory: '{0}'.".format( deprecatedDatabaseDirectory) - umbra.ui.widgets.messageBox.messageBox("Information", "sIBL_GUI | Information", message) + umbra.ui.widgets.messageBox.messageBox("Information", "Information", message) os.makedirs(deprecatedDatabaseDirectory) shutil.move(legacyDatabaseFile, os.path.join(deprecatedDatabaseDirectory, os.path.basename(legacyDatabaseFile))) diff --git a/sibl_gui/resources/patches/003_migrate_4-x-x_to_4-0-3.py b/sibl_gui/resources/patches/003_migrate_4-x-x_to_4-0-3.py index b34a2b0e..d7c7e59f 100644 --- a/sibl_gui/resources/patches/003_migrate_4-x-x_to_4-0-3.py +++ b/sibl_gui/resources/patches/003_migrate_4-x-x_to_4-0-3.py @@ -61,7 +61,7 @@ def apply(): """ umbra.ui.widgets.messageBox.messageBox("Information", - "sIBL_GUI | Message", + "Message", "Hello!\n\nUpon startup and from now on, sIBL_GUI will attempt to connect to \ https://www.crittercism.com/ to report unhandled exceptions whenever they occur!\n\nThis message will only display once!") From 3b0b3202a4b88615f4df4aab1aa7cc2771808785 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Sun, 28 Apr 2013 22:23:56 +0200 Subject: [PATCH 08/54] Raise package release version number to "4.0.8". --- releases/sIBL_GUI_Releases.rc | 2 +- sibl_gui/globals/constants.py | 6 +++--- utilities/actualInstaller/sIBL_GUI.aip | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/releases/sIBL_GUI_Releases.rc b/releases/sIBL_GUI_Releases.rc index 69dcc4c2..1b7b54f1 100644 --- a/releases/sIBL_GUI_Releases.rc +++ b/releases/sIBL_GUI_Releases.rc @@ -1,4 +1,4 @@ [sIBL_GUI] -Release = 4.0.7 +Release = 4.0.8 Url = Windows | "http://kelsolaar.hdrlabs.com/sIBL_GUI/Repository/Builds/Windows/Stable/sIBL_GUI.exe" | Mac Os X | "http://kelsolaar.hdrlabs.com/sIBL_GUI/Repository/Builds/Darwin/Stable/sIBL_GUI.dmg" | Linux | "http://kelsolaar.hdrlabs.com/sIBL_GUI/Repository/Builds/Linux/Nightly/sIBL_GUI.tar.gz" Type = "Stable" diff --git a/sibl_gui/globals/constants.py b/sibl_gui/globals/constants.py index 7feb9e31..3d20a694 100644 --- a/sibl_gui/globals/constants.py +++ b/sibl_gui/globals/constants.py @@ -56,10 +56,10 @@ class Constants(): """Package major version: '**4**' ( String )""" minorVersion = "0" """Package minor version: '**0**' ( String )""" - changeVersion = "7" - """Package change version: '**7**' ( String )""" + changeVersion = "8" + """Package change version: '**8**' ( String )""" releaseVersion = ".".join((majorVersion, minorVersion, changeVersion)) - """Package release version: '**4.0.7**' ( String )""" + """Package release version: '**4.0.8**' ( String )""" logger = "sIBL_GUI_Logger" """Package logger name: '**sIBL_GUI_Logger**' ( String )""" diff --git a/utilities/actualInstaller/sIBL_GUI.aip b/utilities/actualInstaller/sIBL_GUI.aip index 1510dfbd..26be8cb1 100644 --- a/utilities/actualInstaller/sIBL_GUI.aip +++ b/utilities/actualInstaller/sIBL_GUI.aip @@ -2,7 +2,7 @@ Version=4.5 Edition=0 AppName=sIBL_GUI -AppVersion=4.0.7 +AppVersion=4.0.8 CompanyName=HDRLabs WebSite=http://www.hdrlabs.com/ SupportLink=mailto:thomas.mansencal@gmail.com From dd3a44a642603cacaf0caa6d064ca24575ea500c Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Sun, 28 Apr 2013 22:49:04 +0200 Subject: [PATCH 09/54] Update "utilities.darwinBuild.sh" Darwin Os build file. --- utilities/darwinBuild.sh | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/utilities/darwinBuild.sh b/utilities/darwinBuild.sh index 993129d4..cb50f62b 100755 --- a/utilities/darwinBuild.sh +++ b/utilities/darwinBuild.sh @@ -14,7 +14,6 @@ export SOURCE=$PROJECT/ export RELEASES=$PROJECT/releases/Darwin export DISTRIBUTION=$RELEASES/dist export BUILD=$RELEASES/build -export BASE=$DISTRIBUTION/launcher.app export BUNDLE=$DISTRIBUTION/sIBL_GUI\ $MAJOR_VERSION.app export DEPENDENCIES=$BUNDLE/Contents/MacOS export RESOURCES=$BUNDLE/Contents/Resources @@ -42,7 +41,9 @@ echo --------------------------------------------------------------------------- echo ------------------------------------------------------------------------------- echo Build - Begin echo ------------------------------------------------------------------------------- -python $PYINSTALLER/pyinstaller.py --noconfirm --noconsole -o releases/Darwin --hidden-import=ConfigParser --hidden-import=PyQt4 --hidden-import=PyQt4.QtCore --hidden-import=PyQt4.QtGui --hidden-import=PyQt4.QtNetwork --hidden-import=PyQt4.QtWebKit --hidden-import=PyQt4.uic --hidden-import=PyQt4.uic.Compiler --hidden-import=PyQt4.uic.Compiler.PyQt4 --hidden-import=PyQt4.uic.Compiler.compiler --hidden-import=PyQt4.uic.Compiler.indenter --hidden-import=PyQt4.uic.Compiler.logging --hidden-import=PyQt4.uic.Compiler.misc --hidden-import=PyQt4.uic.Compiler.proxy_metaclass --hidden-import=PyQt4.uic.Compiler.qobjectcreator --hidden-import=PyQt4.uic.Compiler.qtproxies --hidden-import=PyQt4.uic.Compiler.re --hidden-import=PyQt4.uic.Compiler.sys --hidden-import=PyQt4.uic.PyQt4 --hidden-import=PyQt4.uic.exceptions --hidden-import=PyQt4.uic.icon_cache --hidden-import=PyQt4.uic.logging --hidden-import=PyQt4.uic.objcreator --hidden-import=PyQt4.uic.os --hidden-import=PyQt4.uic.port_v2 --hidden-import=PyQt4.uic.port_v2.PyQt4 --hidden-import=PyQt4.uic.port_v2.as_string --hidden-import=PyQt4.uic.port_v2.ascii_upper --hidden-import=PyQt4.uic.port_v2.cStringIO --hidden-import=PyQt4.uic.port_v2.load_plugin --hidden-import=PyQt4.uic.port_v2.proxy_base --hidden-import=PyQt4.uic.port_v2.re --hidden-import=PyQt4.uic.port_v2.string --hidden-import=PyQt4.uic.port_v2.string_io --hidden-import=PyQt4.uic.properties --hidden-import=PyQt4.uic.re --hidden-import=PyQt4.uic.sys --hidden-import=PyQt4.uic.uiparser --hidden-import=PyQt4.uic.xml --hidden-import=Queue --hidden-import=SocketServer --hidden-import=StringIO --hidden-import=UserDict --hidden-import=__builtin__ --hidden-import=__future__ --hidden-import=__main__ --hidden-import=_abcoll --hidden-import=_ast --hidden-import=_bisect --hidden-import=_codecs --hidden-import=_collections --hidden-import=_ctypes --hidden-import=_functools --hidden-import=_hashlib --hidden-import=_heapq --hidden-import=_io --hidden-import=_locale --hidden-import=_random --hidden-import=_scproxy --hidden-import=_socket --hidden-import=_sqlite3 --hidden-import=_sre --hidden-import=_ssl --hidden-import=_struct --hidden-import=_virtualenv_distutils --hidden-import=_warnings --hidden-import=_weakref --hidden-import=_weakrefset --hidden-import=abc --hidden-import=array --hidden-import=ast --hidden-import=atexit --hidden-import=base64 --hidden-import=binascii --hidden-import=bisect --hidden-import=cPickle --hidden-import=cStringIO --hidden-import=cgi --hidden-import=code --hidden-import=codecs --hidden-import=codeop --hidden-import=collections --hidden-import=contextlib --hidden-import=copy --hidden-import=copy_reg --hidden-import=ctypes --hidden-import=ctypes._ctypes --hidden-import=ctypes._endian --hidden-import=ctypes.ctypes --hidden-import=ctypes.macholib --hidden-import=ctypes.macholib.dyld --hidden-import=ctypes.macholib.dylib --hidden-import=ctypes.macholib.framework --hidden-import=ctypes.macholib.itertools --hidden-import=ctypes.macholib.os --hidden-import=ctypes.macholib.re --hidden-import=ctypes.os --hidden-import=ctypes.struct --hidden-import=ctypes.sys --hidden-import=ctypes.util --hidden-import=datetime --hidden-import=decimal --hidden-import=decorator --hidden-import=dis --hidden-import=distutils --hidden-import=distutils.debug --hidden-import=distutils.dep_util --hidden-import=distutils.dist --hidden-import=distutils.distutils --hidden-import=distutils.email --hidden-import=distutils.errors --hidden-import=distutils.fancy_getopt --hidden-import=distutils.getopt --hidden-import=distutils.imp --hidden-import=distutils.log --hidden-import=distutils.opcode --hidden-import=distutils.os --hidden-import=distutils.re --hidden-import=distutils.spawn --hidden-import=distutils.stat --hidden-import=distutils.string --hidden-import=distutils.sys --hidden-import=distutils.sysconfig --hidden-import=distutils.text_file --hidden-import=distutils.util --hidden-import=distutils.warnings --hidden-import=email --hidden-import=email.Charset --hidden-import=email.Encoders --hidden-import=email.Errors --hidden-import=email.FeedParser --hidden-import=email.Generator --hidden-import=email.Header --hidden-import=email.Iterators --hidden-import=email.MIMEAudio --hidden-import=email.MIMEBase --hidden-import=email.MIMEImage --hidden-import=email.MIMEMessage --hidden-import=email.MIMEMultipart --hidden-import=email.MIMENonMultipart --hidden-import=email.MIMEText --hidden-import=email.Message --hidden-import=email.Parser --hidden-import=email.Utils --hidden-import=email._parseaddr --hidden-import=email.base64 --hidden-import=email.base64MIME --hidden-import=email.base64mime --hidden-import=email.binascii --hidden-import=email.cStringIO --hidden-import=email.charset --hidden-import=email.codecs --hidden-import=email.email --hidden-import=email.encoders --hidden-import=email.errors --hidden-import=email.feedparser --hidden-import=email.generator --hidden-import=email.header --hidden-import=email.iterators --hidden-import=email.message --hidden-import=email.mime --hidden-import=email.mime.audio --hidden-import=email.mime.base --hidden-import=email.mime.cStringIO --hidden-import=email.mime.email --hidden-import=email.mime.image --hidden-import=email.mime.imghdr --hidden-import=email.mime.message --hidden-import=email.mime.multipart --hidden-import=email.mime.nonmultipart --hidden-import=email.mime.sndhdr --hidden-import=email.mime.text --hidden-import=email.os --hidden-import=email.parser --hidden-import=email.quopri --hidden-import=email.quopriMIME --hidden-import=email.quoprimime --hidden-import=email.random --hidden-import=email.re --hidden-import=email.socket --hidden-import=email.string --hidden-import=email.sys --hidden-import=email.time --hidden-import=email.urllib --hidden-import=email.utils --hidden-import=email.uu --hidden-import=email.warnings --hidden-import=encodings --hidden-import=encodings.__builtin__ --hidden-import=encodings.aliases --hidden-import=encodings.ascii --hidden-import=encodings.codecs --hidden-import=encodings.encodings --hidden-import=encodings.utf_8 --hidden-import=errno --hidden-import=exceptions --hidden-import=fcntl --hidden-import=fnmatch --hidden-import=functools --hidden-import=gc --hidden-import=genericpath --hidden-import=getopt --hidden-import=getpass --hidden-import=gettext --hidden-import=grp --hidden-import=hashlib --hidden-import=heapq --hidden-import=httplib --hidden-import=imghdr --hidden-import=imp --hidden-import=inspect --hidden-import=io --hidden-import=itertools --hidden-import=keyword --hidden-import=linecache --hidden-import=locale --hidden-import=logging --hidden-import=logging.atexit --hidden-import=logging.cStringIO --hidden-import=logging.codecs --hidden-import=logging.os --hidden-import=logging.sys --hidden-import=logging.thread --hidden-import=logging.threading --hidden-import=logging.time --hidden-import=logging.traceback --hidden-import=logging.warnings --hidden-import=logging.weakref --hidden-import=logilab --hidden-import=marshal --hidden-import=math --hidden-import=migrate --hidden-import=migrate.changeset --hidden-import=migrate.changeset.StringIO --hidden-import=migrate.changeset.UserDict --hidden-import=migrate.changeset.ansisql --hidden-import=migrate.changeset.constraint --hidden-import=migrate.changeset.databases --hidden-import=migrate.changeset.databases.UserDict --hidden-import=migrate.changeset.databases.copy --hidden-import=migrate.changeset.databases.firebird --hidden-import=migrate.changeset.databases.migrate --hidden-import=migrate.changeset.databases.mysql --hidden-import=migrate.changeset.databases.oracle --hidden-import=migrate.changeset.databases.postgres --hidden-import=migrate.changeset.databases.sqlalchemy --hidden-import=migrate.changeset.databases.sqlite --hidden-import=migrate.changeset.databases.visitor --hidden-import=migrate.changeset.migrate --hidden-import=migrate.changeset.re --hidden-import=migrate.changeset.schema --hidden-import=migrate.changeset.sqlalchemy --hidden-import=migrate.changeset.warnings --hidden-import=migrate.exceptions --hidden-import=migrate.migrate --hidden-import=migrate.versioning --hidden-import=migrate.versioning.ConfigParser --hidden-import=migrate.versioning.api --hidden-import=migrate.versioning.cfgparse --hidden-import=migrate.versioning.config --hidden-import=migrate.versioning.datetime --hidden-import=migrate.versioning.genmodel --hidden-import=migrate.versioning.inspect --hidden-import=migrate.versioning.logging --hidden-import=migrate.versioning.migrate --hidden-import=migrate.versioning.os --hidden-import=migrate.versioning.pathed --hidden-import=migrate.versioning.pkg_resources --hidden-import=migrate.versioning.re --hidden-import=migrate.versioning.repository --hidden-import=migrate.versioning.schema --hidden-import=migrate.versioning.schemadiff --hidden-import=migrate.versioning.script --hidden-import=migrate.versioning.script.StringIO --hidden-import=migrate.versioning.script.base --hidden-import=migrate.versioning.script.inspect --hidden-import=migrate.versioning.script.logging --hidden-import=migrate.versioning.script.migrate --hidden-import=migrate.versioning.script.py --hidden-import=migrate.versioning.script.shutil --hidden-import=migrate.versioning.script.sql --hidden-import=migrate.versioning.script.warnings --hidden-import=migrate.versioning.shutil --hidden-import=migrate.versioning.sqlalchemy --hidden-import=migrate.versioning.string --hidden-import=migrate.versioning.sys --hidden-import=migrate.versioning.tempita --hidden-import=migrate.versioning.template --hidden-import=migrate.versioning.util --hidden-import=migrate.versioning.util.decorator --hidden-import=migrate.versioning.util.importpath --hidden-import=migrate.versioning.util.keyedinstance --hidden-import=migrate.versioning.util.logging --hidden-import=migrate.versioning.util.migrate --hidden-import=migrate.versioning.util.os --hidden-import=migrate.versioning.util.pkg_resources --hidden-import=migrate.versioning.util.sqlalchemy --hidden-import=migrate.versioning.util.sys --hidden-import=migrate.versioning.util.warnings --hidden-import=migrate.versioning.version --hidden-import=mimetools --hidden-import=new --hidden-import=numbers --hidden-import=opcode --hidden-import=operator --hidden-import=optparse --hidden-import=os --hidden-import=os.path --hidden-import=pickle --hidden-import=pkg_resources --hidden-import=pkgutil --hidden-import=platform --hidden-import=plistlib --hidden-import=posix --hidden-import=posixpath --hidden-import=pwd --hidden-import=pyexpat --hidden-import=pyexpat.errors --hidden-import=pyexpat.model --hidden-import=quopri --hidden-import=random --hidden-import=re --hidden-import=rfc822 --hidden-import=select --hidden-import=sets --hidden-import=shutil --hidden-import=signal --hidden-import=sip --hidden-import=site --hidden-import=sitecustomize --hidden-import=sndhdr --hidden-import=socket --hidden-import=sqlalchemy --hidden-import=sqlalchemy.codecs --hidden-import=sqlalchemy.collections --hidden-import=sqlalchemy.connectors --hidden-import=sqlalchemy.connectors.mxodbc --hidden-import=sqlalchemy.connectors.mysqldb --hidden-import=sqlalchemy.connectors.pyodbc --hidden-import=sqlalchemy.connectors.re --hidden-import=sqlalchemy.connectors.sqlalchemy --hidden-import=sqlalchemy.connectors.sys --hidden-import=sqlalchemy.connectors.urllib --hidden-import=sqlalchemy.connectors.warnings --hidden-import=sqlalchemy.connectors.zxJDBC --hidden-import=sqlalchemy.cprocessors --hidden-import=sqlalchemy.cresultproxy --hidden-import=sqlalchemy.databases --hidden-import=sqlalchemy.databases.sqlalchemy --hidden-import=sqlalchemy.datetime --hidden-import=sqlalchemy.dialects --hidden-import=sqlalchemy.dialects.access --hidden-import=sqlalchemy.dialects.access.base --hidden-import=sqlalchemy.dialects.access.sqlalchemy --hidden-import=sqlalchemy.dialects.drizzle --hidden-import=sqlalchemy.dialects.drizzle.base --hidden-import=sqlalchemy.dialects.drizzle.mysqldb --hidden-import=sqlalchemy.dialects.drizzle.sqlalchemy --hidden-import=sqlalchemy.dialects.firebird --hidden-import=sqlalchemy.dialects.firebird.base --hidden-import=sqlalchemy.dialects.firebird.datetime --hidden-import=sqlalchemy.dialects.firebird.kinterbasdb --hidden-import=sqlalchemy.dialects.firebird.re --hidden-import=sqlalchemy.dialects.firebird.sqlalchemy --hidden-import=sqlalchemy.dialects.informix --hidden-import=sqlalchemy.dialects.informix.base --hidden-import=sqlalchemy.dialects.informix.datetime --hidden-import=sqlalchemy.dialects.informix.informixdb --hidden-import=sqlalchemy.dialects.informix.re --hidden-import=sqlalchemy.dialects.informix.sqlalchemy --hidden-import=sqlalchemy.dialects.maxdb --hidden-import=sqlalchemy.dialects.maxdb.base --hidden-import=sqlalchemy.dialects.maxdb.datetime --hidden-import=sqlalchemy.dialects.maxdb.itertools --hidden-import=sqlalchemy.dialects.maxdb.re --hidden-import=sqlalchemy.dialects.maxdb.sapdb --hidden-import=sqlalchemy.dialects.maxdb.sqlalchemy --hidden-import=sqlalchemy.dialects.mssql --hidden-import=sqlalchemy.dialects.mssql.adodbapi --hidden-import=sqlalchemy.dialects.mssql.base --hidden-import=sqlalchemy.dialects.mssql.datetime --hidden-import=sqlalchemy.dialects.mssql.decimal --hidden-import=sqlalchemy.dialects.mssql.information_schema --hidden-import=sqlalchemy.dialects.mssql.mxodbc --hidden-import=sqlalchemy.dialects.mssql.operator --hidden-import=sqlalchemy.dialects.mssql.pymssql --hidden-import=sqlalchemy.dialects.mssql.pyodbc --hidden-import=sqlalchemy.dialects.mssql.re --hidden-import=sqlalchemy.dialects.mssql.sqlalchemy --hidden-import=sqlalchemy.dialects.mssql.sys --hidden-import=sqlalchemy.dialects.mssql.zxjdbc --hidden-import=sqlalchemy.dialects.mysql --hidden-import=sqlalchemy.dialects.mysql.array --hidden-import=sqlalchemy.dialects.mysql.base --hidden-import=sqlalchemy.dialects.mysql.datetime --hidden-import=sqlalchemy.dialects.mysql.inspect --hidden-import=sqlalchemy.dialects.mysql.mysqlconnector --hidden-import=sqlalchemy.dialects.mysql.mysqldb --hidden-import=sqlalchemy.dialects.mysql.oursql --hidden-import=sqlalchemy.dialects.mysql.pymysql --hidden-import=sqlalchemy.dialects.mysql.pyodbc --hidden-import=sqlalchemy.dialects.mysql.re --hidden-import=sqlalchemy.dialects.mysql.sqlalchemy --hidden-import=sqlalchemy.dialects.mysql.sys --hidden-import=sqlalchemy.dialects.mysql.zxjdbc --hidden-import=sqlalchemy.dialects.oracle --hidden-import=sqlalchemy.dialects.oracle.base --hidden-import=sqlalchemy.dialects.oracle.collections --hidden-import=sqlalchemy.dialects.oracle.cx_oracle --hidden-import=sqlalchemy.dialects.oracle.datetime --hidden-import=sqlalchemy.dialects.oracle.decimal --hidden-import=sqlalchemy.dialects.oracle.random --hidden-import=sqlalchemy.dialects.oracle.re --hidden-import=sqlalchemy.dialects.oracle.sqlalchemy --hidden-import=sqlalchemy.dialects.oracle.zxjdbc --hidden-import=sqlalchemy.dialects.postgresql --hidden-import=sqlalchemy.dialects.postgresql.base --hidden-import=sqlalchemy.dialects.postgresql.logging --hidden-import=sqlalchemy.dialects.postgresql.pg8000 --hidden-import=sqlalchemy.dialects.postgresql.psycopg2 --hidden-import=sqlalchemy.dialects.postgresql.pypostgresql --hidden-import=sqlalchemy.dialects.postgresql.re --hidden-import=sqlalchemy.dialects.postgresql.sqlalchemy --hidden-import=sqlalchemy.dialects.postgresql.uuid --hidden-import=sqlalchemy.dialects.postgresql.zxjdbc --hidden-import=sqlalchemy.dialects.sqlite --hidden-import=sqlalchemy.dialects.sqlite.base --hidden-import=sqlalchemy.dialects.sqlite.datetime --hidden-import=sqlalchemy.dialects.sqlite.os --hidden-import=sqlalchemy.dialects.sqlite.pysqlite --hidden-import=sqlalchemy.dialects.sqlite.re --hidden-import=sqlalchemy.dialects.sqlite.sqlalchemy --hidden-import=sqlalchemy.dialects.sqlite.sqlite3 --hidden-import=sqlalchemy.dialects.sybase --hidden-import=sqlalchemy.dialects.sybase.base --hidden-import=sqlalchemy.dialects.sybase.operator --hidden-import=sqlalchemy.dialects.sybase.pyodbc --hidden-import=sqlalchemy.dialects.sybase.pysybase --hidden-import=sqlalchemy.dialects.sybase.sqlalchemy --hidden-import=sqlalchemy.engine --hidden-import=sqlalchemy.engine.StringIO --hidden-import=sqlalchemy.engine.base --hidden-import=sqlalchemy.engine.codecs --hidden-import=sqlalchemy.engine.collections --hidden-import=sqlalchemy.engine.ddl --hidden-import=sqlalchemy.engine.default --hidden-import=sqlalchemy.engine.inspect --hidden-import=sqlalchemy.engine.itertools --hidden-import=sqlalchemy.engine.operator --hidden-import=sqlalchemy.engine.random --hidden-import=sqlalchemy.engine.re --hidden-import=sqlalchemy.engine.reflection --hidden-import=sqlalchemy.engine.sqlalchemy --hidden-import=sqlalchemy.engine.strategies --hidden-import=sqlalchemy.engine.sys --hidden-import=sqlalchemy.engine.threadlocal --hidden-import=sqlalchemy.engine.url --hidden-import=sqlalchemy.engine.urllib --hidden-import=sqlalchemy.engine.weakref --hidden-import=sqlalchemy.event --hidden-import=sqlalchemy.events --hidden-import=sqlalchemy.exc --hidden-import=sqlalchemy.ext --hidden-import=sqlalchemy.ext.declarative --hidden-import=sqlalchemy.ext.sqlalchemy --hidden-import=sqlalchemy.inspect --hidden-import=sqlalchemy.interfaces --hidden-import=sqlalchemy.log --hidden-import=sqlalchemy.logging --hidden-import=sqlalchemy.orm --hidden-import=sqlalchemy.orm.attributes --hidden-import=sqlalchemy.orm.collections --hidden-import=sqlalchemy.orm.copy --hidden-import=sqlalchemy.orm.dependency --hidden-import=sqlalchemy.orm.deprecated_interfaces --hidden-import=sqlalchemy.orm.descriptor_props --hidden-import=sqlalchemy.orm.evaluator --hidden-import=sqlalchemy.orm.events --hidden-import=sqlalchemy.orm.exc --hidden-import=sqlalchemy.orm.identity --hidden-import=sqlalchemy.orm.inspect --hidden-import=sqlalchemy.orm.instrumentation --hidden-import=sqlalchemy.orm.interfaces --hidden-import=sqlalchemy.orm.itertools --hidden-import=sqlalchemy.orm.mapper --hidden-import=sqlalchemy.orm.operator --hidden-import=sqlalchemy.orm.persistence --hidden-import=sqlalchemy.orm.properties --hidden-import=sqlalchemy.orm.query --hidden-import=sqlalchemy.orm.re --hidden-import=sqlalchemy.orm.scoping --hidden-import=sqlalchemy.orm.session --hidden-import=sqlalchemy.orm.sets --hidden-import=sqlalchemy.orm.sqlalchemy --hidden-import=sqlalchemy.orm.state --hidden-import=sqlalchemy.orm.strategies --hidden-import=sqlalchemy.orm.sync --hidden-import=sqlalchemy.orm.sys --hidden-import=sqlalchemy.orm.types --hidden-import=sqlalchemy.orm.unitofwork --hidden-import=sqlalchemy.orm.util --hidden-import=sqlalchemy.orm.weakref --hidden-import=sqlalchemy.pool --hidden-import=sqlalchemy.processors --hidden-import=sqlalchemy.re --hidden-import=sqlalchemy.schema --hidden-import=sqlalchemy.sql --hidden-import=sqlalchemy.sql.collections --hidden-import=sqlalchemy.sql.compiler --hidden-import=sqlalchemy.sql.decimal --hidden-import=sqlalchemy.sql.expression --hidden-import=sqlalchemy.sql.functions --hidden-import=sqlalchemy.sql.itertools --hidden-import=sqlalchemy.sql.operator --hidden-import=sqlalchemy.sql.operators --hidden-import=sqlalchemy.sql.re --hidden-import=sqlalchemy.sql.sqlalchemy --hidden-import=sqlalchemy.sql.sys --hidden-import=sqlalchemy.sql.util --hidden-import=sqlalchemy.sql.visitors --hidden-import=sqlalchemy.sqlalchemy --hidden-import=sqlalchemy.sys --hidden-import=sqlalchemy.time --hidden-import=sqlalchemy.traceback --hidden-import=sqlalchemy.types --hidden-import=sqlalchemy.util --hidden-import=sqlalchemy.util._collections --hidden-import=sqlalchemy.util.cPickle --hidden-import=sqlalchemy.util.collections --hidden-import=sqlalchemy.util.compat --hidden-import=sqlalchemy.util.contextlib --hidden-import=sqlalchemy.util.decimal --hidden-import=sqlalchemy.util.deprecations --hidden-import=sqlalchemy.util.functools --hidden-import=sqlalchemy.util.hashlib --hidden-import=sqlalchemy.util.inspect --hidden-import=sqlalchemy.util.itertools --hidden-import=sqlalchemy.util.langhelpers --hidden-import=sqlalchemy.util.operator --hidden-import=sqlalchemy.util.queue --hidden-import=sqlalchemy.util.re --hidden-import=sqlalchemy.util.sets --hidden-import=sqlalchemy.util.sqlalchemy --hidden-import=sqlalchemy.util.sys --hidden-import=sqlalchemy.util.threading --hidden-import=sqlalchemy.util.time --hidden-import=sqlalchemy.util.topological --hidden-import=sqlalchemy.util.types --hidden-import=sqlalchemy.util.urlparse --hidden-import=sqlalchemy.util.warnings --hidden-import=sqlalchemy.util.weakref --hidden-import=sqlalchemy.weakref --hidden-import=sqlite3 --hidden-import=sqlite3._sqlite3 --hidden-import=sqlite3.datetime --hidden-import=sqlite3.dbapi2 --hidden-import=sqlite3.time --hidden-import=sre_compile --hidden-import=sre_constants --hidden-import=sre_parse --hidden-import=ssl --hidden-import=stat --hidden-import=string --hidden-import=strop --hidden-import=struct --hidden-import=sys --hidden-import=tempfile --hidden-import=tempita --hidden-import=tempita._looper --hidden-import=tempita.cStringIO --hidden-import=tempita.cgi --hidden-import=tempita.compat3 --hidden-import=tempita.os --hidden-import=tempita.re --hidden-import=tempita.sys --hidden-import=tempita.tempita --hidden-import=tempita.tokenize --hidden-import=tempita.urllib --hidden-import=termios --hidden-import=textwrap --hidden-import=thread --hidden-import=threading --hidden-import=time --hidden-import=token --hidden-import=tokenize --hidden-import=traceback --hidden-import=types --hidden-import=urllib --hidden-import=urllib2 --hidden-import=urlparse --hidden-import=uu --hidden-import=uuid --hidden-import=warnings --hidden-import=weakref --hidden-import=xml --hidden-import=xml.etree --hidden-import=xml.etree.ElementPath --hidden-import=xml.etree.ElementTree --hidden-import=xml.etree.re --hidden-import=xml.etree.sys --hidden-import=xml.etree.warnings --hidden-import=xml.etree.xml --hidden-import=xml.parsers --hidden-import=xml.parsers.expat --hidden-import=xml.parsers.pyexpat --hidden-import=zipfile --hidden-import=zipimport --hidden-import=zlib sibl_gui/launcher.py +mv sibl_gui/launcher.py sibl_gui/sIBL_GUI\ $MAJOR_VERSION.py +python $PYINSTALLER/pyinstaller.py --noconfirm --noconsole -o releases/Darwin --hidden-import=ConfigParser --hidden-import=PyQt4 --hidden-import=PyQt4.QtCore --hidden-import=PyQt4.QtGui --hidden-import=PyQt4.QtNetwork --hidden-import=PyQt4.QtWebKit --hidden-import=PyQt4.uic --hidden-import=PyQt4.uic.Compiler --hidden-import=PyQt4.uic.Compiler.PyQt4 --hidden-import=PyQt4.uic.Compiler.compiler --hidden-import=PyQt4.uic.Compiler.indenter --hidden-import=PyQt4.uic.Compiler.logging --hidden-import=PyQt4.uic.Compiler.misc --hidden-import=PyQt4.uic.Compiler.proxy_metaclass --hidden-import=PyQt4.uic.Compiler.qobjectcreator --hidden-import=PyQt4.uic.Compiler.qtproxies --hidden-import=PyQt4.uic.Compiler.re --hidden-import=PyQt4.uic.Compiler.sys --hidden-import=PyQt4.uic.PyQt4 --hidden-import=PyQt4.uic.exceptions --hidden-import=PyQt4.uic.icon_cache --hidden-import=PyQt4.uic.logging --hidden-import=PyQt4.uic.objcreator --hidden-import=PyQt4.uic.os --hidden-import=PyQt4.uic.port_v2 --hidden-import=PyQt4.uic.port_v2.PyQt4 --hidden-import=PyQt4.uic.port_v2.as_string --hidden-import=PyQt4.uic.port_v2.ascii_upper --hidden-import=PyQt4.uic.port_v2.cStringIO --hidden-import=PyQt4.uic.port_v2.load_plugin --hidden-import=PyQt4.uic.port_v2.proxy_base --hidden-import=PyQt4.uic.port_v2.re --hidden-import=PyQt4.uic.port_v2.string --hidden-import=PyQt4.uic.port_v2.string_io --hidden-import=PyQt4.uic.properties --hidden-import=PyQt4.uic.re --hidden-import=PyQt4.uic.sys --hidden-import=PyQt4.uic.uiparser --hidden-import=PyQt4.uic.xml --hidden-import=Queue --hidden-import=SocketServer --hidden-import=StringIO --hidden-import=UserDict --hidden-import=__builtin__ --hidden-import=__future__ --hidden-import=__main__ --hidden-import=_abcoll --hidden-import=_ast --hidden-import=_bisect --hidden-import=_codecs --hidden-import=_collections --hidden-import=_ctypes --hidden-import=_functools --hidden-import=_hashlib --hidden-import=_heapq --hidden-import=_io --hidden-import=_locale --hidden-import=_random --hidden-import=_scproxy --hidden-import=_socket --hidden-import=_sqlite3 --hidden-import=_sre --hidden-import=_ssl --hidden-import=_struct --hidden-import=_virtualenv_distutils --hidden-import=_warnings --hidden-import=_weakref --hidden-import=_weakrefset --hidden-import=abc --hidden-import=array --hidden-import=ast --hidden-import=atexit --hidden-import=base64 --hidden-import=binascii --hidden-import=bisect --hidden-import=cPickle --hidden-import=cStringIO --hidden-import=cgi --hidden-import=code --hidden-import=codecs --hidden-import=codeop --hidden-import=collections --hidden-import=contextlib --hidden-import=copy --hidden-import=copy_reg --hidden-import=ctypes --hidden-import=ctypes._ctypes --hidden-import=ctypes._endian --hidden-import=ctypes.ctypes --hidden-import=ctypes.macholib --hidden-import=ctypes.macholib.dyld --hidden-import=ctypes.macholib.dylib --hidden-import=ctypes.macholib.framework --hidden-import=ctypes.macholib.itertools --hidden-import=ctypes.macholib.os --hidden-import=ctypes.macholib.re --hidden-import=ctypes.os --hidden-import=ctypes.struct --hidden-import=ctypes.sys --hidden-import=ctypes.util --hidden-import=datetime --hidden-import=decimal --hidden-import=decorator --hidden-import=dis --hidden-import=distutils --hidden-import=distutils.debug --hidden-import=distutils.dep_util --hidden-import=distutils.dist --hidden-import=distutils.distutils --hidden-import=distutils.email --hidden-import=distutils.errors --hidden-import=distutils.fancy_getopt --hidden-import=distutils.getopt --hidden-import=distutils.imp --hidden-import=distutils.log --hidden-import=distutils.opcode --hidden-import=distutils.os --hidden-import=distutils.re --hidden-import=distutils.spawn --hidden-import=distutils.stat --hidden-import=distutils.string --hidden-import=distutils.sys --hidden-import=distutils.sysconfig --hidden-import=distutils.text_file --hidden-import=distutils.util --hidden-import=distutils.warnings --hidden-import=email --hidden-import=email.Charset --hidden-import=email.Encoders --hidden-import=email.Errors --hidden-import=email.FeedParser --hidden-import=email.Generator --hidden-import=email.Header --hidden-import=email.Iterators --hidden-import=email.MIMEAudio --hidden-import=email.MIMEBase --hidden-import=email.MIMEImage --hidden-import=email.MIMEMessage --hidden-import=email.MIMEMultipart --hidden-import=email.MIMENonMultipart --hidden-import=email.MIMEText --hidden-import=email.Message --hidden-import=email.Parser --hidden-import=email.Utils --hidden-import=email._parseaddr --hidden-import=email.base64 --hidden-import=email.base64MIME --hidden-import=email.base64mime --hidden-import=email.binascii --hidden-import=email.cStringIO --hidden-import=email.charset --hidden-import=email.codecs --hidden-import=email.email --hidden-import=email.encoders --hidden-import=email.errors --hidden-import=email.feedparser --hidden-import=email.generator --hidden-import=email.header --hidden-import=email.iterators --hidden-import=email.message --hidden-import=email.mime --hidden-import=email.mime.audio --hidden-import=email.mime.base --hidden-import=email.mime.cStringIO --hidden-import=email.mime.email --hidden-import=email.mime.image --hidden-import=email.mime.imghdr --hidden-import=email.mime.message --hidden-import=email.mime.multipart --hidden-import=email.mime.nonmultipart --hidden-import=email.mime.sndhdr --hidden-import=email.mime.text --hidden-import=email.os --hidden-import=email.parser --hidden-import=email.quopri --hidden-import=email.quopriMIME --hidden-import=email.quoprimime --hidden-import=email.random --hidden-import=email.re --hidden-import=email.socket --hidden-import=email.string --hidden-import=email.sys --hidden-import=email.time --hidden-import=email.urllib --hidden-import=email.utils --hidden-import=email.uu --hidden-import=email.warnings --hidden-import=encodings --hidden-import=encodings.__builtin__ --hidden-import=encodings.aliases --hidden-import=encodings.ascii --hidden-import=encodings.codecs --hidden-import=encodings.encodings --hidden-import=encodings.utf_8 --hidden-import=errno --hidden-import=exceptions --hidden-import=fcntl --hidden-import=fnmatch --hidden-import=functools --hidden-import=gc --hidden-import=genericpath --hidden-import=getopt --hidden-import=getpass --hidden-import=gettext --hidden-import=grp --hidden-import=hashlib --hidden-import=heapq --hidden-import=httplib --hidden-import=imghdr --hidden-import=imp --hidden-import=inspect --hidden-import=io --hidden-import=itertools --hidden-import=keyword --hidden-import=linecache --hidden-import=locale --hidden-import=logging --hidden-import=logging.atexit --hidden-import=logging.cStringIO --hidden-import=logging.codecs --hidden-import=logging.os --hidden-import=logging.sys --hidden-import=logging.thread --hidden-import=logging.threading --hidden-import=logging.time --hidden-import=logging.traceback --hidden-import=logging.warnings --hidden-import=logging.weakref --hidden-import=logilab --hidden-import=marshal --hidden-import=math --hidden-import=migrate --hidden-import=migrate.changeset --hidden-import=migrate.changeset.StringIO --hidden-import=migrate.changeset.UserDict --hidden-import=migrate.changeset.ansisql --hidden-import=migrate.changeset.constraint --hidden-import=migrate.changeset.databases --hidden-import=migrate.changeset.databases.UserDict --hidden-import=migrate.changeset.databases.copy --hidden-import=migrate.changeset.databases.firebird --hidden-import=migrate.changeset.databases.migrate --hidden-import=migrate.changeset.databases.mysql --hidden-import=migrate.changeset.databases.oracle --hidden-import=migrate.changeset.databases.postgres --hidden-import=migrate.changeset.databases.sqlalchemy --hidden-import=migrate.changeset.databases.sqlite --hidden-import=migrate.changeset.databases.visitor --hidden-import=migrate.changeset.migrate --hidden-import=migrate.changeset.re --hidden-import=migrate.changeset.schema --hidden-import=migrate.changeset.sqlalchemy --hidden-import=migrate.changeset.warnings --hidden-import=migrate.exceptions --hidden-import=migrate.migrate --hidden-import=migrate.versioning --hidden-import=migrate.versioning.ConfigParser --hidden-import=migrate.versioning.api --hidden-import=migrate.versioning.cfgparse --hidden-import=migrate.versioning.config --hidden-import=migrate.versioning.datetime --hidden-import=migrate.versioning.genmodel --hidden-import=migrate.versioning.inspect --hidden-import=migrate.versioning.logging --hidden-import=migrate.versioning.migrate --hidden-import=migrate.versioning.os --hidden-import=migrate.versioning.pathed --hidden-import=migrate.versioning.pkg_resources --hidden-import=migrate.versioning.re --hidden-import=migrate.versioning.repository --hidden-import=migrate.versioning.schema --hidden-import=migrate.versioning.schemadiff --hidden-import=migrate.versioning.script --hidden-import=migrate.versioning.script.StringIO --hidden-import=migrate.versioning.script.base --hidden-import=migrate.versioning.script.inspect --hidden-import=migrate.versioning.script.logging --hidden-import=migrate.versioning.script.migrate --hidden-import=migrate.versioning.script.py --hidden-import=migrate.versioning.script.shutil --hidden-import=migrate.versioning.script.sql --hidden-import=migrate.versioning.script.warnings --hidden-import=migrate.versioning.shutil --hidden-import=migrate.versioning.sqlalchemy --hidden-import=migrate.versioning.string --hidden-import=migrate.versioning.sys --hidden-import=migrate.versioning.tempita --hidden-import=migrate.versioning.template --hidden-import=migrate.versioning.util --hidden-import=migrate.versioning.util.decorator --hidden-import=migrate.versioning.util.importpath --hidden-import=migrate.versioning.util.keyedinstance --hidden-import=migrate.versioning.util.logging --hidden-import=migrate.versioning.util.migrate --hidden-import=migrate.versioning.util.os --hidden-import=migrate.versioning.util.pkg_resources --hidden-import=migrate.versioning.util.sqlalchemy --hidden-import=migrate.versioning.util.sys --hidden-import=migrate.versioning.util.warnings --hidden-import=migrate.versioning.version --hidden-import=mimetools --hidden-import=new --hidden-import=numbers --hidden-import=opcode --hidden-import=operator --hidden-import=optparse --hidden-import=os --hidden-import=os.path --hidden-import=pickle --hidden-import=pkg_resources --hidden-import=pkgutil --hidden-import=platform --hidden-import=plistlib --hidden-import=posix --hidden-import=posixpath --hidden-import=pwd --hidden-import=pyexpat --hidden-import=pyexpat.errors --hidden-import=pyexpat.model --hidden-import=quopri --hidden-import=random --hidden-import=re --hidden-import=rfc822 --hidden-import=select --hidden-import=sets --hidden-import=shutil --hidden-import=signal --hidden-import=sip --hidden-import=site --hidden-import=sitecustomize --hidden-import=sndhdr --hidden-import=socket --hidden-import=sqlalchemy --hidden-import=sqlalchemy.codecs --hidden-import=sqlalchemy.collections --hidden-import=sqlalchemy.connectors --hidden-import=sqlalchemy.connectors.mxodbc --hidden-import=sqlalchemy.connectors.mysqldb --hidden-import=sqlalchemy.connectors.pyodbc --hidden-import=sqlalchemy.connectors.re --hidden-import=sqlalchemy.connectors.sqlalchemy --hidden-import=sqlalchemy.connectors.sys --hidden-import=sqlalchemy.connectors.urllib --hidden-import=sqlalchemy.connectors.warnings --hidden-import=sqlalchemy.connectors.zxJDBC --hidden-import=sqlalchemy.cprocessors --hidden-import=sqlalchemy.cresultproxy --hidden-import=sqlalchemy.databases --hidden-import=sqlalchemy.databases.sqlalchemy --hidden-import=sqlalchemy.datetime --hidden-import=sqlalchemy.dialects --hidden-import=sqlalchemy.dialects.access --hidden-import=sqlalchemy.dialects.access.base --hidden-import=sqlalchemy.dialects.access.sqlalchemy --hidden-import=sqlalchemy.dialects.drizzle --hidden-import=sqlalchemy.dialects.drizzle.base --hidden-import=sqlalchemy.dialects.drizzle.mysqldb --hidden-import=sqlalchemy.dialects.drizzle.sqlalchemy --hidden-import=sqlalchemy.dialects.firebird --hidden-import=sqlalchemy.dialects.firebird.base --hidden-import=sqlalchemy.dialects.firebird.datetime --hidden-import=sqlalchemy.dialects.firebird.kinterbasdb --hidden-import=sqlalchemy.dialects.firebird.re --hidden-import=sqlalchemy.dialects.firebird.sqlalchemy --hidden-import=sqlalchemy.dialects.informix --hidden-import=sqlalchemy.dialects.informix.base --hidden-import=sqlalchemy.dialects.informix.datetime --hidden-import=sqlalchemy.dialects.informix.informixdb --hidden-import=sqlalchemy.dialects.informix.re --hidden-import=sqlalchemy.dialects.informix.sqlalchemy --hidden-import=sqlalchemy.dialects.maxdb --hidden-import=sqlalchemy.dialects.maxdb.base --hidden-import=sqlalchemy.dialects.maxdb.datetime --hidden-import=sqlalchemy.dialects.maxdb.itertools --hidden-import=sqlalchemy.dialects.maxdb.re --hidden-import=sqlalchemy.dialects.maxdb.sapdb --hidden-import=sqlalchemy.dialects.maxdb.sqlalchemy --hidden-import=sqlalchemy.dialects.mssql --hidden-import=sqlalchemy.dialects.mssql.adodbapi --hidden-import=sqlalchemy.dialects.mssql.base --hidden-import=sqlalchemy.dialects.mssql.datetime --hidden-import=sqlalchemy.dialects.mssql.decimal --hidden-import=sqlalchemy.dialects.mssql.information_schema --hidden-import=sqlalchemy.dialects.mssql.mxodbc --hidden-import=sqlalchemy.dialects.mssql.operator --hidden-import=sqlalchemy.dialects.mssql.pymssql --hidden-import=sqlalchemy.dialects.mssql.pyodbc --hidden-import=sqlalchemy.dialects.mssql.re --hidden-import=sqlalchemy.dialects.mssql.sqlalchemy --hidden-import=sqlalchemy.dialects.mssql.sys --hidden-import=sqlalchemy.dialects.mssql.zxjdbc --hidden-import=sqlalchemy.dialects.mysql --hidden-import=sqlalchemy.dialects.mysql.array --hidden-import=sqlalchemy.dialects.mysql.base --hidden-import=sqlalchemy.dialects.mysql.datetime --hidden-import=sqlalchemy.dialects.mysql.inspect --hidden-import=sqlalchemy.dialects.mysql.mysqlconnector --hidden-import=sqlalchemy.dialects.mysql.mysqldb --hidden-import=sqlalchemy.dialects.mysql.oursql --hidden-import=sqlalchemy.dialects.mysql.pymysql --hidden-import=sqlalchemy.dialects.mysql.pyodbc --hidden-import=sqlalchemy.dialects.mysql.re --hidden-import=sqlalchemy.dialects.mysql.sqlalchemy --hidden-import=sqlalchemy.dialects.mysql.sys --hidden-import=sqlalchemy.dialects.mysql.zxjdbc --hidden-import=sqlalchemy.dialects.oracle --hidden-import=sqlalchemy.dialects.oracle.base --hidden-import=sqlalchemy.dialects.oracle.collections --hidden-import=sqlalchemy.dialects.oracle.cx_oracle --hidden-import=sqlalchemy.dialects.oracle.datetime --hidden-import=sqlalchemy.dialects.oracle.decimal --hidden-import=sqlalchemy.dialects.oracle.random --hidden-import=sqlalchemy.dialects.oracle.re --hidden-import=sqlalchemy.dialects.oracle.sqlalchemy --hidden-import=sqlalchemy.dialects.oracle.zxjdbc --hidden-import=sqlalchemy.dialects.postgresql --hidden-import=sqlalchemy.dialects.postgresql.base --hidden-import=sqlalchemy.dialects.postgresql.logging --hidden-import=sqlalchemy.dialects.postgresql.pg8000 --hidden-import=sqlalchemy.dialects.postgresql.psycopg2 --hidden-import=sqlalchemy.dialects.postgresql.pypostgresql --hidden-import=sqlalchemy.dialects.postgresql.re --hidden-import=sqlalchemy.dialects.postgresql.sqlalchemy --hidden-import=sqlalchemy.dialects.postgresql.uuid --hidden-import=sqlalchemy.dialects.postgresql.zxjdbc --hidden-import=sqlalchemy.dialects.sqlite --hidden-import=sqlalchemy.dialects.sqlite.base --hidden-import=sqlalchemy.dialects.sqlite.datetime --hidden-import=sqlalchemy.dialects.sqlite.os --hidden-import=sqlalchemy.dialects.sqlite.pysqlite --hidden-import=sqlalchemy.dialects.sqlite.re --hidden-import=sqlalchemy.dialects.sqlite.sqlalchemy --hidden-import=sqlalchemy.dialects.sqlite.sqlite3 --hidden-import=sqlalchemy.dialects.sybase --hidden-import=sqlalchemy.dialects.sybase.base --hidden-import=sqlalchemy.dialects.sybase.operator --hidden-import=sqlalchemy.dialects.sybase.pyodbc --hidden-import=sqlalchemy.dialects.sybase.pysybase --hidden-import=sqlalchemy.dialects.sybase.sqlalchemy --hidden-import=sqlalchemy.engine --hidden-import=sqlalchemy.engine.StringIO --hidden-import=sqlalchemy.engine.base --hidden-import=sqlalchemy.engine.codecs --hidden-import=sqlalchemy.engine.collections --hidden-import=sqlalchemy.engine.ddl --hidden-import=sqlalchemy.engine.default --hidden-import=sqlalchemy.engine.inspect --hidden-import=sqlalchemy.engine.itertools --hidden-import=sqlalchemy.engine.operator --hidden-import=sqlalchemy.engine.random --hidden-import=sqlalchemy.engine.re --hidden-import=sqlalchemy.engine.reflection --hidden-import=sqlalchemy.engine.sqlalchemy --hidden-import=sqlalchemy.engine.strategies --hidden-import=sqlalchemy.engine.sys --hidden-import=sqlalchemy.engine.threadlocal --hidden-import=sqlalchemy.engine.url --hidden-import=sqlalchemy.engine.urllib --hidden-import=sqlalchemy.engine.weakref --hidden-import=sqlalchemy.event --hidden-import=sqlalchemy.events --hidden-import=sqlalchemy.exc --hidden-import=sqlalchemy.ext --hidden-import=sqlalchemy.ext.declarative --hidden-import=sqlalchemy.ext.sqlalchemy --hidden-import=sqlalchemy.inspect --hidden-import=sqlalchemy.interfaces --hidden-import=sqlalchemy.log --hidden-import=sqlalchemy.logging --hidden-import=sqlalchemy.orm --hidden-import=sqlalchemy.orm.attributes --hidden-import=sqlalchemy.orm.collections --hidden-import=sqlalchemy.orm.copy --hidden-import=sqlalchemy.orm.dependency --hidden-import=sqlalchemy.orm.deprecated_interfaces --hidden-import=sqlalchemy.orm.descriptor_props --hidden-import=sqlalchemy.orm.evaluator --hidden-import=sqlalchemy.orm.events --hidden-import=sqlalchemy.orm.exc --hidden-import=sqlalchemy.orm.identity --hidden-import=sqlalchemy.orm.inspect --hidden-import=sqlalchemy.orm.instrumentation --hidden-import=sqlalchemy.orm.interfaces --hidden-import=sqlalchemy.orm.itertools --hidden-import=sqlalchemy.orm.mapper --hidden-import=sqlalchemy.orm.operator --hidden-import=sqlalchemy.orm.persistence --hidden-import=sqlalchemy.orm.properties --hidden-import=sqlalchemy.orm.query --hidden-import=sqlalchemy.orm.re --hidden-import=sqlalchemy.orm.scoping --hidden-import=sqlalchemy.orm.session --hidden-import=sqlalchemy.orm.sets --hidden-import=sqlalchemy.orm.sqlalchemy --hidden-import=sqlalchemy.orm.state --hidden-import=sqlalchemy.orm.strategies --hidden-import=sqlalchemy.orm.sync --hidden-import=sqlalchemy.orm.sys --hidden-import=sqlalchemy.orm.types --hidden-import=sqlalchemy.orm.unitofwork --hidden-import=sqlalchemy.orm.util --hidden-import=sqlalchemy.orm.weakref --hidden-import=sqlalchemy.pool --hidden-import=sqlalchemy.processors --hidden-import=sqlalchemy.re --hidden-import=sqlalchemy.schema --hidden-import=sqlalchemy.sql --hidden-import=sqlalchemy.sql.collections --hidden-import=sqlalchemy.sql.compiler --hidden-import=sqlalchemy.sql.decimal --hidden-import=sqlalchemy.sql.expression --hidden-import=sqlalchemy.sql.functions --hidden-import=sqlalchemy.sql.itertools --hidden-import=sqlalchemy.sql.operator --hidden-import=sqlalchemy.sql.operators --hidden-import=sqlalchemy.sql.re --hidden-import=sqlalchemy.sql.sqlalchemy --hidden-import=sqlalchemy.sql.sys --hidden-import=sqlalchemy.sql.util --hidden-import=sqlalchemy.sql.visitors --hidden-import=sqlalchemy.sqlalchemy --hidden-import=sqlalchemy.sys --hidden-import=sqlalchemy.time --hidden-import=sqlalchemy.traceback --hidden-import=sqlalchemy.types --hidden-import=sqlalchemy.util --hidden-import=sqlalchemy.util._collections --hidden-import=sqlalchemy.util.cPickle --hidden-import=sqlalchemy.util.collections --hidden-import=sqlalchemy.util.compat --hidden-import=sqlalchemy.util.contextlib --hidden-import=sqlalchemy.util.decimal --hidden-import=sqlalchemy.util.deprecations --hidden-import=sqlalchemy.util.functools --hidden-import=sqlalchemy.util.hashlib --hidden-import=sqlalchemy.util.inspect --hidden-import=sqlalchemy.util.itertools --hidden-import=sqlalchemy.util.langhelpers --hidden-import=sqlalchemy.util.operator --hidden-import=sqlalchemy.util.queue --hidden-import=sqlalchemy.util.re --hidden-import=sqlalchemy.util.sets --hidden-import=sqlalchemy.util.sqlalchemy --hidden-import=sqlalchemy.util.sys --hidden-import=sqlalchemy.util.threading --hidden-import=sqlalchemy.util.time --hidden-import=sqlalchemy.util.topological --hidden-import=sqlalchemy.util.types --hidden-import=sqlalchemy.util.urlparse --hidden-import=sqlalchemy.util.warnings --hidden-import=sqlalchemy.util.weakref --hidden-import=sqlalchemy.weakref --hidden-import=sqlite3 --hidden-import=sqlite3._sqlite3 --hidden-import=sqlite3.datetime --hidden-import=sqlite3.dbapi2 --hidden-import=sqlite3.time --hidden-import=sre_compile --hidden-import=sre_constants --hidden-import=sre_parse --hidden-import=ssl --hidden-import=stat --hidden-import=string --hidden-import=strop --hidden-import=struct --hidden-import=sys --hidden-import=tempfile --hidden-import=tempita --hidden-import=tempita._looper --hidden-import=tempita.cStringIO --hidden-import=tempita.cgi --hidden-import=tempita.compat3 --hidden-import=tempita.os --hidden-import=tempita.re --hidden-import=tempita.sys --hidden-import=tempita.tempita --hidden-import=tempita.tokenize --hidden-import=tempita.urllib --hidden-import=termios --hidden-import=textwrap --hidden-import=thread --hidden-import=threading --hidden-import=time --hidden-import=token --hidden-import=tokenize --hidden-import=traceback --hidden-import=types --hidden-import=urllib --hidden-import=urllib2 --hidden-import=urlparse --hidden-import=uu --hidden-import=uuid --hidden-import=warnings --hidden-import=weakref --hidden-import=xml --hidden-import=xml.etree --hidden-import=xml.etree.ElementPath --hidden-import=xml.etree.ElementTree --hidden-import=xml.etree.re --hidden-import=xml.etree.sys --hidden-import=xml.etree.warnings --hidden-import=xml.etree.xml --hidden-import=xml.parsers --hidden-import=xml.parsers.expat --hidden-import=xml.parsers.pyexpat --hidden-import=zipfile --hidden-import=zipimport --hidden-import=zlib sibl_gui/sIBL_GUI\ $MAJOR_VERSION.py +mv sibl_gui/sIBL_GUI\ $MAJOR_VERSION.py sibl_gui/launcher.py echo ------------------------------------------------------------------------------- echo Build - End echo ------------------------------------------------------------------------------- @@ -51,7 +52,6 @@ echo --------------------------------------------------------------------------- echo ------------------------------------------------------------------------------- echo Release - Begin echo ------------------------------------------------------------------------------- -mv $BASE $BUNDLE packages="foundations,manager,umbra,sibl_gui" for package in $packages do From 98f3b4c20ec0682c4996dbe0d43110facaf29b3d Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Thu, 20 Jun 2013 08:09:59 +0100 Subject: [PATCH 10/54] Update imports in "loaderScript" component. --- sibl_gui/components/addons/loaderScript/loaderScript.py | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/sibl_gui/components/addons/loaderScript/loaderScript.py b/sibl_gui/components/addons/loaderScript/loaderScript.py index 715909a0..f0a1c4df 100644 --- a/sibl_gui/components/addons/loaderScript/loaderScript.py +++ b/sibl_gui/components/addons/loaderScript/loaderScript.py @@ -40,7 +40,6 @@ import sibl_gui.exceptions import umbra.exceptions from foundations.io import File -from foundations.parsers import SectionsFileParser from manager.qwidgetComponent import QWidgetComponentFactory from umbra.globals.constants import Constants @@ -697,7 +696,7 @@ def __templatesOutliner_view_selectionModel__selectionChanged(self, selectedItem LOGGER.debug("> Parsing '{0}' Template for '{1}' section.".format(template.name, self.__templateRemoteConnectionSection)) - templateSectionsFileParser = SectionsFileParser(template.path) + templateSectionsFileParser = foundations.parsers.SectionsFileParser(template.path) templateSectionsFileParser.read() and templateSectionsFileParser.parse( rawSections=(self.__templateScriptSection)) @@ -846,7 +845,7 @@ def sendLoaderScriptToSoftware(self, template, loaderScriptPath): """ LOGGER.info("{0} | Starting remote connection!".format(self.__class__.__name__)) - templateSectionsFileParser = SectionsFileParser(template.path) + templateSectionsFileParser = foundations.parsers.SectionsFileParser(template.path) templateSectionsFileParser.read() and templateSectionsFileParser.parse( rawSections=(self.__templateScriptSection)) connectionType = foundations.parsers.getAttributeCompound("ConnectionType", @@ -953,7 +952,7 @@ def getLoaderScript(self, template, iblSet, overrideKeys): """ LOGGER.debug("> Parsing Template file: '{0}'.".format(template)) - templateSectionsFileParser = SectionsFileParser(template) + templateSectionsFileParser = foundations.parsers.SectionsFileParser(template) templateSectionsFileParser.read() and templateSectionsFileParser.parse( rawSections=(self.__templateScriptSection)) templateSections = dict.copy(templateSectionsFileParser.sections) @@ -969,7 +968,7 @@ def getLoaderScript(self, template, iblSet, overrideKeys): for attribute, value in templateSections[section].iteritems())) LOGGER.debug("> Parsing Ibl Set file: '{0}'.".format(iblSet)) - iblSetSectionsFileParser = SectionsFileParser(iblSet) + iblSetSectionsFileParser = foundations.parsers.SectionsFileParser(iblSet) iblSetSectionsFileParser.read() and iblSetSectionsFileParser.parse() iblSetSections = dict.copy(iblSetSectionsFileParser.sections) From 1455e9be4fe952bd16ae3ed1ac23c5608d13bcc3 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Thu, 20 Jun 2013 08:10:42 +0100 Subject: [PATCH 11/54] Update "sibl_gui.launcher.sIBL_GUI" class attributes. --- sibl_gui/launcher.py | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/sibl_gui/launcher.py b/sibl_gui/launcher.py index d3822d78..e3d013cd 100644 --- a/sibl_gui/launcher.py +++ b/sibl_gui/launcher.py @@ -139,10 +139,6 @@ def __init__(self, LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) - # --- Setting class attributes. --- - self.__thumbnailsCacheDirectory = None - self.__imagesCaches = None - umbra.engine.Umbra.__init__(self, parent, componentsPaths, @@ -151,6 +147,10 @@ def __init__(self, *args, **kwargs) + # --- Setting class attributes. --- + self.__thumbnailsCacheDirectory = self.__thumbnailsCacheDirectory + self.__imagesCaches = self.__imagesCaches + #****************************************************************************************************************** #*** Attributes properties. #****************************************************************************************************************** @@ -264,6 +264,13 @@ def onPreInitialisation(self): self.__setThumbnailsCacheDirectory() self.__setImagesCaches() + def onInitialisation(self): + """ + This method is called by the :class:`umbra.engine.Umbra` class on Application main class initialisation. + """ + + pass + def onPostInitialisation(self): """ This method is called by the :class:`umbra.engine.Umbra` class after Application main class initialisation. From 8acc97c575ea9e4abc11a3d9ec4edd368d60471a Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Fri, 28 Feb 2014 22:26:05 +0100 Subject: [PATCH 12/54] Change copyrights dates. --- CHANGES.rst | 4 ++-- README.rst | 4 ++-- bin/sIBL_GUI | 2 +- docs/donations/Make_A_Donation.html | 4 ++-- docs/donations/Make_A_Donation.rst | 4 ++-- docs/help/sIBL_GUI_Manual.html | 4 ++-- docs/help/sIBL_GUI_Manual.rst | 4 ++-- docs/help/sIBL_GUI_Manual_Body.html | 4 ++-- docs/sphinx/source/resources/pages/about.rst | 4 ++-- setup.py | 2 +- sibl_gui/__init__.py | 2 +- sibl_gui/components/addons/about/about.py | 4 ++-- .../components/addons/cachesOperations/cachesOperations.py | 2 +- .../addons/databaseOperations/databaseOperations.py | 2 +- sibl_gui/components/addons/gpsMap/gpsMap.py | 2 +- sibl_gui/components/addons/gpsMap/views.py | 2 +- sibl_gui/components/addons/iblSetsScanner/iblSetsScanner.py | 2 +- sibl_gui/components/addons/iblSetsScanner/workers.py | 2 +- sibl_gui/components/addons/loaderScript/loaderScript.py | 2 +- .../addons/loaderScriptOptions/loaderScriptOptions.py | 2 +- sibl_gui/components/addons/loaderScriptOptions/views.py | 2 +- .../components/addons/locationsBrowser/locationsBrowser.py | 2 +- sibl_gui/components/addons/loggingNotifier/loggingNotifier.py | 2 +- sibl_gui/components/addons/onlineUpdater/downloadManager.py | 2 +- sibl_gui/components/addons/onlineUpdater/onlineUpdater.py | 2 +- sibl_gui/components/addons/onlineUpdater/remoteUpdater.py | 2 +- sibl_gui/components/addons/onlineUpdater/views.py | 2 +- sibl_gui/components/addons/preview/imagesPreviewer.py | 2 +- sibl_gui/components/addons/preview/preview.py | 2 +- .../addons/rawEditingUtilities/rawEditingUtilities.py | 2 +- sibl_gui/components/addons/rewiringTool/rewiringTool.py | 2 +- .../components/addons/sIBLeditUtilities/sIBLeditUtilities.py | 2 +- sibl_gui/components/addons/searchDatabase/searchDatabase.py | 2 +- sibl_gui/components/addons/searchDatabase/views.py | 2 +- .../core/collectionsOutliner/collectionsOutliner.py | 2 +- sibl_gui/components/core/collectionsOutliner/models.py | 2 +- sibl_gui/components/core/collectionsOutliner/nodes.py | 2 +- sibl_gui/components/core/collectionsOutliner/views.py | 2 +- sibl_gui/components/core/database/database.py | 2 +- sibl_gui/components/core/database/exceptions.py | 2 +- sibl_gui/components/core/database/nodes.py | 2 +- sibl_gui/components/core/database/operations.py | 2 +- sibl_gui/components/core/database/types.py | 2 +- sibl_gui/components/core/iblSetsOutliner/iblSetsOutliner.py | 2 +- sibl_gui/components/core/iblSetsOutliner/models.py | 2 +- sibl_gui/components/core/iblSetsOutliner/views.py | 2 +- sibl_gui/components/core/inspector/inspector.py | 2 +- sibl_gui/components/core/inspector/models.py | 2 +- sibl_gui/components/core/inspector/nodes.py | 2 +- sibl_gui/components/core/inspector/views.py | 2 +- sibl_gui/components/core/templatesOutliner/models.py | 2 +- sibl_gui/components/core/templatesOutliner/nodes.py | 2 +- .../components/core/templatesOutliner/templatesOutliner.py | 2 +- sibl_gui/components/core/templatesOutliner/views.py | 2 +- sibl_gui/exceptions.py | 2 +- sibl_gui/globals/constants.py | 2 +- sibl_gui/globals/runtimeGlobals.py | 2 +- sibl_gui/globals/uiConstants.py | 2 +- sibl_gui/launcher.py | 2 +- sibl_gui/libraries/freeImage/freeImage.py | 2 +- sibl_gui/resources/patches/001_migrate_3-x-x_to_4-0-0.py | 2 +- sibl_gui/resources/patches/002_migrate_4-x-x_to_4-0-2.py | 2 +- sibl_gui/resources/patches/003_migrate_4-x-x_to_4-0-3.py | 2 +- sibl_gui/resources/patches/004_migrate_4-x-x_to_4-0-7.py | 2 +- sibl_gui/tests/tests.py | 2 +- sibl_gui/tests/testsInternational.py | 2 +- sibl_gui/tests/testsSibl_gui/testsExceptions.py | 2 +- sibl_gui/tests/testsSibl_gui/testsGlobals/testsConstants.py | 2 +- .../tests/testsSibl_gui/testsGlobals/testsRuntimeGlobals.py | 2 +- sibl_gui/tests/testsSibl_gui/testsGlobals/testsUiConstants.py | 2 +- sibl_gui/tests/utilities.py | 2 +- sibl_gui/ui/caches.py | 2 +- sibl_gui/ui/common.py | 2 +- sibl_gui/ui/models.py | 2 +- sibl_gui/ui/nodes.py | 2 +- sibl_gui/ui/views.py | 2 +- sibl_gui/ui/widgets/application_QToolBar.py | 2 +- sibl_gui/ui/workers.py | 2 +- utilities/__init__.py | 2 +- utilities/darwinSetup.py | 2 +- utilities/getDependenciesInformations.py | 2 +- utilities/getHDRLabsDocumentation.py | 2 +- utilities/getPackagePath.py | 2 +- utilities/getSphinxDocumentationApi.py | 2 +- utilities/getSphinxDocumentationTocTree.py | 2 +- utilities/listImports.py | 2 +- utilities/reStructuredTextToHtml.py | 2 +- utilities/recursiveRemove.py | 2 +- utilities/sliceDocumentation.py | 2 +- utilities/windowsSetup.py | 2 +- 90 files changed, 99 insertions(+), 99 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 0083cfa3..224df737 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -624,7 +624,7 @@ I would like to thanks **Jens Lindgren** for providing me a much needed stable P About ----- -| **sIBL_GUI** by Thomas Mansencal – 2008 - 2013 -| Copyright© 2008 - 2013 – Thomas Mansencal – `thomas.mansencal@gmail.com `_ +| **sIBL_GUI** by Thomas Mansencal – 2008 - 2014 +| Copyright © 2008 - 2014 – Thomas Mansencal – `thomas.mansencal@gmail.com `_ | This software is released under terms of GNU GPL V3 license: http://www.gnu.org/licenses/ | `http://www.thomasmansencal.com/ `_ \ No newline at end of file diff --git a/README.rst b/README.rst index 16a9ad08..9ff73d3c 100644 --- a/README.rst +++ b/README.rst @@ -73,7 +73,7 @@ Once installed, you can launch **sIBL_GUI** using this shell command:: About ----- -| **sIBL_GUI** by Thomas Mansencal – 2008 - 2013 -| Copyright© 2008 - 2013 – Thomas Mansencal – `thomas.mansencal@gmail.com `_ +| **sIBL_GUI** by Thomas Mansencal – 2008 - 2014 +| Copyright © 2008 - 2014 – Thomas Mansencal – `thomas.mansencal@gmail.com `_ | This software is released under terms of GNU GPL V3 license: http://www.gnu.org/licenses/ | `http://www.thomasmansencal.com/ `_ \ No newline at end of file diff --git a/bin/sIBL_GUI b/bin/sIBL_GUI index e4adf7c7..824851b3 100755 --- a/bin/sIBL_GUI +++ b/bin/sIBL_GUI @@ -47,7 +47,7 @@ from sibl_gui.launcher import main #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/docs/donations/Make_A_Donation.html b/docs/donations/Make_A_Donation.html index 8e5f39cd..d456d235 100644 --- a/docs/donations/Make_A_Donation.html +++ b/docs/donations/Make_A_Donation.html @@ -108,10 +108,10 @@

- sIBL_GUI by Thomas Mansencal - 2008 - 2013 + sIBL_GUI by Thomas Mansencal - 2008 - 2014
- Copyright© 2008 - 2013 - Thomas Mansencal - thomas.mansencal@gmail.com + Copyright © 2008 - 2014 - Thomas Mansencal - thomas.mansencal@gmail.com
This software is released under terms of GNU GPL V3 license: http://www.gnu.org/licenses/ diff --git a/docs/donations/Make_A_Donation.rst b/docs/donations/Make_A_Donation.rst index b607c225..3f16d76d 100644 --- a/docs/donations/Make_A_Donation.rst +++ b/docs/donations/Make_A_Donation.rst @@ -17,7 +17,7 @@ With sIBL_GUI 4 release I decided to accept donations, so if you think the appli About ===== -| **sIBL_GUI** by Thomas Mansencal - 2008 - 2013 -| Copyright© 2008 - 2013 - Thomas Mansencal - `thomas.mansencal@gmail.com `_ +| **sIBL_GUI** by Thomas Mansencal - 2008 - 2014 +| Copyright © 2008 - 2014 - Thomas Mansencal - `thomas.mansencal@gmail.com `_ | This software is released under terms of GNU GPL V3 license: http://www.gnu.org/licenses/ | http://www.thomasmansencal.com/ \ No newline at end of file diff --git a/docs/help/sIBL_GUI_Manual.html b/docs/help/sIBL_GUI_Manual.html index 6be15637..6bdb3361 100644 --- a/docs/help/sIBL_GUI_Manual.html +++ b/docs/help/sIBL_GUI_Manual.html @@ -3316,10 +3316,10 @@

- sIBL_GUI by Thomas Mansencal - 2008 - 2013 + sIBL_GUI by Thomas Mansencal - 2008 - 2014
- Copyright© 2008 - 2013 - Thomas Mansencal - thomas.mansencal@gmail.com + Copyright © 2008 - 2014 - Thomas Mansencal - thomas.mansencal@gmail.com
This software is released under terms of GNU GPL V3 license: http://www.gnu.org/licenses/ diff --git a/docs/help/sIBL_GUI_Manual.rst b/docs/help/sIBL_GUI_Manual.rst index eddd103e..4a5ca48f 100644 --- a/docs/help/sIBL_GUI_Manual.rst +++ b/docs/help/sIBL_GUI_Manual.rst @@ -1894,7 +1894,7 @@ Changes About ===== -| **sIBL_GUI** by Thomas Mansencal - 2008 - 2013 -| Copyright© 2008 - 2013 - Thomas Mansencal - `thomas.mansencal@gmail.com `_ +| **sIBL_GUI** by Thomas Mansencal - 2008 - 2014 +| Copyright © 2008 - 2014 - Thomas Mansencal - `thomas.mansencal@gmail.com `_ | This software is released under terms of GNU GPL V3 license: http://www.gnu.org/licenses/ | http://www.thomasmansencal.com/ \ No newline at end of file diff --git a/docs/help/sIBL_GUI_Manual_Body.html b/docs/help/sIBL_GUI_Manual_Body.html index de61ddc4..aab634cb 100644 --- a/docs/help/sIBL_GUI_Manual_Body.html +++ b/docs/help/sIBL_GUI_Manual_Body.html @@ -6454,13 +6454,13 @@

- sIBL_GUI by Thomas Mansencal - 2008 - 2013 + sIBL_GUI by Thomas Mansencal - 2008 - 2014
- Copyright© 2008 - 2013 - Thomas Mansencal - thomas.mansencal@gmail.com + Copyright © 2008 - 2014 - Thomas Mansencal - thomas.mansencal@gmail.com
diff --git a/docs/sphinx/source/resources/pages/about.rst b/docs/sphinx/source/resources/pages/about.rst index 1d77bb8c..c33e0339 100644 --- a/docs/sphinx/source/resources/pages/about.rst +++ b/docs/sphinx/source/resources/pages/about.rst @@ -1,7 +1,7 @@ About ----- -| **sIBL_GUI** by Thomas Mansencal – 2008 - 2013 -| Copyright© 2008 - 2013 – Thomas Mansencal – `thomas.mansencal@gmail.com `_ +| **sIBL_GUI** by Thomas Mansencal – 2008 - 2014 +| Copyright © 2008 - 2014 – Thomas Mansencal – `thomas.mansencal@gmail.com `_ | This software is released under terms of GNU GPL V3 license: http://www.gnu.org/licenses/ | `http://www.thomasmansencal.com/ `_ \ No newline at end of file diff --git a/setup.py b/setup.py index d60237d3..03150d3f 100644 --- a/setup.py +++ b/setup.py @@ -50,7 +50,7 @@ def _setEncoding(): #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/__init__.py b/sibl_gui/__init__.py index 410331ef..269d6572 100644 --- a/sibl_gui/__init__.py +++ b/sibl_gui/__init__.py @@ -17,7 +17,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/addons/about/about.py b/sibl_gui/components/addons/about/about.py index bdbda41a..bd2af84c 100644 --- a/sibl_gui/components/addons/about/about.py +++ b/sibl_gui/components/addons/about/about.py @@ -37,7 +37,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" @@ -91,7 +91,7 @@ thomas.mansencal@gmail.com

-sIBL_GUI by Thomas Mansencal - 2008 - 2013 +sIBL_GUI by Thomas Mansencal - 2008 - 2014
This software is released under terms of GNU GPL v3 license: http://www.gnu.org/licenses/ diff --git a/sibl_gui/components/addons/cachesOperations/cachesOperations.py b/sibl_gui/components/addons/cachesOperations/cachesOperations.py index f341744f..061ce437 100644 --- a/sibl_gui/components/addons/cachesOperations/cachesOperations.py +++ b/sibl_gui/components/addons/cachesOperations/cachesOperations.py @@ -43,7 +43,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/addons/databaseOperations/databaseOperations.py b/sibl_gui/components/addons/databaseOperations/databaseOperations.py index aecb8974..87be6248 100644 --- a/sibl_gui/components/addons/databaseOperations/databaseOperations.py +++ b/sibl_gui/components/addons/databaseOperations/databaseOperations.py @@ -43,7 +43,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/addons/gpsMap/gpsMap.py b/sibl_gui/components/addons/gpsMap/gpsMap.py index d6471005..6aac3dbf 100644 --- a/sibl_gui/components/addons/gpsMap/gpsMap.py +++ b/sibl_gui/components/addons/gpsMap/gpsMap.py @@ -45,7 +45,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/addons/gpsMap/views.py b/sibl_gui/components/addons/gpsMap/views.py index d6a9d39e..13d26440 100644 --- a/sibl_gui/components/addons/gpsMap/views.py +++ b/sibl_gui/components/addons/gpsMap/views.py @@ -35,7 +35,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/addons/iblSetsScanner/iblSetsScanner.py b/sibl_gui/components/addons/iblSetsScanner/iblSetsScanner.py index 976885cb..a9572e40 100644 --- a/sibl_gui/components/addons/iblSetsScanner/iblSetsScanner.py +++ b/sibl_gui/components/addons/iblSetsScanner/iblSetsScanner.py @@ -40,7 +40,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/addons/iblSetsScanner/workers.py b/sibl_gui/components/addons/iblSetsScanner/workers.py index de7314d3..317dd1fa 100644 --- a/sibl_gui/components/addons/iblSetsScanner/workers.py +++ b/sibl_gui/components/addons/iblSetsScanner/workers.py @@ -43,7 +43,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/addons/loaderScript/loaderScript.py b/sibl_gui/components/addons/loaderScript/loaderScript.py index f0a1c4df..9d919b5a 100644 --- a/sibl_gui/components/addons/loaderScript/loaderScript.py +++ b/sibl_gui/components/addons/loaderScript/loaderScript.py @@ -47,7 +47,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py b/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py index 2358b422..ab970a31 100644 --- a/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py +++ b/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py @@ -59,7 +59,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/addons/loaderScriptOptions/views.py b/sibl_gui/components/addons/loaderScriptOptions/views.py index 720d7f72..a804bedb 100644 --- a/sibl_gui/components/addons/loaderScriptOptions/views.py +++ b/sibl_gui/components/addons/loaderScriptOptions/views.py @@ -25,7 +25,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/addons/locationsBrowser/locationsBrowser.py b/sibl_gui/components/addons/locationsBrowser/locationsBrowser.py index f29adfa9..042aa360 100644 --- a/sibl_gui/components/addons/locationsBrowser/locationsBrowser.py +++ b/sibl_gui/components/addons/locationsBrowser/locationsBrowser.py @@ -45,7 +45,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/addons/loggingNotifier/loggingNotifier.py b/sibl_gui/components/addons/loggingNotifier/loggingNotifier.py index 3ce966b7..1e498ca0 100644 --- a/sibl_gui/components/addons/loggingNotifier/loggingNotifier.py +++ b/sibl_gui/components/addons/loggingNotifier/loggingNotifier.py @@ -30,7 +30,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/addons/onlineUpdater/downloadManager.py b/sibl_gui/components/addons/onlineUpdater/downloadManager.py index bd01c013..81239f90 100644 --- a/sibl_gui/components/addons/onlineUpdater/downloadManager.py +++ b/sibl_gui/components/addons/onlineUpdater/downloadManager.py @@ -44,7 +44,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/addons/onlineUpdater/onlineUpdater.py b/sibl_gui/components/addons/onlineUpdater/onlineUpdater.py index 5596f5a0..f31437e3 100644 --- a/sibl_gui/components/addons/onlineUpdater/onlineUpdater.py +++ b/sibl_gui/components/addons/onlineUpdater/onlineUpdater.py @@ -48,7 +48,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/addons/onlineUpdater/remoteUpdater.py b/sibl_gui/components/addons/onlineUpdater/remoteUpdater.py index 39d5347d..861ff993 100644 --- a/sibl_gui/components/addons/onlineUpdater/remoteUpdater.py +++ b/sibl_gui/components/addons/onlineUpdater/remoteUpdater.py @@ -57,7 +57,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/addons/onlineUpdater/views.py b/sibl_gui/components/addons/onlineUpdater/views.py index 87932e26..dbdd95a3 100644 --- a/sibl_gui/components/addons/onlineUpdater/views.py +++ b/sibl_gui/components/addons/onlineUpdater/views.py @@ -30,7 +30,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/addons/preview/imagesPreviewer.py b/sibl_gui/components/addons/preview/imagesPreviewer.py index e127df5d..b2e54230 100644 --- a/sibl_gui/components/addons/preview/imagesPreviewer.py +++ b/sibl_gui/components/addons/preview/imagesPreviewer.py @@ -48,7 +48,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/addons/preview/preview.py b/sibl_gui/components/addons/preview/preview.py index 2694efb5..2efc31e7 100644 --- a/sibl_gui/components/addons/preview/preview.py +++ b/sibl_gui/components/addons/preview/preview.py @@ -54,7 +54,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/addons/rawEditingUtilities/rawEditingUtilities.py b/sibl_gui/components/addons/rawEditingUtilities/rawEditingUtilities.py index dd83e862..c10dc317 100644 --- a/sibl_gui/components/addons/rawEditingUtilities/rawEditingUtilities.py +++ b/sibl_gui/components/addons/rawEditingUtilities/rawEditingUtilities.py @@ -48,7 +48,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/addons/rewiringTool/rewiringTool.py b/sibl_gui/components/addons/rewiringTool/rewiringTool.py index 8fac6654..ea06e0e7 100644 --- a/sibl_gui/components/addons/rewiringTool/rewiringTool.py +++ b/sibl_gui/components/addons/rewiringTool/rewiringTool.py @@ -43,7 +43,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/addons/sIBLeditUtilities/sIBLeditUtilities.py b/sibl_gui/components/addons/sIBLeditUtilities/sIBLeditUtilities.py index cea61ef2..7f2f0eab 100644 --- a/sibl_gui/components/addons/sIBLeditUtilities/sIBLeditUtilities.py +++ b/sibl_gui/components/addons/sIBLeditUtilities/sIBLeditUtilities.py @@ -43,7 +43,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/addons/searchDatabase/searchDatabase.py b/sibl_gui/components/addons/searchDatabase/searchDatabase.py index 631dcb83..02859599 100644 --- a/sibl_gui/components/addons/searchDatabase/searchDatabase.py +++ b/sibl_gui/components/addons/searchDatabase/searchDatabase.py @@ -49,7 +49,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/addons/searchDatabase/views.py b/sibl_gui/components/addons/searchDatabase/views.py index ce7d692b..adbc6432 100644 --- a/sibl_gui/components/addons/searchDatabase/views.py +++ b/sibl_gui/components/addons/searchDatabase/views.py @@ -30,7 +30,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/core/collectionsOutliner/collectionsOutliner.py b/sibl_gui/components/core/collectionsOutliner/collectionsOutliner.py index 5571477a..9d672b41 100644 --- a/sibl_gui/components/core/collectionsOutliner/collectionsOutliner.py +++ b/sibl_gui/components/core/collectionsOutliner/collectionsOutliner.py @@ -62,7 +62,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/core/collectionsOutliner/models.py b/sibl_gui/components/core/collectionsOutliner/models.py index 60eac102..50e31af7 100644 --- a/sibl_gui/components/core/collectionsOutliner/models.py +++ b/sibl_gui/components/core/collectionsOutliner/models.py @@ -30,7 +30,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/core/collectionsOutliner/nodes.py b/sibl_gui/components/core/collectionsOutliner/nodes.py index f7ab3056..009c1372 100644 --- a/sibl_gui/components/core/collectionsOutliner/nodes.py +++ b/sibl_gui/components/core/collectionsOutliner/nodes.py @@ -35,7 +35,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/core/collectionsOutliner/views.py b/sibl_gui/components/core/collectionsOutliner/views.py index a417d860..6e949cb2 100644 --- a/sibl_gui/components/core/collectionsOutliner/views.py +++ b/sibl_gui/components/core/collectionsOutliner/views.py @@ -40,7 +40,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/core/database/database.py b/sibl_gui/components/core/database/database.py index d69e0aa0..1bd3daeb 100644 --- a/sibl_gui/components/core/database/database.py +++ b/sibl_gui/components/core/database/database.py @@ -41,7 +41,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/core/database/exceptions.py b/sibl_gui/components/core/database/exceptions.py index 5878a9ba..599c5904 100644 --- a/sibl_gui/components/core/database/exceptions.py +++ b/sibl_gui/components/core/database/exceptions.py @@ -28,7 +28,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/core/database/nodes.py b/sibl_gui/components/core/database/nodes.py index 89ba0092..f1946724 100644 --- a/sibl_gui/components/core/database/nodes.py +++ b/sibl_gui/components/core/database/nodes.py @@ -40,7 +40,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/core/database/operations.py b/sibl_gui/components/core/database/operations.py index 4a84ed2c..336320d9 100644 --- a/sibl_gui/components/core/database/operations.py +++ b/sibl_gui/components/core/database/operations.py @@ -40,7 +40,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/core/database/types.py b/sibl_gui/components/core/database/types.py index 9529e2f1..f8e390e9 100644 --- a/sibl_gui/components/core/database/types.py +++ b/sibl_gui/components/core/database/types.py @@ -39,7 +39,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/core/iblSetsOutliner/iblSetsOutliner.py b/sibl_gui/components/core/iblSetsOutliner/iblSetsOutliner.py index 9998b0ca..c801b733 100644 --- a/sibl_gui/components/core/iblSetsOutliner/iblSetsOutliner.py +++ b/sibl_gui/components/core/iblSetsOutliner/iblSetsOutliner.py @@ -73,7 +73,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/core/iblSetsOutliner/models.py b/sibl_gui/components/core/iblSetsOutliner/models.py index 6426b4b6..69e6aef5 100644 --- a/sibl_gui/components/core/iblSetsOutliner/models.py +++ b/sibl_gui/components/core/iblSetsOutliner/models.py @@ -36,7 +36,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/core/iblSetsOutliner/views.py b/sibl_gui/components/core/iblSetsOutliner/views.py index b4735bf9..5e90bba0 100644 --- a/sibl_gui/components/core/iblSetsOutliner/views.py +++ b/sibl_gui/components/core/iblSetsOutliner/views.py @@ -39,7 +39,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/core/inspector/inspector.py b/sibl_gui/components/core/inspector/inspector.py index 942e2203..fa4e825e 100644 --- a/sibl_gui/components/core/inspector/inspector.py +++ b/sibl_gui/components/core/inspector/inspector.py @@ -67,7 +67,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/core/inspector/models.py b/sibl_gui/components/core/inspector/models.py index 6ef33120..a58e75fb 100644 --- a/sibl_gui/components/core/inspector/models.py +++ b/sibl_gui/components/core/inspector/models.py @@ -30,7 +30,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/core/inspector/nodes.py b/sibl_gui/components/core/inspector/nodes.py index fc2777f8..3cb28754 100644 --- a/sibl_gui/components/core/inspector/nodes.py +++ b/sibl_gui/components/core/inspector/nodes.py @@ -36,7 +36,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/core/inspector/views.py b/sibl_gui/components/core/inspector/views.py index a19838b5..f1fbc6bb 100644 --- a/sibl_gui/components/core/inspector/views.py +++ b/sibl_gui/components/core/inspector/views.py @@ -39,7 +39,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/core/templatesOutliner/models.py b/sibl_gui/components/core/templatesOutliner/models.py index 5b6e856b..c8f7f43d 100644 --- a/sibl_gui/components/core/templatesOutliner/models.py +++ b/sibl_gui/components/core/templatesOutliner/models.py @@ -30,7 +30,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/core/templatesOutliner/nodes.py b/sibl_gui/components/core/templatesOutliner/nodes.py index 85f834e5..46e05eb1 100644 --- a/sibl_gui/components/core/templatesOutliner/nodes.py +++ b/sibl_gui/components/core/templatesOutliner/nodes.py @@ -35,7 +35,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/core/templatesOutliner/templatesOutliner.py b/sibl_gui/components/core/templatesOutliner/templatesOutliner.py index 8d1ccb06..0765e314 100644 --- a/sibl_gui/components/core/templatesOutliner/templatesOutliner.py +++ b/sibl_gui/components/core/templatesOutliner/templatesOutliner.py @@ -70,7 +70,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/components/core/templatesOutliner/views.py b/sibl_gui/components/core/templatesOutliner/views.py index 94afe79a..66098b34 100644 --- a/sibl_gui/components/core/templatesOutliner/views.py +++ b/sibl_gui/components/core/templatesOutliner/views.py @@ -39,7 +39,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/exceptions.py b/sibl_gui/exceptions.py index 5ef73ce4..1b206751 100644 --- a/sibl_gui/exceptions.py +++ b/sibl_gui/exceptions.py @@ -28,7 +28,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/globals/constants.py b/sibl_gui/globals/constants.py index 3d20a694..4a936061 100644 --- a/sibl_gui/globals/constants.py +++ b/sibl_gui/globals/constants.py @@ -34,7 +34,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/globals/runtimeGlobals.py b/sibl_gui/globals/runtimeGlobals.py index 9c89cd3c..1572159d 100644 --- a/sibl_gui/globals/runtimeGlobals.py +++ b/sibl_gui/globals/runtimeGlobals.py @@ -23,7 +23,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/globals/uiConstants.py b/sibl_gui/globals/uiConstants.py index 278c4a0f..8d0562e3 100644 --- a/sibl_gui/globals/uiConstants.py +++ b/sibl_gui/globals/uiConstants.py @@ -23,7 +23,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/launcher.py b/sibl_gui/launcher.py index e3d013cd..69b2bfed 100644 --- a/sibl_gui/launcher.py +++ b/sibl_gui/launcher.py @@ -102,7 +102,7 @@ def _overrideDependenciesGlobals(): #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/libraries/freeImage/freeImage.py b/sibl_gui/libraries/freeImage/freeImage.py index f36e8420..8509f5e0 100644 --- a/sibl_gui/libraries/freeImage/freeImage.py +++ b/sibl_gui/libraries/freeImage/freeImage.py @@ -45,7 +45,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/resources/patches/001_migrate_3-x-x_to_4-0-0.py b/sibl_gui/resources/patches/001_migrate_3-x-x_to_4-0-0.py index f78fa511..0d5cbdcc 100644 --- a/sibl_gui/resources/patches/001_migrate_3-x-x_to_4-0-0.py +++ b/sibl_gui/resources/patches/001_migrate_3-x-x_to_4-0-0.py @@ -42,7 +42,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/resources/patches/002_migrate_4-x-x_to_4-0-2.py b/sibl_gui/resources/patches/002_migrate_4-x-x_to_4-0-2.py index 6d8e5483..a415ce3a 100644 --- a/sibl_gui/resources/patches/002_migrate_4-x-x_to_4-0-2.py +++ b/sibl_gui/resources/patches/002_migrate_4-x-x_to_4-0-2.py @@ -37,7 +37,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/resources/patches/003_migrate_4-x-x_to_4-0-3.py b/sibl_gui/resources/patches/003_migrate_4-x-x_to_4-0-3.py index d7c7e59f..10875127 100644 --- a/sibl_gui/resources/patches/003_migrate_4-x-x_to_4-0-3.py +++ b/sibl_gui/resources/patches/003_migrate_4-x-x_to_4-0-3.py @@ -38,7 +38,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/resources/patches/004_migrate_4-x-x_to_4-0-7.py b/sibl_gui/resources/patches/004_migrate_4-x-x_to_4-0-7.py index 4565257e..4c3fe3b9 100644 --- a/sibl_gui/resources/patches/004_migrate_4-x-x_to_4-0-7.py +++ b/sibl_gui/resources/patches/004_migrate_4-x-x_to_4-0-7.py @@ -42,7 +42,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/tests/tests.py b/sibl_gui/tests/tests.py index 6af6f10e..d44b73e3 100644 --- a/sibl_gui/tests/tests.py +++ b/sibl_gui/tests/tests.py @@ -33,7 +33,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/tests/testsInternational.py b/sibl_gui/tests/testsInternational.py index 2b240465..51fbf5b2 100644 --- a/sibl_gui/tests/testsInternational.py +++ b/sibl_gui/tests/testsInternational.py @@ -36,7 +36,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/tests/testsSibl_gui/testsExceptions.py b/sibl_gui/tests/testsSibl_gui/testsExceptions.py index d7d8f7c8..a7bc6c2d 100644 --- a/sibl_gui/tests/testsSibl_gui/testsExceptions.py +++ b/sibl_gui/tests/testsSibl_gui/testsExceptions.py @@ -38,7 +38,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/tests/testsSibl_gui/testsGlobals/testsConstants.py b/sibl_gui/tests/testsSibl_gui/testsGlobals/testsConstants.py index d03c6112..5ed3e7b4 100644 --- a/sibl_gui/tests/testsSibl_gui/testsGlobals/testsConstants.py +++ b/sibl_gui/tests/testsSibl_gui/testsGlobals/testsConstants.py @@ -37,7 +37,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/tests/testsSibl_gui/testsGlobals/testsRuntimeGlobals.py b/sibl_gui/tests/testsSibl_gui/testsGlobals/testsRuntimeGlobals.py index 0533c532..1f7b8691 100644 --- a/sibl_gui/tests/testsSibl_gui/testsGlobals/testsRuntimeGlobals.py +++ b/sibl_gui/tests/testsSibl_gui/testsGlobals/testsRuntimeGlobals.py @@ -37,7 +37,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/tests/testsSibl_gui/testsGlobals/testsUiConstants.py b/sibl_gui/tests/testsSibl_gui/testsGlobals/testsUiConstants.py index e29972ec..4c72100f 100644 --- a/sibl_gui/tests/testsSibl_gui/testsGlobals/testsUiConstants.py +++ b/sibl_gui/tests/testsSibl_gui/testsGlobals/testsUiConstants.py @@ -38,7 +38,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/tests/utilities.py b/sibl_gui/tests/utilities.py index 33f3f22b..454ab1cb 100644 --- a/sibl_gui/tests/utilities.py +++ b/sibl_gui/tests/utilities.py @@ -28,7 +28,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/ui/caches.py b/sibl_gui/ui/caches.py index d2ec2f65..21cba347 100644 --- a/sibl_gui/ui/caches.py +++ b/sibl_gui/ui/caches.py @@ -39,7 +39,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/ui/common.py b/sibl_gui/ui/common.py index e57df6fd..4b92a511 100644 --- a/sibl_gui/ui/common.py +++ b/sibl_gui/ui/common.py @@ -52,7 +52,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/ui/models.py b/sibl_gui/ui/models.py index 48890e16..0af6f7c2 100644 --- a/sibl_gui/ui/models.py +++ b/sibl_gui/ui/models.py @@ -36,7 +36,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/ui/nodes.py b/sibl_gui/ui/nodes.py index d17bb302..2d667cdb 100644 --- a/sibl_gui/ui/nodes.py +++ b/sibl_gui/ui/nodes.py @@ -35,7 +35,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/ui/views.py b/sibl_gui/ui/views.py index e5d0f2cd..2f8f99e0 100644 --- a/sibl_gui/ui/views.py +++ b/sibl_gui/ui/views.py @@ -31,7 +31,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/ui/widgets/application_QToolBar.py b/sibl_gui/ui/widgets/application_QToolBar.py index ab68680a..72bf5fee 100644 --- a/sibl_gui/ui/widgets/application_QToolBar.py +++ b/sibl_gui/ui/widgets/application_QToolBar.py @@ -43,7 +43,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/sibl_gui/ui/workers.py b/sibl_gui/ui/workers.py index f6b79711..6d13ec54 100644 --- a/sibl_gui/ui/workers.py +++ b/sibl_gui/ui/workers.py @@ -38,7 +38,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/utilities/__init__.py b/utilities/__init__.py index 410331ef..269d6572 100644 --- a/utilities/__init__.py +++ b/utilities/__init__.py @@ -17,7 +17,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/utilities/darwinSetup.py b/utilities/darwinSetup.py index 4291d2b7..6d087960 100755 --- a/utilities/darwinSetup.py +++ b/utilities/darwinSetup.py @@ -28,7 +28,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/utilities/getDependenciesInformations.py b/utilities/getDependenciesInformations.py index d6a84d0c..8ca25737 100755 --- a/utilities/getDependenciesInformations.py +++ b/utilities/getDependenciesInformations.py @@ -39,7 +39,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/utilities/getHDRLabsDocumentation.py b/utilities/getHDRLabsDocumentation.py index 57d8dec6..80ee73a6 100644 --- a/utilities/getHDRLabsDocumentation.py +++ b/utilities/getHDRLabsDocumentation.py @@ -35,7 +35,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/utilities/getPackagePath.py b/utilities/getPackagePath.py index 1863920f..acf02ee1 100755 --- a/utilities/getPackagePath.py +++ b/utilities/getPackagePath.py @@ -28,7 +28,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/utilities/getSphinxDocumentationApi.py b/utilities/getSphinxDocumentationApi.py index 5f0fee63..55888802 100755 --- a/utilities/getSphinxDocumentationApi.py +++ b/utilities/getSphinxDocumentationApi.py @@ -47,7 +47,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/utilities/getSphinxDocumentationTocTree.py b/utilities/getSphinxDocumentationTocTree.py index 56bf95a4..0645f248 100644 --- a/utilities/getSphinxDocumentationTocTree.py +++ b/utilities/getSphinxDocumentationTocTree.py @@ -42,7 +42,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/utilities/listImports.py b/utilities/listImports.py index 5352ebaf..3f79a8ac 100644 --- a/utilities/listImports.py +++ b/utilities/listImports.py @@ -36,7 +36,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/utilities/reStructuredTextToHtml.py b/utilities/reStructuredTextToHtml.py index 917e04fd..bffe7c45 100644 --- a/utilities/reStructuredTextToHtml.py +++ b/utilities/reStructuredTextToHtml.py @@ -35,7 +35,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/utilities/recursiveRemove.py b/utilities/recursiveRemove.py index 4bd329d6..ab86b66c 100644 --- a/utilities/recursiveRemove.py +++ b/utilities/recursiveRemove.py @@ -29,7 +29,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/utilities/sliceDocumentation.py b/utilities/sliceDocumentation.py index 3f232420..304a9619 100644 --- a/utilities/sliceDocumentation.py +++ b/utilities/sliceDocumentation.py @@ -40,7 +40,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" diff --git a/utilities/windowsSetup.py b/utilities/windowsSetup.py index e26d04f2..2df28e72 100644 --- a/utilities/windowsSetup.py +++ b/utilities/windowsSetup.py @@ -28,7 +28,7 @@ #*** Module attributes. #********************************************************************************************************************** __author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" __license__ = "GPL V3.0 - http://www.gnu.org/licenses/" __maintainer__ = "Thomas Mansencal" __email__ = "thomas.mansencal@gmail.com" From 01867b3111f158bfb9ce99bec5627f2ff2677adf Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Sat, 1 Mar 2014 12:30:47 +0100 Subject: [PATCH 13/54] Update class objects docstrings. --- .../cachesOperations/cachesOperations.py | 2 +- .../databaseOperations/databaseOperations.py | 4 +- sibl_gui/components/addons/gpsMap/gpsMap.py | 2 +- sibl_gui/components/addons/gpsMap/views.py | 2 +- .../addons/iblSetsScanner/iblSetsScanner.py | 2 +- .../addons/iblSetsScanner/workers.py | 2 +- .../addons/loaderScript/loaderScript.py | 2 +- .../loaderScriptOptions.py | 2 +- .../addons/loaderScriptOptions/views.py | 2 +- .../locationsBrowser/locationsBrowser.py | 2 +- .../addons/loggingNotifier/loggingNotifier.py | 2 +- .../addons/onlineUpdater/downloadManager.py | 2 +- .../addons/onlineUpdater/onlineUpdater.py | 2 +- .../addons/onlineUpdater/remoteUpdater.py | 4 +- .../components/addons/onlineUpdater/views.py | 2 +- .../addons/preview/imagesPreviewer.py | 4 +- sibl_gui/components/addons/preview/preview.py | 2 +- .../rawEditingUtilities.py | 2 +- .../addons/rewiringTool/rewiringTool.py | 2 +- .../sIBLeditUtilities/sIBLeditUtilities.py | 2 +- .../addons/searchDatabase/searchDatabase.py | 2 +- .../components/addons/searchDatabase/views.py | 2 +- .../collectionsOutliner.py | 2 +- .../core/collectionsOutliner/models.py | 2 +- .../core/collectionsOutliner/nodes.py | 2 +- .../core/collectionsOutliner/views.py | 2 +- sibl_gui/components/core/database/database.py | 2 +- .../components/core/database/exceptions.py | 24 ++++++------ sibl_gui/components/core/database/nodes.py | 4 +- sibl_gui/components/core/database/types.py | 6 +-- .../core/iblSetsOutliner/iblSetsOutliner.py | 2 +- .../components/core/iblSetsOutliner/models.py | 2 +- .../components/core/iblSetsOutliner/views.py | 4 +- .../components/core/inspector/inspector.py | 6 +-- sibl_gui/components/core/inspector/models.py | 2 +- sibl_gui/components/core/inspector/nodes.py | 2 +- sibl_gui/components/core/inspector/views.py | 2 +- .../core/templatesOutliner/models.py | 2 +- .../core/templatesOutliner/nodes.py | 2 +- .../templatesOutliner/templatesOutliner.py | 2 +- .../core/templatesOutliner/views.py | 2 +- sibl_gui/exceptions.py | 14 +++---- sibl_gui/globals/constants.py | 2 +- sibl_gui/globals/runtimeGlobals.py | 2 +- sibl_gui/globals/uiConstants.py | 2 +- sibl_gui/launcher.py | 2 +- sibl_gui/libraries/freeImage/freeImage.py | 38 +++++++++---------- .../tests/testsSibl_gui/testsExceptions.py | 2 +- .../testsGlobals/testsConstants.py | 2 +- .../testsGlobals/testsRuntimeGlobals.py | 2 +- .../testsGlobals/testsUiConstants.py | 2 +- sibl_gui/ui/caches.py | 6 +-- sibl_gui/ui/models.py | 2 +- sibl_gui/ui/nodes.py | 6 +-- sibl_gui/ui/views.py | 6 +-- sibl_gui/ui/widgets/application_QToolBar.py | 2 +- sibl_gui/ui/workers.py | 2 +- 57 files changed, 107 insertions(+), 107 deletions(-) diff --git a/sibl_gui/components/addons/cachesOperations/cachesOperations.py b/sibl_gui/components/addons/cachesOperations/cachesOperations.py index 061ce437..a374f377 100644 --- a/sibl_gui/components/addons/cachesOperations/cachesOperations.py +++ b/sibl_gui/components/addons/cachesOperations/cachesOperations.py @@ -60,7 +60,7 @@ #********************************************************************************************************************** class CachesOperations(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): """ - | This class is the :mod:`sibl_gui.components.addons.cachesOperations.cachesOperations` Component Interface class. + | Defines the :mod:`sibl_gui.components.addons.cachesOperations.cachesOperations` Component Interface class. | It provides various methods to operate on the images caches. """ diff --git a/sibl_gui/components/addons/databaseOperations/databaseOperations.py b/sibl_gui/components/addons/databaseOperations/databaseOperations.py index 87be6248..ccb44a46 100644 --- a/sibl_gui/components/addons/databaseOperations/databaseOperations.py +++ b/sibl_gui/components/addons/databaseOperations/databaseOperations.py @@ -60,7 +60,7 @@ #********************************************************************************************************************** class DatabaseType(foundations.dataStructures.Structure): """ - | This class represents a storage object for manipulation methods associated to a given Database type. + | Defines a storage object for manipulation methods associated to a given Database type. | See :mod:`sibl_gui.components.core.database.types` module for more informations about the available Database types. """ @@ -78,7 +78,7 @@ def __init__(self, **kwargs): class DatabaseOperations(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): """ - | This class is the :mod:`sibl_gui.components.addons.databaseOperations.databaseOperations` Component Interface class. + | Defines the :mod:`sibl_gui.components.addons.databaseOperations.databaseOperations` Component Interface class. | It provides various methods to operate on the Database. """ diff --git a/sibl_gui/components/addons/gpsMap/gpsMap.py b/sibl_gui/components/addons/gpsMap/gpsMap.py index 6aac3dbf..e63085a4 100644 --- a/sibl_gui/components/addons/gpsMap/gpsMap.py +++ b/sibl_gui/components/addons/gpsMap/gpsMap.py @@ -62,7 +62,7 @@ #********************************************************************************************************************** class GpsMap(QWidgetComponentFactory(uiFile=COMPONENT_FILE)): """ - | This class is the :mod:`sibl_gui.components.addons.gpsMap.gpsMap` Component Interface class. + | Defines the :mod:`sibl_gui.components.addons.gpsMap.gpsMap` Component Interface class. | It displays the GPS map inside a `QDockWidget `_ window. """ diff --git a/sibl_gui/components/addons/gpsMap/views.py b/sibl_gui/components/addons/gpsMap/views.py index 13d26440..53662676 100644 --- a/sibl_gui/components/addons/gpsMap/views.py +++ b/sibl_gui/components/addons/gpsMap/views.py @@ -50,7 +50,7 @@ #********************************************************************************************************************** class Map_QWebView(QWebView): """ - | This class is a `QWebView `_ subclass used for the GPS map. + | Defines a `QWebView `_ subclass used for the GPS map. | It provides various methods to manipulate the `Microsoft Bing Maps `_ defined in the Component resources html file through Javascript evaluation. """ diff --git a/sibl_gui/components/addons/iblSetsScanner/iblSetsScanner.py b/sibl_gui/components/addons/iblSetsScanner/iblSetsScanner.py index a9572e40..04511431 100644 --- a/sibl_gui/components/addons/iblSetsScanner/iblSetsScanner.py +++ b/sibl_gui/components/addons/iblSetsScanner/iblSetsScanner.py @@ -55,7 +55,7 @@ #********************************************************************************************************************** class IblSetsScanner(QObjectComponent): """ - | This class is the :mod:`sibl_gui.components.addons.iblSetsScanner.iblSetsScanner` Component Interface class. + | Defines the :mod:`sibl_gui.components.addons.iblSetsScanner.iblSetsScanner` Component Interface class. | It instantiates the :class:`IblSetsScanner` class on Application startup which will gather new Ibl Sets from Database registered directories parents. """ diff --git a/sibl_gui/components/addons/iblSetsScanner/workers.py b/sibl_gui/components/addons/iblSetsScanner/workers.py index 317dd1fa..64ab7340 100644 --- a/sibl_gui/components/addons/iblSetsScanner/workers.py +++ b/sibl_gui/components/addons/iblSetsScanner/workers.py @@ -58,7 +58,7 @@ #********************************************************************************************************************** class IblSetsScanner_worker(QThread): """ - This class is a `QThread `_ subclass used to retrieve + Defines a `QThread `_ subclass used to retrieve new Ibl Sets from Database registered directories parents. """ diff --git a/sibl_gui/components/addons/loaderScript/loaderScript.py b/sibl_gui/components/addons/loaderScript/loaderScript.py index 9d919b5a..e24a9d6f 100644 --- a/sibl_gui/components/addons/loaderScript/loaderScript.py +++ b/sibl_gui/components/addons/loaderScript/loaderScript.py @@ -64,7 +64,7 @@ #********************************************************************************************************************** class LoaderScript(QWidgetComponentFactory(uiFile=COMPONENT_FILE)): """ - | This class is the :mod:`sibl_gui.components.addons.loaderScript.loaderScript` Component Interface class. + | Defines the :mod:`sibl_gui.components.addons.loaderScript.loaderScript` Component Interface class. | It provides the glue between the Ibl Sets, the Templates and the 3d package. A typical operation is the following: diff --git a/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py b/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py index ab970a31..8c911d88 100644 --- a/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py +++ b/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py @@ -76,7 +76,7 @@ #********************************************************************************************************************** class LoaderScriptOptions(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): """ - | This class isthe :mod:`sibl_gui.components.addons.loaderScriptOptions.loaderScriptOptions` Component Interface class. + | Definesthe :mod:`sibl_gui.components.addons.loaderScriptOptions.loaderScriptOptions` Component Interface class. | It provides override keys on request for the :mod:`sibl_gui.components.addons.loaderScript.loaderScript` Component. | It exposes Templates files **Common Attributes** and **Additional Attributes** sections so that the user can configure the behavior of the Loader Script. diff --git a/sibl_gui/components/addons/loaderScriptOptions/views.py b/sibl_gui/components/addons/loaderScriptOptions/views.py index a804bedb..3cd545d9 100644 --- a/sibl_gui/components/addons/loaderScriptOptions/views.py +++ b/sibl_gui/components/addons/loaderScriptOptions/views.py @@ -40,7 +40,7 @@ #********************************************************************************************************************** class TemplatesAttributes_QTableWidget(umbra.ui.views.Abstract_QTableWidget): """ - This class is used to display Templates attributes. + Defines the view for Templates attributes. """ pass diff --git a/sibl_gui/components/addons/locationsBrowser/locationsBrowser.py b/sibl_gui/components/addons/locationsBrowser/locationsBrowser.py index 042aa360..ed5e0ebd 100644 --- a/sibl_gui/components/addons/locationsBrowser/locationsBrowser.py +++ b/sibl_gui/components/addons/locationsBrowser/locationsBrowser.py @@ -62,7 +62,7 @@ #********************************************************************************************************************** class LocationsBrowser(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): """ - | This class is the :mod:`sibl_gui.components.addons.locationsBrowser.locationsBrowser` Component Interface class. + | Defines the :mod:`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 diff --git a/sibl_gui/components/addons/loggingNotifier/loggingNotifier.py b/sibl_gui/components/addons/loggingNotifier/loggingNotifier.py index 1e498ca0..a69809bd 100644 --- a/sibl_gui/components/addons/loggingNotifier/loggingNotifier.py +++ b/sibl_gui/components/addons/loggingNotifier/loggingNotifier.py @@ -45,7 +45,7 @@ #********************************************************************************************************************** class LoggingNotifier(Component): """ - | This class is the :mod:`sibl_gui.components.addons.loggingNotifier.loggingNotifier` Component Interface class. + | Defines the :mod:`sibl_gui.components.addons.loggingNotifier.loggingNotifier` Component Interface class. | It displays Application logging messages in the Application status bar. | The full Application logging history is available through the :mod:`sibl_gui.components.addons.loggingWindow.loggingWindow` Component. diff --git a/sibl_gui/components/addons/onlineUpdater/downloadManager.py b/sibl_gui/components/addons/onlineUpdater/downloadManager.py index 81239f90..2bf96f62 100644 --- a/sibl_gui/components/addons/onlineUpdater/downloadManager.py +++ b/sibl_gui/components/addons/onlineUpdater/downloadManager.py @@ -61,7 +61,7 @@ #********************************************************************************************************************** class DownloadManager(foundations.ui.common.QWidgetFactory(uiFile=UI_FILE)): """ - | This class defines the Application download manager. + | Defines the Application download manager. | Once initialized with a `QNetworkAccessManager `_ instance, a download directory and a list of requests ( List of online resources / files ), this class can proceed of the download of those requests using the :meth:`DownloadManager.startDownload` method. diff --git a/sibl_gui/components/addons/onlineUpdater/onlineUpdater.py b/sibl_gui/components/addons/onlineUpdater/onlineUpdater.py index f31437e3..22794c16 100644 --- a/sibl_gui/components/addons/onlineUpdater/onlineUpdater.py +++ b/sibl_gui/components/addons/onlineUpdater/onlineUpdater.py @@ -67,7 +67,7 @@ #********************************************************************************************************************** class OnlineUpdater(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): """ - | This class is the :mod:`sibl_gui.components.addons.onlineUpdater.onlineUpdater` Component Interface class. + | Defines the :mod:`sibl_gui.components.addons.onlineUpdater.onlineUpdater` Component Interface class. | This Component provides online updating capabilities to the Application available through options exposed in the :mod:`sibl_gui.components.core.preferencesManager.preferencesManager` Component ui. """ diff --git a/sibl_gui/components/addons/onlineUpdater/remoteUpdater.py b/sibl_gui/components/addons/onlineUpdater/remoteUpdater.py index 861ff993..9f40bef4 100644 --- a/sibl_gui/components/addons/onlineUpdater/remoteUpdater.py +++ b/sibl_gui/components/addons/onlineUpdater/remoteUpdater.py @@ -74,7 +74,7 @@ #********************************************************************************************************************** class ReleaseObject(foundations.dataStructures.Structure): """ - This class represents a storage object for a :class:`RemoteUpdater` class release. + Defines a storage object for a :class:`RemoteUpdater` class release. """ def __init__(self, **kwargs): @@ -90,7 +90,7 @@ def __init__(self, **kwargs): class RemoteUpdater(foundations.ui.common.QWidgetFactory(uiFile=UI_FILE)): """ - | This class defines the Application remote updater. + | Defines the Application remote updater. | The remote updater is initialized with a list of available online releases ( List of :class:`ReleaseObject` class instances ). """ diff --git a/sibl_gui/components/addons/onlineUpdater/views.py b/sibl_gui/components/addons/onlineUpdater/views.py index dbdd95a3..1d3691ab 100644 --- a/sibl_gui/components/addons/onlineUpdater/views.py +++ b/sibl_gui/components/addons/onlineUpdater/views.py @@ -45,7 +45,7 @@ #********************************************************************************************************************** class TemplatesReleases_QTableWidget(umbra.ui.views.Abstract_QTableWidget): """ - This class is used to display Templates releases. + Defines the view for Templates releases. """ pass diff --git a/sibl_gui/components/addons/preview/imagesPreviewer.py b/sibl_gui/components/addons/preview/imagesPreviewer.py index b2e54230..de747caa 100644 --- a/sibl_gui/components/addons/preview/imagesPreviewer.py +++ b/sibl_gui/components/addons/preview/imagesPreviewer.py @@ -65,7 +65,7 @@ #********************************************************************************************************************** class Image_QGraphicsItem(QGraphicsItem): """ - This class is a `QGraphicsItem `_ subclass used + Defines a `QGraphicsItem `_ subclass used to display given `QImage `_. """ @@ -215,7 +215,7 @@ def paint(self, painter, options, widget): class ImagesPreviewer(foundations.ui.common.QWidgetFactory(uiFile=UI_FILE)): """ - | This class provides the Application images previewer. + | Defines the Application images previewer. | It defines methods to navigate through the list of given images ( List of images paths ), zoom in / out and fit the displayed image, etc... """ diff --git a/sibl_gui/components/addons/preview/preview.py b/sibl_gui/components/addons/preview/preview.py index 2efc31e7..a5235a7c 100644 --- a/sibl_gui/components/addons/preview/preview.py +++ b/sibl_gui/components/addons/preview/preview.py @@ -71,7 +71,7 @@ #********************************************************************************************************************** class Preview(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): """ - | This class is the :mod:`sibl_gui.components.addons.preview.preview` Component Interface class. + | Defines the :mod:`sibl_gui.components.addons.preview.preview` Component Interface class. | It provides a basic image previewer. """ diff --git a/sibl_gui/components/addons/rawEditingUtilities/rawEditingUtilities.py b/sibl_gui/components/addons/rawEditingUtilities/rawEditingUtilities.py index c10dc317..13c0ed10 100644 --- a/sibl_gui/components/addons/rawEditingUtilities/rawEditingUtilities.py +++ b/sibl_gui/components/addons/rawEditingUtilities/rawEditingUtilities.py @@ -65,7 +65,7 @@ #********************************************************************************************************************** class RawEditingUtilities(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): """ - | This class is the :mod:`sibl_gui.components.addons.rawEditingUtilities.rawEditingUtilities` Component Interface class. + | Defines the :mod:`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 :mod:`sibl_gui.components.core.preferencesManager.preferencesManager` Component ui. diff --git a/sibl_gui/components/addons/rewiringTool/rewiringTool.py b/sibl_gui/components/addons/rewiringTool/rewiringTool.py index ea06e0e7..6f54ac77 100644 --- a/sibl_gui/components/addons/rewiringTool/rewiringTool.py +++ b/sibl_gui/components/addons/rewiringTool/rewiringTool.py @@ -60,7 +60,7 @@ #********************************************************************************************************************** class RewiringTool(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): """ - | This class is the :mod:`sibl_gui.components.addons.rewiringTool.rewiringTool` Component Interface class. + | Defines the :mod:`sibl_gui.components.addons.rewiringTool.rewiringTool` Component Interface class. | It provides override keys on request for the :mod:`sibl_gui.components.addons.loaderScript.loaderScript` Component. """ diff --git a/sibl_gui/components/addons/sIBLeditUtilities/sIBLeditUtilities.py b/sibl_gui/components/addons/sIBLeditUtilities/sIBLeditUtilities.py index 7f2f0eab..8fba14ed 100644 --- a/sibl_gui/components/addons/sIBLeditUtilities/sIBLeditUtilities.py +++ b/sibl_gui/components/addons/sIBLeditUtilities/sIBLeditUtilities.py @@ -60,7 +60,7 @@ #********************************************************************************************************************** class sIBLeditUtilities(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): """ - | This class is the :mod:`sibl_gui.components.addons.sIBLeditUtilities.sIBLeditUtilities` Component Interface class. + | Defines the :mod:`sibl_gui.components.addons.sIBLeditUtilities.sIBLeditUtilities` Component Interface class. | It provides methods to link the Application to sIBLedit. """ diff --git a/sibl_gui/components/addons/searchDatabase/searchDatabase.py b/sibl_gui/components/addons/searchDatabase/searchDatabase.py index 02859599..1c861f52 100644 --- a/sibl_gui/components/addons/searchDatabase/searchDatabase.py +++ b/sibl_gui/components/addons/searchDatabase/searchDatabase.py @@ -66,7 +66,7 @@ #********************************************************************************************************************** class SearchDatabase(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): """ - | This class is the :mod:`sibl_gui.components.addons.searchDatabase.searchDatabase` Component Interface class. + | Defines the :mod:`sibl_gui.components.addons.searchDatabase.searchDatabase` Component Interface class. | It provides methods for the user to search into the Database using various filters. """ diff --git a/sibl_gui/components/addons/searchDatabase/views.py b/sibl_gui/components/addons/searchDatabase/views.py index adbc6432..10a48499 100644 --- a/sibl_gui/components/addons/searchDatabase/views.py +++ b/sibl_gui/components/addons/searchDatabase/views.py @@ -45,7 +45,7 @@ #********************************************************************************************************************** class TagsCloud_QListView(umbra.ui.views.Abstract_QListWidget): """ - This class is used to display Database Ibl Sets tags cloud. + Defines the view for Database Ibl Sets tags cloud. """ pass diff --git a/sibl_gui/components/core/collectionsOutliner/collectionsOutliner.py b/sibl_gui/components/core/collectionsOutliner/collectionsOutliner.py index 9d672b41..c78cfedb 100644 --- a/sibl_gui/components/core/collectionsOutliner/collectionsOutliner.py +++ b/sibl_gui/components/core/collectionsOutliner/collectionsOutliner.py @@ -79,7 +79,7 @@ #********************************************************************************************************************** class CollectionsOutliner(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): """ - | This class is the :mod:`sibl_gui.components.core.collectionsOutliner.collectionsOutliner` Component Interface class. + | Defines the :mod:`sibl_gui.components.core.collectionsOutliner.collectionsOutliner` Component Interface class. | It defines methods for Database Collections management. """ diff --git a/sibl_gui/components/core/collectionsOutliner/models.py b/sibl_gui/components/core/collectionsOutliner/models.py index 50e31af7..52165a5a 100644 --- a/sibl_gui/components/core/collectionsOutliner/models.py +++ b/sibl_gui/components/core/collectionsOutliner/models.py @@ -45,7 +45,7 @@ #********************************************************************************************************************** class CollectionsModel(sibl_gui.ui.models.GraphModel): """ - This class defines the Model used the by + Defines the Model used the by :class:`sibl_gui.components.core.collectionsOutliner.collectionsOutliner.CollectionsOutliner` Component Interface class. """ diff --git a/sibl_gui/components/core/collectionsOutliner/nodes.py b/sibl_gui/components/core/collectionsOutliner/nodes.py index 009c1372..b5f7bd0f 100644 --- a/sibl_gui/components/core/collectionsOutliner/nodes.py +++ b/sibl_gui/components/core/collectionsOutliner/nodes.py @@ -50,7 +50,7 @@ #********************************************************************************************************************** class OverallCollectionNode(sibl_gui.ui.nodes.GraphModelNode): """ - This class factory defines :class:`sibl_gui.components.core.collectionsOutliner.collectionsOutliner.CollectionsOutliner` + Defines :class:`sibl_gui.components.core.collectionsOutliner.collectionsOutliner.CollectionsOutliner` Component Interface class Model **Overall** collection node. """ diff --git a/sibl_gui/components/core/collectionsOutliner/views.py b/sibl_gui/components/core/collectionsOutliner/views.py index 6e949cb2..1e0a5cde 100644 --- a/sibl_gui/components/core/collectionsOutliner/views.py +++ b/sibl_gui/components/core/collectionsOutliner/views.py @@ -55,7 +55,7 @@ #********************************************************************************************************************** class IblSetsCollections_QTreeView(sibl_gui.ui.views.Abstract_QTreeView): """ - This class is used to display Database Collections. + Defines the view for Database Collections. """ def __init__(self, parent, model=None, readOnly=False, message=None): diff --git a/sibl_gui/components/core/database/database.py b/sibl_gui/components/core/database/database.py index 1bd3daeb..caf80c3a 100644 --- a/sibl_gui/components/core/database/database.py +++ b/sibl_gui/components/core/database/database.py @@ -56,7 +56,7 @@ #********************************************************************************************************************** class Database(Component): """ - | This class is the :mod:`sibl_gui.components.core.database.database` Component Interface class. + | Defines the :mod:`sibl_gui.components.core.database.database` Component Interface class. | It provides Application Database creation and session, proceeds to its backup using the :mod:`foundations.rotatingBackup`. """ diff --git a/sibl_gui/components/core/database/exceptions.py b/sibl_gui/components/core/database/exceptions.py index 599c5904..b4895147 100644 --- a/sibl_gui/components/core/database/exceptions.py +++ b/sibl_gui/components/core/database/exceptions.py @@ -52,84 +52,84 @@ #********************************************************************************************************************** class AbstractDatabaseError(foundations.exceptions.AbstractError): """ - This class is the abstract base class for database related exceptions. + Defines the abstract base class for database related exceptions. """ pass class DatabaseOperationError(AbstractDatabaseError): """ - This class is used for Database operation exceptions. + Defines Database operation exceptions. """ pass class AbstractIblSetError(foundations.exceptions.AbstractError): """ - This class is the abstract base class for Ibl Set related exceptions. + Defines the abstract base class for Ibl Set related exceptions. """ pass class MissingIblSetFileError(AbstractIblSetError): """ - This class is used when an Ibl Set's file is missing. + Raises when an Ibl Set's file is missing. """ pass class MissingIblSetIconError(AbstractIblSetError): """ - This class is used when an Ibl Set's icon is missing. + Raises when an Ibl Set's icon is missing. """ pass class MissingIblSetPreviewImageError(AbstractIblSetError): """ - This class is used when an Ibl Set's preview image is missing. + Raises when an Ibl Set's preview image is missing. """ pass class MissingIblSetBackgroundImageError(AbstractIblSetError): """ - This class is used when an Ibl Set's background image is missing. + Raises when an Ibl Set's background image is missing. """ pass class MissingIblSetLightingImageError(AbstractIblSetError): """ - This class is used when an Ibl Set's lighting image is missing. + Raises when an Ibl Set's lighting image is missing. """ pass class MissingIblSetReflectionImageError(AbstractIblSetError): """ - This class is used when an Ibl Set's reflection image is missing. + Raises when an Ibl Set's reflection image is missing. """ pass class AbstractTemplateError(foundations.exceptions.AbstractError): """ - This class is the abstract base class for Template related exceptions. + Defines the abstract base class for Template related exceptions. """ pass class MissingTemplateFileError(AbstractTemplateError): """ - This class is used when a Template file is missing. + Raises when a Template file is missing. """ pass class MissingTemplateHelpFileError(AbstractTemplateError): """ - This class is used when a Template help file is missing. + Raises when a Template help file is missing. """ pass diff --git a/sibl_gui/components/core/database/nodes.py b/sibl_gui/components/core/database/nodes.py index f1946724..1cc90b37 100644 --- a/sibl_gui/components/core/database/nodes.py +++ b/sibl_gui/components/core/database/nodes.py @@ -71,7 +71,7 @@ def getTemplateUserName(title, software): class AbstractDatabaseNode(sibl_gui.ui.nodes.GraphModelNode): """ - This class defines Application Database abstract base class used by concrete Database Node classes. + Defines Application Database abstract base class used by concrete Database Node classes. """ __family = "AbstractDatabaseNode" @@ -276,7 +276,7 @@ def updateToolTip(self): class IblSetNode(AbstractDatabaseNode): """ - This class defines Ibl Sets nodes. + Defines Ibl Sets nodes. """ __family = "IblSet" diff --git a/sibl_gui/components/core/database/types.py b/sibl_gui/components/core/database/types.py index f8e390e9..6e849daa 100644 --- a/sibl_gui/components/core/database/types.py +++ b/sibl_gui/components/core/database/types.py @@ -56,7 +56,7 @@ class IblSet(Base): """ - This class defines the Database IblSets type. + Defines the Database IblSets type. """ __tablename__ = "IblSets" @@ -190,7 +190,7 @@ def setContent(self): class Template(Base): """ - This class defines the Database Template type. + Defines the Database Template type. """ __tablename__ = "Templates" @@ -320,7 +320,7 @@ def setContent(self): class Collection(Base): """ - This class defines the Database Collection type. + Defines the Database Collection type. """ __tablename__ = "Collections" diff --git a/sibl_gui/components/core/iblSetsOutliner/iblSetsOutliner.py b/sibl_gui/components/core/iblSetsOutliner/iblSetsOutliner.py index c801b733..ff5a52b1 100644 --- a/sibl_gui/components/core/iblSetsOutliner/iblSetsOutliner.py +++ b/sibl_gui/components/core/iblSetsOutliner/iblSetsOutliner.py @@ -90,7 +90,7 @@ #********************************************************************************************************************** class IblSetsOutliner(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): """ - | This class is the :mod:`sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner` Component Interface class. + | Defines the :mod:`sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner` Component Interface class. | It defines methods for Database Ibl Sets management. """ diff --git a/sibl_gui/components/core/iblSetsOutliner/models.py b/sibl_gui/components/core/iblSetsOutliner/models.py index 69e6aef5..e35dbd98 100644 --- a/sibl_gui/components/core/iblSetsOutliner/models.py +++ b/sibl_gui/components/core/iblSetsOutliner/models.py @@ -51,7 +51,7 @@ #********************************************************************************************************************** class IblSetsModel(sibl_gui.ui.models.GraphModel): """ - This class defines the Model used the by + Defines the Model used the by :class:`sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner.IblSetsOutliner` Component Interface class. """ diff --git a/sibl_gui/components/core/iblSetsOutliner/views.py b/sibl_gui/components/core/iblSetsOutliner/views.py index 5e90bba0..85f23fce 100644 --- a/sibl_gui/components/core/iblSetsOutliner/views.py +++ b/sibl_gui/components/core/iblSetsOutliner/views.py @@ -54,7 +54,7 @@ #********************************************************************************************************************** class Thumbnails_QListView(sibl_gui.ui.views.Abstract_QListView): """ - This class is used to display Database Ibl Sets as thumbnails. + Defines the view for Database Ibl Sets as thumbnails. """ def __init__(self, parent, model=None, readOnly=False, message=None): @@ -187,7 +187,7 @@ def __setDefaultUiState(self, iconsSize=None, iconsRatio=2): class Details_QTreeView(sibl_gui.ui.views.Abstract_QTreeView): """ - This class is used to display Database Ibl Sets columns. + Defines the view for Database Ibl Sets columns. """ def __init__(self, parent, model=None, readOnly=False, message=None): diff --git a/sibl_gui/components/core/inspector/inspector.py b/sibl_gui/components/core/inspector/inspector.py index fa4e825e..a04cdda9 100644 --- a/sibl_gui/components/core/inspector/inspector.py +++ b/sibl_gui/components/core/inspector/inspector.py @@ -84,7 +84,7 @@ #********************************************************************************************************************** class Plate(foundations.dataStructures.Structure): """ - This class represents a storage object for an Ibl Set Plate. + Defines a storage object for an Ibl Set Plate. """ def __init__(self, **kwargs): @@ -100,7 +100,7 @@ def __init__(self, **kwargs): class Light(foundations.dataStructures.Structure): """ - This class represents a storage object for an Ibl Set light. + Defines a storage object for an Ibl Set light. """ def __init__(self, **kwargs): @@ -116,7 +116,7 @@ def __init__(self, **kwargs): class Inspector(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): """ - | This class is the :mod:`sibl_gui.components.core.inspector.inspector` Component Interface class. + | Defines the :mod:`sibl_gui.components.core.inspector.inspector` Component Interface class. | It offers a large preview of the current inspected Ibl Set, and a way to navigate into the current selected Database Collection. """ diff --git a/sibl_gui/components/core/inspector/models.py b/sibl_gui/components/core/inspector/models.py index a58e75fb..31b120ed 100644 --- a/sibl_gui/components/core/inspector/models.py +++ b/sibl_gui/components/core/inspector/models.py @@ -45,7 +45,7 @@ #********************************************************************************************************************** class PlatesModel(sibl_gui.ui.models.GraphModel): """ - This class defines the Model used the by :class:`sibl_gui.components.core.inspector.inspector.Inspector` + Defines the Model used the by :class:`sibl_gui.components.core.inspector.inspector.Inspector` Component Interface class. """ diff --git a/sibl_gui/components/core/inspector/nodes.py b/sibl_gui/components/core/inspector/nodes.py index 3cb28754..1ad781a0 100644 --- a/sibl_gui/components/core/inspector/nodes.py +++ b/sibl_gui/components/core/inspector/nodes.py @@ -51,7 +51,7 @@ #********************************************************************************************************************** class PlatesNode(sibl_gui.ui.nodes.GraphModelNode): """ - This class factory defines :class:`sibl_gui.components.core.inspector.inspector.Inspector` + Defines :class:`sibl_gui.components.core.inspector.inspector.Inspector` Component Interface class Model Plates node. """ diff --git a/sibl_gui/components/core/inspector/views.py b/sibl_gui/components/core/inspector/views.py index f1fbc6bb..256161c9 100644 --- a/sibl_gui/components/core/inspector/views.py +++ b/sibl_gui/components/core/inspector/views.py @@ -54,7 +54,7 @@ #********************************************************************************************************************** class Plates_QListView(sibl_gui.ui.views.Abstract_QListView): """ - This class is used to display Ibl Sets Plates as thumbnails. + Defines the view for Ibl Sets Plates as thumbnails. """ def __init__(self, parent, model=None, readOnly=False, message=None): diff --git a/sibl_gui/components/core/templatesOutliner/models.py b/sibl_gui/components/core/templatesOutliner/models.py index c8f7f43d..065f4f59 100644 --- a/sibl_gui/components/core/templatesOutliner/models.py +++ b/sibl_gui/components/core/templatesOutliner/models.py @@ -45,7 +45,7 @@ #********************************************************************************************************************** class TemplatesModel(sibl_gui.ui.models.GraphModel): """ - This class defines the Model used the by + Defines the Model used the by :class:`sibl_gui.components.core.templatesOutliner.templatesOutliner.TemplatesOutliner` Component Interface class. """ diff --git a/sibl_gui/components/core/templatesOutliner/nodes.py b/sibl_gui/components/core/templatesOutliner/nodes.py index 46e05eb1..b3164076 100644 --- a/sibl_gui/components/core/templatesOutliner/nodes.py +++ b/sibl_gui/components/core/templatesOutliner/nodes.py @@ -50,7 +50,7 @@ #********************************************************************************************************************** class SoftwareNode(sibl_gui.ui.nodes.GraphModelNode): """ - This class factory defines :class:`sibl_gui.components.core.templatesOutliner.templatesOutliner.TemplatesOutliner` + Defines :class:`sibl_gui.components.core.templatesOutliner.templatesOutliner.TemplatesOutliner` Component Interface class Model software node. """ diff --git a/sibl_gui/components/core/templatesOutliner/templatesOutliner.py b/sibl_gui/components/core/templatesOutliner/templatesOutliner.py index 0765e314..c70e1be7 100644 --- a/sibl_gui/components/core/templatesOutliner/templatesOutliner.py +++ b/sibl_gui/components/core/templatesOutliner/templatesOutliner.py @@ -87,7 +87,7 @@ #********************************************************************************************************************** class TemplatesOutliner(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): """ - | This class is the :mod:`sibl_gui.components.core.templatesOutliner.templatesOutliner` Component Interface class. + | Defines the :mod:`sibl_gui.components.core.templatesOutliner.templatesOutliner` Component Interface class. | It defines methods for Database Templates management. """ diff --git a/sibl_gui/components/core/templatesOutliner/views.py b/sibl_gui/components/core/templatesOutliner/views.py index 66098b34..7dd5db9c 100644 --- a/sibl_gui/components/core/templatesOutliner/views.py +++ b/sibl_gui/components/core/templatesOutliner/views.py @@ -54,7 +54,7 @@ #********************************************************************************************************************** class Templates_QTreeView(sibl_gui.ui.views.Abstract_QTreeView): """ - This class is used to display Database Collections. + Defines the view for Database Collections. """ def __init__(self, parent, model=None, readOnly=False, message=None): diff --git a/sibl_gui/exceptions.py b/sibl_gui/exceptions.py index 1b206751..cd8d7bed 100644 --- a/sibl_gui/exceptions.py +++ b/sibl_gui/exceptions.py @@ -45,49 +45,49 @@ #********************************************************************************************************************** class AbstractNetworkError(foundations.exceptions.AbstractError): """ - This class is the abstract base class for network related exceptions. + Defines the abstract base class for network related exceptions. """ pass class NetworkError(AbstractNetworkError): """ - This class is used for network exceptions. + Defines network exceptions. """ pass class SocketConnectionError(AbstractNetworkError): """ - This class is used for socket connection exceptions. + Defines socket connection exceptions. """ pass class Win32OLEServerConnectionError(AbstractNetworkError): """ - This class is used for Win32OLE Server connection exceptions. + Defines Win32OLE Server connection exceptions. """ pass class AbstractCacheError(foundations.exceptions.AbstractError): """ - This class is the abstract base class for caching related exceptions. + Defines the abstract base class for caching related exceptions. """ pass class CacheExistsError(foundations.exceptions.AbstractError): """ - This class is used for non existing cache exceptions. + Defines non existing cache exceptions. """ pass class CacheOperationError(foundations.exceptions.AbstractError): """ - This class is used for cache operations exceptions. + Defines cache operations exceptions. """ pass diff --git a/sibl_gui/globals/constants.py b/sibl_gui/globals/constants.py index 4a936061..144f1548 100644 --- a/sibl_gui/globals/constants.py +++ b/sibl_gui/globals/constants.py @@ -47,7 +47,7 @@ #********************************************************************************************************************** class Constants(): """ - This class provides **sIBL_GUI** package default constants. + Defines **sIBL_GUI** package default constants. """ applicationName = "sIBL_GUI" diff --git a/sibl_gui/globals/runtimeGlobals.py b/sibl_gui/globals/runtimeGlobals.py index 1572159d..6a73266e 100644 --- a/sibl_gui/globals/runtimeGlobals.py +++ b/sibl_gui/globals/runtimeGlobals.py @@ -36,7 +36,7 @@ #********************************************************************************************************************** class RuntimeGlobals(): """ - This class provides **sIBL_GUI** package runtime constants. + Defines **sIBL_GUI** package runtime constants. """ templatesFactoryDirectory = None diff --git a/sibl_gui/globals/uiConstants.py b/sibl_gui/globals/uiConstants.py index 8d0562e3..513c7a05 100644 --- a/sibl_gui/globals/uiConstants.py +++ b/sibl_gui/globals/uiConstants.py @@ -36,7 +36,7 @@ #********************************************************************************************************************** class UiConstants(): """ - This class provides **sIBL_GUI** package ui constants. + Defines **sIBL_GUI** package ui constants. """ uiFile = "sIBL_GUI.ui" diff --git a/sibl_gui/launcher.py b/sibl_gui/launcher.py index 69b2bfed..47c8b6ed 100644 --- a/sibl_gui/launcher.py +++ b/sibl_gui/launcher.py @@ -117,7 +117,7 @@ def _overrideDependenciesGlobals(): #********************************************************************************************************************** class sIBL_GUI(umbra.engine.Umbra): """ - This class is the main class of the **sIBL_GUI** package. + Defines the main class of the **sIBL_GUI** package. """ def __init__(self, diff --git a/sibl_gui/libraries/freeImage/freeImage.py b/sibl_gui/libraries/freeImage/freeImage.py index 8509f5e0..fabfea43 100644 --- a/sibl_gui/libraries/freeImage/freeImage.py +++ b/sibl_gui/libraries/freeImage/freeImage.py @@ -499,7 +499,7 @@ def unchecked(type): class FIBITMAP(ctypes.Structure): """ - This class is a :class:`ctypes.Structure` subclass representing FreeImage **FIBITMAP** C / C++ object. + Defines a :class:`ctypes.Structure` subclass representing FreeImage **FIBITMAP** C / C++ object. """ __slots__ = ["data"] @@ -507,7 +507,7 @@ class FIBITMAP(ctypes.Structure): class FIMULTIBITMAP(ctypes.Structure): """ - This class is a :class:`ctypes.Structure` subclass representing FreeImage **FIMULTIBITMAP** C / C++ object. + Defines a :class:`ctypes.Structure` subclass representing FreeImage **FIMULTIBITMAP** C / C++ object. """ __slots__ = ["data"] @@ -515,7 +515,7 @@ class FIMULTIBITMAP(ctypes.Structure): class tagRGBQUAD(ctypes.Structure): """ - This class is a :class:`ctypes.Structure` subclass representing FreeImage **tagRGBQUAD** C / C++ object. + Defines a :class:`ctypes.Structure` subclass representing FreeImage **tagRGBQUAD** C / C++ object. """ __slots__ = ["rgbBlue", "rgbGreen", "rgbRed", "rgbReserved"] @@ -535,7 +535,7 @@ class tagRGBQUAD(ctypes.Structure): class tagRGBTRIPLE(ctypes.Structure): """ - This class is a :class:`ctypes.Structure` subclass representing FreeImage **tagRGBTRIPLE** C / C++ object. + Defines a :class:`ctypes.Structure` subclass representing FreeImage **tagRGBTRIPLE** C / C++ object. """ __slots__ = ["rgbBlue", "rgbGreen", "rgbRed"] @@ -554,7 +554,7 @@ class tagRGBTRIPLE(ctypes.Structure): class tagBITMAPINFOHEADER(ctypes.Structure): """ - This class is a :class:`ctypes.Structure` subclass representing FreeImage **tagBITMAPINFOHEADER** C / C++ object. + Defines a :class:`ctypes.Structure` subclass representing FreeImage **tagBITMAPINFOHEADER** C / C++ object. """ __slots__ = ["biSize", "biWidth", @@ -584,7 +584,7 @@ class tagBITMAPINFOHEADER(ctypes.Structure): class tagBITMAPINFO(ctypes.Structure): """ - This class is a :class:`ctypes.Structure` subclass representing FreeImage **tagBITMAPINFO** C / C++ object. + Defines a :class:`ctypes.Structure` subclass representing FreeImage **tagBITMAPINFO** C / C++ object. """ __slots__ = ["bmiHeader", "bmiColors"] _fields_ = [("bmiHeader", BITMAPINFOHEADER), @@ -596,7 +596,7 @@ class tagBITMAPINFO(ctypes.Structure): class tagFIRGB16(ctypes.Structure): """ - This class is a :class:`ctypes.Structure` subclass representing FreeImage **tagFIRGB16** C / C++ object. + Defines a :class:`ctypes.Structure` subclass representing FreeImage **tagFIRGB16** C / C++ object. """ __slots__ = ["red", "green", "blue"] @@ -608,7 +608,7 @@ class tagFIRGB16(ctypes.Structure): class tagFIRGBA16(ctypes.Structure): """ - This class is a :class:`ctypes.Structure` subclass representing FreeImage **tagFIRGBA16** C / C++ object. + Defines a :class:`ctypes.Structure` subclass representing FreeImage **tagFIRGBA16** C / C++ object. """ __slots__ = ["red", "green", "blue", "alpha"] @@ -621,7 +621,7 @@ class tagFIRGBA16(ctypes.Structure): class tagFIRGBF(ctypes.Structure): """ - This class is a :class:`ctypes.Structure` subclass representing FreeImage **tagFIRGBF** C / C++ object. + Defines a :class:`ctypes.Structure` subclass representing FreeImage **tagFIRGBF** C / C++ object. """ __slots__ = ["red", "green", "blue"] @@ -633,7 +633,7 @@ class tagFIRGBF(ctypes.Structure): class tagFIRGBAF(ctypes.Structure): """ - This class is a :class:`ctypes.Structure` subclass representing FreeImage **tagFIRGBAF** C / C++ object. + Defines a :class:`ctypes.Structure` subclass representing FreeImage **tagFIRGBAF** C / C++ object. """ __slots__ = ["red", "green", "blue", "alpha"] @@ -646,7 +646,7 @@ class tagFIRGBAF(ctypes.Structure): class tagFICOMPLEX(ctypes.Structure): """ - This class is a :class:`ctypes.Structure` subclass representing FreeImage **tagFICOMPLEX** C / C++ object. + Defines a :class:`ctypes.Structure` subclass representing FreeImage **tagFICOMPLEX** C / C++ object. """ __slots__ = ["r", "i"] @@ -746,7 +746,7 @@ class tagFICOMPLEX(ctypes.Structure): class FIICCPROFILE(ctypes.Structure): """ - This class is a :class:`ctypes.Structure` subclass representing FreeImage **FIICCPROFILE** C / C++ object. + Defines a :class:`ctypes.Structure` subclass representing FreeImage **FIICCPROFILE** C / C++ object. """ __slots__ = ["flags", "size", "data"] @@ -920,7 +920,7 @@ class FIICCPROFILE(ctypes.Structure): class FIMETADATA(ctypes.Structure): """ - This class is a :class:`ctypes.Structure` subclass representing FreeImage **FIMETADATA** C / C++ object. + Defines a :class:`ctypes.Structure` subclass representing FreeImage **FIMETADATA** C / C++ object. """ __slots__ = ["data"] @@ -928,7 +928,7 @@ class FIMETADATA(ctypes.Structure): class FITAG(ctypes.Structure): """ - This class is a :class:`ctypes.Structure` subclass representing FreeImage **FITAG** C / C++ object. + Defines a :class:`ctypes.Structure` subclass representing FreeImage **FITAG** C / C++ object. """ __slots__ = ["data"] @@ -947,7 +947,7 @@ class FITAG(ctypes.Structure): class FreeImageIO(ctypes.Structure): """ - This class is a :class:`ctypes.Structure` subclass representing FreeImage **FreeImageIO** C / C++ object. + Defines a :class:`ctypes.Structure` subclass representing FreeImage **FreeImageIO** C / C++ object. """ __slots__ = ["read_proc", "write_proc", "seek_proc", "tell_proc"] @@ -958,7 +958,7 @@ class FreeImageIO(ctypes.Structure): class FIMEMORY(ctypes.Structure): """ - This class is a :class:`ctypes.Structure` subclass representing FreeImage **FIMEMORY** C / C++ object. + Defines a :class:`ctypes.Structure` subclass representing FreeImage **FIMEMORY** C / C++ object. """ __slots__ = ["data"] @@ -997,7 +997,7 @@ class FIMEMORY(ctypes.Structure): class Plugin(ctypes.Structure): """ - This class is a :class:`ctypes.Structure` subclass representing FreeImage **Plugin** C / C++ object. + Defines a :class:`ctypes.Structure` subclass representing FreeImage **Plugin** C / C++ object. """ __slots__ = ["format_proc", @@ -2016,7 +2016,7 @@ def getFreeImageLibraryPath(): class ImageInformationsHeader(foundations.dataStructures.Structure): """ - This class represents a storage object for image informations header. + Defines a storage object for image informations header. """ def __init__(self, **kwargs): @@ -2032,7 +2032,7 @@ def __init__(self, **kwargs): class Image(object): """ - This class provides various methods to manipulate images files. + Defines various methods to manipulate images files. """ def __init__(self, imagePath=None): diff --git a/sibl_gui/tests/testsSibl_gui/testsExceptions.py b/sibl_gui/tests/testsSibl_gui/testsExceptions.py index a7bc6c2d..9bf71e22 100644 --- a/sibl_gui/tests/testsSibl_gui/testsExceptions.py +++ b/sibl_gui/tests/testsSibl_gui/testsExceptions.py @@ -67,7 +67,7 @@ def _gatherExceptions(): #********************************************************************************************************************** class ExceptionsTestCase(unittest.TestCase): """ - This class defines :mod:`sibl_gui.exceptions` module exceptions classes units tests methods. + Defines :mod:`sibl_gui.exceptions` module exceptions classes units tests methods. """ def testRequiredAttributes(self): diff --git a/sibl_gui/tests/testsSibl_gui/testsGlobals/testsConstants.py b/sibl_gui/tests/testsSibl_gui/testsGlobals/testsConstants.py index 5ed3e7b4..69515707 100644 --- a/sibl_gui/tests/testsSibl_gui/testsGlobals/testsConstants.py +++ b/sibl_gui/tests/testsSibl_gui/testsGlobals/testsConstants.py @@ -50,7 +50,7 @@ #********************************************************************************************************************** class ConstantsTestCase(unittest.TestCase): """ - This class defines :class:`sibl_gui.globals.constants.Constants` class units tests methods. + Defines :class:`sibl_gui.globals.constants.Constants` class units tests methods. """ def testRequiredAttributes(self): diff --git a/sibl_gui/tests/testsSibl_gui/testsGlobals/testsRuntimeGlobals.py b/sibl_gui/tests/testsSibl_gui/testsGlobals/testsRuntimeGlobals.py index 1f7b8691..b98e6f3e 100644 --- a/sibl_gui/tests/testsSibl_gui/testsGlobals/testsRuntimeGlobals.py +++ b/sibl_gui/tests/testsSibl_gui/testsGlobals/testsRuntimeGlobals.py @@ -50,7 +50,7 @@ #********************************************************************************************************************** class RuntimeGlobalsTestCase(unittest.TestCase): """ - This class defines :class:`sibl_gui.globals.runtimeGlobals.RuntimeGlobals` class units tests methods. + Defines :class:`sibl_gui.globals.runtimeGlobals.RuntimeGlobals` class units tests methods. """ def testRequiredAttributes(self): diff --git a/sibl_gui/tests/testsSibl_gui/testsGlobals/testsUiConstants.py b/sibl_gui/tests/testsSibl_gui/testsGlobals/testsUiConstants.py index 4c72100f..b99e6506 100644 --- a/sibl_gui/tests/testsSibl_gui/testsGlobals/testsUiConstants.py +++ b/sibl_gui/tests/testsSibl_gui/testsGlobals/testsUiConstants.py @@ -51,7 +51,7 @@ #********************************************************************************************************************** class UiConstantsTestCase(unittest.TestCase): """ - This class defines :class:`sibl_gui.globals.uiConstants.UiConstants` class units tests methods. + Defines :class:`sibl_gui.globals.uiConstants.UiConstants` class units tests methods. """ def testRequiredAttributes(self): diff --git a/sibl_gui/ui/caches.py b/sibl_gui/ui/caches.py index 21cba347..a02cbe95 100644 --- a/sibl_gui/ui/caches.py +++ b/sibl_gui/ui/caches.py @@ -57,7 +57,7 @@ #********************************************************************************************************************** class CacheMetrics(foundations.dataStructures.Structure): """ - This class represents a storage object for cache metrics. + Defines a storage object for cache metrics. """ def __init__(self, **kwargs): @@ -73,7 +73,7 @@ def __init__(self, **kwargs): class AbstractResourcesCache(QObject): """ - This class is a `QObject `_ subclass used as an abstract resources cache. + Defines a `QObject `_ subclass used as an abstract resources cache. """ contentAdded = pyqtSignal(list) @@ -280,7 +280,7 @@ def getMetrics(self): class AsynchronousGraphicsItemsCache(AbstractResourcesCache): """ - This class provides an asynchronous graphics items cache. + Defines an asynchronous graphics items cache. """ def __init__(self, parent=None, type=None, placeholder=None): diff --git a/sibl_gui/ui/models.py b/sibl_gui/ui/models.py index 0af6f7c2..c95632d8 100644 --- a/sibl_gui/ui/models.py +++ b/sibl_gui/ui/models.py @@ -51,7 +51,7 @@ #********************************************************************************************************************** class GraphModel(umbra.ui.models.GraphModel): """ - This class provideds a graph Model based on :class:`umbra.ui.models.GraphModel` + Defines a graph Model based on :class:`umbra.ui.models.GraphModel` but reimplementing the :meth:`umbra.ui.models.GraphModel.data` method to support various images formats as **Qt.DecorationRole**. """ diff --git a/sibl_gui/ui/nodes.py b/sibl_gui/ui/nodes.py index 2d667cdb..3d7e5124 100644 --- a/sibl_gui/ui/nodes.py +++ b/sibl_gui/ui/nodes.py @@ -53,7 +53,7 @@ #********************************************************************************************************************** class Mixin_GraphModelObject(object): """ - This class is a mixin used to bring common capabilities in Application Nodes classes. + Defines a mixin used to bring common capabilities in Application Nodes classes. """ def __init__(self): @@ -141,7 +141,7 @@ def iconPlaceholder(self): class GraphModelAttribute(umbra.ui.nodes.GraphModelAttribute, Mixin_GraphModelObject): """ - This class represents a storage object for the :class:`GraphModelNode` class attributes. + Defines a storage object for the :class:`GraphModelNode` class attributes. """ def __init__(self, @@ -175,7 +175,7 @@ def __init__(self, class GraphModelNode(umbra.ui.nodes.GraphModelNode, Mixin_GraphModelObject): """ - This class defines :class:`GraphModel` class base Node object. + Defines :class:`GraphModel` class base Node object. """ __family = "GraphModel" diff --git a/sibl_gui/ui/views.py b/sibl_gui/ui/views.py index 2f8f99e0..85d04043 100644 --- a/sibl_gui/ui/views.py +++ b/sibl_gui/ui/views.py @@ -49,7 +49,7 @@ #********************************************************************************************************************** class Mixin_AbstractView(object): """ - This class is a mixin used to bring common capabilities in Application Views classes. + Defines a mixin used to bring common capabilities in Application Views classes. """ def __init__(self, model=None): @@ -180,7 +180,7 @@ def restoreModelSelection(self): class Abstract_QListView(umbra.ui.views.Abstract_QListView, Mixin_AbstractView): """ - This class used as base by others Application Views classes. + Defines the base class used by others Application Views classes. """ def __init__(self, parent=None, model=None, readOnly=False, message=None): @@ -200,7 +200,7 @@ def __init__(self, parent=None, model=None, readOnly=False, message=None): class Abstract_QTreeView(umbra.ui.views.Abstract_QTreeView, Mixin_AbstractView): """ - This class used as base by others Application Views classes. + Defines the base class used by others Application Views classes. """ def __init__(self, parent=None, model=None, readOnly=False, message=None): diff --git a/sibl_gui/ui/widgets/application_QToolBar.py b/sibl_gui/ui/widgets/application_QToolBar.py index 72bf5fee..a4504087 100644 --- a/sibl_gui/ui/widgets/application_QToolBar.py +++ b/sibl_gui/ui/widgets/application_QToolBar.py @@ -58,7 +58,7 @@ #********************************************************************************************************************** class Application_QToolBar(umbra.ui.widgets.application_QToolBar.Application_QToolBar): """ - This class is defines the Application toolbar. + Defines defines the Application toolbar. """ __metaclass__ = umbra.guerilla.baseWarfare diff --git a/sibl_gui/ui/workers.py b/sibl_gui/ui/workers.py index 6d13ec54..62939b5e 100644 --- a/sibl_gui/ui/workers.py +++ b/sibl_gui/ui/workers.py @@ -53,7 +53,7 @@ #********************************************************************************************************************** class GraphicsItem_worker(QThread): """ - This class is a `QThread `_ subclass used to load images. + Defines a `QThread `_ subclass used to load images. """ # If the signal uses **QImage** as signature instead of **object**, a copy gets passed to the slot instead From aa7c12366dc2882e083b1440292cc0b82d6b01d0 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Sat, 1 Mar 2014 16:08:57 +0100 Subject: [PATCH 14/54] Update definitions and methods docstrings. --- setup.py | 4 +- sibl_gui/__init__.py | 2 +- sibl_gui/components/addons/about/about.py | 30 +- .../cachesOperations/cachesOperations.py | 44 +-- .../databaseOperations/databaseOperations.py | 66 ++-- sibl_gui/components/addons/gpsMap/gpsMap.py | 92 +++--- sibl_gui/components/addons/gpsMap/views.py | 14 +- .../addons/iblSetsScanner/iblSetsScanner.py | 38 +-- .../addons/iblSetsScanner/workers.py | 30 +- .../addons/loaderScript/loaderScript.py | 110 +++---- .../loaderScriptOptions.py | 130 ++++---- .../locationsBrowser/locationsBrowser.py | 110 +++---- .../addons/loggingNotifier/loggingNotifier.py | 24 +- .../addons/onlineUpdater/downloadManager.py | 86 +++--- .../addons/onlineUpdater/onlineUpdater.py | 112 +++---- .../addons/onlineUpdater/remoteUpdater.py | 104 +++---- .../addons/preview/imagesPreviewer.py | 166 +++++----- sibl_gui/components/addons/preview/preview.py | 122 ++++---- .../rawEditingUtilities.py | 104 +++---- .../addons/rewiringTool/rewiringTool.py | 68 ++--- .../sIBLeditUtilities/sIBLeditUtilities.py | 72 ++--- .../addons/searchDatabase/searchDatabase.py | 76 ++--- .../collectionsOutliner.py | 156 +++++----- .../core/collectionsOutliner/models.py | 4 +- .../core/collectionsOutliner/nodes.py | 8 +- .../core/collectionsOutliner/views.py | 28 +- sibl_gui/components/core/database/database.py | 66 ++-- sibl_gui/components/core/database/nodes.py | 40 +-- .../components/core/database/operations.py | 80 ++--- sibl_gui/components/core/database/types.py | 10 +- .../core/iblSetsOutliner/iblSetsOutliner.py | 288 +++++++++--------- .../components/core/iblSetsOutliner/models.py | 6 +- .../components/core/iblSetsOutliner/views.py | 30 +- .../components/core/inspector/inspector.py | 144 ++++----- sibl_gui/components/core/inspector/models.py | 4 +- sibl_gui/components/core/inspector/nodes.py | 14 +- sibl_gui/components/core/inspector/views.py | 12 +- .../core/templatesOutliner/models.py | 4 +- .../core/templatesOutliner/nodes.py | 4 +- .../templatesOutliner/templatesOutliner.py | 122 ++++---- .../core/templatesOutliner/views.py | 22 +- sibl_gui/launcher.py | 34 +-- sibl_gui/libraries/freeImage/freeImage.py | 50 +-- .../patches/001_migrate_3-x-x_to_4-0-0.py | 2 +- .../patches/002_migrate_4-x-x_to_4-0-2.py | 2 +- .../patches/003_migrate_4-x-x_to_4-0-3.py | 2 +- .../patches/004_migrate_4-x-x_to_4-0-7.py | 2 +- sibl_gui/tests/tests.py | 4 +- sibl_gui/tests/testsInternational.py | 2 +- .../tests/testsSibl_gui/testsExceptions.py | 6 +- .../testsGlobals/testsConstants.py | 58 ++-- .../testsGlobals/testsRuntimeGlobals.py | 2 +- .../testsGlobals/testsUiConstants.py | 100 +++--- sibl_gui/ui/caches.py | 74 ++--- sibl_gui/ui/common.py | 24 +- sibl_gui/ui/models.py | 4 +- sibl_gui/ui/nodes.py | 18 +- sibl_gui/ui/views.py | 22 +- sibl_gui/ui/widgets/application_QToolBar.py | 12 +- sibl_gui/ui/workers.py | 16 +- utilities/__init__.py | 2 +- utilities/getDependenciesInformations.py | 2 +- utilities/getHDRLabsDocumentation.py | 2 +- utilities/getSphinxDocumentationApi.py | 2 +- utilities/getSphinxDocumentationTocTree.py | 2 +- utilities/listImports.py | 2 +- utilities/reStructuredTextToHtml.py | 2 +- utilities/recursiveRemove.py | 4 +- 68 files changed, 1549 insertions(+), 1549 deletions(-) diff --git a/setup.py b/setup.py index 03150d3f..1a76bc48 100644 --- a/setup.py +++ b/setup.py @@ -24,7 +24,7 @@ #********************************************************************************************************************** def _setEncoding(): """ - This definition sets the Package encoding. + Sets the Package encoding. """ import sys @@ -63,7 +63,7 @@ def _setEncoding(): #********************************************************************************************************************** def getLongDescription(): """ - This definition returns the Package long description. + Returns the Package long description. :return: Package long description. ( String ) """ diff --git a/sibl_gui/__init__.py b/sibl_gui/__init__.py index 269d6572..3fb4857c 100644 --- a/sibl_gui/__init__.py +++ b/sibl_gui/__init__.py @@ -32,7 +32,7 @@ #********************************************************************************************************************** def _setEncoding(): """ - This definition sets the Package encoding. + Sets the Package encoding. """ import sys diff --git a/sibl_gui/components/addons/about/about.py b/sibl_gui/components/addons/about/about.py index bd2af84c..1ff146b8 100644 --- a/sibl_gui/components/addons/about/about.py +++ b/sibl_gui/components/addons/about/about.py @@ -155,7 +155,7 @@ def __init__(self, parent=None, name=None, *args, **kwargs): @property def uiResourcesDirectory(self): """ - This method is the property for **self.__uiResourcesDirectory** attribute. + Property for **self.__uiResourcesDirectory** attribute. :return: self.__uiResourcesDirectory. ( String ) """ @@ -166,7 +166,7 @@ def uiResourcesDirectory(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiResourcesDirectory(self, value): """ - This method is the setter method for **self.__uiResourcesDirectory** attribute. + Setter for **self.__uiResourcesDirectory** attribute. :param value: Attribute value. ( String ) """ @@ -178,7 +178,7 @@ def uiResourcesDirectory(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiResourcesDirectory(self): """ - This method is the deleter method for **self.__uiResourcesDirectory** attribute. + Deleter for **self.__uiResourcesDirectory** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -187,7 +187,7 @@ def uiResourcesDirectory(self): @property def uiLogoImage(self): """ - This method is the property for **self.__uiLogoImage** attribute. + Property for **self.__uiLogoImage** attribute. :return: self.__uiLogoImage. ( String ) """ @@ -198,7 +198,7 @@ def uiLogoImage(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiLogoImage(self, value): """ - This method is the setter method for **self.__uiLogoImage** attribute. + Setter for **self.__uiLogoImage** attribute. :param value: Attribute value. ( String ) """ @@ -210,7 +210,7 @@ def uiLogoImage(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiLogoImage(self): """ - This method is the deleter method for **self.__uiLogoImage** attribute. + Deleter for **self.__uiLogoImage** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -219,7 +219,7 @@ def uiLogoImage(self): @property def uiGpl3Image(self): """ - This method is the property for **self.__uiGpl3Image** attribute. + Property for **self.__uiGpl3Image** attribute. :return: self.__uiGpl3Image. ( String ) """ @@ -230,7 +230,7 @@ def uiGpl3Image(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiGpl3Image(self, value): """ - This method is the setter method for **self.__uiGpl3Image** attribute. + Setter for **self.__uiGpl3Image** attribute. :param value: Attribute value. ( String ) """ @@ -242,7 +242,7 @@ def uiGpl3Image(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiGpl3Image(self): """ - This method is the deleter method for **self.__uiGpl3Image** attribute. + Deleter for **self.__uiGpl3Image** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -251,7 +251,7 @@ def uiGpl3Image(self): @property def engine(self): """ - This method is the property for **self.__engine** attribute. + Property for **self.__engine** attribute. :return: self.__engine. ( QObject ) """ @@ -262,7 +262,7 @@ def engine(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self, value): """ - This method is the setter method for **self.__engine** attribute. + Setter for **self.__engine** attribute. :param value: Attribute value. ( QObject ) """ @@ -274,7 +274,7 @@ def engine(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self): """ - This method is the deleter method for **self.__engine** attribute. + Deleter for **self.__engine** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -283,7 +283,7 @@ def engine(self): @property def miscellaneousMenu(self): """ - This method is the property for **self.__miscellaneousMenu** attribute. + Property for **self.__miscellaneousMenu** attribute. :return: self.__miscellaneousMenu. ( QMenu ) """ @@ -294,7 +294,7 @@ def miscellaneousMenu(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def miscellaneousMenu(self, value): """ - This method is the setter method for **self.__miscellaneousMenu** attribute. + Setter for **self.__miscellaneousMenu** attribute. :param value: Attribute value. ( QMenu ) """ @@ -306,7 +306,7 @@ def miscellaneousMenu(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def miscellaneousMenu(self): """ - This method is the deleter method for **self.__miscellaneousMenu** attribute. + Deleter for **self.__miscellaneousMenu** attribute. """ raise foundations.exceptions.ProgrammingError( diff --git a/sibl_gui/components/addons/cachesOperations/cachesOperations.py b/sibl_gui/components/addons/cachesOperations/cachesOperations.py index a374f377..62feadd9 100644 --- a/sibl_gui/components/addons/cachesOperations/cachesOperations.py +++ b/sibl_gui/components/addons/cachesOperations/cachesOperations.py @@ -66,7 +66,7 @@ class CachesOperations(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): def __init__(self, parent=None, name=None, *args, **kwargs): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param name: Component name. ( String ) @@ -92,7 +92,7 @@ def __init__(self, parent=None, name=None, *args, **kwargs): @property def engine(self): """ - This method is the property for **self.__engine** attribute. + Property for **self.__engine** attribute. :return: self.__engine. ( QObject ) """ @@ -103,7 +103,7 @@ def engine(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self, value): """ - This method is the setter method for **self.__engine** attribute. + Setter for **self.__engine** attribute. :param value: Attribute value. ( QObject ) """ @@ -115,7 +115,7 @@ def engine(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self): """ - This method is the deleter method for **self.__engine** attribute. + Deleter for **self.__engine** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -124,7 +124,7 @@ def engine(self): @property def scriptEditor(self): """ - This method is the property for **self.__scriptEditor** attribute. + Property for **self.__scriptEditor** attribute. :return: self.__scriptEditor. ( QWidget ) """ @@ -135,7 +135,7 @@ def scriptEditor(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def scriptEditor(self, value): """ - This method is the setter method for **self.__scriptEditor** attribute. + Setter for **self.__scriptEditor** attribute. :param value: Attribute value. ( QWidget ) """ @@ -147,7 +147,7 @@ def scriptEditor(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def scriptEditor(self): """ - This method is the deleter method for **self.__scriptEditor** attribute. + Deleter for **self.__scriptEditor** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -156,7 +156,7 @@ def scriptEditor(self): @property def preferencesManager(self): """ - This method is the property for **self.__preferencesManager** attribute. + Property for **self.__preferencesManager** attribute. :return: self.__preferencesManager. ( QWidget ) """ @@ -167,7 +167,7 @@ def preferencesManager(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def preferencesManager(self, value): """ - This method is the setter method for **self.__preferencesManager** attribute. + Setter for **self.__preferencesManager** attribute. :param value: Attribute value. ( QWidget ) """ @@ -179,7 +179,7 @@ def preferencesManager(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def preferencesManager(self): """ - This method is the deleter method for **self.__preferencesManager** attribute. + Deleter for **self.__preferencesManager** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -190,7 +190,7 @@ def preferencesManager(self): #****************************************************************************************************************** def activate(self, engine): """ - This method activates the Component. + Activates the Component. :param engine: Engine to attach the Component to. ( QObject ) :return: Method success. ( Boolean ) @@ -208,7 +208,7 @@ def activate(self, engine): def deactivate(self): """ - This method deactivates the Component. + Deactivates the Component. :return: Method success. ( Boolean ) """ @@ -225,7 +225,7 @@ def deactivate(self): def initializeUi(self): """ - This method initializes the Component ui. + Initializes the Component ui. :return: Method success. ( Boolean ) """ @@ -242,7 +242,7 @@ def initializeUi(self): def uninitializeUi(self): """ - This method uninitializes the Component ui. + Uninitializes the Component ui. :return: Method success. ( Boolean ) """ @@ -259,7 +259,7 @@ def uninitializeUi(self): def addWidget(self): """ - This method adds the Component Widget to the engine. + Adds the Component Widget to the engine. :return: Method success. ( Boolean ) """ @@ -272,7 +272,7 @@ def addWidget(self): def removeWidget(self): """ - This method removes the Component Widget from the engine. + Removes the Component Widget from the engine. :return: Method success. ( Boolean ) """ @@ -286,7 +286,7 @@ def removeWidget(self): def __Clear_Thumbnails_Cache_pushButton__clicked(self, checked): """ - This method is triggered when **Thumbnails_Cache_pushButton** Widget is clicked. + Defines the slot triggered by **Thumbnails_Cache_pushButton** Widget when clicked. :param checked: Checked state. ( Boolean ) """ @@ -295,7 +295,7 @@ def __Clear_Thumbnails_Cache_pushButton__clicked(self, checked): def __Clear_Images_Caches_pushButton__clicked(self, checked): """ - This method is triggered when **Clear_Images_Caches_pushButton** Widget is clicked. + Defines the slot triggered by **Clear_Images_Caches_pushButton** Widget when clicked. :param checked: Checked state. ( Boolean ) """ @@ -304,7 +304,7 @@ def __Clear_Images_Caches_pushButton__clicked(self, checked): def __Output_Caches_Metrics_pushButton__clicked(self, checked): """ - This method is triggered when **Output_Caches_Metrics_pushButton** Widget is clicked. + Defines the slot triggered by **Output_Caches_Metrics_pushButton** Widget when clicked. :param checked: Checked state. ( Boolean ) """ @@ -314,7 +314,7 @@ def __Output_Caches_Metrics_pushButton__clicked(self, checked): def outputCachesMetrics(self): """ - This method outputs caches metrics. + Outputs caches metrics. :return: Method success. ( Boolean ) """ @@ -356,7 +356,7 @@ def outputCachesMetrics(self): sibl_gui.exceptions.CacheOperationError) def clearThumbnailsCache(self): """ - This method clears the thumbnails cache. + Clears the thumbnails cache. :return: Method success. ( Boolean ) """ @@ -380,7 +380,7 @@ def clearThumbnailsCache(self): sibl_gui.exceptions.CacheOperationError) def clearImagesCaches(self): """ - This method clears the images caches. + Clears the images caches. :return: Method success. ( Boolean ) """ diff --git a/sibl_gui/components/addons/databaseOperations/databaseOperations.py b/sibl_gui/components/addons/databaseOperations/databaseOperations.py index ccb44a46..ee299120 100644 --- a/sibl_gui/components/addons/databaseOperations/databaseOperations.py +++ b/sibl_gui/components/addons/databaseOperations/databaseOperations.py @@ -67,7 +67,7 @@ class DatabaseType(foundations.dataStructures.Structure): def __init__(self, **kwargs): """ - This method initializes the class. + Initializes the class. :param kwargs: type, getMethod, updateContentMethod, removeMethod, modelContainer, updateLocationMethod ( Key / Value pairs ) """ @@ -84,7 +84,7 @@ class DatabaseOperations(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): def __init__(self, parent=None, name=None, *args, **kwargs): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param name: Component name. ( String ) @@ -115,7 +115,7 @@ def __init__(self, parent=None, name=None, *args, **kwargs): @property def engine(self): """ - This method is the property for **self.__engine** attribute. + Property for **self.__engine** attribute. :return: self.__engine. ( QObject ) """ @@ -126,7 +126,7 @@ def engine(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self, value): """ - This method is the setter method for **self.__engine** attribute. + Setter for **self.__engine** attribute. :param value: Attribute value. ( QObject ) """ @@ -138,7 +138,7 @@ def engine(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self): """ - This method is the deleter method for **self.__engine** attribute. + Deleter for **self.__engine** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -147,7 +147,7 @@ def engine(self): @property def settings(self): """ - This method is the property for **self.__settings** attribute. + Property for **self.__settings** attribute. :return: self.__settings. ( QSettings ) """ @@ -158,7 +158,7 @@ def settings(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settings(self, value): """ - This method is the setter method for **self.__settings** attribute. + Setter for **self.__settings** attribute. :param value: Attribute value. ( QSettings ) """ @@ -170,7 +170,7 @@ def settings(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settings(self): """ - This method is the deleter method for **self.__settings** attribute. + Deleter for **self.__settings** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -179,7 +179,7 @@ def settings(self): @property def settingsSection(self): """ - This method is the property for **self.__settingsSection** attribute. + Property for **self.__settingsSection** attribute. :return: self.__settingsSection. ( String ) """ @@ -190,7 +190,7 @@ def settingsSection(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settingsSection(self, value): """ - This method is the setter method for **self.__settingsSection** attribute. + Setter for **self.__settingsSection** attribute. :param value: Attribute value. ( String ) """ @@ -202,7 +202,7 @@ def settingsSection(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settingsSection(self): """ - This method is the deleter method for **self.__settingsSection** attribute. + Deleter for **self.__settingsSection** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -211,7 +211,7 @@ def settingsSection(self): @property def preferencesManager(self): """ - This method is the property for **self.__preferencesManager** attribute. + Property for **self.__preferencesManager** attribute. :return: self.__preferencesManager. ( QWidget ) """ @@ -222,7 +222,7 @@ def preferencesManager(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def preferencesManager(self, value): """ - This method is the setter method for **self.__preferencesManager** attribute. + Setter for **self.__preferencesManager** attribute. :param value: Attribute value. ( QWidget ) """ @@ -234,7 +234,7 @@ def preferencesManager(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def preferencesManager(self): """ - This method is the deleter method for **self.__preferencesManager** attribute. + Deleter for **self.__preferencesManager** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -243,7 +243,7 @@ def preferencesManager(self): @property def iblSetsOutliner(self): """ - This method is the property for **self.__iblSetsOutliner** attribute. + Property for **self.__iblSetsOutliner** attribute. :return: self.__iblSetsOutliner. ( QWidget ) """ @@ -254,7 +254,7 @@ def iblSetsOutliner(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iblSetsOutliner(self, value): """ - This method is the setter method for **self.__iblSetsOutliner** attribute. + Setter for **self.__iblSetsOutliner** attribute. :param value: Attribute value. ( QWidget ) """ @@ -266,7 +266,7 @@ def iblSetsOutliner(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iblSetsOutliner(self): """ - This method is the deleter method for **self.__iblSetsOutliner** attribute. + Deleter for **self.__iblSetsOutliner** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -275,7 +275,7 @@ def iblSetsOutliner(self): @property def templatesOutliner(self): """ - This method is the property for **self.__templatesOutliner** attribute. + Property for **self.__templatesOutliner** attribute. :return: self.__templatesOutliner. ( QWidget ) """ @@ -286,7 +286,7 @@ def templatesOutliner(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templatesOutliner(self, value): """ - This method is the setter method for **self.__templatesOutliner** attribute. + Setter for **self.__templatesOutliner** attribute. :param value: Attribute value. ( QWidget ) """ @@ -298,7 +298,7 @@ def templatesOutliner(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templatesOutliner(self): """ - This method is the deleter method for **self.__templatesOutliner** attribute. + Deleter for **self.__templatesOutliner** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -307,7 +307,7 @@ def templatesOutliner(self): @property def types(self): """ - This method is the property for **self.__types** attribute. + Property for **self.__types** attribute. :return: self.__types. ( Tuple ) """ @@ -318,7 +318,7 @@ def types(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def types(self, value): """ - This method is the setter method for **self.__types** attribute. + Setter for **self.__types** attribute. :param value: Attribute value. ( Tuple ) """ @@ -330,7 +330,7 @@ def types(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def types(self): """ - This method is the deleter method for **self.__types** attribute. + Deleter for **self.__types** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -341,7 +341,7 @@ def types(self): #****************************************************************************************************************** def activate(self, engine): """ - This method activates the Component. + Activates the Component. :param engine: Engine to attach the Component to. ( QObject ) :return: Method success. ( Boolean ) @@ -375,7 +375,7 @@ def activate(self, engine): def deactivate(self): """ - This method deactivates the Component. + Deactivates the Component. :return: Method success. ( Boolean ) """ @@ -395,7 +395,7 @@ def deactivate(self): def initializeUi(self): """ - This method initializes the Component ui. + Initializes the Component ui. :return: Method success. ( Boolean ) """ @@ -416,7 +416,7 @@ def initializeUi(self): def uninitializeUi(self): """ - This method uninitializes the Component ui. + Uninitializes the Component ui. :return: Method success. ( Boolean ) """ @@ -433,7 +433,7 @@ def uninitializeUi(self): def addWidget(self): """ - This method adds the Component Widget to the engine. + Adds the Component Widget to the engine. :return: Method success. ( Boolean ) """ @@ -446,7 +446,7 @@ def addWidget(self): def removeWidget(self): """ - This method removes the Component Widget from the engine. + Removes the Component Widget from the engine. :return: Method success. ( Boolean ) """ @@ -460,7 +460,7 @@ def removeWidget(self): def __Update_Database_pushButton__clicked(self, checked): """ - This method is triggered when **Update_Database_pushButton** Widget is clicked. + Defines the slot triggered by **Update_Database_pushButton** Widget when clicked. :param checked: Checked state. ( Boolean ) """ @@ -469,7 +469,7 @@ def __Update_Database_pushButton__clicked(self, checked): def __Remove_Invalid_Data_pushButton__clicked(self, checked): """ - This method is triggered when **Remove_Invalid_Data_pushButton** Widget is clicked. + Defines the slot triggered by **Remove_Invalid_Data_pushButton** Widget when clicked. :param checked: Checked state. ( Boolean ) """ @@ -479,7 +479,7 @@ def __Remove_Invalid_Data_pushButton__clicked(self, checked): @umbra.engine.showProcessing("Updating Database ...") def updateDatabase(self): """ - | This method updates the Database. + | Updates the Database. | Each type defined by :meth:`DatabaseOperations.sibl_gui.components.core.database.types` attribute will have its instances checked and updated by their associated methods. @@ -514,7 +514,7 @@ def updateDatabase(self): @umbra.engine.showProcessing("Removing Invalid Data ...") def removeInvalidData(self): """ - This method removes invalid data from the Database. + Removes invalid data from the Database. :return: Method success. ( Boolean ) """ diff --git a/sibl_gui/components/addons/gpsMap/gpsMap.py b/sibl_gui/components/addons/gpsMap/gpsMap.py index e63085a4..d4e664f8 100644 --- a/sibl_gui/components/addons/gpsMap/gpsMap.py +++ b/sibl_gui/components/addons/gpsMap/gpsMap.py @@ -68,7 +68,7 @@ class GpsMap(QWidgetComponentFactory(uiFile=COMPONENT_FILE)): def __init__(self, parent=None, name=None, *args, **kwargs): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param name: Component name. ( String ) @@ -103,7 +103,7 @@ def __init__(self, parent=None, name=None, *args, **kwargs): @property def uiResourcesDirectory(self): """ - This method is the property for **self.__uiResourcesDirectory** attribute. + Property for **self.__uiResourcesDirectory** attribute. :return: self.__uiResourcesDirectory. ( String ) """ @@ -114,7 +114,7 @@ def uiResourcesDirectory(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiResourcesDirectory(self, value): """ - This method is the setter method for **self.__uiResourcesDirectory** attribute. + Setter for **self.__uiResourcesDirectory** attribute. :param value: Attribute value. ( String ) """ @@ -126,7 +126,7 @@ def uiResourcesDirectory(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiResourcesDirectory(self): """ - This method is the deleter method for **self.__uiResourcesDirectory** attribute. + Deleter for **self.__uiResourcesDirectory** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -135,7 +135,7 @@ def uiResourcesDirectory(self): @property def uiZoomInImage(self): """ - This method is the property for **self.__uiZoomInImage** attribute. + Property for **self.__uiZoomInImage** attribute. :return: self.__uiZoomInImage. ( String ) """ @@ -146,7 +146,7 @@ def uiZoomInImage(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiZoomInImage(self, value): """ - This method is the setter method for **self.__uiZoomInImage** attribute. + Setter for **self.__uiZoomInImage** attribute. :param value: Attribute value. ( String ) """ @@ -158,7 +158,7 @@ def uiZoomInImage(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiZoomInImage(self): """ - This method is the deleter method for **self.__uiZoomInImage** attribute. + Deleter for **self.__uiZoomInImage** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -167,7 +167,7 @@ def uiZoomInImage(self): @property def uiZoomOutImage(self): """ - This method is the property for **self.__uiZoomOutImage** attribute. + Property for **self.__uiZoomOutImage** attribute. :return: self.__uiZoomOutImage. ( String ) """ @@ -178,7 +178,7 @@ def uiZoomOutImage(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiZoomOutImage(self, value): """ - This method is the setter method for **self.__uiZoomOutImage** attribute. + Setter for **self.__uiZoomOutImage** attribute. :param value: Attribute value. ( String ) """ @@ -190,7 +190,7 @@ def uiZoomOutImage(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiZoomOutImage(self): """ - This method is the deleter method for **self.__uiZoomOutImage** attribute. + Deleter for **self.__uiZoomOutImage** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -199,7 +199,7 @@ def uiZoomOutImage(self): @property def gpsMapHtmlFile(self): """ - This method is the property for **self.__gpsMapHtmlFile** attribute. + Property for **self.__gpsMapHtmlFile** attribute. :return: self.__gpsMapHtmlFile. ( String ) """ @@ -210,7 +210,7 @@ def gpsMapHtmlFile(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def gpsMapHtmlFile(self, value): """ - This method is the setter method for **self.__gpsMapHtmlFile** attribute. + Setter for **self.__gpsMapHtmlFile** attribute. :param value: Attribute value. ( String ) """ @@ -222,7 +222,7 @@ def gpsMapHtmlFile(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def gpsMapHtmlFile(self): """ - This method is the deleter method for **self.__gpsMapHtmlFile** attribute. + Deleter for **self.__gpsMapHtmlFile** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -231,7 +231,7 @@ def gpsMapHtmlFile(self): @property def gpsMapBaseSize(self): """ - This method is the property for **self.__gpsMapBaseSize** attribute. + Property for **self.__gpsMapBaseSize** attribute. :return: self.__gpsMapBaseSize. ( QSize() ) """ @@ -242,7 +242,7 @@ def gpsMapBaseSize(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def gpsMapBaseSize(self, value): """ - This method is the setter method for **self.__gpsMapBaseSize** attribute. + Setter for **self.__gpsMapBaseSize** attribute. :param value: Attribute value. ( QSize() ) """ @@ -254,7 +254,7 @@ def gpsMapBaseSize(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def gpsMapBaseSize(self): """ - This method is the deleter method for **self.__gpsMapBaseSize** attribute. + Deleter for **self.__gpsMapBaseSize** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -263,7 +263,7 @@ def gpsMapBaseSize(self): @property def dockArea(self): """ - This method is the property for **self.__dockArea** attribute. + Property for **self.__dockArea** attribute. :return: self.__dockArea. ( Integer ) """ @@ -274,7 +274,7 @@ def dockArea(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def dockArea(self, value): """ - This method is the setter method for **self.__dockArea** attribute. + Setter for **self.__dockArea** attribute. :param value: Attribute value. ( Integer ) """ @@ -286,7 +286,7 @@ def dockArea(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def dockArea(self): """ - This method is the deleter method for **self.__dockArea** attribute. + Deleter for **self.__dockArea** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -295,7 +295,7 @@ def dockArea(self): @property def engine(self): """ - This method is the property for **self.__engine** attribute. + Property for **self.__engine** attribute. :return: self.__engine. ( QObject ) """ @@ -306,7 +306,7 @@ def engine(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self, value): """ - This method is the setter method for **self.__engine** attribute. + Setter for **self.__engine** attribute. :param value: Attribute value. ( QObject ) """ @@ -318,7 +318,7 @@ def engine(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self): """ - This method is the deleter method for **self.__engine** attribute. + Deleter for **self.__engine** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -327,7 +327,7 @@ def engine(self): @property def iblSetsOutliner(self): """ - This method is the property for **self.__iblSetsOutliner** attribute. + Property for **self.__iblSetsOutliner** attribute. :return: self.__iblSetsOutliner. ( QWidget ) """ @@ -338,7 +338,7 @@ def iblSetsOutliner(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iblSetsOutliner(self, value): """ - This method is the setter method for **self.__iblSetsOutliner** attribute. + Setter for **self.__iblSetsOutliner** attribute. :param value: Attribute value. ( QWidget ) """ @@ -350,7 +350,7 @@ def iblSetsOutliner(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iblSetsOutliner(self): """ - This method is the deleter method for **self.__iblSetsOutliner** attribute. + Deleter for **self.__iblSetsOutliner** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -359,7 +359,7 @@ def iblSetsOutliner(self): @property def map(self): """ - This method is the property for **self.__map** attribute. + Property for **self.__map** attribute. :return: self.__map. ( QObject ) """ @@ -370,7 +370,7 @@ def map(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def map(self, value): """ - This method is the setter method for **self.__map** attribute. + Setter for **self.__map** attribute. :param value: Attribute value. ( QObject ) """ @@ -382,7 +382,7 @@ def map(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def map(self): """ - This method is the deleter method for **self.__map** attribute. + Deleter for **self.__map** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -391,7 +391,7 @@ def map(self): @property def mapTypeIds(self): """ - This method is the property for **self.__mapTypeIds** attribute. + Property for **self.__mapTypeIds** attribute. :return: self.__mapTypeIds. ( Tuple ) """ @@ -402,7 +402,7 @@ def mapTypeIds(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def mapTypeIds(self, value): """ - This method is the setter method for **self.__mapTypeIds** attribute. + Setter for **self.__mapTypeIds** attribute. :param value: Attribute value. ( Tuple ) """ @@ -414,7 +414,7 @@ def mapTypeIds(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def mapTypeIds(self): """ - This method is the deleter method for **self.__mapTypeIds** attribute. + Deleter for **self.__mapTypeIds** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -425,7 +425,7 @@ def mapTypeIds(self): #****************************************************************************************************************** def activate(self, engine): """ - This method activates the Component. + Activates the Component. :param engine: Engine to attach the Component to. ( QObject ) :return: Method success. ( Boolean ) @@ -444,7 +444,7 @@ def activate(self, engine): def deactivate(self): """ - This method deactivates the Component. + Deactivates the Component. :return: Method success. ( Boolean ) """ @@ -462,7 +462,7 @@ def deactivate(self): def initializeUi(self): """ - This method initializes the Component ui. + Initializes the Component ui. :return: Method success. ( Boolean ) """ @@ -496,7 +496,7 @@ def initializeUi(self): def uninitializeUi(self): """ - This method uninitializes the Component ui. + Uninitializes the Component ui. :return: Method success. ( Boolean ) """ @@ -518,7 +518,7 @@ def uninitializeUi(self): def addWidget(self): """ - This method adds the Component Widget to the engine. + Adds the Component Widget to the engine. :return: Method success. ( Boolean ) """ @@ -531,7 +531,7 @@ def addWidget(self): def removeWidget(self): """ - This method removes the Component Widget from the engine. + Removes the Component Widget from the engine. :return: Method success. ( Boolean ) """ @@ -545,7 +545,7 @@ def removeWidget(self): def onClose(self): """ - This method is triggered on Framework close. + Defines the slot triggered on Framework close. :return: Method success. ( Boolean ) """ @@ -557,7 +557,7 @@ def onClose(self): def __iblSetsOutliner_view_selectionModel__selectionChanged(self, selectedItems, deselectedItems): """ - This method is triggered when **Data** Model selection has changed. + Defines the slot triggered by **Data** Model when selection changed :param selectedItems: Selected items. ( QItemSelection ) :param deselectedItems: Deselected items. ( QItemSelection ) @@ -567,7 +567,7 @@ def __iblSetsOutliner_view_selectionModel__selectionChanged(self, selectedItems, def __Map_Type_comboBox__activated(self, index): """ - This method is triggered when **Map_Type_comboBox** index changes. + Defines the slot triggered by **Map_Type_comboBox** when activated. :param index: ComboBox activated item index. ( Integer ) """ @@ -576,7 +576,7 @@ def __Map_Type_comboBox__activated(self, index): def __Zoom_In_pushButton__clicked(self, checked): """ - This method is triggered when **Zoom_In_pushButton** Widget is clicked. + Defines the slot triggered by **Zoom_In_pushButton** Widget when clicked. :param checked: Checked state. ( Boolean ) """ @@ -585,7 +585,7 @@ def __Zoom_In_pushButton__clicked(self, checked): def __Zoom_Out_pushButton__clicked(self, checked): """ - This method is triggered when **Zoom_Out_pushButton** Widget is clicked. + Defines the slot triggered by **Zoom_Out_pushButton** Widget when clicked. :param checked: Checked state. ( Boolean ) """ @@ -594,7 +594,7 @@ def __Zoom_Out_pushButton__clicked(self, checked): def __map__loadFinished(self, state): """ - This method is triggered when the GPS map finishes loading. + Defines the slot triggered by the GPS map when load finished. :param state: Loading state. ( Boolean ) """ @@ -604,7 +604,7 @@ def __map__loadFinished(self, state): @foundations.exceptions.handleExceptions(umbra.exceptions.notifyExceptionHandler, Exception) def setMarkersUi(self): """ - This method sets selected Ibl Sets markers. + Sets selected Ibl Sets markers. :return: Method success. ( Boolean ) @@ -626,7 +626,7 @@ def setMarkersUi(self): def setMarker(self, iblSet): """ - This method sets given Ibl Set marker. + Sets given Ibl Set marker. :param iblSet: Ibl Set to display marker. ( IblSet ) :return: Method success. ( Boolean ) @@ -648,7 +648,7 @@ def setMarker(self, iblSet): def removeMarkers(self): """ - This method removes the GPS map markers. + Removes the GPS map markers. :return: Method success. ( Boolean ) """ diff --git a/sibl_gui/components/addons/gpsMap/views.py b/sibl_gui/components/addons/gpsMap/views.py index 53662676..631aec74 100644 --- a/sibl_gui/components/addons/gpsMap/views.py +++ b/sibl_gui/components/addons/gpsMap/views.py @@ -57,7 +57,7 @@ class Map_QWebView(QWebView): def __init__(self, parent=None): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) """ @@ -66,7 +66,7 @@ def __init__(self, parent=None): def __evaluateJavascript(self, javascript): """ - This method evaluates given javascript content in the View. + Evaluates given javascript content in the View. :param javascript: Javascript. ( String ) """ @@ -75,7 +75,7 @@ def __evaluateJavascript(self, javascript): def addMarker(self, coordinates, title, icon, content): """ - This method adds a marker to the GPS map. + Adds a marker to the GPS map. :param coordinates: Marker coordinates. ( Tuple ) :param title: Marker title. ( String ) @@ -97,7 +97,7 @@ def addMarker(self, coordinates, title, icon, content): def removeMarkers(self): """ - This method removes the GPS map markers. + Removes the GPS map markers. :return: Method success. ( Boolean ) """ @@ -109,7 +109,7 @@ def removeMarkers(self): def setCenter(self): """ - This method centers the GPS map. + Centers the GPS map. :return: Method success. ( Boolean ) """ @@ -121,7 +121,7 @@ def setCenter(self): def setMapType(self, mapTypeId): """ - This method sets the GPS map type. + Sets the GPS map type. Available map types: @@ -140,7 +140,7 @@ def setMapType(self, mapTypeId): def setZoom(self, type): """ - This method sets the GPS map zoom. + Sets the GPS map zoom. :param type: Zoom type. ( String ) :return: Method success. ( Boolean ) diff --git a/sibl_gui/components/addons/iblSetsScanner/iblSetsScanner.py b/sibl_gui/components/addons/iblSetsScanner/iblSetsScanner.py index 04511431..0614ab21 100644 --- a/sibl_gui/components/addons/iblSetsScanner/iblSetsScanner.py +++ b/sibl_gui/components/addons/iblSetsScanner/iblSetsScanner.py @@ -62,7 +62,7 @@ class IblSetsScanner(QObjectComponent): def __init__(self, parent=None, name=None, *args, **kwargs): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param name: Component name. ( String ) @@ -90,7 +90,7 @@ def __init__(self, parent=None, name=None, *args, **kwargs): @property def engine(self): """ - This method is the property for **self.__engine** attribute. + Property for **self.__engine** attribute. :return: self.__engine. ( QObject ) """ @@ -101,7 +101,7 @@ def engine(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self, value): """ - This method is the setter method for **self.__engine** attribute. + Setter for **self.__engine** attribute. :param value: Attribute value. ( QObject ) """ @@ -113,7 +113,7 @@ def engine(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self): """ - This method is the deleter method for **self.__engine** attribute. + Deleter for **self.__engine** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -122,7 +122,7 @@ def engine(self): @property def collectionsOutliner(self): """ - This method is the property for **self.__collectionsOutliner** attribute. + Property for **self.__collectionsOutliner** attribute. :return: self.__collectionsOutliner. ( QWidget ) """ @@ -133,7 +133,7 @@ def collectionsOutliner(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def collectionsOutliner(self, value): """ - This method is the setter method for **self.__collectionsOutliner** attribute. + Setter for **self.__collectionsOutliner** attribute. :param value: Attribute value. ( QWidget ) """ @@ -145,7 +145,7 @@ def collectionsOutliner(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def collectionsOutliner(self): """ - This method is the deleter method for **self.__collectionsOutliner** attribute. + Deleter for **self.__collectionsOutliner** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -154,7 +154,7 @@ def collectionsOutliner(self): @property def iblSetsOutliner(self): """ - This method is the property for **self.__iblSetsOutliner** attribute. + Property for **self.__iblSetsOutliner** attribute. :return: self.__iblSetsOutliner. ( QWidget ) """ @@ -165,7 +165,7 @@ def iblSetsOutliner(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iblSetsOutliner(self, value): """ - This method is the setter method for **self.__iblSetsOutliner** attribute. + Setter for **self.__iblSetsOutliner** attribute. :param value: Attribute value. ( QWidget ) """ @@ -177,7 +177,7 @@ def iblSetsOutliner(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iblSetsOutliner(self): """ - This method is the deleter method for **self.__iblSetsOutliner** attribute. + Deleter for **self.__iblSetsOutliner** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -186,7 +186,7 @@ def iblSetsOutliner(self): @property def iblSetsScannerWorkerThread(self): """ - This method is the property for **self.__iblSetsScannerWorkerThread** attribute. + Property for **self.__iblSetsScannerWorkerThread** attribute. :return: self.__iblSetsScannerWorkerThread. ( QThread ) """ @@ -197,7 +197,7 @@ def iblSetsScannerWorkerThread(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iblSetsScannerWorkerThread(self, value): """ - This method is the setter method for **self.__iblSetsScannerWorkerThread** attribute. + Setter for **self.__iblSetsScannerWorkerThread** attribute. :param value: Attribute value. ( QThread ) """ @@ -209,7 +209,7 @@ def iblSetsScannerWorkerThread(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iblSetsScannerWorkerThread(self): """ - This method is the deleter method for **self.__iblSetsScannerWorkerThread** attribute. + Deleter for **self.__iblSetsScannerWorkerThread** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -220,7 +220,7 @@ def iblSetsScannerWorkerThread(self): #****************************************************************************************************************** def activate(self, engine): """ - This method activates the Component. + Activates the Component. :param engine: Engine to attach the Component to. ( QObject ) :return: Method success. ( Boolean ) @@ -238,7 +238,7 @@ def activate(self, engine): def deactivate(self): """ - This method deactivates the Component. + Deactivates the Component. :return: Method success. ( Boolean ) """ @@ -255,7 +255,7 @@ def deactivate(self): def initialize(self): """ - This method initializes the Component. + Initializes the Component. :return: Method success. ( Boolean ) """ @@ -281,7 +281,7 @@ def initialize(self): def uninitialize(self): """ - This method uninitializes the Component. + Uninitializes the Component. :return: Method success. ( Boolean ) """ @@ -303,7 +303,7 @@ def uninitialize(self): def onStartup(self): """ - This method is triggered on Framework startup. + Defines the slot triggered on Framework startup. :return: Method success. ( Boolean ) """ @@ -317,7 +317,7 @@ def onStartup(self): @umbra.engine.encapsulateProcessing def __iblSetsScannerWorkerThread__iblSetsRetrieved(self, iblSets): """ - This method is triggered by the **IblSetsScanner_worker** when the Database has changed. + Defines the slot triggered by **IblSetsScanner_worker** when the Database has changed. :param iblSets: Retrieve Ibl Sets. ( Dictionary ) """ diff --git a/sibl_gui/components/addons/iblSetsScanner/workers.py b/sibl_gui/components/addons/iblSetsScanner/workers.py index 64ab7340..93b89853 100644 --- a/sibl_gui/components/addons/iblSetsScanner/workers.py +++ b/sibl_gui/components/addons/iblSetsScanner/workers.py @@ -72,7 +72,7 @@ class IblSetsScanner_worker(QThread): def __init__(self, parent): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) """ @@ -96,7 +96,7 @@ def __init__(self, parent): @property def container(self): """ - This method is the property for **self.__container** attribute. + Property for **self.__container** attribute. :return: self.__container. ( QObject ) """ @@ -107,7 +107,7 @@ def container(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def container(self, value): """ - This method is the setter method for **self.__container** attribute. + Setter for **self.__container** attribute. :param value: Attribute value. ( QObject ) """ @@ -119,7 +119,7 @@ def container(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def container(self): """ - This method is the deleter method for **self.__container** attribute. + Deleter for **self.__container** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -128,7 +128,7 @@ def container(self): @property def databaseSession(self): """ - This method is the property for **self.__databaseSession** attribute. + Property for **self.__databaseSession** attribute. :return: self.__databaseSession. ( Object ) """ @@ -139,7 +139,7 @@ def databaseSession(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def databaseSession(self, value): """ - This method is the setter method for **self.__databaseSession** attribute. + Setter for **self.__databaseSession** attribute. :param value: Attribute value. ( Object ) """ @@ -151,7 +151,7 @@ def databaseSession(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def databaseSession(self): """ - This method is the deleter method for **self.__databaseSession** attribute. + Deleter for **self.__databaseSession** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -160,7 +160,7 @@ def databaseSession(self): @property def extension(self): """ - This method is the property for **self.__extension** attribute. + Property for **self.__extension** attribute. :return: self.__extension. ( String ) """ @@ -171,7 +171,7 @@ def extension(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def extension(self, value): """ - This method is the setter method for **self.__extension** attribute. + Setter for **self.__extension** attribute. :param value: Attribute value. ( String ) """ @@ -183,7 +183,7 @@ def extension(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def extension(self): """ - This method is the deleter method for **self.__extension** attribute. + Deleter for **self.__extension** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -192,7 +192,7 @@ def extension(self): @property def newIblSets(self): """ - This method is the property for **self.__newIblSets** attribute. + Property for **self.__newIblSets** attribute. :return: self.__newIblSets. ( List ) """ @@ -203,7 +203,7 @@ def newIblSets(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def newIblSets(self, value): """ - This method is the setter method for **self.__newIblSets** attribute. + Setter for **self.__newIblSets** attribute. :param value: Attribute value. ( List ) """ @@ -215,7 +215,7 @@ def newIblSets(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def newIblSets(self): """ - This method is the deleter method for **self.__newIblSets** attribute. + Deleter for **self.__newIblSets** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -226,14 +226,14 @@ def newIblSets(self): #****************************************************************************************************************** def run(self): """ - This method reimplements the :meth:`QThread.run` method. + Reimplements the :meth:`QThread.run` method. """ self.scanIblSetsDirectories() def scanIblSetsDirectories(self): """ - This method scans Ibl Sets directories. + Scans Ibl Sets directories. :return: Method success. ( Boolean ) """ diff --git a/sibl_gui/components/addons/loaderScript/loaderScript.py b/sibl_gui/components/addons/loaderScript/loaderScript.py index e24a9d6f..7b4311da 100644 --- a/sibl_gui/components/addons/loaderScript/loaderScript.py +++ b/sibl_gui/components/addons/loaderScript/loaderScript.py @@ -79,7 +79,7 @@ class LoaderScript(QWidgetComponentFactory(uiFile=COMPONENT_FILE)): def __init__(self, parent=None, name=None, *args, **kwargs): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param name: Component name. ( String ) @@ -122,7 +122,7 @@ def __init__(self, parent=None, name=None, *args, **kwargs): @property def dockArea(self): """ - This method is the property for **self.__dockArea** attribute. + Property for **self.__dockArea** attribute. :return: self.__dockArea. ( Integer ) """ @@ -133,7 +133,7 @@ def dockArea(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def dockArea(self, value): """ - This method is the setter method for **self.__dockArea** attribute. + Setter for **self.__dockArea** attribute. :param value: Attribute value. ( Integer ) """ @@ -145,7 +145,7 @@ def dockArea(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def dockArea(self): """ - This method is the deleter method for **self.__dockArea** attribute. + Deleter for **self.__dockArea** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -154,7 +154,7 @@ def dockArea(self): @property def engine(self): """ - This method is the property for **self.__engine** attribute. + Property for **self.__engine** attribute. :return: self.__engine. ( QObject ) """ @@ -165,7 +165,7 @@ def engine(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self, value): """ - This method is the setter method for **self.__engine** attribute. + Setter for **self.__engine** attribute. :param value: Attribute value. ( QObject ) """ @@ -177,7 +177,7 @@ def engine(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self): """ - This method is the deleter method for **self.__engine** attribute. + Deleter for **self.__engine** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -186,7 +186,7 @@ def engine(self): @property def iblSetsOutliner(self): """ - This method is the property for **self.__iblSetsOutliner** attribute. + Property for **self.__iblSetsOutliner** attribute. :return: self.__iblSetsOutliner. ( QWidget ) """ @@ -197,7 +197,7 @@ def iblSetsOutliner(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iblSetsOutliner(self, value): """ - This method is the setter method for **self.__iblSetsOutliner** attribute. + Setter for **self.__iblSetsOutliner** attribute. :param value: Attribute value. ( QWidget ) """ @@ -209,7 +209,7 @@ def iblSetsOutliner(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iblSetsOutliner(self): """ - This method is the deleter method for **self.__iblSetsOutliner** attribute. + Deleter for **self.__iblSetsOutliner** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -218,7 +218,7 @@ def iblSetsOutliner(self): @property def templatesOutliner(self): """ - This method is the property for **self.__templatesOutliner** attribute. + Property for **self.__templatesOutliner** attribute. :return: self.__templatesOutliner. ( QWidget ) """ @@ -229,7 +229,7 @@ def templatesOutliner(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templatesOutliner(self, value): """ - This method is the setter method for **self.__templatesOutliner** attribute. + Setter for **self.__templatesOutliner** attribute. :param value: Attribute value. ( QWidget ) """ @@ -241,7 +241,7 @@ def templatesOutliner(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templatesOutliner(self): """ - This method is the deleter method for **self.__templatesOutliner** attribute. + Deleter for **self.__templatesOutliner** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -250,7 +250,7 @@ def templatesOutliner(self): @property def tcpClientUi(self): """ - This method is the property for **self.__tcpClientUi** attribute. + Property for **self.__tcpClientUi** attribute. :return: self.__tcpClientUi. ( QWidget ) """ @@ -261,7 +261,7 @@ def tcpClientUi(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def tcpClientUi(self, value): """ - This method is the setter method for **self.__tcpClientUi** attribute. + Setter for **self.__tcpClientUi** attribute. :param value: Attribute value. ( QWidget ) """ @@ -273,7 +273,7 @@ def tcpClientUi(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def tcpClientUi(self): """ - This method is the deleter method for **self.__tcpClientUi** attribute. + Deleter for **self.__tcpClientUi** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -282,7 +282,7 @@ def tcpClientUi(self): @property def ioDirectory(self): """ - This method is the property for **self.__ioDirectory** attribute. + Property for **self.__ioDirectory** attribute. :return: self.__ioDirectory. ( String ) """ @@ -293,7 +293,7 @@ def ioDirectory(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def ioDirectory(self, value): """ - This method is the setter method for **self.__ioDirectory** attribute. + Setter for **self.__ioDirectory** attribute. :param value: Attribute value. ( String ) """ @@ -305,7 +305,7 @@ def ioDirectory(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def ioDirectory(self): """ - This method is the deleter method for **self.__ioDirectory** attribute. + Deleter for **self.__ioDirectory** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -314,7 +314,7 @@ def ioDirectory(self): @property def bindingIdentifierPattern(self): """ - This method is the property for **self.__bindingIdentifierPattern** attribute. + Property for **self.__bindingIdentifierPattern** attribute. :return: self.__bindingIdentifierPattern. ( String ) """ @@ -325,7 +325,7 @@ def bindingIdentifierPattern(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def bindingIdentifierPattern(self, value): """ - This method is the setter method for **self.__bindingIdentifierPattern** attribute. + Setter for **self.__bindingIdentifierPattern** attribute. :param value: Attribute value. ( String ) """ @@ -337,7 +337,7 @@ def bindingIdentifierPattern(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def bindingIdentifierPattern(self): """ - This method is the deleter method for **self.__bindingIdentifierPattern** attribute. + Deleter for **self.__bindingIdentifierPattern** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -346,7 +346,7 @@ def bindingIdentifierPattern(self): @property def templateScriptSection(self): """ - This method is the property for **self.__templateScriptSection** attribute. + Property for **self.__templateScriptSection** attribute. :return: self.__templateScriptSection. ( String ) """ @@ -357,7 +357,7 @@ def templateScriptSection(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templateScriptSection(self, value): """ - This method is the setter method for **self.__templateScriptSection** attribute. + Setter for **self.__templateScriptSection** attribute. :param value: Attribute value. ( String ) """ @@ -369,7 +369,7 @@ def templateScriptSection(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templateScriptSection(self): """ - This method is the deleter method for **self.__templateScriptSection** attribute. + Deleter for **self.__templateScriptSection** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -378,7 +378,7 @@ def templateScriptSection(self): @property def templateIblSetAttributesSection(self): """ - This method is the property for **self.__templateIblSetAttributesSection** attribute. + Property for **self.__templateIblSetAttributesSection** attribute. :return: self.__templateIblSetAttributesSection. ( String ) """ @@ -389,7 +389,7 @@ def templateIblSetAttributesSection(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templateIblSetAttributesSection(self, value): """ - This method is the setter method for **self.__templateIblSetAttributesSection** attribute. + Setter for **self.__templateIblSetAttributesSection** attribute. :param value: Attribute value. ( String ) """ @@ -401,7 +401,7 @@ def templateIblSetAttributesSection(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templateIblSetAttributesSection(self): """ - This method is the deleter method for **self.__templateIblSetAttributesSection** attribute. + Deleter for **self.__templateIblSetAttributesSection** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -410,7 +410,7 @@ def templateIblSetAttributesSection(self): @property def templateRemoteConnectionSection(self): """ - This method is the property for **self.__templateRemoteConnectionSection** attribute. + Property for **self.__templateRemoteConnectionSection** attribute. :return: self.__templateRemoteConnectionSection. ( String ) """ @@ -421,7 +421,7 @@ def templateRemoteConnectionSection(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templateRemoteConnectionSection(self, value): """ - This method is the setter method for **self.__templateRemoteConnectionSection** attribute. + Setter for **self.__templateRemoteConnectionSection** attribute. :param value: Attribute value. ( String ) """ @@ -433,7 +433,7 @@ def templateRemoteConnectionSection(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templateRemoteConnectionSection(self): """ - This method is the deleter method for **self.__templateRemoteConnectionSection** attribute. + Deleter for **self.__templateRemoteConnectionSection** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -442,7 +442,7 @@ def templateRemoteConnectionSection(self): @property def overrideKeys(self): """ - This method is the property for **self.__overrideKeys** attribute. + Property for **self.__overrideKeys** attribute. :return: self.__overrideKeys. ( Dictionary ) """ @@ -453,7 +453,7 @@ def overrideKeys(self): @foundations.exceptions.handleExceptions(AssertionError) def overrideKeys(self, value): """ - This method is the setter method for **self.__overrideKeys** attribute. + Setter for **self.__overrideKeys** attribute. :param value: Attribute value. ( Dictionary ) """ @@ -472,7 +472,7 @@ def overrideKeys(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def overrideKeys(self): """ - This method is the deleter method for **self.__overrideKeys** attribute. + Deleter for **self.__overrideKeys** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -481,7 +481,7 @@ def overrideKeys(self): @property def defaultStringSeparator(self): """ - This method is the property for **self.__defaultStringSeparator** attribute. + Property for **self.__defaultStringSeparator** attribute. :return: self.__defaultStringSeparator. ( String ) """ @@ -492,7 +492,7 @@ def defaultStringSeparator(self): @foundations.exceptions.handleExceptions(AssertionError) def defaultStringSeparator(self, value): """ - This method is the setter method for **self.__defaultStringSeparator** attribute. + Setter for **self.__defaultStringSeparator** attribute. :param value: Attribute value. ( String ) """ @@ -510,7 +510,7 @@ def defaultStringSeparator(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def defaultStringSeparator(self): """ - This method is the deleter method for **self.__defaultStringSeparator** attribute. + Deleter for **self.__defaultStringSeparator** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -519,7 +519,7 @@ def defaultStringSeparator(self): @property def unnamedLightName(self): """ - This method is the property for **self.__unnamedLightName** attribute. + Property for **self.__unnamedLightName** attribute. :return: self.__unnamedLightName. ( String ) """ @@ -530,7 +530,7 @@ def unnamedLightName(self): @foundations.exceptions.handleExceptions(AssertionError) def unnamedLightName(self, value): """ - This method is the setter method for **self.__unnamedLightName** attribute. + Setter for **self.__unnamedLightName** attribute. :param value: Attribute value. ( String ) """ @@ -544,7 +544,7 @@ def unnamedLightName(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def unnamedLightName(self): """ - This method is the deleter method for **self.__unnamedLightName** attribute. + Deleter for **self.__unnamedLightName** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -555,7 +555,7 @@ def unnamedLightName(self): #****************************************************************************************************************** def activate(self, engine): """ - This method activates the Component. + Activates the Component. :param engine: Engine to attach the Component to. ( QObject ) :return: Method success. ( Boolean ) @@ -579,7 +579,7 @@ def activate(self, engine): def deactivate(self): """ - This method deactivates the Component. + Deactivates the Component. :return: Method success. ( Boolean ) """ @@ -599,7 +599,7 @@ def deactivate(self): def initializeUi(self): """ - This method initializes the Component ui. + Initializes the Component ui. :return: Method success. ( Boolean ) """ @@ -620,7 +620,7 @@ def initializeUi(self): def uninitializeUi(self): """ - This method uninitializes the Component ui. + Uninitializes the Component ui. :return: Method success. ( Boolean ) """ @@ -638,7 +638,7 @@ def uninitializeUi(self): def addWidget(self): """ - This method adds the Component Widget to the engine. + Adds the Component Widget to the engine. :return: Method success. ( Boolean ) """ @@ -651,7 +651,7 @@ def addWidget(self): def removeWidget(self): """ - This method removes the Component Widget from the engine. + Removes the Component Widget from the engine. :return: Method success. ( Boolean ) """ @@ -665,7 +665,7 @@ def removeWidget(self): def __Output_Loader_Script_pushButton__clicked(self, checked): """ - This method is triggered when **Output_Loader_Script_pushButton** Widget is clicked. + Defines the slot triggered by **Output_Loader_Script_pushButton** Widget when clicked. :param checked: Checked state. ( Boolean ) """ @@ -674,7 +674,7 @@ def __Output_Loader_Script_pushButton__clicked(self, checked): def __Send_To_Software_pushButton__clicked(self, checked): """ - This method is triggered when **Send_To_Software_pushButton** Widget is clicked. + Defines the slot triggered by **Send_To_Software_pushButton** Widget when clicked. :param checked: Checked state. ( Boolean ) """ @@ -683,7 +683,7 @@ def __Send_To_Software_pushButton__clicked(self, checked): def __templatesOutliner_view_selectionModel__selectionChanged(self, selectedItems, deselectedItems): """ - This method is triggered when **templatesOutliner.view** Model selection has changed. + Defines the slot triggered by **templatesOutliner.view** Model when selection changed :param selectedItems: Selected items. ( QItemSelection ) :param deselectedItems: Deselected items. ( QItemSelection ) @@ -722,7 +722,7 @@ def __templatesOutliner_view_selectionModel__selectionChanged(self, selectedItem Exception) def outputLoaderScriptUi(self): """ - This method outputs the Loader Script. + Outputs the Loader Script. :return: Method success. ( Boolean ) @@ -773,7 +773,7 @@ def outputLoaderScriptUi(self): @foundations.exceptions.handleExceptions(umbra.exceptions.notifyExceptionHandler, Exception) def sendLoaderScriptToSoftwareUi(self): """ - This method sends the Loader Script to associated 3d package. + Sends the Loader Script to associated 3d package. :return: Method success. ( Boolean ) @@ -800,7 +800,7 @@ def sendLoaderScriptToSoftwareUi(self): foundations.exceptions.DirectoryExistsError) def outputLoaderScript(self, template, iblSet): """ - This method outputs the Loader Script. + Outputs the Loader Script. :param template: Template. ( Template ) :param iblSet: Ibl Set. ( IblSet ) @@ -837,7 +837,7 @@ def outputLoaderScript(self, template, iblSet): sibl_gui.exceptions.Win32OLEServerConnectionError) def sendLoaderScriptToSoftware(self, template, loaderScriptPath): """ - This method sends the Loader Script to associated 3d package. + Sends the Loader Script to associated 3d package. :param template: Template. ( Template ) :param loaderScriptPath: Loader Script path. ( String ) @@ -896,7 +896,7 @@ def sendLoaderScriptToSoftware(self, template, loaderScriptPath): def getDefaultOverrideKeys(self): """ - This method gets default override keys. + Gets default override keys. :return: Override keys. ( Dictionary ) """ @@ -943,7 +943,7 @@ def getDefaultOverrideKeys(self): def getLoaderScript(self, template, iblSet, overrideKeys): """ - This method builds a Loader Script. + Builds a Loader Script. :param template: Template path. ( String ) :param iblSet: Ibl Set path. ( String ) diff --git a/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py b/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py index 8c911d88..1bf8dc7e 100644 --- a/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py +++ b/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py @@ -84,7 +84,7 @@ class LoaderScriptOptions(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): def __init__(self, parent=None, name=None, *args, **kwargs): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param name: Component name. ( String ) @@ -130,7 +130,7 @@ def __init__(self, parent=None, name=None, *args, **kwargs): @property def dockArea(self): """ - This method is the property for **self.__dockArea** attribute. + Property for **self.__dockArea** attribute. :return: self.__dockArea. ( Integer ) """ @@ -141,7 +141,7 @@ def dockArea(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def dockArea(self, value): """ - This method is the setter method for **self.__dockArea** attribute. + Setter for **self.__dockArea** attribute. :param value: Attribute value. ( Integer ) """ @@ -153,7 +153,7 @@ def dockArea(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def dockArea(self): """ - This method is the deleter method for **self.__dockArea** attribute. + Deleter for **self.__dockArea** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -162,7 +162,7 @@ def dockArea(self): @property def engine(self): """ - This method is the property for **self.__engine** attribute. + Property for **self.__engine** attribute. :return: self.__engine. ( QObject ) """ @@ -173,7 +173,7 @@ def engine(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self, value): """ - This method is the setter method for **self.__engine** attribute. + Setter for **self.__engine** attribute. :param value: Attribute value. ( QObject ) """ @@ -185,7 +185,7 @@ def engine(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self): """ - This method is the deleter method for **self.__engine** attribute. + Deleter for **self.__engine** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -194,7 +194,7 @@ def engine(self): @property def templatesOutliner(self): """ - This method is the property for **self.__templatesOutliner** attribute. + Property for **self.__templatesOutliner** attribute. :return: self.__templatesOutliner. ( QWidget ) """ @@ -205,7 +205,7 @@ def templatesOutliner(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templatesOutliner(self, value): """ - This method is the setter method for **self.__templatesOutliner** attribute. + Setter for **self.__templatesOutliner** attribute. :param value: Attribute value. ( QWidget ) """ @@ -217,7 +217,7 @@ def templatesOutliner(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templatesOutliner(self): """ - This method is the deleter method for **self.__templatesOutliner** attribute. + Deleter for **self.__templatesOutliner** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -226,7 +226,7 @@ def templatesOutliner(self): @property def loaderScript(self): """ - This method is the property for **self.__loaderScript** attribute. + Property for **self.__loaderScript** attribute. :return: self.__loaderScript. ( QWidget ) """ @@ -237,7 +237,7 @@ def loaderScript(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def loaderScript(self, value): """ - This method is the setter method for **self.__loaderScript** attribute. + Setter for **self.__loaderScript** attribute. :param value: Attribute value. ( QWidget ) """ @@ -249,7 +249,7 @@ def loaderScript(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def loaderScript(self): """ - This method is the deleter method for **self.__loaderScript** attribute. + Deleter for **self.__loaderScript** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -258,7 +258,7 @@ def loaderScript(self): @property def views(self): """ - This method is the property for **self.__views** attribute. + Property for **self.__views** attribute. :return: self.__views. ( Tuple ) """ @@ -269,7 +269,7 @@ def views(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def views(self, value): """ - This method is the setter method for **self.__views** attribute. + Setter for **self.__views** attribute. :param value: Attribute value. ( Tuple ) """ @@ -281,7 +281,7 @@ def views(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def views(self): """ - This method is the deleter method for **self.__views** attribute. + Deleter for **self.__views** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -290,7 +290,7 @@ def views(self): @property def commonView(self): """ - This method is the property for **self.__commonView** attribute. + Property for **self.__commonView** attribute. :return: self.__commonView. ( QListView ) """ @@ -301,7 +301,7 @@ def commonView(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def commonView(self, value): """ - This method is the setter method for **self.__commonView** attribute. + Setter for **self.__commonView** attribute. :param value: Attribute value. ( QListView ) """ @@ -313,7 +313,7 @@ def commonView(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def commonView(self): """ - This method is the deleter method for **self.__commonView** attribute. + Deleter for **self.__commonView** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -322,7 +322,7 @@ def commonView(self): @property def additionalView(self): """ - This method is the property for **self.__additionalView** attribute. + Property for **self.__additionalView** attribute. :return: self.__additionalView. ( QListView ) """ @@ -333,7 +333,7 @@ def additionalView(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def additionalView(self, value): """ - This method is the setter method for **self.__additionalView** attribute. + Setter for **self.__additionalView** attribute. :param value: Attribute value. ( QListView ) """ @@ -345,7 +345,7 @@ def additionalView(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def additionalView(self): """ - This method is the deleter method for **self.__additionalView** attribute. + Deleter for **self.__additionalView** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -354,7 +354,7 @@ def additionalView(self): @property def namespaceSplitter(self): """ - This method is the property for **self.__namespaceSplitter** attribute. + Property for **self.__namespaceSplitter** attribute. :return: self.__namespaceSplitter. ( String ) """ @@ -365,7 +365,7 @@ def namespaceSplitter(self): @foundations.exceptions.handleExceptions(AssertionError) def namespaceSplitter(self, value): """ - This method is the setter method for **self.__namespaceSplitter** attribute. + Setter for **self.__namespaceSplitter** attribute. :param value: Attribute value. ( String ) """ @@ -383,7 +383,7 @@ def namespaceSplitter(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def namespaceSplitter(self): """ - This method is the deleter method for **self.__namespaceSplitter** attribute. + Deleter for **self.__namespaceSplitter** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -392,7 +392,7 @@ def namespaceSplitter(self): @property def templatesSettingsDirectory(self): """ - This method is the property for **self.__templatesSettingsDirectory** attribute. + Property for **self.__templatesSettingsDirectory** attribute. :return: self.__templatesSettingsDirectory. ( String ) """ @@ -403,7 +403,7 @@ def templatesSettingsDirectory(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templatesSettingsDirectory(self, value): """ - This method is the setter method for **self.__templatesSettingsDirectory** attribute. + Setter for **self.__templatesSettingsDirectory** attribute. :param value: Attribute value. ( String ) """ @@ -415,7 +415,7 @@ def templatesSettingsDirectory(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templatesSettingsDirectory(self): """ - This method is the deleter method for **self.__templatesSettingsDirectory** attribute. + Deleter for **self.__templatesSettingsDirectory** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -424,7 +424,7 @@ def templatesSettingsDirectory(self): @property def templateSettingsFile(self): """ - This method is the property for **self.__templateSettingsFile** attribute. + Property for **self.__templateSettingsFile** attribute. :return: self.__templateSettingsFile. ( String ) """ @@ -435,7 +435,7 @@ def templateSettingsFile(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templateSettingsFile(self, value): """ - This method is the setter method for **self.__templateSettingsFile** attribute. + Setter for **self.__templateSettingsFile** attribute. :param value: Attribute value. ( String ) """ @@ -447,7 +447,7 @@ def templateSettingsFile(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templateSettingsFile(self): """ - This method is the deleter method for **self.__templateSettingsFile** attribute. + Deleter for **self.__templateSettingsFile** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -456,7 +456,7 @@ def templateSettingsFile(self): @property def templateCommonAttributesSection(self): """ - This method is the property for **self.__templateCommonAttributesSection** attribute. + Property for **self.__templateCommonAttributesSection** attribute. :return: self.__templateCommonAttributesSection. ( String ) """ @@ -467,7 +467,7 @@ def templateCommonAttributesSection(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templateCommonAttributesSection(self, value): """ - This method is the setter method for **self.__templateCommonAttributesSection** attribute. + Setter for **self.__templateCommonAttributesSection** attribute. :param value: Attribute value. ( String ) """ @@ -479,7 +479,7 @@ def templateCommonAttributesSection(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templateCommonAttributesSection(self): """ - This method is the deleter method for **self.__templateCommonAttributesSection** attribute. + Deleter for **self.__templateCommonAttributesSection** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -488,7 +488,7 @@ def templateCommonAttributesSection(self): @property def templateAdditionalAttributesSection(self): """ - This method is the property for **self.__templateAdditionalAttributesSection** attribute. + Property for **self.__templateAdditionalAttributesSection** attribute. :return: self.__templateAdditionalAttributesSection. ( String ) """ @@ -499,7 +499,7 @@ def templateAdditionalAttributesSection(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templateAdditionalAttributesSection(self, value): """ - This method is the setter method for **self.__templateAdditionalAttributesSection** attribute. + Setter for **self.__templateAdditionalAttributesSection** attribute. :param value: Attribute value. ( String ) """ @@ -511,7 +511,7 @@ def templateAdditionalAttributesSection(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templateAdditionalAttributesSection(self): """ - This method is the deleter method for **self.__templateAdditionalAttributesSection** attribute. + Deleter for **self.__templateAdditionalAttributesSection** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -521,7 +521,7 @@ def templateAdditionalAttributesSection(self): @property def templateScriptSection(self): """ - This method is the property for **self.__templateScriptSection** attribute. + Property for **self.__templateScriptSection** attribute. :return: self.__templateScriptSection. ( String ) """ @@ -532,7 +532,7 @@ def templateScriptSection(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templateScriptSection(self, value): """ - This method is the setter method for **self.__templateScriptSection** attribute. + Setter for **self.__templateScriptSection** attribute. :param value: Attribute value. ( String ) """ @@ -544,7 +544,7 @@ def templateScriptSection(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templateScriptSection(self): """ - This method is the deleter method for **self.__templateScriptSection** attribute. + Deleter for **self.__templateScriptSection** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -553,7 +553,7 @@ def templateScriptSection(self): @property def optionsToolboxesHeaders(self): """ - This method is the property for **self.__optionsToolboxesHeaders** attribute. + Property for **self.__optionsToolboxesHeaders** attribute. :return: self.__optionsToolboxesHeaders. ( List ) """ @@ -564,7 +564,7 @@ def optionsToolboxesHeaders(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def optionsToolboxesHeaders(self, value): """ - This method is the setter method for **self.__optionsToolboxesHeaders** attribute. + Setter for **self.__optionsToolboxesHeaders** attribute. :param value: Attribute value. ( List ) """ @@ -576,7 +576,7 @@ def optionsToolboxesHeaders(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def optionsToolboxesHeaders(self): """ - This method is the deleter method for **self.__optionsToolboxesHeaders** attribute. + Deleter for **self.__optionsToolboxesHeaders** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -585,7 +585,7 @@ def optionsToolboxesHeaders(self): @property def uiLightGrayColor(self): """ - This method is the property for **self.__uiLightGrayColor** attribute. + Property for **self.__uiLightGrayColor** attribute. :return: self.__uiLightGrayColor. ( QColor ) """ @@ -596,7 +596,7 @@ def uiLightGrayColor(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiLightGrayColor(self, value): """ - This method is the setter method for **self.__uiLightGrayColor** attribute. + Setter for **self.__uiLightGrayColor** attribute. :param value: Attribute value. ( QColor ) """ @@ -608,7 +608,7 @@ def uiLightGrayColor(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiLightGrayColor(self): """ - This method is the deleter method for **self.__uiLightGrayColor** attribute. + Deleter for **self.__uiLightGrayColor** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -617,7 +617,7 @@ def uiLightGrayColor(self): @property def uiDarkGrayColor(self): """ - This method is the property for **self.__uiDarkGrayColor** attribute. + Property for **self.__uiDarkGrayColor** attribute. :return: self.__uiDarkGrayColor. ( QColor ) """ @@ -628,7 +628,7 @@ def uiDarkGrayColor(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiDarkGrayColor(self, value): """ - This method is the setter method for **self.__uiDarkGrayColor** attribute. + Setter for **self.__uiDarkGrayColor** attribute. :param value: Attribute value. ( QColor ) """ @@ -640,7 +640,7 @@ def uiDarkGrayColor(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiDarkGrayColor(self): """ - This method is the deleter method for **self.__uiDarkGrayColor** attribute. + Deleter for **self.__uiDarkGrayColor** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -649,7 +649,7 @@ def uiDarkGrayColor(self): @property def enumSplitter(self): """ - This method is the property for **self.__enumSplitter** attribute. + Property for **self.__enumSplitter** attribute. :return: self.__enumSplitter. ( String ) """ @@ -660,7 +660,7 @@ def enumSplitter(self): @foundations.exceptions.handleExceptions(AssertionError) def enumSplitter(self, value): """ - This method is the setter method for **self.__enumSplitter** attribute. + Setter for **self.__enumSplitter** attribute. :param value: Attribute value. ( String ) """ @@ -677,7 +677,7 @@ def enumSplitter(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def enumSplitter(self): """ - This method is the deleter method for **self.__enumSplitter** attribute. + Deleter for **self.__enumSplitter** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -688,7 +688,7 @@ def enumSplitter(self): #****************************************************************************************************************** def activate(self, engine): """ - This method activates the Component. + Activates the Component. :param engine: Engine to attach the Component to. ( QObject ) :return: Method success. ( Boolean ) @@ -713,7 +713,7 @@ def activate(self, engine): def deactivate(self): """ - This method deactivates the Component. + Deactivates the Component. :return: Method success. ( Boolean ) """ @@ -733,7 +733,7 @@ def deactivate(self): def initializeUi(self): """ - This method initializes the Component ui. + Initializes the Component ui. :return: Method success. ( Boolean ) """ @@ -765,7 +765,7 @@ def initializeUi(self): def uninitializeUi(self): """ - This method uninitializes the Component ui. + Uninitializes the Component ui. :return: Method success. ( Boolean ) """ @@ -785,7 +785,7 @@ def uninitializeUi(self): def addWidget(self): """ - This method adds the Component Widget to the engine. + Adds the Component Widget to the engine. :return: Method success. ( Boolean ) """ @@ -798,7 +798,7 @@ def addWidget(self): def removeWidget(self): """ - This method removes the Component Widget from the engine. + Removes the Component Widget from the engine. :return: Method success. ( Boolean ) """ @@ -812,7 +812,7 @@ def removeWidget(self): def __view_setUi(self, section, view, overrides): """ - This method defines and sets the given View. + Defines and sets the given View. :param section: Section attributes. ( Dictionary ) :param view: Table Widget. ( QTableWidget ) @@ -896,7 +896,7 @@ def __view_setUi(self, section, view, overrides): def __view_clearUi(self, view): """ - This method defines and sets the given View. + Defines and sets the given View. :param view: Table Widget. ( QTableWidget ) """ @@ -909,7 +909,7 @@ def __view_clearUi(self, view): def __views_setUi(self): """ - This method sets the Views. + Sets the Views. """ selectedTemplates = self.__templatesOutliner.getSelectedTemplates() @@ -967,7 +967,7 @@ def __views_setUi(self): def __view__valueChanged(self, *args): """ - This method is triggered when a View Widget value has changed. + Defines the slot triggered by a View when value changed. :param \*args: Arguments. ( \* ) """ @@ -996,7 +996,7 @@ def __view__valueChanged(self, *args): def __templatesOutliner_view_selectionModel__selectionChanged(self, selectedItems, deselectedItems): """ - This method is triggered when **templatesOutliner.view** Model selection has changed. + Defines the slot triggered by **templatesOutliner.view** Model when selection changed :param selectedItems: Selected items. ( QItemSelection ) :param deselectedItems: Deselected items. ( QItemSelection ) @@ -1006,7 +1006,7 @@ def __templatesOutliner_view_selectionModel__selectionChanged(self, selectedItem def __updateOverrideKeys(self, view): """ - This method updates the Loader Script Component override keys. + Updates the Loader Script Component override keys. :param view: Table Widget. ( QTableWidget ) :return: Method success. ( Boolean ) @@ -1033,7 +1033,7 @@ def __updateOverrideKeys(self, view): @foundations.exceptions.handleExceptions(umbra.exceptions.notifyExceptionHandler, Exception) def getOverrideKeys(self): """ - This method gets override keys. + Gets override keys. :return: Method success. ( Boolean ) """ diff --git a/sibl_gui/components/addons/locationsBrowser/locationsBrowser.py b/sibl_gui/components/addons/locationsBrowser/locationsBrowser.py index ed5e0ebd..0ac6d50b 100644 --- a/sibl_gui/components/addons/locationsBrowser/locationsBrowser.py +++ b/sibl_gui/components/addons/locationsBrowser/locationsBrowser.py @@ -88,7 +88,7 @@ class LocationsBrowser(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): def __init__(self, parent=None, name=None, *args, **kwargs): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param name: Component name. ( String ) @@ -124,7 +124,7 @@ def __init__(self, parent=None, name=None, *args, **kwargs): @property def engine(self): """ - This method is the property for **self.__engine** attribute. + Property for **self.__engine** attribute. :return: self.__engine. ( QObject ) """ @@ -135,7 +135,7 @@ def engine(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self, value): """ - This method is the setter method for **self.__engine** attribute. + Setter for **self.__engine** attribute. :param value: Attribute value. ( QObject ) """ @@ -147,7 +147,7 @@ def engine(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self): """ - This method is the deleter method for **self.__engine** attribute. + Deleter for **self.__engine** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -156,7 +156,7 @@ def engine(self): @property def settings(self): """ - This method is the property for **self.__settings** attribute. + Property for **self.__settings** attribute. :return: self.__settings. ( QSettings ) """ @@ -167,7 +167,7 @@ def settings(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settings(self, value): """ - This method is the setter method for **self.__settings** attribute. + Setter for **self.__settings** attribute. :param value: Attribute value. ( QSettings ) """ @@ -179,7 +179,7 @@ def settings(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settings(self): """ - This method is the deleter method for **self.__settings** attribute. + Deleter for **self.__settings** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -188,7 +188,7 @@ def settings(self): @property def settingsSection(self): """ - This method is the property for **self.__settingsSection** attribute. + Property for **self.__settingsSection** attribute. :return: self.__settingsSection. ( String ) """ @@ -199,7 +199,7 @@ def settingsSection(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settingsSection(self, value): """ - This method is the setter method for **self.__settingsSection** attribute. + Setter for **self.__settingsSection** attribute. :param value: Attribute value. ( String ) """ @@ -211,7 +211,7 @@ def settingsSection(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settingsSection(self): """ - This method is the deleter method for **self.__settingsSection** attribute. + Deleter for **self.__settingsSection** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -220,7 +220,7 @@ def settingsSection(self): @property def componentsManagerUi(self): """ - This method is the property for **self.__componentsManagerUi** attribute. + Property for **self.__componentsManagerUi** attribute. :return: self.__componentsManagerUi. ( QWidget ) """ @@ -231,7 +231,7 @@ def componentsManagerUi(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def componentsManagerUi(self, value): """ - This method is the setter method for **self.__componentsManagerUi** attribute. + Setter for **self.__componentsManagerUi** attribute. :param value: Attribute value. ( QWidget ) """ @@ -243,7 +243,7 @@ def componentsManagerUi(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def componentsManagerUi(self): """ - This method is the deleter method for **self.__componentsManagerUi** attribute. + Deleter for **self.__componentsManagerUi** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -252,7 +252,7 @@ def componentsManagerUi(self): @property def preferencesManager(self): """ - This method is the property for **self.__preferencesManager** attribute. + Property for **self.__preferencesManager** attribute. :return: self.__preferencesManager. ( QWidget ) """ @@ -263,7 +263,7 @@ def preferencesManager(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def preferencesManager(self, value): """ - This method is the setter method for **self.__preferencesManager** attribute. + Setter for **self.__preferencesManager** attribute. :param value: Attribute value. ( QWidget ) """ @@ -275,7 +275,7 @@ def preferencesManager(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def preferencesManager(self): """ - This method is the deleter method for **self.__preferencesManager** attribute. + Deleter for **self.__preferencesManager** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -284,7 +284,7 @@ def preferencesManager(self): @property def iblSetsOutliner(self): """ - This method is the property for **self.__iblSetsOutliner** attribute. + Property for **self.__iblSetsOutliner** attribute. :return: self.__iblSetsOutliner. ( QWidget ) """ @@ -295,7 +295,7 @@ def iblSetsOutliner(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iblSetsOutliner(self, value): """ - This method is the setter method for **self.__iblSetsOutliner** attribute. + Setter for **self.__iblSetsOutliner** attribute. :param value: Attribute value. ( QWidget ) """ @@ -307,7 +307,7 @@ def iblSetsOutliner(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iblSetsOutliner(self): """ - This method is the deleter method for **self.__iblSetsOutliner** attribute. + Deleter for **self.__iblSetsOutliner** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -316,7 +316,7 @@ def iblSetsOutliner(self): @property def templatesOutliner(self): """ - This method is the property for **self.__templatesOutliner** attribute. + Property for **self.__templatesOutliner** attribute. :return: self.__templatesOutliner. ( QWidget ) """ @@ -327,7 +327,7 @@ def templatesOutliner(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templatesOutliner(self, value): """ - This method is the setter method for **self.__templatesOutliner** attribute. + Setter for **self.__templatesOutliner** attribute. :param value: Attribute value. ( QWidget ) """ @@ -339,7 +339,7 @@ def templatesOutliner(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templatesOutliner(self): """ - This method is the deleter method for **self.__templatesOutliner** attribute. + Deleter for **self.__templatesOutliner** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -348,7 +348,7 @@ def templatesOutliner(self): @property def loaderScript(self): """ - This method is the property for **self.__loaderScript** attribute. + Property for **self.__loaderScript** attribute. :return: self.__loaderScript. ( QWidget ) """ @@ -359,7 +359,7 @@ def loaderScript(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def loaderScript(self, value): """ - This method is the setter method for **self.__loaderScript** attribute. + Setter for **self.__loaderScript** attribute. :param value: Attribute value. ( QWidget ) """ @@ -371,7 +371,7 @@ def loaderScript(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def loaderScript(self): """ - This method is the deleter method for **self.__loaderScript** attribute. + Deleter for **self.__loaderScript** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -380,7 +380,7 @@ def loaderScript(self): @property def Open_Output_Directory_pushButton(self): """ - This method is the property for **self.__Open_Output_Directory_pushButton** attribute. + Property for **self.__Open_Output_Directory_pushButton** attribute. :return: self.__Open_Output_Directory_pushButton. ( QPushButton ) """ @@ -391,7 +391,7 @@ def Open_Output_Directory_pushButton(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def Open_Output_Directory_pushButton(self, value): """ - This method is the setter method for **self.__Open_Output_Directory_pushButton** attribute. + Setter for **self.__Open_Output_Directory_pushButton** attribute. :param value: Attribute value. ( QPushButton ) """ @@ -403,7 +403,7 @@ def Open_Output_Directory_pushButton(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def Open_Output_Directory_pushButton(self): """ - This method is the deleter method for **self.__Open_Output_Directory_pushButton** attribute. + Deleter for **self.__Open_Output_Directory_pushButton** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -412,7 +412,7 @@ def Open_Output_Directory_pushButton(self): @property def linuxBrowsers(self): """ - This method is the property for **self.__linuxBrowsers** attribute. + Property for **self.__linuxBrowsers** attribute. :return: self.__linuxBrowsers. ( QObject ) """ @@ -423,7 +423,7 @@ def linuxBrowsers(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def linuxBrowsers(self, value): """ - This method is the setter method for **self.__linuxBrowsers** attribute. + Setter for **self.__linuxBrowsers** attribute. :param value: Attribute value. ( QObject ) """ @@ -435,7 +435,7 @@ def linuxBrowsers(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def linuxBrowsers(self): """ - This method is the deleter method for **self.__linuxBrowsers** attribute. + Deleter for **self.__linuxBrowsers** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -446,7 +446,7 @@ def linuxBrowsers(self): #****************************************************************************************************************** def activate(self, engine): """ - This method Engine the Component. + Activates the Component. :param engine: Container to attach the Component to. ( QObject ) :return: Method success. ( Boolean ) @@ -470,7 +470,7 @@ def activate(self, engine): def deactivate(self): """ - This method deactivates the Component. + Deactivates the Component. :return: Method success. ( Boolean ) """ @@ -493,7 +493,7 @@ def deactivate(self): def initializeUi(self): """ - This method initializes the Component ui. + Initializes the Component ui. :return: Method success. ( Boolean ) """ @@ -522,7 +522,7 @@ def initializeUi(self): def uninitializeUi(self): """ - This method uninitializes the Component ui. + Uninitializes the Component ui. :return: Method success. ( Boolean ) """ @@ -549,7 +549,7 @@ def uninitializeUi(self): def addWidget(self): """ - This method adds the Component Widget to the engine. + Adds the Component Widget to the engine. :return: Method success. ( Boolean ) """ @@ -562,7 +562,7 @@ def addWidget(self): def removeWidget(self): """ - This method removes the Component Widget from the engine. + Removes the Component Widget from the engine. :return: Method success. ( Boolean ) """ @@ -575,7 +575,7 @@ def removeWidget(self): def __addActions(self): """ - This method sets Component actions. + Sets Component actions. """ LOGGER.debug("> Adding '{0}' Component actions.".format(self.__class__.__name__)) @@ -601,7 +601,7 @@ def __addActions(self): def __removeActions(self): """ - This method removes actions. + Removes actions. """ LOGGER.debug("> Removing '{0}' Component actions.".format(self.__class__.__name__)) @@ -627,7 +627,7 @@ def __removeActions(self): def __iblSetsOutliner_views_openIblSetsLocationsAction__triggered(self, checked): """ - This method is triggered by + Defines the slot triggered by **'Actions|Umbra|Components|core.iblSetsOutliner|Open Ibl Set(s) Location(s) ...'** action. :param checked: Action checked state. ( Boolean ) @@ -638,7 +638,7 @@ def __iblSetsOutliner_views_openIblSetsLocationsAction__triggered(self, checked) def __inspector_openActiveIblSetLocationsAction__triggered(self, checked): """ - This method is triggered by **'Actions|Umbra|Components|core.inspector|Open Ibl Set location ...'** action. + Defines the slot triggered by **'Actions|Umbra|Components|core.inspector|Open Ibl Set location ...'** action. :param checked: Action checked state. ( Boolean ) :return: Method success. ( Boolean ) @@ -648,7 +648,7 @@ def __inspector_openActiveIblSetLocationsAction__triggered(self, checked): def __componentsManagerUi_view_openComponentsLocationsAction__triggered(self, checked): """ - This method is triggered by + Defines the slot triggered by **'Actions|Umbra|Components|factory.ComponentsManagerUi|Open Component(s) Location(s) ...'** action. :param checked: Action checked state. ( Boolean ) @@ -659,7 +659,7 @@ def __componentsManagerUi_view_openComponentsLocationsAction__triggered(self, ch def __templatesOutliner_view_openTemplatesLocationsAction__triggered(self, checked): """ - This method is triggered by + Defines the slot triggered by **'Actions|Umbra|Components|core.templatesOutliner|Open Template(s) Location(s) ...'** action. :param checked: Action checked state. ( Boolean ) @@ -670,7 +670,7 @@ def __templatesOutliner_view_openTemplatesLocationsAction__triggered(self, check def __Custom_File_Browser_Path_lineEdit_setUi(self): """ - This method fills **Custom_File_Browser_Path_lineEdit** Widget. + Fills **Custom_File_Browser_Path_lineEdit** Widget. """ customFileBrowser = self.__settings.getKey(self.__settingsSection, "customFileBrowser") @@ -680,7 +680,7 @@ def __Custom_File_Browser_Path_lineEdit_setUi(self): def __Custom_File_Browser_Path_toolButton__clicked(self, checked): """ - This method is triggered when **Custom_File_Browser_Path_toolButton** Widget is clicked. + Defines the slot triggered by **Custom_File_Browser_Path_toolButton** Widget when clicked. :param checked: Checked state. ( Boolean ) """ @@ -698,8 +698,8 @@ def __Custom_File_Browser_Path_toolButton__clicked(self, checked): foundations.exceptions.UserError) def __Custom_File_Browser_Path_lineEdit__editFinished(self): """ - This method is triggered when **Custom_File_Browser_Path_lineEdit** Widget - is edited and check that entered path is valid. + Defines the slot triggered by **Custom_File_Browser_Path_lineEdit** Widget + when edited and check that entered path is valid. """ value = foundations.strings.toString(self.Custom_File_Browser_Path_lineEdit.text()) @@ -716,7 +716,7 @@ def __Custom_File_Browser_Path_lineEdit__editFinished(self): def __Open_Output_Directory_pushButton__clicked(self, checked): """ - This method is triggered when **Open_Output_Directory_pushButton** Widget is clicked. + Defines the slot triggered by **Open_Output_Directory_pushButton** Widget when clicked. :param checked: Checked state. ( Boolean ) """ @@ -726,7 +726,7 @@ def __Open_Output_Directory_pushButton__clicked(self, checked): @foundations.exceptions.handleExceptions(umbra.exceptions.notifyExceptionHandler, Exception) def openIblSetsLocationsUi(self): """ - This method open selected Ibl Sets directories. + Open selected Ibl Sets directories. :return: Method success. ( Boolean ) @@ -755,7 +755,7 @@ def openIblSetsLocationsUi(self): foundations.exceptions.FileExistsError) def openActiveIblSetLocationsUi(self): """ - This method opens :mod:`sibl_gui.components.core.inspector.inspector` Component Ibl Set directory. + Opens :mod:`sibl_gui.components.core.inspector.inspector` Component Ibl Set directory. :return: Method success. ( Boolean ) @@ -777,7 +777,7 @@ def openActiveIblSetLocationsUi(self): @foundations.exceptions.handleExceptions(umbra.exceptions.notifyExceptionHandler, Exception) def openComponentsLocationsUi(self): """ - This method opens selected Components directories. + Opens selected Components directories. :return: Method success. ( Boolean ) @@ -805,7 +805,7 @@ def openComponentsLocationsUi(self): @foundations.exceptions.handleExceptions(umbra.exceptions.notifyExceptionHandler, Exception) def openTemplatesLocationsUi(self): """ - This method opens selected Templates directories. + Opens selected Templates directories. :return: Method success. ( Boolean ) @@ -835,7 +835,7 @@ def openTemplatesLocationsUi(self): Exception) def openOutputDirectoryUi(self): """ - This method opens output directory. + Opens output directory. :return: Method success. ( Boolean ) @@ -858,7 +858,7 @@ def openOutputDirectoryUi(self): @foundations.exceptions.handleExceptions(umbra.exceptions.notifyExceptionHandler, Exception) def getProcessCommand(self, directory, customBrowser=None): """ - This method gets process command. + Gets process command. :param directory: Directory to explore. ( String ) :param customBrowser: Custom browser. ( String ) @@ -905,7 +905,7 @@ def getProcessCommand(self, directory, customBrowser=None): def exploreDirectory(self, directory, customBrowser=None): """ - This method provides directory exploring capability. + Provides directory exploring capability. :param directory: Directory to explore. ( String ) :param customBrowser: Custom browser. ( String ) diff --git a/sibl_gui/components/addons/loggingNotifier/loggingNotifier.py b/sibl_gui/components/addons/loggingNotifier/loggingNotifier.py index a69809bd..d8994627 100644 --- a/sibl_gui/components/addons/loggingNotifier/loggingNotifier.py +++ b/sibl_gui/components/addons/loggingNotifier/loggingNotifier.py @@ -53,7 +53,7 @@ class LoggingNotifier(Component): def __init__(self, name=None): """ - This method initializes the class. + Initializes the class. :param name: Component name. ( String ) """ @@ -75,7 +75,7 @@ def __init__(self, name=None): @property def engine(self): """ - This method is the property for **self.__engine** attribute. + Property for **self.__engine** attribute. :return: self.__engine. ( QObject ) """ @@ -86,7 +86,7 @@ def engine(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self, value): """ - This method is the setter method for **self.__engine** attribute. + Setter for **self.__engine** attribute. :param value: Attribute value. ( QObject ) """ @@ -98,7 +98,7 @@ def engine(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self): """ - This method is the deleter method for **self.__engine** attribute. + Deleter for **self.__engine** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -107,7 +107,7 @@ def engine(self): @property def memoryHandlerStackDepth(self): """ - This method is the property for **self.__memoryHandlerStackDepth** attribute. + Property for **self.__memoryHandlerStackDepth** attribute. :return: self.__memoryHandlerStackDepth. ( Integer ) """ @@ -118,7 +118,7 @@ def memoryHandlerStackDepth(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def memoryHandlerStackDepth(self, value): """ - This method is the setter method for **self.__memoryHandlerStackDepth** attribute. + Setter for **self.__memoryHandlerStackDepth** attribute. :param value: Attribute value. ( Integer ) """ @@ -130,7 +130,7 @@ def memoryHandlerStackDepth(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def memoryHandlerStackDepth(self): """ - This method is the deleter method for **self.__memoryHandlerStackDepth** attribute. + Deleter for **self.__memoryHandlerStackDepth** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -141,7 +141,7 @@ def memoryHandlerStackDepth(self): #****************************************************************************************************************** def activate(self, engine): """ - This method activates the Component. + Activates the Component. :param engine: Engine to attach the Component to. ( QObject ) :return: Method success. ( Boolean ) @@ -156,7 +156,7 @@ def activate(self, engine): def deactivate(self): """ - This method deactivates the Component. + Deactivates the Component. :return: Method success. ( Boolean ) """ @@ -170,7 +170,7 @@ def deactivate(self): def initialize(self): """ - This method initializes the Component. + Initializes the Component. :return: Method success. ( Boolean ) """ @@ -185,7 +185,7 @@ def initialize(self): def uninitialize(self): """ - This method uninitializes the Component. + Uninitializes the Component. :return: Method success. ( Boolean ) """ @@ -200,7 +200,7 @@ def uninitialize(self): def __statusBar_showLoggingMessages(self): """ - This method updates the engine status bar with logging messages. + Updates the engine status bar with logging messages. """ memoryHandlerStackDepth = len(self.__engine.loggingSessionHandlerStream.stream) diff --git a/sibl_gui/components/addons/onlineUpdater/downloadManager.py b/sibl_gui/components/addons/onlineUpdater/downloadManager.py index 2bf96f62..1f9fe7be 100644 --- a/sibl_gui/components/addons/onlineUpdater/downloadManager.py +++ b/sibl_gui/components/addons/onlineUpdater/downloadManager.py @@ -75,7 +75,7 @@ class DownloadManager(foundations.ui.common.QWidgetFactory(uiFile=UI_FILE)): def __init__(self, parent, networkAccessManager, downloadDirectory, requests=None, *args, **kwargs): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param networkAccessManager: Network access manager. ( QNetworkAccessManager ) @@ -116,7 +116,7 @@ def __init__(self, parent, networkAccessManager, downloadDirectory, requests=Non @property def container(self): """ - This method is the property for **self.__container** attribute. + Property for **self.__container** attribute. :return: self.__container. ( QObject ) """ @@ -127,7 +127,7 @@ def container(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def container(self, value): """ - This method is the setter method for **self.__container** attribute. + Setter for **self.__container** attribute. :param value: Attribute value. ( QObject ) """ @@ -139,7 +139,7 @@ def container(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def container(self): """ - This method is the deleter method for **self.__container** attribute. + Deleter for **self.__container** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -148,7 +148,7 @@ def container(self): @property def networkAccessManager(self): """ - This method is the property for **self.__networkAccessManager** attribute. + Property for **self.__networkAccessManager** attribute. :return: self.__networkAccessManager. ( QNetworkAccessManager ) """ @@ -159,7 +159,7 @@ def networkAccessManager(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def networkAccessManager(self, value): """ - This method is the setter method for **self.__networkAccessManager** attribute. + Setter for **self.__networkAccessManager** attribute. :param value: Attribute value. ( QNetworkAccessManager ) """ @@ -171,7 +171,7 @@ def networkAccessManager(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def networkAccessManager(self): """ - This method is the deleter method for **self.__networkAccessManager** attribute. + Deleter for **self.__networkAccessManager** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -180,7 +180,7 @@ def networkAccessManager(self): @property def downloadDirectory(self): """ - This method is the property for **self.__downloadDirectory** attribute. + Property for **self.__downloadDirectory** attribute. :return: self.__downloadDirectory. ( String ) """ @@ -191,7 +191,7 @@ def downloadDirectory(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def downloadDirectory(self, value): """ - This method is the setter method for **self.__downloadDirectory** attribute. + Setter for **self.__downloadDirectory** attribute. :param value: Attribute value. ( String ) """ @@ -203,7 +203,7 @@ def downloadDirectory(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def downloadDirectory(self): """ - This method is the deleter method for **self.__downloadDirectory** attribute. + Deleter for **self.__downloadDirectory** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -212,7 +212,7 @@ def downloadDirectory(self): @property def uiResourcesDirectory(self): """ - This method is the property for **self.__uiResourcesDirectory** attribute. + Property for **self.__uiResourcesDirectory** attribute. :return: self.__uiResourcesDirectory. ( String ) """ @@ -223,7 +223,7 @@ def uiResourcesDirectory(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiResourcesDirectory(self, value): """ - This method is the setter method for **self.__uiResourcesDirectory** attribute. + Setter for **self.__uiResourcesDirectory** attribute. :param value: Attribute value. ( String ) """ @@ -235,7 +235,7 @@ def uiResourcesDirectory(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiResourcesDirectory(self): """ - This method is the deleter method for **self.__uiResourcesDirectory** attribute. + Deleter for **self.__uiResourcesDirectory** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -244,7 +244,7 @@ def uiResourcesDirectory(self): @property def uiLogoImage(self): """ - This method is the property for **self.__uiLogoImage** attribute. + Property for **self.__uiLogoImage** attribute. :return: self.__uiLogoImage. ( String ) """ @@ -255,7 +255,7 @@ def uiLogoImage(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiLogoImage(self, value): """ - This method is the setter method for **self.__uiLogoImage** attribute. + Setter for **self.__uiLogoImage** attribute. :param value: Attribute value. ( String ) """ @@ -267,7 +267,7 @@ def uiLogoImage(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiLogoImage(self): """ - This method is the deleter method for **self.__uiLogoImage** attribute. + Deleter for **self.__uiLogoImage** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -276,7 +276,7 @@ def uiLogoImage(self): @property def requests(self): """ - This method is the property for **self.__requests** attribute. + Property for **self.__requests** attribute. :return: self.__requests. ( List ) """ @@ -287,7 +287,7 @@ def requests(self): @foundations.exceptions.handleExceptions(AssertionError) def requests(self, value): """ - This method is the setter method for **self.__requests** attribute. + Setter for **self.__requests** attribute. :param value: Attribute value. ( List ) """ @@ -303,7 +303,7 @@ def requests(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def requests(self): """ - This method is the deleter method for **self.__requests** attribute. + Deleter for **self.__requests** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -312,7 +312,7 @@ def requests(self): @property def downloads(self): """ - This method is the property for **self.__downloads** attribute. + Property for **self.__downloads** attribute. :return: self.__downloads. ( Dictionary ) """ @@ -323,7 +323,7 @@ def downloads(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def downloads(self, value): """ - This method is the setter method for **self.__downloads** attribute. + Setter for **self.__downloads** attribute. :param value: Attribute value. ( Dictionary ) """ @@ -335,7 +335,7 @@ def downloads(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def downloads(self): """ - This method is the deleter method for **self.__downloads** attribute. + Deleter for **self.__downloads** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -344,7 +344,7 @@ def downloads(self): @property def currentRequest(self): """ - This method is the property for **self.__currentRequest** attribute. + Property for **self.__currentRequest** attribute. :return: self.__currentRequest. ( QNetworkReply ) """ @@ -355,7 +355,7 @@ def currentRequest(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def currentRequest(self, value): """ - This method is the setter method for **self.__currentRequest** attribute. + Setter for **self.__currentRequest** attribute. :param value: Attribute value. ( QNetworkReply ) """ @@ -367,7 +367,7 @@ def currentRequest(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def currentRequest(self): """ - This method is the deleter method for **self.__currentRequest** attribute. + Deleter for **self.__currentRequest** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -376,7 +376,7 @@ def currentRequest(self): @property def currentFile(self): """ - This method is the property for **self.__currentFile** attribute. + Property for **self.__currentFile** attribute. :return: self.__currentFile. ( QFile ) """ @@ -387,7 +387,7 @@ def currentFile(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def currentFile(self, value): """ - This method is the setter method for **self.__currentFile** attribute. + Setter for **self.__currentFile** attribute. :param value: Attribute value. ( QFile ) """ @@ -399,7 +399,7 @@ def currentFile(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def currentFile(self): """ - This method is the deleter method for **self.__currentFile** attribute. + Deleter for **self.__currentFile** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -408,7 +408,7 @@ def currentFile(self): @property def currentFilePath(self): """ - This method is the property for **self.__currentFilePath** attribute. + Property for **self.__currentFilePath** attribute. :return: self.__currentFilePath. ( String ) """ @@ -419,7 +419,7 @@ def currentFilePath(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def currentFilePath(self, value): """ - This method is the setter method for **self.__currentFilePath** attribute. + Setter for **self.__currentFilePath** attribute. :param value: Attribute value. ( String ) """ @@ -431,7 +431,7 @@ def currentFilePath(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def currentFilePath(self): """ - This method is the deleter method for **self.__currentFilePath** attribute. + Deleter for **self.__currentFilePath** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -440,7 +440,7 @@ def currentFilePath(self): @property def downloadStatus(self): """ - This method is the property for **self.__downloadStatus** attribute. + Property for **self.__downloadStatus** attribute. :return: self.__downloadStatus. ( QObject ) """ @@ -451,7 +451,7 @@ def downloadStatus(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def downloadStatus(self, value): """ - This method is the setter method for **self.__downloadStatus** attribute. + Setter for **self.__downloadStatus** attribute. :param value: Attribute value. ( QObject ) """ @@ -463,7 +463,7 @@ def downloadStatus(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def downloadStatus(self): """ - This method is the deleter method for **self.__downloadStatus** attribute. + Deleter for **self.__downloadStatus** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -474,7 +474,7 @@ def downloadStatus(self): #****************************************************************************************************************** def closeEvent(self, event): """ - This method reimplements the :meth:`QWidget.closeEvent` method. + Reimplements the :meth:`QWidget.closeEvent` method. :param event: QEvent. ( QEvent ) """ @@ -485,7 +485,7 @@ def closeEvent(self, event): def __initializeUi(self): """ - This method initializes the Widget ui. + Initializes the Widget ui. """ umbra.ui.common.setWindowDefaultIcon(self) @@ -500,7 +500,7 @@ def __initializeUi(self): def __Cancel_Close_pushButton__clicked(self, checked): """ - This method is triggered when **Cancel_Close_pushButton** Widget is clicked. + Defines the slot triggered by **Cancel_Close_pushButton** Widget when clicked. :param checked: Checked state. ( Boolean ) """ @@ -509,7 +509,7 @@ def __Cancel_Close_pushButton__clicked(self, checked): def __downloadNext(self): """ - This method downloads the next request. + Downloads the next request. """ if not self.__requests: @@ -542,7 +542,7 @@ def __downloadNext(self): def __downloadProgress(self, bytesReceived, bytesTotal): """ - This method updates the download progress. + Updates the download progress. :param bytesReceived: Bytes received. ( Integer ) :param bytesTotal: Bytes total. ( Integer ) @@ -558,7 +558,7 @@ def __downloadProgress(self, bytesReceived, bytesTotal): def __requestReady(self): """ - This method is triggered when the request is ready to write. + Defines the slot triggered by the request when ready. """ LOGGER.debug("> Updating '{0}' file content.".format(self.__currentFile)) @@ -567,7 +567,7 @@ def __requestReady(self): def __downloadComplete(self): """ - This method is triggered when the request download is complete. + Defines the slot triggered by the request when download complete. """ LOGGER.debug("> '{0}' download complete.".format(self.__currentFile)) @@ -589,7 +589,7 @@ def __downloadComplete(self): def startDownload(self): """ - This method triggers the download. + Triggers the download. :return: Method success. ( Boolean ) """ @@ -600,7 +600,7 @@ def startDownload(self): def abortDownload(self): """ - This method aborts the current download. + Aborts the current download. :return: Method success. ( Boolean ) """ diff --git a/sibl_gui/components/addons/onlineUpdater/onlineUpdater.py b/sibl_gui/components/addons/onlineUpdater/onlineUpdater.py index 22794c16..2d1da3cc 100644 --- a/sibl_gui/components/addons/onlineUpdater/onlineUpdater.py +++ b/sibl_gui/components/addons/onlineUpdater/onlineUpdater.py @@ -74,7 +74,7 @@ class OnlineUpdater(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): def __init__(self, parent=None, name=None, *args, **kwargs): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param name: Component name. ( String ) @@ -114,7 +114,7 @@ def __init__(self, parent=None, name=None, *args, **kwargs): @property def engine(self): """ - This method is the property for **self.__engine** attribute. + Property for **self.__engine** attribute. :return: self.__engine. ( QObject ) """ @@ -125,7 +125,7 @@ def engine(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self, value): """ - This method is the setter method for **self.__engine** attribute. + Setter for **self.__engine** attribute. :param value: Attribute value. ( QObject ) """ @@ -137,7 +137,7 @@ def engine(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self): """ - This method is the deleter method for **self.__engine** attribute. + Deleter for **self.__engine** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -146,7 +146,7 @@ def engine(self): @property def settings(self): """ - This method is the property for **self.__settings** attribute. + Property for **self.__settings** attribute. :return: self.__settings. ( QSettings ) """ @@ -157,7 +157,7 @@ def settings(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settings(self, value): """ - This method is the setter method for **self.__settings** attribute. + Setter for **self.__settings** attribute. :param value: Attribute value. ( QSettings ) """ @@ -169,7 +169,7 @@ def settings(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settings(self): """ - This method is the deleter method for **self.__settings** attribute. + Deleter for **self.__settings** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -178,7 +178,7 @@ def settings(self): @property def settingsSection(self): """ - This method is the property for **self.__settingsSection** attribute. + Property for **self.__settingsSection** attribute. :return: self.__settingsSection. ( String ) """ @@ -189,7 +189,7 @@ def settingsSection(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settingsSection(self, value): """ - This method is the setter method for **self.__settingsSection** attribute. + Setter for **self.__settingsSection** attribute. :param value: Attribute value. ( String ) """ @@ -201,7 +201,7 @@ def settingsSection(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settingsSection(self): """ - This method is the deleter method for **self.__settingsSection** attribute. + Deleter for **self.__settingsSection** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -210,7 +210,7 @@ def settingsSection(self): @property def preferencesManager(self): """ - This method is the property for **self.__preferencesManager** attribute. + Property for **self.__preferencesManager** attribute. :return: self.__preferencesManager. ( QWidget ) """ @@ -221,7 +221,7 @@ def preferencesManager(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def preferencesManager(self, value): """ - This method is the setter method for **self.__preferencesManager** attribute. + Setter for **self.__preferencesManager** attribute. :param value: Attribute value. ( QWidget ) """ @@ -233,7 +233,7 @@ def preferencesManager(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def preferencesManager(self): """ - This method is the deleter method for **self.__preferencesManager** attribute. + Deleter for **self.__preferencesManager** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -242,7 +242,7 @@ def preferencesManager(self): @property def templatesOutliner(self): """ - This method is the property for **self.__templatesOutliner** attribute. + Property for **self.__templatesOutliner** attribute. :return: self.__templatesOutliner. ( QWidget ) """ @@ -253,7 +253,7 @@ def templatesOutliner(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templatesOutliner(self, value): """ - This method is the setter method for **self.__templatesOutliner** attribute. + Setter for **self.__templatesOutliner** attribute. :param value: Attribute value. ( QWidget ) """ @@ -265,7 +265,7 @@ def templatesOutliner(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templatesOutliner(self): """ - This method is the deleter method for **self.__templatesOutliner** attribute. + Deleter for **self.__templatesOutliner** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -274,7 +274,7 @@ def templatesOutliner(self): @property def locationsBrowser(self): """ - This method is the property for **self.__locationsBrowser** attribute. + Property for **self.__locationsBrowser** attribute. :return: self.__locationsBrowser. ( QWidget ) """ @@ -285,7 +285,7 @@ def locationsBrowser(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def locationsBrowser(self, value): """ - This method is the setter method for **self.__locationsBrowser** attribute. + Setter for **self.__locationsBrowser** attribute. :param value: Attribute value. ( QWidget ) """ @@ -297,7 +297,7 @@ def locationsBrowser(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def locationsBrowser(self): """ - This method is the deleter method for **self.__locationsBrowser** attribute. + Deleter for **self.__locationsBrowser** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -306,7 +306,7 @@ def locationsBrowser(self): @property def ioDirectory(self): """ - This method is the property for **self.__ioDirectory** attribute. + Property for **self.__ioDirectory** attribute. :return: self.__ioDirectory. ( String ) """ @@ -317,7 +317,7 @@ def ioDirectory(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def ioDirectory(self, value): """ - This method is the setter method for **self.__ioDirectory** attribute. + Setter for **self.__ioDirectory** attribute. :param value: Attribute value. ( String ) """ @@ -329,7 +329,7 @@ def ioDirectory(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def ioDirectory(self): """ - This method is the deleter method for **self.__ioDirectory** attribute. + Deleter for **self.__ioDirectory** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -338,7 +338,7 @@ def ioDirectory(self): @property def repositoryUrl(self): """ - This method is the property for **self.__repositoryUrl** attribute. + Property for **self.__repositoryUrl** attribute. :return: self.__repositoryUrl. ( String ) """ @@ -349,7 +349,7 @@ def repositoryUrl(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def repositoryUrl(self, value): """ - This method is the setter method for **self.__repositoryUrl** attribute. + Setter for **self.__repositoryUrl** attribute. :param value: Attribute value. ( String ) """ @@ -361,7 +361,7 @@ def repositoryUrl(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def repositoryUrl(self): """ - This method is the deleter method for **self.__repositoryUrl** attribute. + Deleter for **self.__repositoryUrl** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -370,7 +370,7 @@ def repositoryUrl(self): @property def releasesFileUrl(self): """ - This method is the property for **self.__releasesFileUrl** attribute. + Property for **self.__releasesFileUrl** attribute. :return: self.__releasesFileUrl. ( String ) """ @@ -381,7 +381,7 @@ def releasesFileUrl(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def releasesFileUrl(self, value): """ - This method is the setter method for **self.__releasesFileUrl** attribute. + Setter for **self.__releasesFileUrl** attribute. :param value: Attribute value. ( String ) """ @@ -393,7 +393,7 @@ def releasesFileUrl(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def releasesFileUrl(self): """ - This method is the deleter method for **self.__releasesFileUrl** attribute. + Deleter for **self.__releasesFileUrl** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -402,7 +402,7 @@ def releasesFileUrl(self): @property def networkAccessManager(self): """ - This method is the property for **self.__networkAccessManager** attribute. + Property for **self.__networkAccessManager** attribute. :return: self.__networkAccessManager. ( QNetworkAccessManager ) """ @@ -413,7 +413,7 @@ def networkAccessManager(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def networkAccessManager(self, value): """ - This method is the setter method for **self.__networkAccessManager** attribute. + Setter for **self.__networkAccessManager** attribute. :param value: Attribute value. ( QNetworkAccessManager ) """ @@ -425,7 +425,7 @@ def networkAccessManager(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def networkAccessManager(self): """ - This method is the deleter method for **self.__networkAccessManager** attribute. + Deleter for **self.__networkAccessManager** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -434,7 +434,7 @@ def networkAccessManager(self): @property def releaseReply(self): """ - This method is the property for **self.__releasesFileReply** attribute. + Property for **self.__releasesFileReply** attribute. :return: self.__releasesFileReply. ( QNetworkReply ) """ @@ -445,7 +445,7 @@ def releaseReply(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def releaseReply(self, value): """ - This method is the setter method for **self.__releasesFileReply** attribute. + Setter for **self.__releasesFileReply** attribute. :param value: Attribute value. ( QNetworkReply ) """ @@ -457,7 +457,7 @@ def releaseReply(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def releaseReply(self): """ - This method is the deleter method for **self.__releasesFileReply** attribute. + Deleter for **self.__releasesFileReply** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -466,7 +466,7 @@ def releaseReply(self): @property def remoteUpdater(self): """ - This method is the property for **self.__remoteUpdater** attribute. + Property for **self.__remoteUpdater** attribute. :return: self.__remoteUpdater. ( Object ) """ @@ -477,7 +477,7 @@ def remoteUpdater(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def remoteUpdater(self, value): """ - This method is the setter method for **self.__remoteUpdater** attribute. + Setter for **self.__remoteUpdater** attribute. :param value: Attribute value. ( Object ) """ @@ -489,7 +489,7 @@ def remoteUpdater(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def remoteUpdater(self): """ - This method is the deleter method for **self.__remoteUpdater** attribute. + Deleter for **self.__remoteUpdater** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -498,7 +498,7 @@ def remoteUpdater(self): @property def reportUpdateStatus(self): """ - This method is the property for **self.__reportUpdateStatus** attribute. + Property for **self.__reportUpdateStatus** attribute. :return: self.__reportUpdateStatus. ( Boolean ) """ @@ -509,7 +509,7 @@ def reportUpdateStatus(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def reportUpdateStatus(self, value): """ - This method is the setter method for **self.__reportUpdateStatus** attribute. + Setter for **self.__reportUpdateStatus** attribute. :param value: Attribute value. ( Boolean ) """ @@ -521,7 +521,7 @@ def reportUpdateStatus(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def reportUpdateStatus(self): """ - This method is the deleter method for **self.__reportUpdateStatus** attribute. + Deleter for **self.__reportUpdateStatus** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -532,7 +532,7 @@ def reportUpdateStatus(self): #****************************************************************************************************************** def activate(self, engine): """ - This method activates the Component. + Activates the Component. :param engine: Engine to attach the Component to. ( QObject ) :return: Method success. ( Boolean ) @@ -561,7 +561,7 @@ def activate(self, engine): def deactivate(self): """ - This method deactivates the Component. + Deactivates the Component. :return: Method success. ( Boolean ) """ @@ -587,7 +587,7 @@ def deactivate(self): def initializeUi(self): """ - This method initializes the Component ui. + Initializes the Component ui. :return: Method success. ( Boolean ) """ @@ -614,7 +614,7 @@ def initializeUi(self): def uninitializeUi(self): """ - This method uninitializes the Component ui. + Uninitializes the Component ui. :return: Method success. ( Boolean ) """ @@ -633,7 +633,7 @@ def uninitializeUi(self): def onStartup(self): """ - This method is triggered on Framework startup. + Defines the slot triggered on Framework startup. :return: Method success. ( Boolean ) """ @@ -648,7 +648,7 @@ def onStartup(self): def addWidget(self): """ - This method adds the Component Widget to the engine. + Adds the Component Widget to the engine. :return: Method success. ( Boolean ) """ @@ -659,7 +659,7 @@ def addWidget(self): def removeWidget(self): """ - This method removes the Component Widget from the engine. + Removes the Component Widget from the engine. :return: Method success. ( Boolean ) """ @@ -670,7 +670,7 @@ def removeWidget(self): def __Check_For_New_Releases_On_Startup_checkBox_setUi(self): """ - This method sets the **Check_For_New_Releases_On_Startup_checkBox** Widget. + Sets the **Check_For_New_Releases_On_Startup_checkBox** Widget. """ # Adding settings key if it doesn't exists. @@ -685,7 +685,7 @@ def __Check_For_New_Releases_On_Startup_checkBox_setUi(self): def __Check_For_New_Releases_On_Startup_checkBox__stateChanged(self, state): """ - This method is triggered when **Check_For_New_Releases_On_Startup_checkBox** Widget state changes. + Defines the slot triggered by **Check_For_New_Releases_On_Startup_checkBox** Widget when state changed. :param state: Checkbox state. ( Integer ) """ @@ -695,7 +695,7 @@ def __Check_For_New_Releases_On_Startup_checkBox__stateChanged(self, state): def __Ignore_Non_Existing_Templates_checkBox_setUi(self): """ - This method sets the **Ignore_Non_Existing_Templates_checkBox** Widget. + Sets the **Ignore_Non_Existing_Templates_checkBox** Widget. """ # Adding settings key if it doesn't exists. @@ -710,7 +710,7 @@ def __Ignore_Non_Existing_Templates_checkBox_setUi(self): def __Ignore_Non_Existing_Templates_checkBox__stateChanged(self, state): """ - This method is triggered when **Ignore_Non_Existing_Templates_checkBox** Widget state changes. + Defines the slot triggered by **Ignore_Non_Existing_Templates_checkBox** Widget when state changed. :param state: Checkbox state. ( Integer ) """ @@ -720,7 +720,7 @@ def __Ignore_Non_Existing_Templates_checkBox__stateChanged(self, state): def __Check_For_New_Releases_pushButton__clicked(self, checked): """ - This method is triggered when **Check_For_New_Releases_pushButton** Widget is clicked. + Defines the slot triggered by **Check_For_New_Releases_pushButton** Widget when clicked. :param checked: Checked state. ( Boolean ) """ @@ -730,7 +730,7 @@ def __Check_For_New_Releases_pushButton__clicked(self, checked): @foundations.exceptions.handleExceptions(sibl_gui.exceptions.NetworkError) def __releasesFileReply__finished(self): """ - This method is triggered when the releases file reply finishes. + Defines the slot triggered by the releases file reply when finished. """ self.__engine.stopProcessing() @@ -805,7 +805,7 @@ def __releasesFileReply__finished(self): def __getReleasesFile(self, url): """ - This method gets the releases file. + Gets the releases file. """ LOGGER.debug("> Downloading '{0}' releases file.".format(url.path())) @@ -819,7 +819,7 @@ def __getReleasesFile(self, url): Exception) def checkForNewReleasesUi(self): """ - This method checks for new releases. + Checks for new releases. :return: Method success. ( Boolean ) @@ -838,7 +838,7 @@ def checkForNewReleasesUi(self): @foundations.exceptions.handleExceptions(sibl_gui.exceptions.NetworkError, Exception) def checkForNewReleases(self): """ - This method checks for new releases. + Checks for new releases. :return: Method success. ( Boolean ) """ diff --git a/sibl_gui/components/addons/onlineUpdater/remoteUpdater.py b/sibl_gui/components/addons/onlineUpdater/remoteUpdater.py index 9f40bef4..c99c926a 100644 --- a/sibl_gui/components/addons/onlineUpdater/remoteUpdater.py +++ b/sibl_gui/components/addons/onlineUpdater/remoteUpdater.py @@ -79,7 +79,7 @@ class ReleaseObject(foundations.dataStructures.Structure): def __init__(self, **kwargs): """ - This method initializes the class. + Initializes the class. :param kwargs: name, repositoryVersion, localVersion, type, url, comment. ( Key / Value pairs ) """ @@ -97,7 +97,7 @@ class RemoteUpdater(foundations.ui.common.QWidgetFactory(uiFile=UI_FILE)): def __init__(self, parent, releases=None, *args, **kwargs): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param releases: Releases. ( Dictionary ) @@ -144,7 +144,7 @@ def __init__(self, parent, releases=None, *args, **kwargs): @property def container(self): """ - This method is the property for **self.__container** attribute. + Property for **self.__container** attribute. :return: self.__container. ( QObject ) """ @@ -155,7 +155,7 @@ def container(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def container(self, value): """ - This method is the setter method for **self.__container** attribute. + Setter for **self.__container** attribute. :param value: Attribute value. ( QObject ) """ @@ -167,7 +167,7 @@ def container(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def container(self): """ - This method is the deleter method for **self.__container** attribute. + Deleter for **self.__container** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -176,7 +176,7 @@ def container(self): @property def releases(self): """ - This method is the property for **self.__releases** attribute. + Property for **self.__releases** attribute. :return: self.__releases. ( Dictionary ) """ @@ -187,7 +187,7 @@ def releases(self): @foundations.exceptions.handleExceptions(AssertionError) def releases(self, value): """ - This method is the setter method for **self.__releases** attribute. + Setter for **self.__releases** attribute. :param value: Attribute value. ( Dictionary ) """ @@ -205,7 +205,7 @@ def releases(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def releases(self): """ - This method is the deleter method for **self.__releases** attribute. + Deleter for **self.__releases** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -214,7 +214,7 @@ def releases(self): @property def uiResourcesDirectory(self): """ - This method is the property for **self.__uiResourcesDirectory** attribute. + Property for **self.__uiResourcesDirectory** attribute. :return: self.__uiResourcesDirectory. ( String ) """ @@ -225,7 +225,7 @@ def uiResourcesDirectory(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiResourcesDirectory(self, value): """ - This method is the setter method for **self.__uiResourcesDirectory** attribute. + Setter for **self.__uiResourcesDirectory** attribute. :param value: Attribute value. ( String ) """ @@ -237,7 +237,7 @@ def uiResourcesDirectory(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiResourcesDirectory(self): """ - This method is the deleter method for **self.__uiResourcesDirectory** attribute. + Deleter for **self.__uiResourcesDirectory** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -246,7 +246,7 @@ def uiResourcesDirectory(self): @property def uiLogoImage(self): """ - This method is the property for **self.__uiLogoImage** attribute. + Property for **self.__uiLogoImage** attribute. :return: self.__uiLogoImage. ( String ) """ @@ -257,7 +257,7 @@ def uiLogoImage(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiLogoImage(self, value): """ - This method is the setter method for **self.__uiLogoImage** attribute. + Setter for **self.__uiLogoImage** attribute. :param value: Attribute value. ( String ) """ @@ -269,7 +269,7 @@ def uiLogoImage(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiLogoImage(self): """ - This method is the deleter method for **self.__uiLogoImage** attribute. + Deleter for **self.__uiLogoImage** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -278,7 +278,7 @@ def uiLogoImage(self): @property def uiTemplatesImage(self): """ - This method is the property for **self.__uiTemplatesImage** attribute. + Property for **self.__uiTemplatesImage** attribute. :return: self.__uiTemplatesImage. ( String ) """ @@ -289,7 +289,7 @@ def uiTemplatesImage(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiTemplatesImage(self, value): """ - This method is the setter method for **self.__uiTemplatesImage** attribute. + Setter for **self.__uiTemplatesImage** attribute. :param value: Attribute value. ( String ) """ @@ -301,7 +301,7 @@ def uiTemplatesImage(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiTemplatesImage(self): """ - This method is the deleter method for **self.__uiTemplatesImage** attribute. + Deleter for **self.__uiTemplatesImage** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -310,7 +310,7 @@ def uiTemplatesImage(self): @property def uiLightGrayColor(self): """ - This method is the property for **self.__uiLightGrayColor** attribute. + Property for **self.__uiLightGrayColor** attribute. :return: self.__uiLightGrayColor. ( QColor ) """ @@ -321,7 +321,7 @@ def uiLightGrayColor(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiLightGrayColor(self, value): """ - This method is the setter method for **self.__uiLightGrayColor** attribute. + Setter for **self.__uiLightGrayColor** attribute. :param value: Attribute value. ( QColor ) """ @@ -333,7 +333,7 @@ def uiLightGrayColor(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiLightGrayColor(self): """ - This method is the deleter method for **self.__uiLightGrayColor** attribute. + Deleter for **self.__uiLightGrayColor** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -342,7 +342,7 @@ def uiLightGrayColor(self): @property def uiDarkGrayColor(self): """ - This method is the property for **self.__uiDarkGrayColor** attribute. + Property for **self.__uiDarkGrayColor** attribute. :return: self.__uiDarkGrayColor. ( QColor ) """ @@ -353,7 +353,7 @@ def uiDarkGrayColor(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiDarkGrayColor(self, value): """ - This method is the setter method for **self.__uiDarkGrayColor** attribute. + Setter for **self.__uiDarkGrayColor** attribute. :param value: Attribute value. ( QColor ) """ @@ -365,7 +365,7 @@ def uiDarkGrayColor(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiDarkGrayColor(self): """ - This method is the deleter method for **self.__uiDarkGrayColor** attribute. + Deleter for **self.__uiDarkGrayColor** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -374,7 +374,7 @@ def uiDarkGrayColor(self): @property def view(self): """ - This method is the property for **self.__view** attribute. + Property for **self.__view** attribute. :return: self.__view. ( QWidget ) """ @@ -385,7 +385,7 @@ def view(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def view(self, value): """ - This method is the setter method for **self.__view** attribute. + Setter for **self.__view** attribute. :param value: Attribute value. ( QWidget ) """ @@ -397,7 +397,7 @@ def view(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def view(self): """ - This method is the deleter method for **self.__view** attribute. + Deleter for **self.__view** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -406,7 +406,7 @@ def view(self): @property def splitter(self): """ - This method is the property for **self.__splitter** attribute. + Property for **self.__splitter** attribute. :return: self.__splitter. ( String ) """ @@ -417,7 +417,7 @@ def splitter(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def splitter(self, value): """ - This method is the setter method for **self.__splitter** attribute. + Setter for **self.__splitter** attribute. :param value: Attribute value. ( String ) """ @@ -429,7 +429,7 @@ def splitter(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def splitter(self): """ - This method is the deleter method for **self.__splitter** attribute. + Deleter for **self.__splitter** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -438,7 +438,7 @@ def splitter(self): @property def headers(self): """ - This method is the property for **self.__headers** attribute. + Property for **self.__headers** attribute. :return: self.__headers. ( String ) """ @@ -449,7 +449,7 @@ def headers(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def headers(self, value): """ - This method is the setter method for **self.__headers** attribute. + Setter for **self.__headers** attribute. :param value: Attribute value. ( String ) """ @@ -461,7 +461,7 @@ def headers(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def headers(self): """ - This method is the deleter method for **self.__headers** attribute. + Deleter for **self.__headers** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -470,7 +470,7 @@ def headers(self): @property def applicationChangesUrl(self): """ - This method is the property for **self.__applicationChangesUrl** attribute. + Property for **self.__applicationChangesUrl** attribute. :return: self.__applicationChangesUrl. ( String ) """ @@ -481,7 +481,7 @@ def applicationChangesUrl(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def applicationChangesUrl(self, value): """ - This method is the setter method for **self.__applicationChangesUrl** attribute. + Setter for **self.__applicationChangesUrl** attribute. :param value: Attribute value. ( String ) """ @@ -493,7 +493,7 @@ def applicationChangesUrl(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def applicationChangesUrl(self): """ - This method is the deleter method for **self.__applicationChangesUrl** attribute. + Deleter for **self.__applicationChangesUrl** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -502,7 +502,7 @@ def applicationChangesUrl(self): @property def repositoryUrl(self): """ - This method is the property for **self.__repositoryUrl** attribute. + Property for **self.__repositoryUrl** attribute. :return: self.__repositoryUrl. ( String ) """ @@ -513,7 +513,7 @@ def repositoryUrl(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def repositoryUrl(self, value): """ - This method is the setter method for **self.__repositoryUrl** attribute. + Setter for **self.__repositoryUrl** attribute. :param value: Attribute value. ( String ) """ @@ -525,7 +525,7 @@ def repositoryUrl(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def repositoryUrl(self): """ - This method is the deleter method for **self.__repositoryUrl** attribute. + Deleter for **self.__repositoryUrl** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -534,7 +534,7 @@ def repositoryUrl(self): @property def downloadManager(self): """ - This method is the property for **self.__downloadManager** attribute. + Property for **self.__downloadManager** attribute. :return: self.__downloadManager. ( Object ) """ @@ -545,7 +545,7 @@ def downloadManager(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def downloadManager(self, value): """ - This method is the setter method for **self.__downloadManager** attribute. + Setter for **self.__downloadManager** attribute. :param value: Attribute value. ( Object ) """ @@ -557,7 +557,7 @@ def downloadManager(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def downloadManager(self): """ - This method is the deleter method for **self.__downloadManager** attribute. + Deleter for **self.__downloadManager** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -566,7 +566,7 @@ def downloadManager(self): @property def networkAccessManager(self): """ - This method is the property for **self.__networkAccessManager** attribute. + Property for **self.__networkAccessManager** attribute. :return: self.__networkAccessManager. ( QNetworkAccessManager ) """ @@ -577,7 +577,7 @@ def networkAccessManager(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def networkAccessManager(self, value): """ - This method is the setter method for **self.__networkAccessManager** attribute. + Setter for **self.__networkAccessManager** attribute. :param value: Attribute value. ( QNetworkAccessManager ) """ @@ -589,7 +589,7 @@ def networkAccessManager(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def networkAccessManager(self): """ - This method is the deleter method for **self.__networkAccessManager** attribute. + Deleter for **self.__networkAccessManager** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -600,7 +600,7 @@ def networkAccessManager(self): #****************************************************************************************************************** def __initializeUi(self): """ - This method initializes the Widget ui. + Initializes the Widget ui. """ umbra.ui.common.setWindowDefaultIcon(self) @@ -683,7 +683,7 @@ def __initializeUi(self): def __Get_sIBL_GUI_pushButton__clicked(self, checked): """ - This method is triggered when **Get_sIBL_GUI_pushButton** Widget is clicked. + Defines the slot triggered by **Get_sIBL_GUI_pushButton** Widget when clicked. :param checked: Checked state. ( Boolean ) """ @@ -708,7 +708,7 @@ def __Get_sIBL_GUI_pushButton__clicked(self, checked): def __Get_Latest_Templates_pushButton__clicked(self, checked): """ - This method is triggered when **Get_Latest_Templates_pushButton** Widget is clicked. + Defines the slot triggered by **Get_Latest_Templates_pushButton** Widget when clicked. :param checked: Checked state. ( Boolean ) """ @@ -737,7 +737,7 @@ def __Get_Latest_Templates_pushButton__clicked(self, checked): def __Open_Repository_pushButton__clicked(self, checked): """ - This method is triggered when **Open_Repository_pushButton** Widget is clicked. + Defines the slot triggered by **Open_Repository_pushButton** Widget when clicked. :param checked: Checked state. ( Boolean ) """ @@ -747,7 +747,7 @@ def __Open_Repository_pushButton__clicked(self, checked): def __Close_pushButton__clicked(self, checked): """ - This method closes the RemoteUpdater. + Closes the RemoteUpdater. :param checked: Checked state. ( Boolean ) """ @@ -757,7 +757,7 @@ def __Close_pushButton__clicked(self, checked): def __downloadManager__finished(self): """ - This method is triggered when the download Manager finishes. + Defines the slot triggered by the download Manager when finished. """ for download, data in self.__downloadManager.downloads.iteritems(): @@ -785,7 +785,7 @@ def __downloadManager__finished(self): def __getTemplatesDownloadDirectory(self): """ - This method gets the Templates directory. + Gets the Templates directory. """ LOGGER.debug("> Retrieving Templates download directory.") @@ -808,7 +808,7 @@ def __getTemplatesDownloadDirectory(self): def extractZipFile(self, file): """ - This method uncompress the given zip file. + Uncompress the given zip file. :param file: File to extract. ( String ) :return: Extraction success. ( Boolean ) diff --git a/sibl_gui/components/addons/preview/imagesPreviewer.py b/sibl_gui/components/addons/preview/imagesPreviewer.py index de747caa..6d24b963 100644 --- a/sibl_gui/components/addons/preview/imagesPreviewer.py +++ b/sibl_gui/components/addons/preview/imagesPreviewer.py @@ -71,7 +71,7 @@ class Image_QGraphicsItem(QGraphicsItem): def __init__(self, parent=None, image=None): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param image: Image. ( QImage ) @@ -93,7 +93,7 @@ def __init__(self, parent=None, image=None): @property def image(self): """ - This method is the property for **self.__image** attribute. + Property for **self.__image** attribute. :return: self.__image. ( QImage ) """ @@ -104,7 +104,7 @@ def image(self): @foundations.exceptions.handleExceptions(AssertionError) def image(self, value): """ - This method is the setter method for **self.__image** attribute. + Setter for **self.__image** attribute. :param value: Attribute value. ( QImage ) """ @@ -117,7 +117,7 @@ def image(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def image(self): """ - This method is the deleter method for **self.__image** attribute. + Deleter for **self.__image** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -126,7 +126,7 @@ def image(self): @property def width(self): """ - This method is the property for **self.__width** attribute. + Property for **self.__width** attribute. :return: self.__width. ( Integer ) """ @@ -137,7 +137,7 @@ def width(self): @foundations.exceptions.handleExceptions(AssertionError) def width(self, value): """ - This method is the setter method for **self.__width** attribute. + Setter for **self.__width** attribute. :param value: Attribute value. ( Integer ) """ @@ -150,7 +150,7 @@ def width(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def width(self): """ - This method is the deleter method for **self.__width** attribute. + Deleter for **self.__width** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -159,7 +159,7 @@ def width(self): @property def height(self): """ - This method is the property for **self.__height** attribute. + Property for **self.__height** attribute. :return: self.__height. ( Integer ) """ @@ -170,7 +170,7 @@ def height(self): @foundations.exceptions.handleExceptions(AssertionError) def height(self, value): """ - This method is the setter method for **self.__height** attribute. + Setter for **self.__height** attribute. :param value: Attribute value. ( Integer ) """ @@ -183,7 +183,7 @@ def height(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def height(self): """ - This method is the deleter method for **self.__height** attribute. + Deleter for **self.__height** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -194,7 +194,7 @@ def height(self): #****************************************************************************************************************** def boundingRect(self): """ - This method reimplements the :meth:`QGraphicsItem.boundingRect` method. + Reimplements the :meth:`QGraphicsItem.boundingRect` method. """ return QRectF(-(self.__image.width()) / 2, @@ -204,7 +204,7 @@ def boundingRect(self): def paint(self, painter, options, widget): """ - This method reimplements the :meth:`QGraphicsItem.paint` method. + Reimplements the :meth:`QGraphicsItem.paint` method. :param painter: QPainter ( QPainter ) :param options: QStyleOptionGraphicsItem ( QStyleOptionGraphicsItem ) @@ -222,7 +222,7 @@ class ImagesPreviewer(foundations.ui.common.QWidgetFactory(uiFile=UI_FILE)): def __init__(self, parent, paths=None, *args, **kwargs): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param paths: Images paths. ( Tuple / List ) @@ -274,7 +274,7 @@ def __init__(self, parent, paths=None, *args, **kwargs): @property def container(self): """ - This method is the property for **self.__container** attribute. + Property for **self.__container** attribute. :return: self.__container. ( QObject ) """ @@ -285,7 +285,7 @@ def container(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def container(self, value): """ - This method is the setter method for **self.__container** attribute. + Setter for **self.__container** attribute. :param value: Attribute value. ( QObject ) """ @@ -297,7 +297,7 @@ def container(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def container(self): """ - This method is the deleter method for **self.__container** attribute. + Deleter for **self.__container** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -306,7 +306,7 @@ def container(self): @property def paths(self): """ - This method is the property for **self.__paths** attribute. + Property for **self.__paths** attribute. :return: self.__paths. ( Tuple / List ) """ @@ -317,7 +317,7 @@ def paths(self): @foundations.exceptions.handleExceptions(AssertionError) def paths(self, value): """ - This method is the setter method for **self.__paths** attribute. + Setter for **self.__paths** attribute. :param value: Attribute value. ( Tuple / List ) """ @@ -333,7 +333,7 @@ def paths(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def paths(self): """ - This method is the deleter method for **self.__paths** attribute. + Deleter for **self.__paths** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -342,7 +342,7 @@ def paths(self): @property def uiResourcesDirectory(self): """ - This method is the property for **self.__uiResourcesDirectory** attribute. + Property for **self.__uiResourcesDirectory** attribute. :return: self.__uiResourcesDirectory. ( String ) """ @@ -353,7 +353,7 @@ def uiResourcesDirectory(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiResourcesDirectory(self, value): """ - This method is the setter method for **self.__uiResourcesDirectory** attribute. + Setter for **self.__uiResourcesDirectory** attribute. :param value: Attribute value. ( String ) """ @@ -365,7 +365,7 @@ def uiResourcesDirectory(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiResourcesDirectory(self): """ - This method is the deleter method for **self.__uiResourcesDirectory** attribute. + Deleter for **self.__uiResourcesDirectory** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -374,7 +374,7 @@ def uiResourcesDirectory(self): @property def uiPreviousImage(self): """ - This method is the property for **self.__uiPreviousImage** attribute. + Property for **self.__uiPreviousImage** attribute. :return: self.__uiPreviousImage. ( String ) """ @@ -385,7 +385,7 @@ def uiPreviousImage(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiPreviousImage(self, value): """ - This method is the setter method for **self.__uiPreviousImage** attribute. + Setter for **self.__uiPreviousImage** attribute. :param value: Attribute value. ( String ) """ @@ -397,7 +397,7 @@ def uiPreviousImage(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiPreviousImage(self): """ - This method is the deleter method for **self.__uiPreviousImage** attribute. + Deleter for **self.__uiPreviousImage** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -406,7 +406,7 @@ def uiPreviousImage(self): @property def uiNextImage(self): """ - This method is the property for **self.__uiNextImage** attribute. + Property for **self.__uiNextImage** attribute. :return: self.__uiNextImage. ( String ) """ @@ -417,7 +417,7 @@ def uiNextImage(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiNextImage(self, value): """ - This method is the setter method for **self.__uiNextImage** attribute. + Setter for **self.__uiNextImage** attribute. :param value: Attribute value. ( String ) """ @@ -429,7 +429,7 @@ def uiNextImage(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiNextImage(self): """ - This method is the deleter method for **self.__uiNextImage** attribute. + Deleter for **self.__uiNextImage** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -438,7 +438,7 @@ def uiNextImage(self): @property def uiZoomOutImage(self): """ - This method is the property for **self.__uiZoomOutImage** attribute. + Property for **self.__uiZoomOutImage** attribute. :return: self.__uiZoomOutImage. ( String ) """ @@ -449,7 +449,7 @@ def uiZoomOutImage(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiZoomOutImage(self, value): """ - This method is the setter method for **self.__uiZoomOutImage** attribute. + Setter for **self.__uiZoomOutImage** attribute. :param value: Attribute value. ( String ) """ @@ -461,7 +461,7 @@ def uiZoomOutImage(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiZoomOutImage(self): """ - This method is the deleter method for **self.__uiZoomOutImage** attribute. + Deleter for **self.__uiZoomOutImage** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -470,7 +470,7 @@ def uiZoomOutImage(self): @property def uiZoomInImage(self): """ - This method is the property for **self.__uiZoomInImage** attribute. + Property for **self.__uiZoomInImage** attribute. :return: self.__uiZoomInImage. ( String ) """ @@ -481,7 +481,7 @@ def uiZoomInImage(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiZoomInImage(self, value): """ - This method is the setter method for **self.__uiZoomInImage** attribute. + Setter for **self.__uiZoomInImage** attribute. :param value: Attribute value. ( String ) """ @@ -493,7 +493,7 @@ def uiZoomInImage(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiZoomInImage(self): """ - This method is the deleter method for **self.__uiZoomInImage** attribute. + Deleter for **self.__uiZoomInImage** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -502,7 +502,7 @@ def uiZoomInImage(self): @property def graphicsSceneBackgroundColor(self): """ - This method is the property for **self.__graphicsSceneBackgroundColor** attribute. + Property for **self.__graphicsSceneBackgroundColor** attribute. :return: self.__graphicsSceneBackgroundColor. ( QColors ) """ @@ -513,7 +513,7 @@ def graphicsSceneBackgroundColor(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def graphicsSceneBackgroundColor(self, value): """ - This method is the setter method for **self.__graphicsSceneBackgroundColor** attribute. + Setter for **self.__graphicsSceneBackgroundColor** attribute. :param value: Attribute value. ( QColors ) """ @@ -525,7 +525,7 @@ def graphicsSceneBackgroundColor(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def graphicsSceneBackgroundColor(self): """ - This method is the deleter method for **self.__graphicsSceneBackgroundColor** attribute. + Deleter for **self.__graphicsSceneBackgroundColor** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -534,7 +534,7 @@ def graphicsSceneBackgroundColor(self): @property def graphicsSceneWidth(self): """ - This method is the property for **self.__graphicsSceneWidth** attribute. + Property for **self.__graphicsSceneWidth** attribute. :return: self.__graphicsSceneWidth. ( Integer ) """ @@ -545,7 +545,7 @@ def graphicsSceneWidth(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def graphicsSceneWidth(self, value): """ - This method is the setter method for **self.__graphicsSceneWidth** attribute. + Setter for **self.__graphicsSceneWidth** attribute. :param value: Attribute value. ( Integer ) """ @@ -557,7 +557,7 @@ def graphicsSceneWidth(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def graphicsSceneWidth(self): """ - This method is the deleter method for **self.__graphicsSceneWidth** attribute. + Deleter for **self.__graphicsSceneWidth** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -566,7 +566,7 @@ def graphicsSceneWidth(self): @property def graphicsSceneHeight(self): """ - This method is the property for **self.__graphicsSceneHeight** attribute. + Property for **self.__graphicsSceneHeight** attribute. :return: self.__graphicsSceneHeight. ( Object ) """ @@ -577,7 +577,7 @@ def graphicsSceneHeight(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def graphicsSceneHeight(self, value): """ - This method is the setter method for **self.__graphicsSceneHeight** attribute. + Setter for **self.__graphicsSceneHeight** attribute. :param value: Attribute value. ( Object ) """ @@ -589,7 +589,7 @@ def graphicsSceneHeight(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def graphicsSceneHeight(self): """ - This method is the deleter method for **self.__graphicsSceneHeight** attribute. + Deleter for **self.__graphicsSceneHeight** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -598,7 +598,7 @@ def graphicsSceneHeight(self): @property def minimumZoomFactor(self): """ - This method is the property for **self.__minimumZoomFactor** attribute. + Property for **self.__minimumZoomFactor** attribute. :return: self.__minimumZoomFactor. ( Float ) """ @@ -609,7 +609,7 @@ def minimumZoomFactor(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def minimumZoomFactor(self, value): """ - This method is the setter method for **self.__minimumZoomFactor** attribute. + Setter for **self.__minimumZoomFactor** attribute. :param value: Attribute value. ( Float ) """ @@ -621,7 +621,7 @@ def minimumZoomFactor(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def minimumZoomFactor(self): """ - This method is the deleter method for **self.__minimumZoomFactor** attribute. + Deleter for **self.__minimumZoomFactor** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -630,7 +630,7 @@ def minimumZoomFactor(self): @property def maximumZoomFactor(self): """ - This method is the property for **self.__maximumZoomFactor** attribute. + Property for **self.__maximumZoomFactor** attribute. :return: self.__maximumZoomFactor. ( Float ) """ @@ -641,7 +641,7 @@ def maximumZoomFactor(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def maximumZoomFactor(self, value): """ - This method is the setter method for **self.__maximumZoomFactor** attribute. + Setter for **self.__maximumZoomFactor** attribute. :param value: Attribute value. ( Float ) """ @@ -653,7 +653,7 @@ def maximumZoomFactor(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def maximumZoomFactor(self): """ - This method is the deleter method for **self.__maximumZoomFactor** attribute. + Deleter for **self.__maximumZoomFactor** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -662,7 +662,7 @@ def maximumZoomFactor(self): @property def wheelZoomFactor(self): """ - This method is the property for **self.__wheelZoomFactor** attribute. + Property for **self.__wheelZoomFactor** attribute. :return: self.__wheelZoomFactor. ( Float ) """ @@ -673,7 +673,7 @@ def wheelZoomFactor(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def wheelZoomFactor(self, value): """ - This method is the setter method for **self.__wheelZoomFactor** attribute. + Setter for **self.__wheelZoomFactor** attribute. :param value: Attribute value. ( Float ) """ @@ -685,7 +685,7 @@ def wheelZoomFactor(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def wheelZoomFactor(self): """ - This method is the deleter method for **self.__wheelZoomFactor** attribute. + Deleter for **self.__wheelZoomFactor** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -694,7 +694,7 @@ def wheelZoomFactor(self): @property def keyZoomFactor(self): """ - This method is the property for **self.__keyZoomFactor** attribute. + Property for **self.__keyZoomFactor** attribute. :return: self.__keyZoomFactor. ( Float ) """ @@ -705,7 +705,7 @@ def keyZoomFactor(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def keyZoomFactor(self, value): """ - This method is the setter method for **self.__keyZoomFactor** attribute. + Setter for **self.__keyZoomFactor** attribute. :param value: Attribute value. ( Float ) """ @@ -717,7 +717,7 @@ def keyZoomFactor(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def keyZoomFactor(self): """ - This method is the deleter method for **self.__keyZoomFactor** attribute. + Deleter for **self.__keyZoomFactor** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -726,7 +726,7 @@ def keyZoomFactor(self): @property def graphicsView(self): """ - This method is the property for **self.__graphicsView** attribute. + Property for **self.__graphicsView** attribute. :return: self.__graphicsView. ( QGraphicsView ) """ @@ -737,7 +737,7 @@ def graphicsView(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def graphicsView(self, value): """ - This method is the setter method for **self.__graphicsView** attribute. + Setter for **self.__graphicsView** attribute. :param value: Attribute value. ( QGraphicsView ) """ @@ -749,7 +749,7 @@ def graphicsView(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def graphicsView(self): """ - This method is the deleter method for **self.__graphicsView** attribute. + Deleter for **self.__graphicsView** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -758,7 +758,7 @@ def graphicsView(self): @property def graphicsScene(self): """ - This method is the property for **self.__graphicsScene** attribute. + Property for **self.__graphicsScene** attribute. :return: self.__graphicsScene. ( QGraphicsScene ) """ @@ -769,7 +769,7 @@ def graphicsScene(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def graphicsScene(self, value): """ - This method is the setter method for **self.__graphicsScene** attribute. + Setter for **self.__graphicsScene** attribute. :param value: Attribute value. ( QGraphicsScene ) """ @@ -781,7 +781,7 @@ def graphicsScene(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def graphicsScene(self): """ - This method is the deleter method for **self.__graphicsScene** attribute. + Deleter for **self.__graphicsScene** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -790,7 +790,7 @@ def graphicsScene(self): @property def displayGraphicsItem(self): """ - This method is the property for **self.__displayGraphicsItem** attribute. + Property for **self.__displayGraphicsItem** attribute. :return: self.__displayGraphicsItem. ( QGraphicsItem ) """ @@ -801,7 +801,7 @@ def displayGraphicsItem(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def displayGraphicsItem(self, value): """ - This method is the setter method for **self.__displayGraphicsItem** attribute. + Setter for **self.__displayGraphicsItem** attribute. :param value: Attribute value. ( QGraphicsItem ) """ @@ -813,7 +813,7 @@ def displayGraphicsItem(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def displayGraphicsItem(self): """ - This method is the deleter method for **self.__displayGraphicsItem** attribute. + Deleter for **self.__displayGraphicsItem** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -824,7 +824,7 @@ def displayGraphicsItem(self): #****************************************************************************************************************** def show(self): """ - This method reimplements the :meth:`QWidget.show` method. + Reimplements the :meth:`QWidget.show` method. """ super(ImagesPreviewer, self).show() @@ -833,7 +833,7 @@ def show(self): def closeEvent(self, event): """ - This method reimplements the :meth:`QWidget.closeEvent` method. + Reimplements the :meth:`QWidget.closeEvent` method. :param event: QEvent ( QEvent ) """ @@ -845,7 +845,7 @@ def closeEvent(self, event): def wheelEvent(self, event): """ - This method reimplements the :meth:`QWidget.wheelEvent` method. + Reimplements the :meth:`QWidget.wheelEvent` method. :param event: QEvent ( QEvent ) """ @@ -854,7 +854,7 @@ def wheelEvent(self, event): def keyPressEvent(self, event): """ - This method reimplements the :meth:`QWidget.keyPressEvent` method. + Reimplements the :meth:`QWidget.keyPressEvent` method. :param event: QEvent ( QEvent ) """ @@ -869,7 +869,7 @@ def keyPressEvent(self, event): def __initializeUi(self): """ - This method initializes the Widget ui. + Initializes the Widget ui. """ LOGGER.debug("> Initializing '{0}' ui.".format(self.__class__.__name__)) @@ -912,7 +912,7 @@ def __initializeUi(self): def __Images_Informations_label_setUi(self): """ - This method sets the **Images_Informations_label** Widget ui. + Sets the **Images_Informations_label** Widget ui. """ if not self.__displayGraphicsItem: @@ -926,7 +926,7 @@ def __Images_Informations_label_setUi(self): def __engine_imagesCaches_QImage__contentAdded(self, content): """ - This method is triggered by the Application **QImage** images cache when content has been added. + Defines the slot triggered by Application **QImage** images cache when content has been added. :param content: Cache added content. ( List ) """ @@ -943,7 +943,7 @@ def __engine_imagesCaches_QImage__contentAdded(self, content): def __Previous_Image_pushButton__clicked(self, checked): """ - This method is triggered when **Previous_Image_pushButton** Widget is clicked. + Defines the slot triggered by **Previous_Image_pushButton** Widget when clicked. :param checked: Checked state. ( Boolean ) """ @@ -952,7 +952,7 @@ def __Previous_Image_pushButton__clicked(self, checked): def __Next_Image_pushButton__clicked(self, checked): """ - This method is triggered when **Next_Image_pushButton** Widget is clicked. + Defines the slot triggered by **Next_Image_pushButton** Widget when clicked. :param checked: Checked state. ( Boolean ) """ @@ -961,7 +961,7 @@ def __Next_Image_pushButton__clicked(self, checked): def __Zoom_In_pushButton__clicked(self, checked): """ - This method is triggered when **Zoom_In_pushButton** Widget is clicked. + Defines the slot triggered by **Zoom_In_pushButton** Widget when clicked. :param checked: Checked state. ( Boolean ) """ @@ -970,7 +970,7 @@ def __Zoom_In_pushButton__clicked(self, checked): def __Zoom_Out_pushButton__clicked(self, checked): """ - This method is triggered when **Zoom_Out_pushButton** Widget is clicked. + Defines the slot triggered by **Zoom_Out_pushButton** Widget when clicked. :param checked: Checked state. ( Boolean ) """ @@ -979,7 +979,7 @@ def __Zoom_Out_pushButton__clicked(self, checked): def __Zoom_Fit_pushButton__clicked(self, checked): """ - This method is triggered when **Zoom_Fit_pushButton** Widget is clicked. + Defines the slot triggered by **Zoom_Fit_pushButton** Widget when clicked. :param checked: Checked state. ( Boolean ) """ @@ -988,7 +988,7 @@ def __Zoom_Fit_pushButton__clicked(self, checked): def __clearGraphicsScene(self): """ - This method clears the View. + Clears the View. """ for graphicsItem in self.__graphicsScene.items(): @@ -996,7 +996,7 @@ def __clearGraphicsScene(self): def __setDisplayGraphicsItem(self, image): """ - This method sets the View using given image. + Sets the View using given image. :param image: Image to display. ( Qimage ) """ @@ -1011,7 +1011,7 @@ def __setDisplayGraphicsItem(self, image): def loadImage(self, index=0): """ - This method loads the display image in the View. + Loads the display image in the View. :param index: Index to load. ( Integer ) :return: Method success. ( Boolean ) @@ -1027,7 +1027,7 @@ def loadImage(self, index=0): def scaleView(self, scaleFactor): """ - This method scales the Previewer view. + Scales the Previewer view. :param scaleFactor: Float ( Float ) :return: Method success. ( Boolean ) @@ -1043,7 +1043,7 @@ def scaleView(self, scaleFactor): def fitWindow(self): """ - This method fits the View window. + Fits the View window. :return: Method success. ( Boolean ) """ @@ -1063,7 +1063,7 @@ def fitWindow(self): def fitImage(self): """ - This method fits the image to the View. + Fits the image to the View. :return: Method success. ( Boolean ) """ @@ -1081,7 +1081,7 @@ def fitImage(self): def loopThroughImages(self, backward=False): """ - This method loops through View images. + Loops through View images. :param backward: Looping backward. ( Boolean ) :return: Method success. ( Boolean ) diff --git a/sibl_gui/components/addons/preview/preview.py b/sibl_gui/components/addons/preview/preview.py index a5235a7c..c9761b53 100644 --- a/sibl_gui/components/addons/preview/preview.py +++ b/sibl_gui/components/addons/preview/preview.py @@ -77,7 +77,7 @@ class Preview(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): def __init__(self, parent=None, name=None, *args, **kwargs): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param name: Component name. ( String ) @@ -128,7 +128,7 @@ def __init__(self, parent=None, name=None, *args, **kwargs): @property def uiResourcesDirectory(self): """ - This method is the property for **self.__uiResourcesDirectory** attribute. + Property for **self.__uiResourcesDirectory** attribute. :return: self.__uiResourcesDirectory. ( String ) """ @@ -139,7 +139,7 @@ def uiResourcesDirectory(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiResourcesDirectory(self, value): """ - This method is the setter method for **self.__uiResourcesDirectory** attribute. + Setter for **self.__uiResourcesDirectory** attribute. :param value: Attribute value. ( String ) """ @@ -151,7 +151,7 @@ def uiResourcesDirectory(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiResourcesDirectory(self): """ - This method is the deleter method for **self.__uiResourcesDirectory** attribute. + Deleter for **self.__uiResourcesDirectory** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -160,7 +160,7 @@ def uiResourcesDirectory(self): @property def engine(self): """ - This method is the property for **self.__engine** attribute. + Property for **self.__engine** attribute. :return: self.__engine. ( QObject ) """ @@ -171,7 +171,7 @@ def engine(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self, value): """ - This method is the setter method for **self.__engine** attribute. + Setter for **self.__engine** attribute. :param value: Attribute value. ( QObject ) """ @@ -183,7 +183,7 @@ def engine(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self): """ - This method is the deleter method for **self.__engine** attribute. + Deleter for **self.__engine** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -192,7 +192,7 @@ def engine(self): @property def settings(self): """ - This method is the property for **self.__settings** attribute. + Property for **self.__settings** attribute. :return: self.__settings. ( QSettings ) """ @@ -203,7 +203,7 @@ def settings(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settings(self, value): """ - This method is the setter method for **self.__settings** attribute. + Setter for **self.__settings** attribute. :param value: Attribute value. ( QSettings ) """ @@ -215,7 +215,7 @@ def settings(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settings(self): """ - This method is the deleter method for **self.__settings** attribute. + Deleter for **self.__settings** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -224,7 +224,7 @@ def settings(self): @property def settingsSection(self): """ - This method is the property for **self.__settingsSection** attribute. + Property for **self.__settingsSection** attribute. :return: self.__settingsSection. ( String ) """ @@ -235,7 +235,7 @@ def settingsSection(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settingsSection(self, value): """ - This method is the setter method for **self.__settingsSection** attribute. + Setter for **self.__settingsSection** attribute. :param value: Attribute value. ( String ) """ @@ -247,7 +247,7 @@ def settingsSection(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settingsSection(self): """ - This method is the deleter method for **self.__settingsSection** attribute. + Deleter for **self.__settingsSection** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -256,7 +256,7 @@ def settingsSection(self): @property def preferencesManager(self): """ - This method is the property for **self.__preferencesManager** attribute. + Property for **self.__preferencesManager** attribute. :return: self.__preferencesManager. ( QWidget ) """ @@ -267,7 +267,7 @@ def preferencesManager(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def preferencesManager(self, value): """ - This method is the setter method for **self.__preferencesManager** attribute. + Setter for **self.__preferencesManager** attribute. :param value: Attribute value. ( QWidget ) """ @@ -279,7 +279,7 @@ def preferencesManager(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def preferencesManager(self): """ - This method is the deleter method for **self.__preferencesManager** attribute. + Deleter for **self.__preferencesManager** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -288,7 +288,7 @@ def preferencesManager(self): @property def iblSetsOutliner(self): """ - This method is the property for **self.__iblSetsOutliner** attribute. + Property for **self.__iblSetsOutliner** attribute. :return: self.__iblSetsOutliner. ( QWidget ) """ @@ -299,7 +299,7 @@ def iblSetsOutliner(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iblSetsOutliner(self, value): """ - This method is the setter method for **self.__iblSetsOutliner** attribute. + Setter for **self.__iblSetsOutliner** attribute. :param value: Attribute value. ( QWidget ) """ @@ -311,7 +311,7 @@ def iblSetsOutliner(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iblSetsOutliner(self): """ - This method is the deleter method for **self.__iblSetsOutliner** attribute. + Deleter for **self.__iblSetsOutliner** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -320,7 +320,7 @@ def iblSetsOutliner(self): @property def inspector(self): """ - This method is the property for **self.__inspector** attribute. + Property for **self.__inspector** attribute. :return: self.__inspector. ( QWidget ) """ @@ -331,7 +331,7 @@ def inspector(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def inspector(self, value): """ - This method is the setter method for **self.__inspector** attribute. + Setter for **self.__inspector** attribute. :param value: Attribute value. ( QWidget ) """ @@ -343,7 +343,7 @@ def inspector(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def inspector(self): """ - This method is the deleter method for **self.__inspector** attribute. + Deleter for **self.__inspector** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -352,7 +352,7 @@ def inspector(self): @property def imagesPreviewers(self): """ - This method is the property for **self.__imagesPreviewers** attribute. + Property for **self.__imagesPreviewers** attribute. :return: self.__imagesPreviewers. ( List ) """ @@ -363,7 +363,7 @@ def imagesPreviewers(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def imagesPreviewers(self, value): """ - This method is the setter method for **self.__imagesPreviewers** attribute. + Setter for **self.__imagesPreviewers** attribute. :param value: Attribute value. ( List ) """ @@ -375,7 +375,7 @@ def imagesPreviewers(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def imagesPreviewers(self): """ - This method is the deleter method for **self.__imagesPreviewers** attribute. + Deleter for **self.__imagesPreviewers** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -384,7 +384,7 @@ def imagesPreviewers(self): @property def maximumImagesPreviewersInstances(self): """ - This method is the property for **self.__maximumImagesPreviewersInstances** attribute. + Property for **self.__maximumImagesPreviewersInstances** attribute. :return: self.__maximumImagesPreviewersInstances. ( Integer ) """ @@ -395,7 +395,7 @@ def maximumImagesPreviewersInstances(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def maximumImagesPreviewersInstances(self, value): """ - This method is the setter method for **self.__maximumImagesPreviewersInstances** attribute. + Setter for **self.__maximumImagesPreviewersInstances** attribute. :param value: Attribute value. ( Integer ) """ @@ -407,7 +407,7 @@ def maximumImagesPreviewersInstances(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def maximumImagesPreviewersInstances(self): """ - This method is the deleter method for **self.__maximumImagesPreviewersInstances** attribute. + Deleter for **self.__maximumImagesPreviewersInstances** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -416,7 +416,7 @@ def maximumImagesPreviewersInstances(self): @property def inspectorButtons(self): """ - This method is the property for **self.__inspectorButtons** attribute. + Property for **self.__inspectorButtons** attribute. :return: self.__inspectorButtons. ( Dictionary ) """ @@ -427,7 +427,7 @@ def inspectorButtons(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def inspectorButtons(self, value): """ - This method is the setter method for **self.__inspectorButtons** attribute. + Setter for **self.__inspectorButtons** attribute. :param value: Attribute value. ( Dictionary ) """ @@ -439,7 +439,7 @@ def inspectorButtons(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def inspectorButtons(self): """ - This method is the deleter method for **self.__inspectorButtons** attribute. + Deleter for **self.__inspectorButtons** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -450,7 +450,7 @@ def inspectorButtons(self): #****************************************************************************************************************** def activate(self, engine): """ - This method activates the Component. + Activates the Component. :param engine: Engine to attach the Component to. ( QObject ) :return: Method success. ( Boolean ) @@ -474,7 +474,7 @@ def activate(self, engine): def deactivate(self): """ - This method deactivates the Component. + Deactivates the Component. :return: Method success. ( Boolean ) """ @@ -498,7 +498,7 @@ def deactivate(self): def initializeUi(self): """ - This method initializes the Component ui. + Initializes the Component ui. :return: Method success. ( Boolean ) """ @@ -519,7 +519,7 @@ def initializeUi(self): def uninitializeUi(self): """ - This method uninitializes the Component ui. + Uninitializes the Component ui. :return: Method success. ( Boolean ) """ @@ -538,7 +538,7 @@ def uninitializeUi(self): def addWidget(self): """ - This method adds the Component Widget to the engine. + Adds the Component Widget to the engine. :return: Method success. ( Boolean ) """ @@ -551,7 +551,7 @@ def addWidget(self): def removeWidget(self): """ - This method removes the Component Widget from the engine. + Removes the Component Widget from the engine. :return: Method success. ( Boolean ) """ @@ -565,7 +565,7 @@ def removeWidget(self): def __addActions(self): """ - This method sets Component actions. + Sets Component actions. """ LOGGER.debug("> Adding '{0}' Component actions.".format(self.__class__.__name__)) @@ -612,7 +612,7 @@ def __addActions(self): def __removeActions(self): """ - This method removes actions. + Removes actions. """ LOGGER.debug("> Removing '{0}' Component actions.".format(self.__class__.__name__)) @@ -645,7 +645,7 @@ def __removeActions(self): def __addInspectorButtons(self): """ - This method adds buttons to the :mod:`sibl_gui.components.core.inspector.inspector` Component. + Adds buttons to the :mod:`sibl_gui.components.core.inspector.inspector` Component. """ self.__inspector.Inspector_Options_groupBox.show() @@ -658,7 +658,7 @@ def __addInspectorButtons(self): def __removeInspectorButtons(self): """ - This method removes buttons from the :mod:`sibl_gui.components.core.inspector.inspector` Component. + Removes buttons from the :mod:`sibl_gui.components.core.inspector.inspector` Component. """ for value in self.__inspectorButtons.itervalues(): @@ -666,7 +666,7 @@ def __removeInspectorButtons(self): def __iblSetsOutliner_views_viewIblSetsBackgroundImagesAction__triggered(self, checked): """ - This method is triggered by **'Actions|Umbra|Components|core.iblSetsOutliner|View Background Image ...'** action. + Defines the slot triggered by **'Actions|Umbra|Components|core.iblSetsOutliner|View Background Image ...'** action. :param checked: Action checked state. ( Boolean ) :return: Method success. ( Boolean ) @@ -676,7 +676,7 @@ def __iblSetsOutliner_views_viewIblSetsBackgroundImagesAction__triggered(self, c def __iblSetsOutliner_views_viewIblSetsLightingImagesAction__triggered(self, checked): """ - This method is triggered by **'Actions|Umbra|Components|core.iblSetsOutliner|View Lighting Image ...'** action. + Defines the slot triggered by **'Actions|Umbra|Components|core.iblSetsOutliner|View Lighting Image ...'** action. :param checked: Action checked state. ( Boolean ) :return: Method success. ( Boolean ) @@ -686,7 +686,7 @@ def __iblSetsOutliner_views_viewIblSetsLightingImagesAction__triggered(self, che def __iblSetsOutliner_views_viewIblSetsReflectionImagesAction__triggered(self, checked): """ - This method is triggered by **'Actions|Umbra|Components|core.iblSetsOutliner|View Reflection Image ...'** action. + Defines the slot triggered by **'Actions|Umbra|Components|core.iblSetsOutliner|View Reflection Image ...'** action. :param checked: Action checked state. ( Boolean ) :return: Method success. ( Boolean ) @@ -696,7 +696,7 @@ def __iblSetsOutliner_views_viewIblSetsReflectionImagesAction__triggered(self, c def __iblSetsOutliner_views_viewIblSetsPlatesAction__triggered(self, checked): """ - This method is triggered by **'Actions|Umbra|Components|core.iblSetsOutliner|View Plate(s) ...'** action. + Defines the slot triggered by **'Actions|Umbra|Components|core.iblSetsOutliner|View Plate(s) ...'** action. :param checked: Action checked state. ( Boolean ) :return: Method success. ( Boolean ) @@ -706,7 +706,7 @@ def __iblSetsOutliner_views_viewIblSetsPlatesAction__triggered(self, checked): def __Inspector_Overall_frame_viewActiveIblSetBackgroundImageAction__triggered(self, checked): """ - This method is triggered by **'Actions|Umbra|Components|core.inspector|View Background Image ...'** action. + Defines the slot triggered by **'Actions|Umbra|Components|core.inspector|View Background Image ...'** action. :param checked: Action checked state. ( Boolean ) :return: Method success. ( Boolean ) @@ -716,7 +716,7 @@ def __Inspector_Overall_frame_viewActiveIblSetBackgroundImageAction__triggered(s def __Inspector_Overall_frame_viewActiveIblSetLightingImageAction__triggered(self, checked): """ - This method is triggered by **'Actions|Umbra|Components|core.inspector|View Lighting Image ...'** action. + Defines the slot triggered by **'Actions|Umbra|Components|core.inspector|View Lighting Image ...'** action. :param checked: Action checked state. ( Boolean ) :return: Method success. ( Boolean ) @@ -726,7 +726,7 @@ def __Inspector_Overall_frame_viewActiveIblSetLightingImageAction__triggered(sel def __Inspector_Overall_frame_viewActiveIblSetReflectionImageAction__triggered(self, checked): """ - This method is triggered by **'"Actions|Umbra|Components|core.inspector|View Reflection Image ...'** action. + Defines the slot triggered by **'"Actions|Umbra|Components|core.inspector|View Reflection Image ...'** action. :param checked: Action checked state. ( Boolean ) :return: Method success. ( Boolean ) @@ -736,7 +736,7 @@ def __Inspector_Overall_frame_viewActiveIblSetReflectionImageAction__triggered(s def __Inspector_Overall_frame_viewActiveIblSetPlatesAction__triggered(self, checked): """ - This method is triggered by **'Actions|Umbra|Components|core.inspector|View Plate(s) ...'** action. + Defines the slot triggered by **'Actions|Umbra|Components|core.inspector|View Plate(s) ...'** action. :param checked: Action checked state. ( Boolean ) :return: Method success. ( Boolean ) @@ -746,7 +746,7 @@ def __Inspector_Overall_frame_viewActiveIblSetPlatesAction__triggered(self, chec def __Custom_Previewer_Path_lineEdit_setUi(self): """ - This method fills **Custom_Previewer_Path_lineEdit** Widget. + Fills **Custom_Previewer_Path_lineEdit** Widget. """ customPreviewer = self.__settings.getKey(self.__settingsSection, "customPreviewer") @@ -756,7 +756,7 @@ def __Custom_Previewer_Path_lineEdit_setUi(self): def __Custom_Previewer_Path_toolButton__clicked(self, checked): """ - This method is triggered when **Custom_Previewer_Path_toolButton** Widget is clicked. + Defines the slot triggered by **Custom_Previewer_Path_toolButton** Widget when clicked. :param checked: Checked state. ( Boolean ) """ @@ -774,7 +774,7 @@ def __Custom_Previewer_Path_toolButton__clicked(self, checked): foundations.exceptions.UserError) def __Custom_Previewer_Path_lineEdit__editFinished(self): """ - This method is triggered when **Custom_Previewer_Path_lineEdit** Widget is edited and check that entered path is valid. + Defines the slot triggered by **Custom_Previewer_Path_lineEdit** Widget when edited and check that entered path is valid. """ value = foundations.strings.toString(self.Custom_Previewer_Path_lineEdit.text()) @@ -789,7 +789,7 @@ def __Custom_Previewer_Path_lineEdit__editFinished(self): def __hasMaximumImagesPreviewersInstances(self): """ - This method returns if the maximum Previewers instances allowed is reached. + Returns if the maximum Previewers instances allowed is reached. :return: Maximum instances reached. ( Boolean ) """ @@ -805,7 +805,7 @@ def __hasMaximumImagesPreviewersInstances(self): @foundations.exceptions.handleExceptions(umbra.exceptions.notifyExceptionHandler, Exception) def viewIblSetsImagesUi(self, imageType, *args): """ - This method launches selected Ibl Sets Images Previewer. + Launches selected Ibl Sets Images Previewer. :param imageType: Image type. ( String ) :param \*args: Arguments. ( \* ) @@ -840,7 +840,7 @@ def viewIblSetsImagesUi(self, imageType, *args): Exception) def viewActiveIblSetImagesUi(self, imageType, *args): """ - This method launches :mod:`sibl_gui.components.core.inspector.inspector` Component Ibl Set Images Previewer. + Launches :mod:`sibl_gui.components.core.inspector.inspector` Component Ibl Set Images Previewer. :param imageType: Image type. ( String ) :param \*args: Arguments. ( \* ) @@ -878,7 +878,7 @@ def viewActiveIblSetImagesUi(self, imageType, *args): @foundations.exceptions.handleExceptions(umbra.exceptions.notifyExceptionHandler, Exception) def viewImages(self, paths, customPreviewer=None): """ - This method launches an Ibl Set Images Previewer. + Launches an Ibl Set Images Previewer. :param paths: Image paths. ( List ) :param customPreviewer: Custom previewer. ( String ) @@ -905,7 +905,7 @@ def viewImages(self, paths, customPreviewer=None): def addImagesPreviewer(self, imagesPreviewer): """ - This method adds an Images Previewer. + Adds an Images Previewer. :param imagesPreviewer: Images Previewer. ( ImagesPreviewer ) :return: Method success. ( Boolean ) @@ -918,7 +918,7 @@ def addImagesPreviewer(self, imagesPreviewer): def removeImagesPreviewer(self, imagesPreviewer): """ - This method removes an Images Previewer. + Removes an Images Previewer. :param imagesPreviewer: Images Previewer. ( ImagesPreviewer ) """ @@ -932,7 +932,7 @@ def removeImagesPreviewer(self, imagesPreviewer): @umbra.engine.showProcessing("Reading Images...") def getImagesPreviewer(self, paths): """ - This method launches an Images Previewer. + Launches an Images Previewer. :param paths: Images paths. ( List ) :return: Method success. ( Boolean ) @@ -946,7 +946,7 @@ def getImagesPreviewer(self, paths): def getProcessCommand(self, paths, customPreviewer): """ - This method gets process command. + Gets process command. :param paths: Paths to preview. ( String ) :param customPreviewer: Custom browser. ( String ) @@ -965,7 +965,7 @@ def getProcessCommand(self, paths, customPreviewer): def getIblSetImagesPaths(self, iblSet, imageType): """ - This method gets Ibl Set images paths. + Gets Ibl Set images paths. :param iblSet: Ibl Set. ( IblSet ) :param imageType: Image type. ( String ) diff --git a/sibl_gui/components/addons/rawEditingUtilities/rawEditingUtilities.py b/sibl_gui/components/addons/rawEditingUtilities/rawEditingUtilities.py index 13c0ed10..1f05fc2f 100644 --- a/sibl_gui/components/addons/rawEditingUtilities/rawEditingUtilities.py +++ b/sibl_gui/components/addons/rawEditingUtilities/rawEditingUtilities.py @@ -73,7 +73,7 @@ class RawEditingUtilities(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): def __init__(self, parent=None, name=None, *args, **kwargs): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param name: Component name. ( String ) @@ -105,7 +105,7 @@ def __init__(self, parent=None, name=None, *args, **kwargs): @property def engine(self): """ - This method is the property for **self.__engine** attribute. + Property for **self.__engine** attribute. :return: self.__engine. ( QObject ) """ @@ -116,7 +116,7 @@ def engine(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self, value): """ - This method is the setter method for **self.__engine** attribute. + Setter for **self.__engine** attribute. :param value: Attribute value. ( QObject ) """ @@ -128,7 +128,7 @@ def engine(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self): """ - This method is the deleter method for **self.__engine** attribute. + Deleter for **self.__engine** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -137,7 +137,7 @@ def engine(self): @property def settings(self): """ - This method is the property for **self.__settings** attribute. + Property for **self.__settings** attribute. :return: self.__settings. ( QSettings ) """ @@ -148,7 +148,7 @@ def settings(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settings(self, value): """ - This method is the setter method for **self.__settings** attribute. + Setter for **self.__settings** attribute. :param value: Attribute value. ( QSettings ) """ @@ -160,7 +160,7 @@ def settings(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settings(self): """ - This method is the deleter method for **self.__settings** attribute. + Deleter for **self.__settings** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -169,7 +169,7 @@ def settings(self): @property def settingsSection(self): """ - This method is the property for **self.__settingsSection** attribute. + Property for **self.__settingsSection** attribute. :return: self.__settingsSection. ( String ) """ @@ -180,7 +180,7 @@ def settingsSection(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settingsSection(self, value): """ - This method is the setter method for **self.__settingsSection** attribute. + Setter for **self.__settingsSection** attribute. :param value: Attribute value. ( String ) """ @@ -192,7 +192,7 @@ def settingsSection(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settingsSection(self): """ - This method is the deleter method for **self.__settingsSection** attribute. + Deleter for **self.__settingsSection** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -201,7 +201,7 @@ def settingsSection(self): @property def scriptEditor(self): """ - This method is the property for **self.__scriptEditor** attribute. + Property for **self.__scriptEditor** attribute. :return: self.__scriptEditor. ( QWidget ) """ @@ -212,7 +212,7 @@ def scriptEditor(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def scriptEditor(self, value): """ - This method is the setter method for **self.__scriptEditor** attribute. + Setter for **self.__scriptEditor** attribute. :param value: Attribute value. ( QWidget ) """ @@ -224,7 +224,7 @@ def scriptEditor(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def scriptEditor(self): """ - This method is the deleter method for **self.__scriptEditor** attribute. + Deleter for **self.__scriptEditor** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -233,7 +233,7 @@ def scriptEditor(self): @property def preferencesManager(self): """ - This method is the property for **self.__preferencesManager** attribute. + Property for **self.__preferencesManager** attribute. :return: self.__preferencesManager. ( QWidget ) """ @@ -244,7 +244,7 @@ def preferencesManager(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def preferencesManager(self, value): """ - This method is the setter method for **self.__preferencesManager** attribute. + Setter for **self.__preferencesManager** attribute. :param value: Attribute value. ( QWidget ) """ @@ -256,7 +256,7 @@ def preferencesManager(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def preferencesManager(self): """ - This method is the deleter method for **self.__preferencesManager** attribute. + Deleter for **self.__preferencesManager** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -265,7 +265,7 @@ def preferencesManager(self): @property def componentsManagerUi(self): """ - This method is the property for **self.__componentsManagerUi** attribute. + Property for **self.__componentsManagerUi** attribute. :return: self.__componentsManagerUi. ( QWidget ) """ @@ -276,7 +276,7 @@ def componentsManagerUi(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def componentsManagerUi(self, value): """ - This method is the setter method for **self.__componentsManagerUi** attribute. + Setter for **self.__componentsManagerUi** attribute. :param value: Attribute value. ( QWidget ) """ @@ -288,7 +288,7 @@ def componentsManagerUi(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def componentsManagerUi(self): """ - This method is the deleter method for **self.__componentsManagerUi** attribute. + Deleter for **self.__componentsManagerUi** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -297,7 +297,7 @@ def componentsManagerUi(self): @property def iblSetsOutliner(self): """ - This method is the property for **self.__iblSetsOutliner** attribute. + Property for **self.__iblSetsOutliner** attribute. :return: self.__iblSetsOutliner. ( QWidget ) """ @@ -308,7 +308,7 @@ def iblSetsOutliner(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iblSetsOutliner(self, value): """ - This method is the setter method for **self.__iblSetsOutliner** attribute. + Setter for **self.__iblSetsOutliner** attribute. :param value: Attribute value. ( QWidget ) """ @@ -320,7 +320,7 @@ def iblSetsOutliner(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iblSetsOutliner(self): """ - This method is the deleter method for **self.__iblSetsOutliner** attribute. + Deleter for **self.__iblSetsOutliner** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -329,7 +329,7 @@ def iblSetsOutliner(self): @property def inspector(self): """ - This method is the property for **self.__inspector** attribute. + Property for **self.__inspector** attribute. :return: self.__inspector. ( QWidget ) """ @@ -340,7 +340,7 @@ def inspector(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def inspector(self, value): """ - This method is the setter method for **self.__inspector** attribute. + Setter for **self.__inspector** attribute. :param value: Attribute value. ( QWidget ) """ @@ -352,7 +352,7 @@ def inspector(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def inspector(self): """ - This method is the deleter method for **self.__inspector** attribute. + Deleter for **self.__inspector** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -361,7 +361,7 @@ def inspector(self): @property def templatesOutliner(self): """ - This method is the property for **self.__templatesOutliner** attribute. + Property for **self.__templatesOutliner** attribute. :return: self.__templatesOutliner. ( QWidget ) """ @@ -372,7 +372,7 @@ def templatesOutliner(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templatesOutliner(self, value): """ - This method is the setter method for **self.__templatesOutliner** attribute. + Setter for **self.__templatesOutliner** attribute. :param value: Attribute value. ( QWidget ) """ @@ -384,7 +384,7 @@ def templatesOutliner(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templatesOutliner(self): """ - This method is the deleter method for **self.__templatesOutliner** attribute. + Deleter for **self.__templatesOutliner** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -395,7 +395,7 @@ def templatesOutliner(self): #****************************************************************************************************************** def activate(self, engine): """ - This method activates the Component. + Activates the Component. :param engine: Engine to attach the Component to. ( QObject ) :return: Method success. ( Boolean ) @@ -419,7 +419,7 @@ def activate(self, engine): def deactivate(self): """ - This method deactivates the Component. + Deactivates the Component. :return: Method success. ( Boolean ) """ @@ -442,7 +442,7 @@ def deactivate(self): def initializeUi(self): """ - This method initializes the Component ui. + Initializes the Component ui. :return: Method success. ( Boolean ) """ @@ -465,7 +465,7 @@ def initializeUi(self): def uninitializeUi(self): """ - This method uninitializes the Component ui. + Uninitializes the Component ui. :return: Method success. ( Boolean ) """ @@ -487,7 +487,7 @@ def uninitializeUi(self): def addWidget(self): """ - This method adds the Component Widget to the engine. + Adds the Component Widget to the engine. :return: Method success. ( Boolean ) """ @@ -500,7 +500,7 @@ def addWidget(self): def removeWidget(self): """ - This method removes the Component Widget from the engine. + Removes the Component Widget from the engine. :return: Method success. ( Boolean ) """ @@ -514,7 +514,7 @@ def removeWidget(self): def __addActions(self): """ - This method sets Component actions. + Sets Component actions. """ LOGGER.debug("> Adding '{0}' Component actions.".format(self.__class__.__name__)) @@ -546,7 +546,7 @@ def __addActions(self): def __removeActions(self): """ - This method removes actions. + Removes actions. """ LOGGER.debug("> Removing '{0}' Component actions.".format(self.__class__.__name__)) @@ -571,7 +571,7 @@ def __removeActions(self): def __iblSetsOutliner_views_editIblSetsFilesAction__triggered(self, checked): """ - This method is triggered by + Defines the slot triggered by **'Actions|Umbra|Components|core.iblSetsOutliner|Edit Ibl Set(s) File(s) ...'** action. :param checked: Action checked state. ( Boolean ) @@ -582,7 +582,7 @@ def __iblSetsOutliner_views_editIblSetsFilesAction__triggered(self, checked): def __inspector_editActiveIblSetFileAction__triggered(self, checked): """ - This method is triggered by **'Actions|Umbra|Components|core.inspector|Edit Ibl Set File ...'** action. + Defines the slot triggered by **'Actions|Umbra|Components|core.inspector|Edit Ibl Set File ...'** action. :param checked: Action checked state. ( Boolean ) :return: Method success. ( Boolean ) @@ -592,7 +592,7 @@ def __inspector_editActiveIblSetFileAction__triggered(self, checked): def __templatesOutliner_view_editTemplatesFilesAction__triggered(self, checked): """ - This method is triggered by + Defines the slot triggered by **'Actions|Umbra|Components|core.templatesOutliner|Edit Template(s) File(s) ...'** action. :param checked: Action checked state. ( Boolean ) @@ -603,7 +603,7 @@ def __templatesOutliner_view_editTemplatesFilesAction__triggered(self, checked): def __componentsManagerUi_view_editComponentsAction__triggered(self, checked): """ - This method is triggered by + Defines the slot triggered by **'Actions|Umbra|Components|factory.componentsManagerUi|Edit Component(s) ...'** action. :param checked: Action checked state. ( Boolean ) @@ -614,7 +614,7 @@ def __componentsManagerUi_view_editComponentsAction__triggered(self, checked): def __Custom_Text_Editor_Path_lineEdit_setUi(self): """ - This method fills **Custom_Text_Editor_Path_lineEdit** Widget. + Fills **Custom_Text_Editor_Path_lineEdit** Widget. """ customTextEditor = self.__settings.getKey(self.__settingsSection, "customTextEditor") @@ -624,7 +624,7 @@ def __Custom_Text_Editor_Path_lineEdit_setUi(self): def __Custom_Text_Editor_Path_toolButton__clicked(self, checked): """ - This method is triggered when **Custom_Text_Editor_Path_toolButton** Widget is clicked. + Defines the slot triggered by **Custom_Text_Editor_Path_toolButton** Widget when clicked. :param checked: Checked state. ( Boolean ) """ @@ -642,8 +642,8 @@ def __Custom_Text_Editor_Path_toolButton__clicked(self, checked): foundations.exceptions.UserError) def __Custom_Text_Editor_Path_lineEdit__editFinished(self): """ - This method is triggered when **Custom_Text_Editor_Path_lineEdit** Widget - is edited and check that entered path is valid. + Defines the slot triggered by **Custom_Text_Editor_Path_lineEdit** Widget + when edited and check that entered path is valid. """ value = foundations.strings.toString(self.Custom_Text_Editor_Path_lineEdit.text()) @@ -661,7 +661,7 @@ def __Custom_Text_Editor_Path_lineEdit__editFinished(self): @umbra.engine.encapsulateProcessing def __engine__contentDropped(self, event): """ - This method is triggered when content is dropped into the engine. + Defines the slot triggered by content when dropped into the engine. :param event: Event. ( QEvent ) """ @@ -687,7 +687,7 @@ def __engine__contentDropped(self, event): def __scriptEditor_Script_Editor_tabWidget__contentDropped(self, event): """ - This method is triggered when content is dropped in the **scriptEditor.Script_Editor_tabWidget** Widget. + Defines the slot triggered by content when dropped into the **scriptEditor.Script_Editor_tabWidget** Widget. :param event: Event. ( QEvent ) """ @@ -700,7 +700,7 @@ def __scriptEditor_Script_Editor_tabWidget__contentDropped(self, event): @foundations.exceptions.handleExceptions(umbra.exceptions.notifyExceptionHandler, Exception) def editIblSetsFilesUi(self): """ - This method edits selected Ibl Sets files. + Edits selected Ibl Sets files. :return: Method success. ( Boolean ) @@ -728,7 +728,7 @@ def editIblSetsFilesUi(self): foundations.exceptions.FileExistsError) def editActiveIblSetFileUi(self): """ - This method edits :mod:`sibl_gui.components.core.inspector.inspector` Component Ibl Set file. + Edits :mod:`sibl_gui.components.core.inspector.inspector` Component Ibl Set file. :return: Method success. ( Boolean ) @@ -749,7 +749,7 @@ def editActiveIblSetFileUi(self): @foundations.exceptions.handleExceptions(umbra.exceptions.notifyExceptionHandler, Exception) def editTemplatesFilesUi(self): """ - This method edits selected Templates files. + Edits selected Templates files. :return: Method success. ( Boolean ) @@ -776,7 +776,7 @@ def editTemplatesFilesUi(self): @foundations.exceptions.handleExceptions(umbra.exceptions.notifyExceptionHandler, Exception) def editComponentsUi(self): """ - This method edits selected Components packages. + Edits selected Components packages. :return: Method success. ( Boolean ) @@ -802,7 +802,7 @@ def editComponentsUi(self): def getProcessCommand(self, path, customTextEditor): """ - This method gets process command. + Gets process command. :param path: Path to edit. ( String ) :param customTextEditor: Custom text editor. ( String ) @@ -822,7 +822,7 @@ def getProcessCommand(self, path, customTextEditor): @foundations.exceptions.handleExceptions(umbra.exceptions.notifyExceptionHandler, Exception) def editPath(self, path, customTextEditor=None): """ - This method provides editing capability. + Provides editing capability. :param path: Path to edit. ( String ) :param customTextEditor: Custom text editor. ( String ) diff --git a/sibl_gui/components/addons/rewiringTool/rewiringTool.py b/sibl_gui/components/addons/rewiringTool/rewiringTool.py index 6f54ac77..b2a5d28b 100644 --- a/sibl_gui/components/addons/rewiringTool/rewiringTool.py +++ b/sibl_gui/components/addons/rewiringTool/rewiringTool.py @@ -66,7 +66,7 @@ class RewiringTool(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): def __init__(self, parent=None, name=None, *args, **kwargs): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param name: Component name. ( String ) @@ -104,7 +104,7 @@ def __init__(self, parent=None, name=None, *args, **kwargs): @property def dockArea(self): """ - This method is the property for **self.__dockArea** attribute. + Property for **self.__dockArea** attribute. :return: self.__dockArea. ( Integer ) """ @@ -115,7 +115,7 @@ def dockArea(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def dockArea(self, value): """ - This method is the setter method for **self.__dockArea** attribute. + Setter for **self.__dockArea** attribute. :param value: Attribute value. ( Integer ) """ @@ -127,7 +127,7 @@ def dockArea(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def dockArea(self): """ - This method is the deleter method for **self.__dockArea** attribute. + Deleter for **self.__dockArea** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -136,7 +136,7 @@ def dockArea(self): @property def engine(self): """ - This method is the property for **self.__engine** attribute. + Property for **self.__engine** attribute. :return: self.__engine. ( QObject ) """ @@ -147,7 +147,7 @@ def engine(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self, value): """ - This method is the setter method for **self.__engine** attribute. + Setter for **self.__engine** attribute. :param value: Attribute value. ( QObject ) """ @@ -159,7 +159,7 @@ def engine(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self): """ - This method is the deleter method for **self.__engine** attribute. + Deleter for **self.__engine** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -168,7 +168,7 @@ def engine(self): @property def iblSetsOutliner(self): """ - This method is the property for **self.__iblSetsOutliner** attribute. + Property for **self.__iblSetsOutliner** attribute. :return: self.__iblSetsOutliner. ( QWidget ) """ @@ -179,7 +179,7 @@ def iblSetsOutliner(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iblSetsOutliner(self, value): """ - This method is the setter method for **self.__iblSetsOutliner** attribute. + Setter for **self.__iblSetsOutliner** attribute. :param value: Attribute value. ( QWidget ) """ @@ -191,7 +191,7 @@ def iblSetsOutliner(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iblSetsOutliner(self): """ - This method is the deleter method for **self.__iblSetsOutliner** attribute. + Deleter for **self.__iblSetsOutliner** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -200,7 +200,7 @@ def iblSetsOutliner(self): @property def reWireFramesWidgets(self): """ - This method is the property for **self.__reWireFramesWidgets** attribute. + Property for **self.__reWireFramesWidgets** attribute. :return: self.__reWireFramesWidgets. ( Tuple ) """ @@ -211,7 +211,7 @@ def reWireFramesWidgets(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def reWireFramesWidgets(self, value): """ - This method is the setter method for **self.__reWireFramesWidgets** attribute. + Setter for **self.__reWireFramesWidgets** attribute. :param value: Attribute value. ( Tuple ) """ @@ -223,7 +223,7 @@ def reWireFramesWidgets(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def reWireFramesWidgets(self): """ - This method is the deleter method for **self.__reWireFramesWidgets** attribute. + Deleter for **self.__reWireFramesWidgets** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -232,7 +232,7 @@ def reWireFramesWidgets(self): @property def reWireComboBoxesWidgets(self): """ - This method is the property for **self.__reWireComboBoxesWidgets** attribute. + Property for **self.__reWireComboBoxesWidgets** attribute. :return: self.__reWireComboBoxesWidgets. ( Tuple ) """ @@ -243,7 +243,7 @@ def reWireComboBoxesWidgets(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def reWireComboBoxesWidgets(self, value): """ - This method is the setter method for **self.__reWireComboBoxesWidgets** attribute. + Setter for **self.__reWireComboBoxesWidgets** attribute. :param value: Attribute value. ( Tuple ) """ @@ -255,7 +255,7 @@ def reWireComboBoxesWidgets(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def reWireComboBoxesWidgets(self): """ - This method is the deleter method for **self.__reWireComboBoxesWidgets** attribute. + Deleter for **self.__reWireComboBoxesWidgets** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -264,7 +264,7 @@ def reWireComboBoxesWidgets(self): @property def reWireLineEditWidgets(self): """ - This method is the property for **self.__reWireLineEditWidgets** attribute. + Property for **self.__reWireLineEditWidgets** attribute. :return: self.__reWireLineEditWidgets. ( Tuple ) """ @@ -275,7 +275,7 @@ def reWireLineEditWidgets(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def reWireLineEditWidgets(self, value): """ - This method is the setter method for **self.__reWireLineEditWidgets** attribute. + Setter for **self.__reWireLineEditWidgets** attribute. :param value: Attribute value. ( Tuple ) """ @@ -287,7 +287,7 @@ def reWireLineEditWidgets(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def reWireLineEditWidgets(self): """ - This method is the deleter method for **self.__reWireLineEditWidgets** attribute. + Deleter for **self.__reWireLineEditWidgets** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -296,7 +296,7 @@ def reWireLineEditWidgets(self): @property def rewiringParameters(self): """ - This method is the property for **self.__rewiringParameters** attribute. + Property for **self.__rewiringParameters** attribute. :return: self.__rewiringParameters. ( Tuple ) """ @@ -307,7 +307,7 @@ def rewiringParameters(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def rewiringParameters(self, value): """ - This method is the setter method for **self.__rewiringParameters** attribute. + Setter for **self.__rewiringParameters** attribute. :param value: Attribute value. ( Tuple ) """ @@ -319,7 +319,7 @@ def rewiringParameters(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def rewiringParameters(self): """ - This method is the deleter method for **self.__rewiringParameters** attribute. + Deleter for **self.__rewiringParameters** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -330,7 +330,7 @@ def rewiringParameters(self): #****************************************************************************************************************** def activate(self, engine): """ - This method activates the Component. + Activates the Component. :param engine: Engine to attach the Component to. ( QObject ) :return: Method success. ( Boolean ) @@ -348,7 +348,7 @@ def activate(self, engine): def deactivate(self): """ - This method deactivates the Component. + Deactivates the Component. :return: Method success. ( Boolean ) """ @@ -365,7 +365,7 @@ def deactivate(self): def initializeUi(self): """ - This method initializes the Component ui. + Initializes the Component ui. :return: Method success. ( Boolean ) """ @@ -401,7 +401,7 @@ def initializeUi(self): def uninitializeUi(self): """ - This method uninitializes the Component ui. + Uninitializes the Component ui. :return: Method success. ( Boolean ) """ @@ -425,7 +425,7 @@ def uninitializeUi(self): def addWidget(self): """ - This method adds the Component Widget to the engine. + Adds the Component Widget to the engine. :return: Method success. ( Boolean ) """ @@ -438,7 +438,7 @@ def addWidget(self): def removeWidget(self): """ - This method removes the Component Widget from the engine. + Removes the Component Widget from the engine. :return: Method success. ( Boolean ) """ @@ -452,7 +452,7 @@ def removeWidget(self): def __Background_Path_toolButton__clicked(self, checked): """ - This method is triggered when **Background_ToolButton** Widget is clicked. + Defines the slot triggered by **Background_ToolButton** Widget when clicked. :param checked: Checked state. ( Boolean ) """ @@ -461,7 +461,7 @@ def __Background_Path_toolButton__clicked(self, checked): def __Lighting_Path_toolButton__clicked(self, checked): """ - This method is triggered when **Lighting_ToolButton** Widget is clicked. + Defines the slot triggered by **Lighting_ToolButton** Widget when clicked. :param checked: Checked state. ( Boolean ) """ @@ -470,7 +470,7 @@ def __Lighting_Path_toolButton__clicked(self, checked): def __Reflection_Path_toolButton__clicked(self, checked): """ - This method is triggered when **Reflection_ToolButton** Widget is clicked. + Defines the slot triggered by **Reflection_ToolButton** Widget when clicked. :param checked: Checked state. ( Boolean ) """ @@ -479,7 +479,7 @@ def __Reflection_Path_toolButton__clicked(self, checked): def __setReWireWidgetFramesVisibility(self, index): """ - This method shows / hides rewire Widget frames. + Shows / hides rewire Widget frames. :param index: ComboBox index. ( Tuple ) """ @@ -494,7 +494,7 @@ def __setReWireWidgetFramesVisibility(self, index): def __setReWireCustomPath(self, component): """ - This method sets the :mod:`sibl_gui.components.addons.rewiringTool.rewiringTool` Component + Sets the :mod:`sibl_gui.components.addons.rewiringTool.rewiringTool` Component custom image QLineEdit Widgets. :param component: Target Component. ( String ) @@ -514,7 +514,7 @@ def __setReWireCustomPath(self, component): def getOverrideKeys(self): """ - This method gets override keys. + Gets override keys. :return: Method success. ( Boolean ) """ diff --git a/sibl_gui/components/addons/sIBLeditUtilities/sIBLeditUtilities.py b/sibl_gui/components/addons/sIBLeditUtilities/sIBLeditUtilities.py index 8fba14ed..8b9de039 100644 --- a/sibl_gui/components/addons/sIBLeditUtilities/sIBLeditUtilities.py +++ b/sibl_gui/components/addons/sIBLeditUtilities/sIBLeditUtilities.py @@ -66,7 +66,7 @@ class sIBLeditUtilities(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): def __init__(self, parent=None, name=None, *args, **kwargs): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param name: Component name. ( String ) @@ -95,7 +95,7 @@ def __init__(self, parent=None, name=None, *args, **kwargs): @property def engine(self): """ - This method is the property for **self.__engine** attribute. + Property for **self.__engine** attribute. :return: self.__engine. ( QObject ) """ @@ -106,7 +106,7 @@ def engine(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self, value): """ - This method is the setter method for **self.__engine** attribute. + Setter for **self.__engine** attribute. :param value: Attribute value. ( QObject ) """ @@ -118,7 +118,7 @@ def engine(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self): """ - This method is the deleter method for **self.__engine** attribute. + Deleter for **self.__engine** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -127,7 +127,7 @@ def engine(self): @property def settings(self): """ - This method is the property for **self.__settings** attribute. + Property for **self.__settings** attribute. :return: self.__settings. ( QSettings ) """ @@ -138,7 +138,7 @@ def settings(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settings(self, value): """ - This method is the setter method for **self.__settings** attribute. + Setter for **self.__settings** attribute. :param value: Attribute value. ( QSettings ) """ @@ -150,7 +150,7 @@ def settings(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settings(self): """ - This method is the deleter method for **self.__settings** attribute. + Deleter for **self.__settings** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -159,7 +159,7 @@ def settings(self): @property def settingsSection(self): """ - This method is the property for **self.__settingsSection** attribute. + Property for **self.__settingsSection** attribute. :return: self.__settingsSection. ( String ) """ @@ -170,7 +170,7 @@ def settingsSection(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settingsSection(self, value): """ - This method is the setter method for **self.__settingsSection** attribute. + Setter for **self.__settingsSection** attribute. :param value: Attribute value. ( String ) """ @@ -182,7 +182,7 @@ def settingsSection(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settingsSection(self): """ - This method is the deleter method for **self.__settingsSection** attribute. + Deleter for **self.__settingsSection** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -191,7 +191,7 @@ def settingsSection(self): @property def preferencesManager(self): """ - This method is the property for **self.__preferencesManager** attribute. + Property for **self.__preferencesManager** attribute. :return: self.__preferencesManager. ( QWidget ) """ @@ -202,7 +202,7 @@ def preferencesManager(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def preferencesManager(self, value): """ - This method is the setter method for **self.__preferencesManager** attribute. + Setter for **self.__preferencesManager** attribute. :param value: Attribute value. ( QWidget ) """ @@ -214,7 +214,7 @@ def preferencesManager(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def preferencesManager(self): """ - This method is the deleter method for **self.__preferencesManager** attribute. + Deleter for **self.__preferencesManager** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -223,7 +223,7 @@ def preferencesManager(self): @property def iblSetsOutliner(self): """ - This method is the property for **self.__iblSetsOutliner** attribute. + Property for **self.__iblSetsOutliner** attribute. :return: self.__iblSetsOutliner. ( QWidget ) """ @@ -234,7 +234,7 @@ def iblSetsOutliner(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iblSetsOutliner(self, value): """ - This method is the setter method for **self.__iblSetsOutliner** attribute. + Setter for **self.__iblSetsOutliner** attribute. :param value: Attribute value. ( QWidget ) """ @@ -246,7 +246,7 @@ def iblSetsOutliner(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iblSetsOutliner(self): """ - This method is the deleter method for **self.__iblSetsOutliner** attribute. + Deleter for **self.__iblSetsOutliner** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -255,7 +255,7 @@ def iblSetsOutliner(self): @property def inspector(self): """ - This method is the property for **self.__inspector** attribute. + Property for **self.__inspector** attribute. :return: self.__inspector. ( QWidget ) """ @@ -266,7 +266,7 @@ def inspector(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def inspector(self, value): """ - This method is the setter method for **self.__inspector** attribute. + Setter for **self.__inspector** attribute. :param value: Attribute value. ( QWidget ) """ @@ -278,7 +278,7 @@ def inspector(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def inspector(self): """ - This method is the deleter method for **self.__inspector** attribute. + Deleter for **self.__inspector** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -289,7 +289,7 @@ def inspector(self): #****************************************************************************************************************** def activate(self, engine): """ - This method activates the Component. + Activates the Component. :param engine: Engine to attach the Component to. ( QObject ) :return: Method success. ( Boolean ) @@ -310,7 +310,7 @@ def activate(self, engine): def deactivate(self): """ - This method deactivates the Component. + Deactivates the Component. :return: Method success. ( Boolean ) """ @@ -330,7 +330,7 @@ def deactivate(self): def initializeUi(self): """ - This method initializes the Component ui. + Initializes the Component ui. :return: Method success. ( Boolean ) """ @@ -350,7 +350,7 @@ def initializeUi(self): def uninitializeUi(self): """ - This method uninitializes the Component ui. + Uninitializes the Component ui. :return: Method success. ( Boolean ) """ @@ -368,7 +368,7 @@ def uninitializeUi(self): def addWidget(self): """ - This method adds the Component Widget to the engine. + Adds the Component Widget to the engine. :return: Method success. ( Boolean ) """ @@ -381,7 +381,7 @@ def addWidget(self): def removeWidget(self): """ - This method removes the Component Widget from the engine. + Removes the Component Widget from the engine. :return: Method success. ( Boolean ) """ @@ -394,7 +394,7 @@ def removeWidget(self): def __addActions(self): """ - This method sets Component actions. + Sets Component actions. """ LOGGER.debug("> Adding '{0}' Component actions.".format(self.__class__.__name__)) @@ -415,7 +415,7 @@ def __addActions(self): def __removeActions(self): """ - This method removes actions. + Removes actions. """ LOGGER.debug("> Removing '{0}' Component actions.".format(self.__class__.__name__)) @@ -432,7 +432,7 @@ def __removeActions(self): def __iblSetsOutliner_views_editIblSetInSIBLEditAction__triggered(self, checked): """ - This method is triggered by **'Actions|Umbra|Components|core.iblSetsOutliner|Edit In sIBLedit ...'** action. + Defines the slot triggered by **'Actions|Umbra|Components|core.iblSetsOutliner|Edit In sIBLedit ...'** action. :param checked: Action checked state. ( Boolean ) :return: Method success. ( Boolean ) @@ -442,7 +442,7 @@ def __iblSetsOutliner_views_editIblSetInSIBLEditAction__triggered(self, checked) def __inspector_editActiveIblSetInSIBLEditAction__triggered(self, checked): """ - This method is triggered by **'Actions|Umbra|Components|core.inspector|Edit In sIBLedit ...'** action. + Defines the slot triggered by **'Actions|Umbra|Components|core.inspector|Edit In sIBLedit ...'** action. :param checked: Action checked state. ( Boolean ) :return: Method success. ( Boolean ) @@ -452,7 +452,7 @@ def __inspector_editActiveIblSetInSIBLEditAction__triggered(self, checked): def __sIBLedit_Path_lineEdit_setUi(self): """ - This method fills **sIBLedit_Path_lineEdit** Widget. + Fills **sIBLedit_Path_lineEdit** Widget. """ sIBLeditExecutable = self.__settings.getKey(self.__settingsSection, "sIBLeditExecutable") @@ -461,7 +461,7 @@ def __sIBLedit_Path_lineEdit_setUi(self): def __sIBLedit_Path_toolButton__clicked(self, checked): """ - This method is triggered when **sIBLedit_Path_toolButton** Widget is clicked. + Defines the slot triggered by **sIBLedit_Path_toolButton** Widget when clicked. :param checked: Checked state. ( Boolean ) """ @@ -478,7 +478,7 @@ def __sIBLedit_Path_toolButton__clicked(self, checked): foundations.exceptions.UserError) def __sIBLedit_Path_lineEdit__editFinished(self): """ - This method is triggered when **sIBLedit_Path_lineEdit** Widget is edited and check that entered path is valid. + Defines the slot triggered by **sIBLedit_Path_lineEdit** Widget when edited and check that entered path is valid. """ value = foundations.strings.toString(self.sIBLedit_Path_lineEdit.text()) @@ -494,7 +494,7 @@ def __sIBLedit_Path_lineEdit__editFinished(self): foundations.exceptions.FileExistsError) def editIblSetInSIBLEditUi(self): """ - This method edits selected Ibl Set in sIBLedit. + Edits selected Ibl Set in sIBLedit. :return: Method success. ( Boolean ) @@ -522,7 +522,7 @@ def editIblSetInSIBLEditUi(self): foundations.exceptions.FileExistsError) def editActiveIblSetInSIBLEditUi(self): """ - This method edits :mod:`sibl_gui.components.core.inspector.inspector` Component inspected Ibl Set in sIBLedit. + Edits :mod:`sibl_gui.components.core.inspector.inspector` Component inspected Ibl Set in sIBLedit. :return: Method success. ( Boolean ) @@ -547,7 +547,7 @@ def editActiveIblSetInSIBLEditUi(self): def getProcessCommand(self, path, sIBLedit): """ - This method gets process command. + Gets process command. :param path: Path. ( String ) :param sIBLedit: sIBLedit. ( String ) @@ -559,7 +559,7 @@ def getProcessCommand(self, path, sIBLedit): @foundations.exceptions.handleExceptions(umbra.exceptions.notifyExceptionHandler, Exception) def editIblSetInSIBLedit(self, path, sIBLedit): """ - This method edits given Ibl Set in sIBLedit. + Edits given Ibl Set in sIBLedit. :param path: Path. ( String ) :param sIBLedit: sIBLedit. ( String ) diff --git a/sibl_gui/components/addons/searchDatabase/searchDatabase.py b/sibl_gui/components/addons/searchDatabase/searchDatabase.py index 1c861f52..0bc9a5db 100644 --- a/sibl_gui/components/addons/searchDatabase/searchDatabase.py +++ b/sibl_gui/components/addons/searchDatabase/searchDatabase.py @@ -72,7 +72,7 @@ class SearchDatabase(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): def __init__(self, parent=None, name=None, *args, **kwargs): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param name: Component name. ( String ) @@ -105,7 +105,7 @@ def __init__(self, parent=None, name=None, *args, **kwargs): @property def dockArea(self): """ - This method is the property for **self.__dockArea** attribute. + Property for **self.__dockArea** attribute. :return: self.__dockArea. ( Integer ) """ @@ -116,7 +116,7 @@ def dockArea(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def dockArea(self, value): """ - This method is the setter method for **self.__dockArea** attribute. + Setter for **self.__dockArea** attribute. :param value: Attribute value. ( Integer ) """ @@ -128,7 +128,7 @@ def dockArea(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def dockArea(self): """ - This method is the deleter method for **self.__dockArea** attribute. + Deleter for **self.__dockArea** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -137,7 +137,7 @@ def dockArea(self): @property def viewSpacing(self): """ - This method is the property for **self.__viewSpacing** attribute. + Property for **self.__viewSpacing** attribute. :return: self.__viewSpacing. ( Integer ) """ @@ -148,7 +148,7 @@ def viewSpacing(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def viewSpacing(self, value): """ - This method is the setter method for **self.__viewSpacing** attribute. + Setter for **self.__viewSpacing** attribute. :param value: Attribute value. ( Integer ) """ @@ -160,7 +160,7 @@ def viewSpacing(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def viewSpacing(self): """ - This method is the deleter method for **self.__viewSpacing** attribute. + Deleter for **self.__viewSpacing** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -169,7 +169,7 @@ def viewSpacing(self): @property def engine(self): """ - This method is the property for **self.__engine** attribute. + Property for **self.__engine** attribute. :return: self.__engine. ( QObject ) """ @@ -180,7 +180,7 @@ def engine(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self, value): """ - This method is the setter method for **self.__engine** attribute. + Setter for **self.__engine** attribute. :param value: Attribute value. ( QObject ) """ @@ -192,7 +192,7 @@ def engine(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self): """ - This method is the deleter method for **self.__engine** attribute. + Deleter for **self.__engine** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -202,7 +202,7 @@ def engine(self): @property def iblSetsOutliner(self): """ - This method is the property for **self.__iblSetsOutliner** attribute. + Property for **self.__iblSetsOutliner** attribute. :return: self.__iblSetsOutliner. ( QWidget ) """ @@ -213,7 +213,7 @@ def iblSetsOutliner(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iblSetsOutliner(self, value): """ - This method is the setter method for **self.__iblSetsOutliner** attribute. + Setter for **self.__iblSetsOutliner** attribute. :param value: Attribute value. ( QWidget ) """ @@ -225,7 +225,7 @@ def iblSetsOutliner(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iblSetsOutliner(self): """ - This method is the deleter method for **self.__iblSetsOutliner** attribute. + Deleter for **self.__iblSetsOutliner** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -234,7 +234,7 @@ def iblSetsOutliner(self): @property def collectionsOutliner(self): """ - This method is the property for **self.__collectionsOutliner** attribute. + Property for **self.__collectionsOutliner** attribute. :return: self.__collectionsOutliner. ( QWidget ) """ @@ -245,7 +245,7 @@ def collectionsOutliner(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def collectionsOutliner(self, value): """ - This method is the setter method for **self.__collectionsOutliner** attribute. + Setter for **self.__collectionsOutliner** attribute. :param value: Attribute value. ( QWidget ) """ @@ -257,7 +257,7 @@ def collectionsOutliner(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def collectionsOutliner(self): """ - This method is the deleter method for **self.__collectionsOutliner** attribute. + Deleter for **self.__collectionsOutliner** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -266,7 +266,7 @@ def collectionsOutliner(self): @property def view(self): """ - This method is the property for **self.__view** attribute. + Property for **self.__view** attribute. :return: self.__view. ( QWidget ) """ @@ -277,7 +277,7 @@ def view(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def view(self, value): """ - This method is the setter method for **self.__view** attribute. + Setter for **self.__view** attribute. :param value: Attribute value. ( QWidget ) """ @@ -289,7 +289,7 @@ def view(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def view(self): """ - This method is the deleter method for **self.__view** attribute. + Deleter for **self.__view** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -298,7 +298,7 @@ def view(self): @property def cloudExcludedTags(self): """ - This method is the property for **self.__cloudExcludedTags** attribute. + Property for **self.__cloudExcludedTags** attribute. :return: self.__cloudExcludedTags. ( List ) """ @@ -309,7 +309,7 @@ def cloudExcludedTags(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def cloudExcludedTags(self, value): """ - This method is the setter method for **self.__cloudExcludedTags** attribute. + Setter for **self.__cloudExcludedTags** attribute. :param value: Attribute value. ( List ) """ @@ -321,7 +321,7 @@ def cloudExcludedTags(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def cloudExcludedTags(self): """ - This method is the deleter method for **self.__cloudExcludedTags** attribute. + Deleter for **self.__cloudExcludedTags** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -332,7 +332,7 @@ def cloudExcludedTags(self): #****************************************************************************************************************** def activate(self, engine): """ - This method activates the Component. + Activates the Component. :param engine: Engine to attach the Component to. ( QObject ) :return: Method success. ( Boolean ) @@ -350,7 +350,7 @@ def activate(self, engine): def deactivate(self): """ - This method deactivates the Component. + Deactivates the Component. :return: Method success. ( Boolean ) """ @@ -367,7 +367,7 @@ def deactivate(self): def initializeUi(self): """ - This method initializes the Component ui. + Initializes the Component ui. :return: Method success. ( Boolean ) """ @@ -413,7 +413,7 @@ def initializeUi(self): def uninitializeUi(self): """ - This method uninitializes the Component ui. + Uninitializes the Component ui. :return: Method success. ( Boolean ) """ @@ -437,7 +437,7 @@ def uninitializeUi(self): def addWidget(self): """ - This method adds the Component Widget to the engine. + Adds the Component Widget to the engine. :return: Method success. ( Boolean ) """ @@ -450,7 +450,7 @@ def addWidget(self): def removeWidget(self): """ - This method removes the Component Widget from the engine. + Removes the Component Widget from the engine. :return: Method success. ( Boolean ) """ @@ -464,7 +464,7 @@ def removeWidget(self): def __Search_Database_lineEdit__textChanged(self, text): """ - This method is triggered when **Search_Database_lineEdit** text changes. + Defines the slot triggered by **Search_Database_lineEdit** Widget when text changed. :param text: Current text value. ( QString ) """ @@ -473,7 +473,7 @@ def __Search_Database_lineEdit__textChanged(self, text): def __Case_Sensitive_Matching_pushButton__clicked(self, checked): """ - This method is triggered when **Case_Sensitive_Matching_pushButton** Widget is clicked. + Defines the slot triggered by **Case_Sensitive_Matching_pushButton** Widget when clicked. :param checked: Checked state. ( Boolean ) """ @@ -482,7 +482,7 @@ def __Case_Sensitive_Matching_pushButton__clicked(self, checked): def __Time_Low_timeEdit__timeChanged(self, time): """ - This method is triggered when **Time_Low_timeEdit** time changes. + Defines the slot triggered by **Time_Low_timeEdit** Widget when time changed. :param time: Current time. ( QTime ) """ @@ -493,7 +493,7 @@ def __Time_Low_timeEdit__timeChanged(self, time): def __Time_High_timeEdit__timeChanged(self, time): """ - This method is triggered when **Time_Low_timeEdit** time changes. + Defines the slot triggered by **Time_Low_timeEdit** Widget when time changed. :param time: Current time. ( QTime ) """ @@ -504,7 +504,7 @@ def __Time_High_timeEdit__timeChanged(self, time): def __view__doubleClicked(self, listWidgetItem): """ - This method is triggered when the View is double clicked. + Defines the slot triggered by the View when double clicked. :param listWidgetItem: List Widget item. ( QlistWidgetItem ) """ @@ -513,7 +513,7 @@ def __view__doubleClicked(self, listWidgetItem): def __collectionsOutliner_view_selectionModel__selectionChanged(self, selectedItems, deselectedItems): """ - This method is triggered when **collectionsOutliner.view** Model selection has changed. + Defines the slot triggered by **collectionsOutliner.view** Model when selection changed :param selectedItems: Selected items. ( QItemSelection ) :param deselectedItems: Deselected items. ( QItemSelection ) @@ -523,7 +523,7 @@ def __collectionsOutliner_view_selectionModel__selectionChanged(self, selectedIt def setTagsCloudMatchingIblsSetsUi(self): """ - This method sets the user defined pattern matching Ibl Sets and + Sets the user defined pattern matching Ibl Sets and updates :mod:`sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner` Component Model content. :return: Method success. ( Boolean ) @@ -536,7 +536,7 @@ def setTagsCloudMatchingIblsSetsUi(self): def setTimeMatchingIblSetsUi(self): """ - This method sets the user defined time matching Ibl Sets and + Sets the user defined time matching Ibl Sets and updates :mod:`sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner` Component Model content. :return: Method success. ( Boolean ) @@ -548,7 +548,7 @@ def setTimeMatchingIblSetsUi(self): def setTagsCloudMatchingIblsSets(self, pattern, flags=re.IGNORECASE): """ - This method sets the pattern matching Ibl Sets and + Sets the pattern matching Ibl Sets and updates :mod:`sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner` Component Model content. :param pattern: Filtering pattern. ( String ) @@ -603,7 +603,7 @@ def setTagsCloudMatchingIblsSets(self, pattern, flags=re.IGNORECASE): def setTimeMatchingIblSets(self, timeLow, timeHigh): """ - This method sets the time matching Ibl Sets and + Sets the time matching Ibl Sets and updates :mod:`sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner` Component Model content. :param timeLow: Time low. ( QTime ) diff --git a/sibl_gui/components/core/collectionsOutliner/collectionsOutliner.py b/sibl_gui/components/core/collectionsOutliner/collectionsOutliner.py index c78cfedb..0c7a3c12 100644 --- a/sibl_gui/components/core/collectionsOutliner/collectionsOutliner.py +++ b/sibl_gui/components/core/collectionsOutliner/collectionsOutliner.py @@ -92,7 +92,7 @@ class CollectionsOutliner(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): def __init__(self, parent=None, name=None, *args, **kwargs): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param name: Component name. ( String ) @@ -134,7 +134,7 @@ def __init__(self, parent=None, name=None, *args, **kwargs): @property def uiResourcesDirectory(self): """ - This method is the property for **self.__uiResourcesDirectory** attribute. + Property for **self.__uiResourcesDirectory** attribute. :return: self.__uiResourcesDirectory. ( String ) """ @@ -145,7 +145,7 @@ def uiResourcesDirectory(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiResourcesDirectory(self, value): """ - This method is the setter method for **self.__uiResourcesDirectory** attribute. + Setter for **self.__uiResourcesDirectory** attribute. :param value: Attribute value. ( String ) """ @@ -157,7 +157,7 @@ def uiResourcesDirectory(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiResourcesDirectory(self): """ - This method is the deleter method for **self.__uiResourcesDirectory** attribute. + Deleter for **self.__uiResourcesDirectory** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -166,7 +166,7 @@ def uiResourcesDirectory(self): @property def uiDefaultCollectionImage(self): """ - This method is the property for **self.__uiDefaultCollectionImage** attribute. + Property for **self.__uiDefaultCollectionImage** attribute. :return: self.__uiDefaultCollectionImage. ( String ) """ @@ -177,7 +177,7 @@ def uiDefaultCollectionImage(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiDefaultCollectionImage(self, value): """ - This method is the setter method for **self.__uiDefaultCollectionImage** attribute. + Setter for **self.__uiDefaultCollectionImage** attribute. :param value: Attribute value. ( String ) """ @@ -189,7 +189,7 @@ def uiDefaultCollectionImage(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiDefaultCollectionImage(self): """ - This method is the deleter method for **self.__uiDefaultCollectionImage** attribute. + Deleter for **self.__uiDefaultCollectionImage** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -198,7 +198,7 @@ def uiDefaultCollectionImage(self): @property def uiUserCollectionImage(self): """ - This method is the property for **self.__uiUserCollectionImage** attribute. + Property for **self.__uiUserCollectionImage** attribute. :return: self.__uiUserCollectionImage. ( String ) """ @@ -209,7 +209,7 @@ def uiUserCollectionImage(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiUserCollectionImage(self, value): """ - This method is the setter method for **self.__uiUserCollectionImage** attribute. + Setter for **self.__uiUserCollectionImage** attribute. :param value: Attribute value. ( String ) """ @@ -221,7 +221,7 @@ def uiUserCollectionImage(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiUserCollectionImage(self): """ - This method is the deleter method for **self.__uiUserCollectionImage** attribute. + Deleter for **self.__uiUserCollectionImage** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -230,7 +230,7 @@ def uiUserCollectionImage(self): @property def dockArea(self): """ - This method is the property for **self.__dockArea** attribute. + Property for **self.__dockArea** attribute. :return: self.__dockArea. ( Integer ) """ @@ -241,7 +241,7 @@ def dockArea(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def dockArea(self, value): """ - This method is the setter method for **self.__dockArea** attribute. + Setter for **self.__dockArea** attribute. :param value: Attribute value. ( Integer ) """ @@ -253,7 +253,7 @@ def dockArea(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def dockArea(self): """ - This method is the deleter method for **self.__dockArea** attribute. + Deleter for **self.__dockArea** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -262,7 +262,7 @@ def dockArea(self): @property def engine(self): """ - This method is the property for **self.__engine** attribute. + Property for **self.__engine** attribute. :return: self.__engine. ( QObject ) """ @@ -273,7 +273,7 @@ def engine(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self, value): """ - This method is the setter method for **self.__engine** attribute. + Setter for **self.__engine** attribute. :param value: Attribute value. ( QObject ) """ @@ -285,7 +285,7 @@ def engine(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self): """ - This method is the deleter method for **self.__engine** attribute. + Deleter for **self.__engine** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -294,7 +294,7 @@ def engine(self): @property def settings(self): """ - This method is the property for **self.__settings** attribute. + Property for **self.__settings** attribute. :return: self.__settings. ( QSettings ) """ @@ -305,7 +305,7 @@ def settings(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settings(self, value): """ - This method is the setter method for **self.__settings** attribute. + Setter for **self.__settings** attribute. :param value: Attribute value. ( QSettings ) """ @@ -317,7 +317,7 @@ def settings(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settings(self): """ - This method is the deleter method for **self.__settings** attribute. + Deleter for **self.__settings** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -326,7 +326,7 @@ def settings(self): @property def settingsSection(self): """ - This method is the property for **self.__settingsSection** attribute. + Property for **self.__settingsSection** attribute. :return: self.__settingsSection. ( String ) """ @@ -337,7 +337,7 @@ def settingsSection(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settingsSection(self, value): """ - This method is the setter method for **self.__settingsSection** attribute. + Setter for **self.__settingsSection** attribute. :param value: Attribute value. ( String ) """ @@ -349,7 +349,7 @@ def settingsSection(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settingsSection(self): """ - This method is the deleter method for **self.__settingsSection** attribute. + Deleter for **self.__settingsSection** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -358,7 +358,7 @@ def settingsSection(self): @property def settingsSeparator(self): """ - This method is the property for **self.__settingsSeparator** attribute. + Property for **self.__settingsSeparator** attribute. :return: self.__settingsSeparator. ( String ) """ @@ -369,7 +369,7 @@ def settingsSeparator(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settingsSeparator(self, value): """ - This method is the setter method for **self.__settingsSeparator** attribute. + Setter for **self.__settingsSeparator** attribute. :param value: Attribute value. ( String ) """ @@ -381,7 +381,7 @@ def settingsSeparator(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settingsSeparator(self): """ - This method is the deleter method for **self.__settingsSeparator** attribute. + Deleter for **self.__settingsSeparator** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -390,7 +390,7 @@ def settingsSeparator(self): @property def iblSetsOutliner(self): """ - This method is the property for **self.__iblSetsOutliner** attribute. + Property for **self.__iblSetsOutliner** attribute. :return: self.__iblSetsOutliner. ( QWidget ) """ @@ -401,7 +401,7 @@ def iblSetsOutliner(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iblSetsOutliner(self, value): """ - This method is the setter method for **self.__iblSetsOutliner** attribute. + Setter for **self.__iblSetsOutliner** attribute. :param value: Attribute value. ( QWidget ) """ @@ -413,7 +413,7 @@ def iblSetsOutliner(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iblSetsOutliner(self): """ - This method is the deleter method for **self.__iblSetsOutliner** attribute. + Deleter for **self.__iblSetsOutliner** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -422,7 +422,7 @@ def iblSetsOutliner(self): @property def model(self): """ - This method is the property for **self.__model** attribute. + Property for **self.__model** attribute. :return: self.__model. ( CollectionsModel ) """ @@ -433,7 +433,7 @@ def model(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def model(self, value): """ - This method is the setter method for **self.__model** attribute. + Setter for **self.__model** attribute. :param value: Attribute value. ( CollectionsModel ) """ @@ -445,7 +445,7 @@ def model(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def model(self): """ - This method is the deleter method for **self.__model** attribute. + Deleter for **self.__model** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -454,7 +454,7 @@ def model(self): @property def view(self): """ - This method is the property for **self.__view** attribute. + Property for **self.__view** attribute. :return: self.__view. ( QWidget ) """ @@ -465,7 +465,7 @@ def view(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def view(self, value): """ - This method is the setter method for **self.__view** attribute. + Setter for **self.__view** attribute. :param value: Attribute value. ( QWidget ) """ @@ -477,7 +477,7 @@ def view(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def view(self): """ - This method is the deleter method for **self.__view** attribute. + Deleter for **self.__view** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -486,7 +486,7 @@ def view(self): @property def overallCollection(self): """ - This method is the property for **self.__overallCollection** attribute. + Property for **self.__overallCollection** attribute. :return: self.__overallCollection. ( String ) """ @@ -497,7 +497,7 @@ def overallCollection(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def overallCollection(self, value): """ - This method is the setter method for **self.__overallCollection** attribute. + Setter for **self.__overallCollection** attribute. :param value: Attribute value. ( String ) """ @@ -509,7 +509,7 @@ def overallCollection(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def overallCollection(self): """ - This method is the deleter method for **self.__overallCollection** attribute. + Deleter for **self.__overallCollection** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -518,7 +518,7 @@ def overallCollection(self): @property def defaultCollection(self): """ - This method is the property for **self.__defaultCollection** attribute. + Property for **self.__defaultCollection** attribute. :return: self.__defaultCollection. ( String ) """ @@ -529,7 +529,7 @@ def defaultCollection(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def defaultCollection(self, value): """ - This method is the setter method for **self.__defaultCollection** attribute. + Setter for **self.__defaultCollection** attribute. :param value: Attribute value. ( String ) """ @@ -541,7 +541,7 @@ def defaultCollection(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def defaultCollection(self): """ - This method is the deleter method for **self.__defaultCollection** attribute. + Deleter for **self.__defaultCollection** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -550,7 +550,7 @@ def defaultCollection(self): @property def iblSetsCountLabel(self): """ - This method is the property for **self.__iblSetsCountLabel** attribute. + Property for **self.__iblSetsCountLabel** attribute. :return: self.__iblSetsCountLabel. ( String ) """ @@ -561,7 +561,7 @@ def iblSetsCountLabel(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iblSetsCountLabel(self, value): """ - This method is the setter method for **self.__iblSetsCountLabel** attribute. + Setter for **self.__iblSetsCountLabel** attribute. :param value: Attribute value. ( String ) """ @@ -573,7 +573,7 @@ def iblSetsCountLabel(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iblSetsCountLabel(self): """ - This method is the deleter method for **self.__iblSetsCountLabel** attribute. + Deleter for **self.__iblSetsCountLabel** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -582,7 +582,7 @@ def iblSetsCountLabel(self): @property def headers(self): """ - This method is the property for **self.__headers** attribute. + Property for **self.__headers** attribute. :return: self.__headers. ( OrderedDict ) """ @@ -593,7 +593,7 @@ def headers(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def headers(self, value): """ - This method is the setter method for **self.__headers** attribute. + Setter for **self.__headers** attribute. :param value: Attribute value. ( OrderedDict ) """ @@ -605,7 +605,7 @@ def headers(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def headers(self): """ - This method is the deleter method for **self.__headers** attribute. + Deleter for **self.__headers** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -616,7 +616,7 @@ def headers(self): #****************************************************************************************************************** def activate(self, engine): """ - This method activates the Component. + Activates the Component. :param engine: Engine to attach the Component to. ( QObject ) :return: Method success. ( Boolean ) @@ -637,7 +637,7 @@ def activate(self, engine): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def deactivate(self): """ - This method deactivates the Component. + Deactivates the Component. """ raise foundations.exceptions.ProgrammingError( @@ -645,7 +645,7 @@ def deactivate(self): def initializeUi(self): """ - This method initializes the Component ui. + Initializes the Component ui. :return: Method success. ( Boolean ) """ @@ -681,7 +681,7 @@ def initializeUi(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uninitializeUi(self): """ - This method uninitializes the Component ui. + Uninitializes the Component ui. """ raise foundations.exceptions.ProgrammingError( @@ -689,7 +689,7 @@ def uninitializeUi(self): def addWidget(self): """ - This method adds the Component Widget to the engine. + Adds the Component Widget to the engine. :return: Method success. ( Boolean ) """ @@ -703,7 +703,7 @@ def addWidget(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def removeWidget(self): """ - This method removes the Component Widget from the engine. + Removes the Component Widget from the engine. """ raise foundations.exceptions.ProgrammingError( @@ -711,7 +711,7 @@ def removeWidget(self): def onStartup(self): """ - This method is triggered on Framework startup. + Defines the slot triggered on Framework startup. :return: Method success. ( Boolean ) """ @@ -743,7 +743,7 @@ def onStartup(self): def onClose(self): """ - This method is triggered on Framework close. + Defines the slot triggered on Framework close. :return: Method success. ( Boolean ) """ @@ -764,14 +764,14 @@ def onClose(self): def __model__refreshNodes(self): """ - This method is triggered when the Model Nodes need refresh. + Defines the slot triggered by the Model when Nodes need refresh. """ self.setCollections() def __model__refreshAttributes(self): """ - This method refreshes the Model Nodes attributes. + Refreshes the Model Nodes attributes. """ for node in foundations.walkers.nodesWalker(self.__model.rootNode): @@ -788,7 +788,7 @@ def __model__refreshAttributes(self): foundations.exceptions.UserError) def __model__dataChanged(self, startIndex, endIndex): """ - This method is triggered when the Model data has changed. + Defines the slot triggered by the Model when data has changed. :param startIndex: Edited item starting QModelIndex. ( QModelIndex ) :param endIndex: Edited item ending QModelIndex. ( QModelIndex ) @@ -818,7 +818,7 @@ def __model__dataChanged(self, startIndex, endIndex): def __view_addActions(self): """ - This method sets the View actions. + Sets the View actions. """ if not self.__engine.parameters.databaseReadOnly: @@ -838,7 +838,7 @@ def __view_addActions(self): def __view_addContentAction__triggered(self, checked): """ - This method is triggered by **'Actions|Umbra|Components|core.collectionsOutliner|Add Content ...'** action. + Defines the slot triggered by **'Actions|Umbra|Components|core.collectionsOutliner|Add Content ...'** action. :param checked: Action checked state. ( Boolean ) :return: Method success. ( Boolean ) @@ -848,7 +848,7 @@ def __view_addContentAction__triggered(self, checked): def __view_addCollectionAction__triggered(self, checked): """ - This method is triggered by **'Actions|Umbra|Components|core.collectionsOutliner|Add Collection ...'** action. + Defines the slot triggered by **'Actions|Umbra|Components|core.collectionsOutliner|Add Collection ...'** action. :param checked: Action checked state. ( Boolean ) :return: Method success. ( Boolean ) @@ -858,7 +858,7 @@ def __view_addCollectionAction__triggered(self, checked): def __view_removeCollectionsAction__triggered(self, checked): """ - This method is triggered by + Defines the slot triggered by **'Actions|Umbra|Components|core.collectionsOutliner|Remove Collection(s) ...'** action. :param checked: Action checked state. ( Boolean ) @@ -869,7 +869,7 @@ def __view_removeCollectionsAction__triggered(self, checked): def __view_selectionModel__selectionChanged(self, selectedItems, deselectedItems): """ - This method is triggered when the View **selectionModel** has changed. + Defines the slot triggered by the View **selectionModel** when selection changed. :param selectedItems: Selected items. ( QItemSelection ) :param deselectedItems: Deselected items. ( QItemSelection ) @@ -881,7 +881,7 @@ def __view_selectionModel__selectionChanged(self, selectedItems, deselectedItems @umbra.engine.showProcessing("Adding Content ...") def addContentUi(self): """ - This method adds user defined content to the Database. + Adds user defined content to the Database. :return: Method success. ( Boolean ) @@ -911,7 +911,7 @@ def addContentUi(self): @umbra.engine.showProcessing("Adding Collection ...") def addCollectionUi(self): """ - This method adds an user defined Collection to the Database. + Adds an user defined Collection to the Database. :return: Collection name. ( String ) @@ -953,7 +953,7 @@ def addCollectionUi(self): @umbra.engine.encapsulateProcessing def removeCollectionsUi(self): """ - This method removes user selected Collections from the Database. + Removes user selected Collections from the Database. :return: Method success. ( Boolean ) @@ -996,7 +996,7 @@ def removeCollectionsUi(self): sibl_gui.components.core.database.exceptions.DatabaseOperationError) def addCollection(self, name, comment="Double click to set a comment!"): """ - This method adds a Collection to the Database. + Adds a Collection to the Database. :param name: Collection name. ( String ) :param collection: Collection name. ( String ) @@ -1023,7 +1023,7 @@ def addCollection(self, name, comment="Double click to set a comment!"): @foundations.exceptions.handleExceptions(sibl_gui.components.core.database.exceptions.DatabaseOperationError) def removeCollection(self, collection): """ - This method removes given Collection from the Database. + Removes given Collection from the Database. :param collection: Collection to remove. ( Collection ) :return: Method success. ( Boolean ) @@ -1045,7 +1045,7 @@ def removeCollection(self, collection): collection.name)) def getCollections(self): """ - This method returns Database Ibl Sets Collections. + Returns Database Ibl Sets Collections. :return: Database Ibl Sets Collections. ( List ) """ @@ -1054,7 +1054,7 @@ def getCollections(self): def filterCollections(self, pattern, attribute, flags=re.IGNORECASE): """ - This method filters the Database Ibl Sets Collections on given attribute using given pattern. + Filters the Database Ibl Sets Collections on given attribute using given pattern. :param pattern: Filter pattern. ( String ) :param attribute: Attribute to filter on. ( String ) @@ -1073,7 +1073,7 @@ def filterCollections(self, pattern, attribute, flags=re.IGNORECASE): def collectionExists(self, name): """ - This method returns if given Collection name exists in the Database. + Returns if given Collection name exists in the Database. :param name: Collection name. ( String ) :return: Collection exists. ( Boolean ) @@ -1083,7 +1083,7 @@ def collectionExists(self, name): def listCollections(self): """ - This method lists Database Ibl Sets Collections names. + Lists Database Ibl Sets Collections names. :return: Database Ibl Sets Collections names. ( List ) """ @@ -1092,7 +1092,7 @@ def listCollections(self): def setCollections(self): """ - This method sets the Collections Model nodes. + Sets the Collections Model nodes. """ nodeFlags = attributesFlags = self.__engine.parameters.databaseReadOnly and \ @@ -1130,7 +1130,7 @@ def setCollections(self): def getCollectionByName(self, name): """ - This method returns Database Ibl Sets Collection with given name. + Returns Database Ibl Sets Collection with given name. :param name: Collection name. ( String ) :return: Database Ibl Sets Collection. ( Collection ) @@ -1141,7 +1141,7 @@ def getCollectionByName(self, name): def getCollectionsIblSets(self, collections): """ - This method gets given Collections Ibl Sets. + Gets given Collections Ibl Sets. :param collections: Collections to get Ibl Sets from. ( List ) :return: Ibl Sets list. ( List ) @@ -1152,7 +1152,7 @@ def getCollectionsIblSets(self, collections): def getCollectionId(self, collection): """ - This method returns given Collection id. + Returns given Collection id. :param collection: Collection to get the id from. ( String ) :return: Provided Collection id. ( Integer ) @@ -1164,7 +1164,7 @@ def getCollectionId(self, collection): def getSelectedNodes(self): """ - This method returns the View selected nodes. + Returns the View selected nodes. :return: View selected nodes. ( Dictionary ) """ @@ -1173,7 +1173,7 @@ def getSelectedNodes(self): def getSelectedCollectionsNodes(self): """ - This method returns the View selected Collections nodes. + Returns the View selected Collections nodes. :return: View selected Collections nodes. ( List ) """ @@ -1182,7 +1182,7 @@ def getSelectedCollectionsNodes(self): def getSelectedCollections(self): """ - This method gets the View selected Collections. + Gets the View selected Collections. :return: View selected Collections. ( List ) """ diff --git a/sibl_gui/components/core/collectionsOutliner/models.py b/sibl_gui/components/core/collectionsOutliner/models.py index 52165a5a..59664cf9 100644 --- a/sibl_gui/components/core/collectionsOutliner/models.py +++ b/sibl_gui/components/core/collectionsOutliner/models.py @@ -52,7 +52,7 @@ class CollectionsModel(sibl_gui.ui.models.GraphModel): def __init__(self, parent=None, rootNode=None, horizontalHeaders=None, verticalHeaders=None): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param rootNode: Root node. ( AbstractCompositeNode ) @@ -73,7 +73,7 @@ def __init__(self, parent=None, rootNode=None, horizontalHeaders=None, verticalH #****************************************************************************************************************** def initializeModel(self, rootNode): """ - This method initializes the Model using given root node. + Initializes the Model using given root node. :param rootNode: Graph root node. ( DefaultNode ) :return: Method success ( Boolean ) diff --git a/sibl_gui/components/core/collectionsOutliner/nodes.py b/sibl_gui/components/core/collectionsOutliner/nodes.py index b5f7bd0f..8745f32d 100644 --- a/sibl_gui/components/core/collectionsOutliner/nodes.py +++ b/sibl_gui/components/core/collectionsOutliner/nodes.py @@ -67,7 +67,7 @@ def __init__(self, iconPlaceholder=None, **kwargs): """ - This method initializes the class. + Initializes the class. :param name: Node name. ( String ) :param parent: Node parent. ( GraphModelNode ) @@ -99,7 +99,7 @@ def __init__(self, #****************************************************************************************************************** def __initializeNode(self, attributesFlags=int(Qt.ItemIsSelectable | Qt.ItemIsEnabled)): """ - This method initializes the node. + Initializes the node. :param attributesFlags: Attributes flags. ( Integer ) """ @@ -112,7 +112,7 @@ def __initializeNode(self, attributesFlags=int(Qt.ItemIsSelectable | Qt.ItemIsEn def updateNode(self): """ - This method updates the node. + Updates the node. :return: Method success. ( Boolean ) """ @@ -121,7 +121,7 @@ def updateNode(self): def updateNodeAttributes(self): """ - This method updates the Node attributes. + Updates the Node attributes. :return: Method success. ( Boolean ) """ diff --git a/sibl_gui/components/core/collectionsOutliner/views.py b/sibl_gui/components/core/collectionsOutliner/views.py index 1e0a5cde..b7a174d4 100644 --- a/sibl_gui/components/core/collectionsOutliner/views.py +++ b/sibl_gui/components/core/collectionsOutliner/views.py @@ -60,7 +60,7 @@ class IblSetsCollections_QTreeView(sibl_gui.ui.views.Abstract_QTreeView): def __init__(self, parent, model=None, readOnly=False, message=None): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param model: Model. ( QObject ) @@ -85,7 +85,7 @@ def __init__(self, parent, model=None, readOnly=False, message=None): @property def container(self): """ - This method is the property for **self.__container** attribute. + Property for **self.__container** attribute. :return: self.__container. ( QObject ) """ @@ -96,7 +96,7 @@ def container(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def container(self, value): """ - This method is the setter method for **self.__container** attribute. + Setter for **self.__container** attribute. :param value: Attribute value. ( QObject ) """ @@ -108,7 +108,7 @@ def container(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def container(self): """ - This method is the deleter method for **self.__container** attribute. + Deleter for **self.__container** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -117,7 +117,7 @@ def container(self): @property def treeViewIndentation(self): """ - This method is the property for **self.__treeViewIndentation** attribute. + Property for **self.__treeViewIndentation** attribute. :return: self.__treeViewIndentation. ( Integer ) """ @@ -128,7 +128,7 @@ def treeViewIndentation(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def treeViewIndentation(self, value): """ - This method is the setter method for **self.__treeViewIndentation** attribute. + Setter for **self.__treeViewIndentation** attribute. :param value: Attribute value. ( Integer ) """ @@ -140,7 +140,7 @@ def treeViewIndentation(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def treeViewIndentation(self): """ - This method is the deleter method for **self.__treeViewIndentation** attribute. + Deleter for **self.__treeViewIndentation** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -151,7 +151,7 @@ def treeViewIndentation(self): #****************************************************************************************************************** def dragEnterEvent(self, event): """ - This method reimplements the :meth:`sibl_gui.ui.views.Abstract_QTreeView.dragEnterEvent` method. + Reimplements the :meth:`sibl_gui.ui.views.Abstract_QTreeView.dragEnterEvent` method. :param event: QEvent. ( QEvent ) """ @@ -164,7 +164,7 @@ def dragEnterEvent(self, event): def dragMoveEvent(self, event): """ - This method reimplements the :meth:`sibl_gui.ui.views.Abstract_QTreeView.dragMoveEvent` method. + Reimplements the :meth:`sibl_gui.ui.views.Abstract_QTreeView.dragMoveEvent` method. :param event: QEvent. ( QEvent ) """ @@ -176,7 +176,7 @@ def dragMoveEvent(self, event): foundations.exceptions.UserError) def dropEvent(self, event): """ - This method reimplements the :meth:`sibl_gui.ui.views.Abstract_QTreeView.dropEvent` method. + Reimplements the :meth:`sibl_gui.ui.views.Abstract_QTreeView.dropEvent` method. :param event: QEvent. ( QEvent ) """ @@ -214,7 +214,7 @@ def dropEvent(self, event): def __initializeUi(self): """ - This method initializes the Widget ui. + Initializes the Widget ui. """ self.setAutoScroll(True) @@ -232,7 +232,7 @@ def __initializeUi(self): def __setDefaultUiState(self): """ - This method sets the Widget default ui state. + Sets the Widget default ui state. """ LOGGER.debug("> Setting default View state!") @@ -247,7 +247,7 @@ def __setDefaultUiState(self): def storeModelSelection(self): """ - This method stores the Model selection. + Stores the Model selection. :return: Method success. ( Boolean ) """ @@ -264,7 +264,7 @@ def storeModelSelection(self): def restoreModelSelection(self): """ - This method restores the Model selection. + Restores the Model selection. :return: Method success. ( Boolean ) """ diff --git a/sibl_gui/components/core/database/database.py b/sibl_gui/components/core/database/database.py index caf80c3a..a5233a2a 100644 --- a/sibl_gui/components/core/database/database.py +++ b/sibl_gui/components/core/database/database.py @@ -63,7 +63,7 @@ class Database(Component): def __init__(self, name=None): """ - This method initializes the class. + Initializes the class. :param name: Component name. ( String ) """ @@ -94,7 +94,7 @@ def __init__(self, name=None): @property def engine(self): """ - This method is the property for **self.__engine** attribute. + Property for **self.__engine** attribute. :return: self.__engine. ( QObject ) """ @@ -105,7 +105,7 @@ def engine(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self, value): """ - This method is the setter method for **self.__engine** attribute. + Setter for **self.__engine** attribute. :param value: Attribute value. ( QObject ) """ @@ -117,7 +117,7 @@ def engine(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self): """ - This method is the deleter method for **self.__engine** attribute. + Deleter for **self.__engine** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -126,7 +126,7 @@ def engine(self): @property def databaseName(self): """ - This method is the property for **self.__databaseName** attribute. + Property for **self.__databaseName** attribute. :return: self.__databaseName. ( String ) """ @@ -137,7 +137,7 @@ def databaseName(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def databaseName(self, value): """ - This method is the setter method for **self.__databaseName** attribute. + Setter for **self.__databaseName** attribute. :param value: Attribute value. ( String ) """ @@ -149,7 +149,7 @@ def databaseName(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def databaseName(self): """ - This method is the deleter method for **self.__databaseName** attribute. + Deleter for **self.__databaseName** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -158,7 +158,7 @@ def databaseName(self): @property def databaseEngine(self): """ - This method is the property for **self.__databaseEngine** attribute. + Property for **self.__databaseEngine** attribute. :return: self.__databaseEngine. ( Object ) """ @@ -169,7 +169,7 @@ def databaseEngine(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def databaseEngine(self, value): """ - This method is the setter method for **self.__databaseEngine** attribute. + Setter for **self.__databaseEngine** attribute. :param value: Attribute value. ( Object ) """ @@ -181,7 +181,7 @@ def databaseEngine(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def databaseEngine(self): """ - This method is the deleter method for **self.__databaseEngine** attribute. + Deleter for **self.__databaseEngine** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -190,7 +190,7 @@ def databaseEngine(self): @property def databaseCatalog(self): """ - This method is the property for **self.__databaseCatalog** attribute. + Property for **self.__databaseCatalog** attribute. :return: self.__databaseCatalog. ( Object ) """ @@ -201,7 +201,7 @@ def databaseCatalog(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def databaseCatalog(self, value): """ - This method is the setter method for **self.__databaseCatalog** attribute. + Setter for **self.__databaseCatalog** attribute. :param value: Attribute value. ( Object ) """ @@ -213,7 +213,7 @@ def databaseCatalog(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def databaseCatalog(self): """ - This method is the deleter method for **self.__databaseCatalog** attribute. + Deleter for **self.__databaseCatalog** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -222,7 +222,7 @@ def databaseCatalog(self): @property def databaseSession(self): """ - This method is the property for **self.__databaseSession** attribute. + Property for **self.__databaseSession** attribute. :return: self.__databaseSession. ( Object ) """ @@ -233,7 +233,7 @@ def databaseSession(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def databaseSession(self, value): """ - This method is the setter method for **self.__databaseSession** attribute. + Setter for **self.__databaseSession** attribute. :param value: Attribute value. ( Object ) """ @@ -245,7 +245,7 @@ def databaseSession(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def databaseSession(self): """ - This method is the deleter method for **self.__databaseSession** attribute. + Deleter for **self.__databaseSession** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -254,7 +254,7 @@ def databaseSession(self): @property def databaseSessionMaker(self): """ - This method is the property for **self.__databaseSessionMaker** attribute. + Property for **self.__databaseSessionMaker** attribute. :return: self.__databaseSessionMaker. ( Object ) """ @@ -265,7 +265,7 @@ def databaseSessionMaker(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def databaseSessionMaker(self, value): """ - This method is the setter method for **self.__databaseSessionMaker** attribute. + Setter for **self.__databaseSessionMaker** attribute. :param value: Attribute value. ( Object ) """ @@ -277,7 +277,7 @@ def databaseSessionMaker(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def databaseSessionMaker(self): """ - This method is the deleter method for **self.__databaseSessionMaker** attribute. + Deleter for **self.__databaseSessionMaker** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -286,7 +286,7 @@ def databaseSessionMaker(self): @property def databaseConnectionString(self): """ - This method is the property for **self.__databaseConnectionString** attribute. + Property for **self.__databaseConnectionString** attribute. :return: self.__databaseConnectionString. ( String ) """ @@ -297,7 +297,7 @@ def databaseConnectionString(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def databaseConnectionString(self, value): """ - This method is the setter method for **self.__databaseConnectionString** attribute. + Setter for **self.__databaseConnectionString** attribute. :param value: Attribute value. ( String ) """ @@ -309,7 +309,7 @@ def databaseConnectionString(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def databaseConnectionString(self): """ - This method is the deleter method for **self.__databaseConnectionString** attribute. + Deleter for **self.__databaseConnectionString** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -318,7 +318,7 @@ def databaseConnectionString(self): @property def databaseBackupDirectory(self): """ - This method is the property for **self.__databaseBackupDirectory** attribute. + Property for **self.__databaseBackupDirectory** attribute. :return: self.__databaseBackupDirectory. ( String ) """ @@ -329,7 +329,7 @@ def databaseBackupDirectory(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def databaseBackupDirectory(self, value): """ - This method is the setter method for **self.__databaseBackupDirectory** attribute. + Setter for **self.__databaseBackupDirectory** attribute. :param value: Attribute value. ( Object ) """ @@ -341,7 +341,7 @@ def databaseBackupDirectory(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def databaseBackupDirectory(self): """ - This method is the deleter method for **self.__databaseBackupDirectory** attribute. + Deleter for **self.__databaseBackupDirectory** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -350,7 +350,7 @@ def databaseBackupDirectory(self): @property def databaseBackupCount(self): """ - This method is the property for **self.__databaseBackupCount** attribute. + Property for **self.__databaseBackupCount** attribute. :return: self.__databaseBackupCount. ( String ) """ @@ -361,7 +361,7 @@ def databaseBackupCount(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def databaseBackupCount(self, value): """ - This method is the setter method for **self.__databaseBackupCount** attribute. + Setter for **self.__databaseBackupCount** attribute. :param value: Attribute value. ( Object ) """ @@ -373,7 +373,7 @@ def databaseBackupCount(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def databaseBackupCount(self): """ - This method is the deleter method for **self.__databaseBackupCount** attribute. + Deleter for **self.__databaseBackupCount** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -384,7 +384,7 @@ def databaseBackupCount(self): #****************************************************************************************************************** def activate(self, engine): """ - This method activates the Component. + Activates the Component. :param engine: Engine to attach the Component to. ( QObject ) :return: Method success. ( Boolean ) @@ -400,7 +400,7 @@ def activate(self, engine): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def deactivate(self): """ - This method deactivates the Component. + Deactivates the Component. """ raise foundations.exceptions.ProgrammingError( @@ -408,7 +408,7 @@ def deactivate(self): def initialize(self): """ - This method initializes the Component. + Initializes the Component. :return: Method success. ( Boolean ) """ @@ -464,7 +464,7 @@ def initialize(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uninitialize(self): """ - This method uninitializes the Component. + Uninitializes the Component. """ raise foundations.exceptions.ProgrammingError( @@ -472,7 +472,7 @@ def uninitialize(self): def commit(self): """ - This method commits pending changes in the Database. + Commits pending changes in the Database. :return: Method success. ( Boolean ) """ diff --git a/sibl_gui/components/core/database/nodes.py b/sibl_gui/components/core/database/nodes.py index 1cc90b37..04bc1802 100644 --- a/sibl_gui/components/core/database/nodes.py +++ b/sibl_gui/components/core/database/nodes.py @@ -60,7 +60,7 @@ #********************************************************************************************************************** def getTemplateUserName(title, software): """ - This method returns the Template user name. + Returns the Template user name. :param title: Template title. ( String ) :param software: Template software. ( String ) @@ -89,7 +89,7 @@ def __init__(self, iconPlaceholder=None, **kwargs): """ - This method initializes the class. + Initializes the class. :param databaseItem: Database object. ( Object ) :param name: Node name. ( String ) @@ -127,7 +127,7 @@ def __init__(self, @property def databaseItem(self): """ - This method is the property for **self.__databaseItem** attribute. + Property for **self.__databaseItem** attribute. :return: self.__databaseItem. ( Object ) """ @@ -138,7 +138,7 @@ def databaseItem(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def databaseItem(self, value): """ - This method is the setter method for **self.__databaseItem** attribute. + Setter for **self.__databaseItem** attribute. :param value: Attribute value. ( Object ) """ @@ -150,7 +150,7 @@ def databaseItem(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def databaseItem(self): """ - This method is the deleter method for **self.__databaseItem** attribute. + Deleter for **self.__databaseItem** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -159,7 +159,7 @@ def databaseItem(self): @property def toolTipText(self): """ - This method is the property for **self.__toolTipText** attribute. + Property for **self.__toolTipText** attribute. :return: self.__toolTipText. ( String ) """ @@ -170,7 +170,7 @@ def toolTipText(self): @foundations.exceptions.handleExceptions(AssertionError) def toolTipText(self, value): """ - This method is the setter method for **self.__toolTipText** attribute. + Setter for **self.__toolTipText** attribute. :param value: Attribute value. ( String ) """ @@ -184,7 +184,7 @@ def toolTipText(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def toolTipText(self): """ - This method is the deleter method for **self.__toolTipText** attribute. + Deleter for **self.__toolTipText** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -195,7 +195,7 @@ def toolTipText(self): #****************************************************************************************************************** def __initializeNode(self, attributesFlags=int(Qt.ItemIsSelectable | Qt.ItemIsEnabled)): """ - This method initializes the node. + Initializes the node. :param attributesFlags: Attributes flags. ( Integer ) """ @@ -212,7 +212,7 @@ def __initializeNode(self, attributesFlags=int(Qt.ItemIsSelectable | Qt.ItemIsEn def updateNode(self): """ - This method updates the Node from the database item. + Updates the Node from the database item. :return: Method success. ( Boolean ) """ @@ -222,7 +222,7 @@ def updateNode(self): def updateNodeAttributes(self): """ - This method updates the Node attributes from the database item attributes. + Updates the Node attributes from the database item attributes. :return: Method success. ( Boolean ) """ @@ -239,7 +239,7 @@ def updateNodeAttributes(self): def updateDatabaseItem(self): """ - This method updates the database item from the node. + Updates the database item from the node. :return: Method success. ( Boolean ) """ @@ -249,7 +249,7 @@ def updateDatabaseItem(self): def updateDatabaseItemAttributes(self): """ - This method updates the database item attributes from the Node attributes. + Updates the database item attributes from the Node attributes. :return: Method success. ( Boolean ) """ @@ -266,7 +266,7 @@ def updateDatabaseItemAttributes(self): @foundations.exceptions.handleExceptions(NotImplementedError) def updateToolTip(self): """ - This method updates the Node tooltip. + Updates the Node tooltip. :return: Method success. ( Boolean ) """ @@ -295,7 +295,7 @@ def __init__(self, iconPlaceholder=None, **kwargs): """ - This method initializes the class. + Initializes the class. :param databaseItem: Database object. ( Object ) :param name: Node name. ( String ) @@ -342,7 +342,7 @@ def __init__(self, @property def iconPath(self): """ - This method is the property for **self.__iconPath** attribute. + Property for **self.__iconPath** attribute. :return: self.__iconPath. ( String ) """ @@ -353,7 +353,7 @@ def iconPath(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iconPath(self, value): """ - This method is the setter method for **self.__iconPath** attribute. + Setter for **self.__iconPath** attribute. :param value: Attribute value. ( String ) """ @@ -365,7 +365,7 @@ def iconPath(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iconPath(self): """ - This method is the deleter method for **self.__iconPath** attribute. + Deleter for **self.__iconPath** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -448,7 +448,7 @@ def __init__(self, iconPlaceholder=None, **kwargs): """ - This method initializes the class. + Initializes the class. :param databaseItem: Database object. ( Object ) :param name: Node name. ( String ) @@ -564,7 +564,7 @@ def __init__(self, iconPlaceholder=None, **kwargs): """ - This method initializes the class. + Initializes the class. :param databaseItem: Database object. ( Object ) :param name: Node name. ( String ) diff --git a/sibl_gui/components/core/database/operations.py b/sibl_gui/components/core/database/operations.py index 336320d9..b74a2cea 100644 --- a/sibl_gui/components/core/database/operations.py +++ b/sibl_gui/components/core/database/operations.py @@ -107,7 +107,7 @@ #********************************************************************************************************************** def createSession(): """ - This definition creates a default session. + Creates a default session. :return: Database session. ( Session ) """ @@ -116,7 +116,7 @@ def createSession(): def getSession(session=None): """ - This definition returns either given session or the default one. + Returns either given session or the default one. :param session: Database session. ( Session ) :return: Database session. ( Session ) @@ -132,7 +132,7 @@ def getSession(session=None): def query(*args, **kwargs): """ - This definition queries given session or the default one. + Queries given session or the default one. :param \*args: Arguments. ( \* ) :param \*\*kwargs: Keywords arguments. ( \*\* ) @@ -144,7 +144,7 @@ def query(*args, **kwargs): @foundations.exceptions.handleExceptions(sibl_gui.components.core.database.exceptions.DatabaseOperationError) def commit(session=None): """ - This definition commits changes to the Database. + Commits changes to the Database. :param session: Database session. ( Session ) :return: Database commit success. ( Boolean ) @@ -162,7 +162,7 @@ def commit(session=None): def addItem(item, session=None): """ - This definition adds an item to the Database. + Adds an item to the Database. :param item: Item to add. ( Database object ) :param session: Database session. ( Session ) @@ -177,7 +177,7 @@ def addItem(item, session=None): def addStandardItem(type, name, path, collection, session=None): """ - This definition adds a new standard item to the Database. + Adds a new standard item to the Database. :param type: Item type. ( Object ) :param name: Item name. ( String ) @@ -202,7 +202,7 @@ def addStandardItem(type, name, path, collection, session=None): def removeItem(item, session=None): """ - This definition removes an item from the Database. + Removes an item from the Database. :param item: Item to remove. ( Database object ) :param session: Database session. ( Session ) @@ -217,7 +217,7 @@ def removeItem(item, session=None): def removeStandardItem(type, identity, session=None): """ - This definition removes a standard item from the Database. + Removes a standard item from the Database. :param type: Item type. ( Object ) :param identity: Item id. ( String ) @@ -232,7 +232,7 @@ def removeStandardItem(type, identity, session=None): def updateItemContent(item, session=None): """ - This definition update an item content. + Update an item content. :param item: Item to set content. ( IblSet ) :param session: Database session. ( Session ) @@ -252,7 +252,7 @@ def updateItemContent(item, session=None): def updateItemLocation(item, path, session=None): """ - This definition updates an item location. + Updates an item location. :param item: Item to update. ( Object ) :param path: Item path. ( Path ) @@ -275,7 +275,7 @@ def updateItemLocation(item, path, session=None): def filterItems(items, pattern, field, flags=0): """ - This definition filters items from the Database. + Filters items from the Database. :param items: Database items. ( List ) :param pattern: Filtering pattern. ( String ) @@ -288,7 +288,7 @@ def filterItems(items, pattern, field, flags=0): def itemExists(items, pattern, field, flags=0): """ - This definition returns if given item exists in the Database. + Returns if given item exists in the Database. :param items: Database items. ( List ) :param pattern: Filtering pattern. ( String ) @@ -301,7 +301,7 @@ def itemExists(items, pattern, field, flags=0): def getIblSets(session=None): """ - This definition returns the Ibl Sets from the Database. + Returns the Ibl Sets from the Database. :param session: Database session. ( Session ) :return: Database Ibl Sets. ( List ) @@ -311,7 +311,7 @@ def getIblSets(session=None): def filterIblSets(pattern, field, flags=0, session=None): """ - This definition filters the sets from the Database. + Filters the sets from the Database. :param pattern: Filtering pattern. ( String ) :param field: Database field to search into. ( String ) @@ -324,7 +324,7 @@ def filterIblSets(pattern, field, flags=0, session=None): def iblSetExists(path, session=None): """ - This method returns if given Ibl Set exists in the Database. + Returns if given Ibl Set exists in the Database. :param name: Ibl Set path. ( String ) :param session: Database session. ( Session ) @@ -335,7 +335,7 @@ def iblSetExists(path, session=None): def addIblSet(name, path, collection, session=None): """ - This definition adds a new Ibl Set to the Database. + Adds a new Ibl Set to the Database. :param name: Ibl Set name. ( String ) :param path: Ibl Set path. ( String ) @@ -348,7 +348,7 @@ def addIblSet(name, path, collection, session=None): def removeIblSet(identity, session=None): """ - This definition removes an Ibl Set from the Database. + Removes an Ibl Set from the Database. :param identity: Ibl Set id. ( String ) :param session: Database session. ( Session ) @@ -359,7 +359,7 @@ def removeIblSet(identity, session=None): def updateIblSetContent(iblSet, session=None): """ - This definition update an Ibl Set content. + Update an Ibl Set content. :param iblSet: Ibl Set to set content. ( IblSet ) :param session: Database session. ( Session ) @@ -370,7 +370,7 @@ def updateIblSetContent(iblSet, session=None): def updateIblSetLocation(iblSet, path, session=None): """ - This definition updates an Ibl Set location. + Updates an Ibl Set location. :param iblSet: Ibl Set to update. ( IblSet ) :param path: Ibl Set path. ( Path ) @@ -382,7 +382,7 @@ def updateIblSetLocation(iblSet, path, session=None): def checkIblSetsTableIntegrity(session=None): """ - This definition checks sets table integrity. + Checks sets table integrity. :param session: Database session. ( Session ) :return: Ibl Sets table erroneous items. ( Dictionary ) @@ -422,7 +422,7 @@ def checkIblSetsTableIntegrity(session=None): def getCollections(session=None): """ - This definition returns the Collections from the Database. + Returns the Collections from the Database. :param session: Database session. ( Session ) :return: Database Collections. ( List ) @@ -432,7 +432,7 @@ def getCollections(session=None): def filterCollections(pattern, field, flags=0, session=None): """ - This definition filters the Collections from the Database. + Filters the Collections from the Database. :param pattern: Filtering pattern. ( String ) :param field: Database field to search into. ( String ) @@ -445,7 +445,7 @@ def filterCollections(pattern, field, flags=0, session=None): def getCollectionsByType(type, session=None): """ - This method returns Collections of given type. + Returns Collections of given type. :param type: Type name. ( String ) :param session: Database session. ( Session ) @@ -456,7 +456,7 @@ def getCollectionsByType(type, session=None): def filterCollectionsByType(type, pattern, field, flags=0, session=None): """ - This definition filters the Ibl Sets Collections from the Database. + Filters the Ibl Sets Collections from the Database. :param type: Type name. ( String ) :param pattern: Filtering pattern. ( String ) @@ -471,7 +471,7 @@ def filterCollectionsByType(type, pattern, field, flags=0, session=None): def filterIblSetsCollections(pattern, field, flags=0, session=None): """ - This definition filters the Ibl Sets Collections from the Database. + Filters the Ibl Sets Collections from the Database. :param pattern: Filtering pattern. ( String ) :param field: Database field to search into. ( String ) @@ -484,7 +484,7 @@ def filterIblSetsCollections(pattern, field, flags=0, session=None): def filterTemplatesCollections(pattern, field, flags=0, session=None): """ - This definition filters the Templates Collections from the Database. + Filters the Templates Collections from the Database. :param pattern: Filtering pattern. ( String ) :param field: Database field to search into. ( String ) @@ -497,7 +497,7 @@ def filterTemplatesCollections(pattern, field, flags=0, session=None): def collectionExists(name, session=None): """ - This method returns if the Collection exists in the Database. + Returns if the Collection exists in the Database. :param name: Collection name. ( String ) :param session: Database session. ( Session ) @@ -508,7 +508,7 @@ def collectionExists(name, session=None): def addCollection(collection, type, comment, session=None): """ - This definition adds a Collection to the Database. + Adds a Collection to the Database. :param collection: Collection name. ( String ) :param type: Collection type. ( String ) @@ -530,7 +530,7 @@ def addCollection(collection, type, comment, session=None): def removeCollection(identity, session=None): """ - This definition removes a Collection from the Database. + Removes a Collection from the Database. :param identity: Collection id. ( String ) :param session: Database session. ( Session ) @@ -541,7 +541,7 @@ def removeCollection(identity, session=None): def getCollectionsIblSets(identities, session=None): """ - This definition returns Ibl Sets from Collections ids + Returns Ibl Sets from Collections ids :param identities: Collections ids. ( List ) :param session: Database session. ( Session ) @@ -558,7 +558,7 @@ def getCollectionsIblSets(identities, session=None): def getCollectionIblSetsCount(collection, session=None): """ - This method returns given Collection Ibl Sets count. + Returns given Collection Ibl Sets count. :param collection: Collection. ( Collection ) :param session: Database session. ( Session ) @@ -569,7 +569,7 @@ def getCollectionIblSetsCount(collection, session=None): def getCollectionTemplatesCount(collection, session=None): """ - This method returns given Collection Tempates count. + Returns given Collection Tempates count. :param collection: Collection. ( Collection ) :param session: Database session. ( Session ) @@ -580,7 +580,7 @@ def getCollectionTemplatesCount(collection, session=None): def getTemplates(session=None): """ - This definition returns the Templates from the Database. + Returns the Templates from the Database. :param session: Database session. ( Session ) :return: Database Templates. ( List ) @@ -590,7 +590,7 @@ def getTemplates(session=None): def filterTemplates(pattern, field, flags=0, session=None): """ - This definition filters the Templates from the Database. + Filters the Templates from the Database. :param pattern: Filtering pattern. ( String ) :param field: Database field to search into. ( String ) @@ -603,7 +603,7 @@ def filterTemplates(pattern, field, flags=0, session=None): def templateExists(path, session=None): """ - This method returns if given Template exists in the Database. + Returns if given Template exists in the Database. :param name: Template path. ( String ) :param session: Database session. ( Session ) @@ -614,7 +614,7 @@ def templateExists(path, session=None): def addTemplate(name, path, collection, session=None): """ - This definition adds a new Template to the Database. + Adds a new Template to the Database. :param name: Template name. ( String ) :param path: Template path. ( String ) @@ -627,7 +627,7 @@ def addTemplate(name, path, collection, session=None): def removeTemplate(identity, session=None): """ - This definition removes a Template from the Database. + Removes a Template from the Database. :param identity: Template id. ( String ) :param session: Database session. ( Session ) @@ -638,7 +638,7 @@ def removeTemplate(identity, session=None): def updateTemplateContent(template, session=None): """ - This definition update a Template content. + Update a Template content. :param template: Template to Template content. ( Template ) :param session: Database session. ( Session ) @@ -649,7 +649,7 @@ def updateTemplateContent(template, session=None): def updateTemplateLocation(template, path, session=None): """ - This definition updates a Template location. + Updates a Template location. :param template: Template to update. ( Template ) :param path: Template path. ( Path ) @@ -661,7 +661,7 @@ def updateTemplateLocation(template, path, session=None): def checkTemplatesTableIntegrity(session=None): """ - This definition checks Templates table integrity. + Checks Templates table integrity. :param session: Database session. ( Session ) :return: Templates table erroneous items. ( Dictionary ) diff --git a/sibl_gui/components/core/database/types.py b/sibl_gui/components/core/database/types.py index 6e849daa..a3a8cae6 100644 --- a/sibl_gui/components/core/database/types.py +++ b/sibl_gui/components/core/database/types.py @@ -102,7 +102,7 @@ def __init__(self, time=None, comment=None): """ - This method initializes the class. + Initializes the class. :param name: Ibl Set name. ( String ) :param path: Ibl Set file path. ( String ) @@ -149,7 +149,7 @@ def __init__(self, @foundations.exceptions.handleExceptions(foundations.exceptions.FileStructureParsingError) def setContent(self): """ - This method initializes the class attributes. + Initializes the class attributes. :return: Method success. ( Boolean ) """ @@ -232,7 +232,7 @@ def __init__(self, outputScript=None, comment=None): """ - This method initializes the class. + Initializes the class. :param name: Template name. ( String ) :param path: Template file path. ( String ) @@ -275,7 +275,7 @@ def __init__(self, @foundations.exceptions.handleExceptions(foundations.exceptions.FileStructureParsingError) def setContent(self): """ - This method initializes the class attributes. + Initializes the class attributes. :return: Method success. ( Boolean ) """ @@ -333,7 +333,7 @@ class Collection(Base): def __init__(self, name=None, type=None, comment=None): """ - This method initializes the class. + Initializes the class. :param name: Collection name. ( String ) :param type: Collection type. ( String ) diff --git a/sibl_gui/components/core/iblSetsOutliner/iblSetsOutliner.py b/sibl_gui/components/core/iblSetsOutliner/iblSetsOutliner.py index ff5a52b1..9f243377 100644 --- a/sibl_gui/components/core/iblSetsOutliner/iblSetsOutliner.py +++ b/sibl_gui/components/core/iblSetsOutliner/iblSetsOutliner.py @@ -110,7 +110,7 @@ class IblSetsOutliner(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): def __init__(self, parent=None, name=None, *args, **kwargs): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param name: Component name. ( String ) @@ -183,7 +183,7 @@ def __init__(self, parent=None, name=None, *args, **kwargs): @property def uiResourcesDirectory(self): """ - This method is the property for **self.__uiResourcesDirectory** attribute. + Property for **self.__uiResourcesDirectory** attribute. :return: self.__uiResourcesDirectory. ( String ) """ @@ -194,7 +194,7 @@ def uiResourcesDirectory(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiResourcesDirectory(self, value): """ - This method is the setter method for **self.__uiResourcesDirectory** attribute. + Setter for **self.__uiResourcesDirectory** attribute. :param value: Attribute value. ( String ) """ @@ -206,7 +206,7 @@ def uiResourcesDirectory(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiResourcesDirectory(self): """ - This method is the deleter method for **self.__uiResourcesDirectory** attribute. + Deleter for **self.__uiResourcesDirectory** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -215,7 +215,7 @@ def uiResourcesDirectory(self): @property def uiThumbnailsViewImage(self): """ - This method is the property for **self.__uiThumbnailsViewImage** attribute. + Property for **self.__uiThumbnailsViewImage** attribute. :return: self.__uiThumbnailsViewImage. ( String ) """ @@ -226,7 +226,7 @@ def uiThumbnailsViewImage(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiThumbnailsViewImage(self, value): """ - This method is the setter method for **self.__uiThumbnailsViewImage** attribute. + Setter for **self.__uiThumbnailsViewImage** attribute. :param value: Attribute value. ( String ) """ @@ -238,7 +238,7 @@ def uiThumbnailsViewImage(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiThumbnailsViewImage(self): """ - This method is the deleter method for **self.__uiThumbnailsViewImage** attribute. + Deleter for **self.__uiThumbnailsViewImage** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -247,7 +247,7 @@ def uiThumbnailsViewImage(self): @property def uiColumnsViewImage(self): """ - This method is the property for **self.__uiColumnsViewImage** attribute. + Property for **self.__uiColumnsViewImage** attribute. :return: self.__uiColumnsViewImage. ( String ) """ @@ -258,7 +258,7 @@ def uiColumnsViewImage(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiColumnsViewImage(self, value): """ - This method is the setter method for **self.__uiColumnsViewImage** attribute. + Setter for **self.__uiColumnsViewImage** attribute. :param value: Attribute value. ( String ) """ @@ -270,7 +270,7 @@ def uiColumnsViewImage(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiColumnsViewImage(self): """ - This method is the deleter method for **self.__uiColumnsViewImage** attribute. + Deleter for **self.__uiColumnsViewImage** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -279,7 +279,7 @@ def uiColumnsViewImage(self): @property def uiDetailsViewImage(self): """ - This method is the property for **self.__uiDetailsViewImage** attribute. + Property for **self.__uiDetailsViewImage** attribute. :return: self.__uiDetailsViewImage. ( String ) """ @@ -290,7 +290,7 @@ def uiDetailsViewImage(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiDetailsViewImage(self, value): """ - This method is the setter method for **self.__uiDetailsViewImage** attribute. + Setter for **self.__uiDetailsViewImage** attribute. :param value: Attribute value. ( String ) """ @@ -302,7 +302,7 @@ def uiDetailsViewImage(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiDetailsViewImage(self): """ - This method is the deleter method for **self.__uiDetailsViewImage** attribute. + Deleter for **self.__uiDetailsViewImage** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -311,7 +311,7 @@ def uiDetailsViewImage(self): @property def uiLargestSizeImage(self): """ - This method is the property for **self.__uiLargestSizeImage** attribute. + Property for **self.__uiLargestSizeImage** attribute. :return: self.__uiLargestSizeImage. ( String ) """ @@ -322,7 +322,7 @@ def uiLargestSizeImage(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiLargestSizeImage(self, value): """ - This method is the setter method for **self.__uiLargestSizeImage** attribute. + Setter for **self.__uiLargestSizeImage** attribute. :param value: Attribute value. ( String ) """ @@ -334,7 +334,7 @@ def uiLargestSizeImage(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiLargestSizeImage(self): """ - This method is the deleter method for **self.__uiLargestSizeImage** attribute. + Deleter for **self.__uiLargestSizeImage** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -343,7 +343,7 @@ def uiLargestSizeImage(self): @property def uiSmallestSizeImage(self): """ - This method is the property for **self.__uiSmallestSizeImage** attribute. + Property for **self.__uiSmallestSizeImage** attribute. :return: self.__uiSmallestSizeImage. ( String ) """ @@ -354,7 +354,7 @@ def uiSmallestSizeImage(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiSmallestSizeImage(self, value): """ - This method is the setter method for **self.__uiSmallestSizeImage** attribute. + Setter for **self.__uiSmallestSizeImage** attribute. :param value: Attribute value. ( String ) """ @@ -366,7 +366,7 @@ def uiSmallestSizeImage(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiSmallestSizeImage(self): """ - This method is the deleter method for **self.__uiSmallestSizeImage** attribute. + Deleter for **self.__uiSmallestSizeImage** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -375,7 +375,7 @@ def uiSmallestSizeImage(self): @property def uiPanoramicLoadingImage(self): """ - This method is the property for **self.__uiPanoramicLoadingImage** attribute. + Property for **self.__uiPanoramicLoadingImage** attribute. :return: self.__uiPanoramicLoadingImage. ( String ) """ @@ -386,7 +386,7 @@ def uiPanoramicLoadingImage(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiPanoramicLoadingImage(self, value): """ - This method is the setter method for **self.__uiPanoramicLoadingImage** attribute. + Setter for **self.__uiPanoramicLoadingImage** attribute. :param value: Attribute value. ( String ) """ @@ -398,7 +398,7 @@ def uiPanoramicLoadingImage(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiPanoramicLoadingImage(self): """ - This method is the deleter method for **self.__uiPanoramicLoadingImage** attribute. + Deleter for **self.__uiPanoramicLoadingImage** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -407,7 +407,7 @@ def uiPanoramicLoadingImage(self): @property def uiSquareLoadingImage(self): """ - This method is the property for **self.__uiSquareLoadingImage** attribute. + Property for **self.__uiSquareLoadingImage** attribute. :return: self.__uiSquareLoadingImage. ( String ) """ @@ -418,7 +418,7 @@ def uiSquareLoadingImage(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiSquareLoadingImage(self, value): """ - This method is the setter method for **self.__uiSquareLoadingImage** attribute. + Setter for **self.__uiSquareLoadingImage** attribute. :param value: Attribute value. ( String ) """ @@ -430,7 +430,7 @@ def uiSquareLoadingImage(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiSquareLoadingImage(self): """ - This method is the deleter method for **self.__uiSquareLoadingImage** attribute. + Deleter for **self.__uiSquareLoadingImage** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -438,7 +438,7 @@ def uiSquareLoadingImage(self): @property def uiSwitchThumbnailsTypeImage(self): """ - This method is the property for **self.__uiSwitchThumbnailsTypeImage** attribute. + Property for **self.__uiSwitchThumbnailsTypeImage** attribute. :return: self.__uiSwitchThumbnailsTypeImage. ( String ) """ @@ -449,7 +449,7 @@ def uiSwitchThumbnailsTypeImage(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiSwitchThumbnailsTypeImage(self, value): """ - This method is the setter method for **self.__uiSwitchThumbnailsTypeImage** attribute. + Setter for **self.__uiSwitchThumbnailsTypeImage** attribute. :param value: Attribute value. ( String ) """ @@ -461,7 +461,7 @@ def uiSwitchThumbnailsTypeImage(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiSwitchThumbnailsTypeImage(self): """ - This method is the deleter method for **self.__uiSwitchThumbnailsTypeImage** attribute. + Deleter for **self.__uiSwitchThumbnailsTypeImage** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -470,7 +470,7 @@ def uiSwitchThumbnailsTypeImage(self): @property def dockArea(self): """ - This method is the property for **self.__dockArea** attribute. + Property for **self.__dockArea** attribute. :return: self.__dockArea. ( Integer ) """ @@ -481,7 +481,7 @@ def dockArea(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def dockArea(self, value): """ - This method is the setter method for **self.__dockArea** attribute. + Setter for **self.__dockArea** attribute. :param value: Attribute value. ( Integer ) """ @@ -493,7 +493,7 @@ def dockArea(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def dockArea(self): """ - This method is the deleter method for **self.__dockArea** attribute. + Deleter for **self.__dockArea** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -502,7 +502,7 @@ def dockArea(self): @property def engine(self): """ - This method is the property for **self.__engine** attribute. + Property for **self.__engine** attribute. :return: self.__engine. ( QObject ) """ @@ -513,7 +513,7 @@ def engine(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self, value): """ - This method is the setter method for **self.__engine** attribute. + Setter for **self.__engine** attribute. :param value: Attribute value. ( QObject ) """ @@ -525,7 +525,7 @@ def engine(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self): """ - This method is the deleter method for **self.__engine** attribute. + Deleter for **self.__engine** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -534,7 +534,7 @@ def engine(self): @property def settings(self): """ - This method is the property for **self.__settings** attribute. + Property for **self.__settings** attribute. :return: self.__settings. ( QSettings ) """ @@ -545,7 +545,7 @@ def settings(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settings(self, value): """ - This method is the setter method for **self.__settings** attribute. + Setter for **self.__settings** attribute. :param value: Attribute value. ( QSettings ) """ @@ -557,7 +557,7 @@ def settings(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settings(self): """ - This method is the deleter method for **self.__settings** attribute. + Deleter for **self.__settings** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -566,7 +566,7 @@ def settings(self): @property def settingsSection(self): """ - This method is the property for **self.__settingsSection** attribute. + Property for **self.__settingsSection** attribute. :return: self.__settingsSection. ( String ) """ @@ -577,7 +577,7 @@ def settingsSection(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settingsSection(self, value): """ - This method is the setter method for **self.__settingsSection** attribute. + Setter for **self.__settingsSection** attribute. :param value: Attribute value. ( String ) """ @@ -589,7 +589,7 @@ def settingsSection(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settingsSection(self): """ - This method is the deleter method for **self.__settingsSection** attribute. + Deleter for **self.__settingsSection** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -598,7 +598,7 @@ def settingsSection(self): @property def settingsSeparator(self): """ - This method is the property for **self.__settingsSeparator** attribute. + Property for **self.__settingsSeparator** attribute. :return: self.__settingsSeparator. ( String ) """ @@ -609,7 +609,7 @@ def settingsSeparator(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settingsSeparator(self, value): """ - This method is the setter method for **self.__settingsSeparator** attribute. + Setter for **self.__settingsSeparator** attribute. :param value: Attribute value. ( String ) """ @@ -621,7 +621,7 @@ def settingsSeparator(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settingsSeparator(self): """ - This method is the deleter method for **self.__settingsSeparator** attribute. + Deleter for **self.__settingsSeparator** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -630,7 +630,7 @@ def settingsSeparator(self): @property def extension(self): """ - This method is the property for **self.__extension** attribute. + Property for **self.__extension** attribute. :return: self.__extension. ( String ) """ @@ -641,7 +641,7 @@ def extension(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def extension(self, value): """ - This method is the setter method for **self.__extension** attribute. + Setter for **self.__extension** attribute. :param value: Attribute value. ( String ) """ @@ -653,7 +653,7 @@ def extension(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def extension(self): """ - This method is the deleter method for **self.__extension** attribute. + Deleter for **self.__extension** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -662,7 +662,7 @@ def extension(self): @property def inspectLayout(self): """ - This method is the property for **self.__inspectLayout** attribute. + Property for **self.__inspectLayout** attribute. :return: self.__inspectLayout. ( String ) """ @@ -673,7 +673,7 @@ def inspectLayout(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def inspectLayout(self, value): """ - This method is the setter method for **self.__inspectLayout** attribute. + Setter for **self.__inspectLayout** attribute. :param value: Attribute value. ( String ) """ @@ -685,7 +685,7 @@ def inspectLayout(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def inspectLayout(self): """ - This method is the deleter method for **self.__inspectLayout** attribute. + Deleter for **self.__inspectLayout** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -694,7 +694,7 @@ def inspectLayout(self): @property def scriptEditor(self): """ - This method is the property for **self.__scriptEditor** attribute. + Property for **self.__scriptEditor** attribute. :return: self.__scriptEditor. ( QWidget ) """ @@ -705,7 +705,7 @@ def scriptEditor(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def scriptEditor(self, value): """ - This method is the setter method for **self.__scriptEditor** attribute. + Setter for **self.__scriptEditor** attribute. :param value: Attribute value. ( QWidget ) """ @@ -717,7 +717,7 @@ def scriptEditor(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def scriptEditor(self): """ - This method is the deleter method for **self.__scriptEditor** attribute. + Deleter for **self.__scriptEditor** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -726,7 +726,7 @@ def scriptEditor(self): @property def collectionsOutliner(self): """ - This method is the property for **self.__collectionsOutliner** attribute. + Property for **self.__collectionsOutliner** attribute. :return: self.__collectionsOutliner. ( QWidget ) """ @@ -737,7 +737,7 @@ def collectionsOutliner(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def collectionsOutliner(self, value): """ - This method is the setter method for **self.__collectionsOutliner** attribute. + Setter for **self.__collectionsOutliner** attribute. :param value: Attribute value. ( QWidget ) """ @@ -749,7 +749,7 @@ def collectionsOutliner(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def collectionsOutliner(self): """ - This method is the deleter method for **self.__collectionsOutliner** attribute. + Deleter for **self.__collectionsOutliner** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -758,7 +758,7 @@ def collectionsOutliner(self): @property def model(self): """ - This method is the property for **self.__model** attribute. + Property for **self.__model** attribute. :return: self.__model. ( IblSetsModel ) """ @@ -769,7 +769,7 @@ def model(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def model(self, value): """ - This method is the setter method for **self.__model** attribute. + Setter for **self.__model** attribute. :param value: Attribute value. ( IblSetsModel ) """ @@ -781,7 +781,7 @@ def model(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def model(self): """ - This method is the deleter method for **self.__model** attribute. + Deleter for **self.__model** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -790,7 +790,7 @@ def model(self): @property def views(self): """ - This method is the property for **self.__views** attribute. + Property for **self.__views** attribute. :return: self.__views. ( Tuple ) """ @@ -801,7 +801,7 @@ def views(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def views(self, value): """ - This method is the setter method for **self.__views** attribute. + Setter for **self.__views** attribute. :param value: Attribute value. ( Tuple ) """ @@ -813,7 +813,7 @@ def views(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def views(self): """ - This method is the deleter method for **self.__views** attribute. + Deleter for **self.__views** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -822,7 +822,7 @@ def views(self): @property def viewsPushButtons(self): """ - This method is the property for **self.__viewsPushButtons** attribute. + Property for **self.__viewsPushButtons** attribute. :return: self.__viewsPushButtons. ( Dictionary ) """ @@ -833,7 +833,7 @@ def viewsPushButtons(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def viewsPushButtons(self, value): """ - This method is the setter method for **self.__viewsPushButtons** attribute. + Setter for **self.__viewsPushButtons** attribute. :param value: Attribute value. ( Dictionary ) """ @@ -845,7 +845,7 @@ def viewsPushButtons(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def viewsPushButtons(self): """ - This method is the deleter method for **self.__viewsPushButtons** attribute. + Deleter for **self.__viewsPushButtons** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -854,7 +854,7 @@ def viewsPushButtons(self): @property def thumbnailsView(self): """ - This method is the property for **self.__thumbnailsView** attribute. + Property for **self.__thumbnailsView** attribute. :return: self.__thumbnailsView. ( QListView ) """ @@ -865,7 +865,7 @@ def thumbnailsView(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def thumbnailsView(self, value): """ - This method is the setter method for **self.__thumbnailsView** attribute. + Setter for **self.__thumbnailsView** attribute. :param value: Attribute value. ( QListView ) """ @@ -877,7 +877,7 @@ def thumbnailsView(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def thumbnailsView(self): """ - This method is the deleter method for **self.__thumbnailsView** attribute. + Deleter for **self.__thumbnailsView** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -886,7 +886,7 @@ def thumbnailsView(self): @property def detailsView(self): """ - This method is the property for **self.__detailsView** attribute. + Property for **self.__detailsView** attribute. :return: self.__detailsView. ( QTreeView ) """ @@ -897,7 +897,7 @@ def detailsView(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def detailsView(self, value): """ - This method is the setter method for **self.__detailsView** attribute. + Setter for **self.__detailsView** attribute. :param value: Attribute value. ( QTreeView ) """ @@ -909,7 +909,7 @@ def detailsView(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def detailsView(self): """ - This method is the deleter method for **self.__detailsView** attribute. + Deleter for **self.__detailsView** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -918,7 +918,7 @@ def detailsView(self): @property def detailsViewHeaders(self): """ - This method is the property for **self.__detailsViewHeaders** attribute. + Property for **self.__detailsViewHeaders** attribute. :return: self.__detailsViewHeaders. ( OrderedDict ) """ @@ -929,7 +929,7 @@ def detailsViewHeaders(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def detailsViewHeaders(self, value): """ - This method is the setter method for **self.__detailsViewHeaders** attribute. + Setter for **self.__detailsViewHeaders** attribute. :param value: Attribute value. ( OrderedDict ) """ @@ -941,7 +941,7 @@ def detailsViewHeaders(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def detailsViewHeaders(self): """ - This method is the deleter method for **self.__detailsViewHeaders** attribute. + Deleter for **self.__detailsViewHeaders** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -950,7 +950,7 @@ def detailsViewHeaders(self): @property def panoramicThumbnails(self): """ - This method is the property for **self.__panoramicThumbnails** attribute. + Property for **self.__panoramicThumbnails** attribute. :return: self.__panoramicThumbnails. ( Boolean ) """ @@ -961,7 +961,7 @@ def panoramicThumbnails(self): @foundations.exceptions.handleExceptions(AssertionError) def panoramicThumbnails(self, value): """ - This method is the setter method for **self.__panoramicThumbnails** attribute. + Setter for **self.__panoramicThumbnails** attribute. :param value: Attribute value. ( Boolean ) """ @@ -974,7 +974,7 @@ def panoramicThumbnails(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def panoramicThumbnails(self): """ - This method is the deleter method for **self.__panoramicThumbnails** attribute. + Deleter for **self.__panoramicThumbnails** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -983,7 +983,7 @@ def panoramicThumbnails(self): @property def panoramicThumbnailsSize(self): """ - This method is the property for **self.__panoramicThumbnailsSize** attribute. + Property for **self.__panoramicThumbnailsSize** attribute. :return: self.__panoramicThumbnailsSize. ( String ) """ @@ -994,7 +994,7 @@ def panoramicThumbnailsSize(self): @foundations.exceptions.handleExceptions(AssertionError) def panoramicThumbnailsSize(self, value): """ - This method is the setter method for **self.__panoramicThumbnailsSize** attribute. + Setter for **self.__panoramicThumbnailsSize** attribute. :param value: Attribute value. ( String ) """ @@ -1007,7 +1007,7 @@ def panoramicThumbnailsSize(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def panoramicThumbnailsSize(self): """ - This method is the deleter method for **self.__panoramicThumbnailsSize** attribute. + Deleter for **self.__panoramicThumbnailsSize** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -1016,7 +1016,7 @@ def panoramicThumbnailsSize(self): @property def squareThumbnailsSize(self): """ - This method is the property for **self.__squareThumbnailsSize** attribute. + Property for **self.__squareThumbnailsSize** attribute. :return: self.__squareThumbnailsSize. ( String ) """ @@ -1027,7 +1027,7 @@ def squareThumbnailsSize(self): @foundations.exceptions.handleExceptions(AssertionError) def squareThumbnailsSize(self, value): """ - This method is the setter method for **self.__squareThumbnailsSize** attribute. + Setter for **self.__squareThumbnailsSize** attribute. :param value: Attribute value. ( String ) """ @@ -1040,7 +1040,7 @@ def squareThumbnailsSize(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def squareThumbnailsSize(self): """ - This method is the deleter method for **self.__squareThumbnailsSize** attribute. + Deleter for **self.__squareThumbnailsSize** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -1049,7 +1049,7 @@ def squareThumbnailsSize(self): @property def thumbnailsMinimumSize(self): """ - This method is the property for **self.__thumbnailsMinimumSize** attribute. + Property for **self.__thumbnailsMinimumSize** attribute. :return: self.__thumbnailsMinimumSize. ( Dictionary ) """ @@ -1060,7 +1060,7 @@ def thumbnailsMinimumSize(self): @foundations.exceptions.handleExceptions(AssertionError) def thumbnailsMinimumSize(self, value): """ - This method is the setter method for **self.__thumbnailsMinimumSize** attribute. + Setter for **self.__thumbnailsMinimumSize** attribute. :param value: Attribute value. ( Dictionary ) """ @@ -1073,7 +1073,7 @@ def thumbnailsMinimumSize(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def thumbnailsMinimumSize(self): """ - This method is the deleter method for **self.__thumbnailsMinimumSize** attribute. + Deleter for **self.__thumbnailsMinimumSize** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -1082,7 +1082,7 @@ def thumbnailsMinimumSize(self): @property def searchContexts(self): """ - This method is the property for **self.__searchContexts** attribute. + Property for **self.__searchContexts** attribute. :return: self.__searchContexts. ( OrderedDict ) """ @@ -1093,7 +1093,7 @@ def searchContexts(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def searchContexts(self, value): """ - This method is the setter method for **self.__searchContexts** attribute. + Setter for **self.__searchContexts** attribute. :param value: Attribute value. ( OrderedDict ) """ @@ -1105,7 +1105,7 @@ def searchContexts(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def searchContexts(self): """ - This method is the deleter method for **self.__searchContexts** attribute. + Deleter for **self.__searchContexts** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -1114,7 +1114,7 @@ def searchContexts(self): @property def activeSearchContext(self): """ - This method is the property for **self.__activeSearchContext** attribute. + Property for **self.__activeSearchContext** attribute. :return: self.__activeSearchContext. ( OrderedDict ) """ @@ -1125,7 +1125,7 @@ def activeSearchContext(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def activeSearchContext(self, value): """ - This method is the setter method for **self.__activeSearchContext** attribute. + Setter for **self.__activeSearchContext** attribute. :param value: Attribute value. ( OrderedDict ) """ @@ -1137,7 +1137,7 @@ def activeSearchContext(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def activeSearchContext(self): """ - This method is the deleter method for **self.__activeSearchContext** attribute. + Deleter for **self.__activeSearchContext** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -1146,7 +1146,7 @@ def activeSearchContext(self): @property def searchContextMenu(self): """ - This method is the property for **self.__searchContextMenu** attribute. + Property for **self.__searchContextMenu** attribute. :return: self.__searchContextMenu. ( QMenu ) """ @@ -1157,7 +1157,7 @@ def searchContextMenu(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def searchContextMenu(self, value): """ - This method is the setter method for **self.__searchContextMenu** attribute. + Setter for **self.__searchContextMenu** attribute. :param value: Attribute value. ( self.__searchContextsMenu ) """ @@ -1169,7 +1169,7 @@ def searchContextMenu(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def searchContextMenu(self): """ - This method is the deleter method for **self.__searchContextMenu** attribute. + Deleter for **self.__searchContextMenu** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -1180,7 +1180,7 @@ def searchContextMenu(self): #****************************************************************************************************************** def activate(self, engine): """ - This method activates the Component. + Activates the Component. :param engine: Engine to attach the Component to. ( QObject ) :return: Method success. ( Boolean ) @@ -1202,7 +1202,7 @@ def activate(self, engine): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def deactivate(self): """ - This method deactivates the Component. + Deactivates the Component. """ raise foundations.exceptions.ProgrammingError( @@ -1210,7 +1210,7 @@ def deactivate(self): def initializeUi(self): """ - This method initializes the Component ui. + Initializes the Component ui. :return: Method success. ( Boolean ) """ @@ -1304,7 +1304,7 @@ def initializeUi(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uninitializeUi(self): """ - This method uninitializes the Component ui. + Uninitializes the Component ui. """ raise foundations.exceptions.ProgrammingError( @@ -1312,7 +1312,7 @@ def uninitializeUi(self): def addWidget(self): """ - This method adds the Component Widget to the engine. + Adds the Component Widget to the engine. :return: Method success. ( Boolean ) """ @@ -1326,7 +1326,7 @@ def addWidget(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def removeWidget(self): """ - This method removes the Component Widget from the engine. + Removes the Component Widget from the engine. """ raise foundations.exceptions.ProgrammingError( @@ -1335,7 +1335,7 @@ def removeWidget(self): @foundations.exceptions.handleExceptions(umbra.exceptions.notifyExceptionHandler, Exception) def onStartup(self): """ - This method is triggered on Framework startup. + Defines the slot triggered on Framework startup. :return: Method success. ( Boolean ) """ @@ -1400,7 +1400,7 @@ def onStartup(self): def onClose(self): """ - This method is triggered on Framework close. + Defines the slot triggered on Framework close. :return: Method success. ( Boolean ) """ @@ -1420,7 +1420,7 @@ def onClose(self): def __views_setUi(self, thumbnailsSize=None): """ - This method sets the Views ui. + Sets the Views ui. :param thumbnailsSize: Thumbnails size. ( Integer ) """ @@ -1444,7 +1444,7 @@ def __views_setUi(self, thumbnailsSize=None): def __views_refreshUi(self, thumbnailsSize=None): """ - This method refreshes the Views ui. + Refreshes the Views ui. :param thumbnailsSize: Thumbnails size. ( Integer ) """ @@ -1453,14 +1453,14 @@ def __views_refreshUi(self, thumbnailsSize=None): def __model__refreshNodes(self): """ - This method is triggered when the Model Nodes need refresh. + Defines the slot triggered by the Model when Nodes need refresh. """ self.setIblSets() def __views_addActions(self): """ - This method sets the Views actions. + Sets the Views actions. """ if not self.__engine.parameters.databaseReadOnly: @@ -1493,7 +1493,7 @@ def __views_addActions(self): def __views_addContentAction__triggered(self, checked): """ - This method is triggered by **'Actions|Umbra|Components|core.iblSetsOutliner|Add Content ...'** action. + Defines the slot triggered by **'Actions|Umbra|Components|core.iblSetsOutliner|Add Content ...'** action. :param checked: Action checked state. ( Boolean ) :return: Method success. ( Boolean ) @@ -1503,7 +1503,7 @@ def __views_addContentAction__triggered(self, checked): def __views_addIblSetAction__triggered(self, checked): """ - This method is triggered by **'Actions|Umbra|Components|core.iblSetsOutliner|Add Ibl Set ...'** action. + Defines the slot triggered by **'Actions|Umbra|Components|core.iblSetsOutliner|Add Ibl Set ...'** action. :param checked: Action checked state. ( Boolean ) :return: Method success. ( Boolean ) @@ -1513,7 +1513,7 @@ def __views_addIblSetAction__triggered(self, checked): def __views_removeIblSetsAction__triggered(self, checked): """ - This method is triggered by **'Actions|Umbra|Components|core.iblSetsOutliner|Remove Ibl Set(s) ...'** action. + Defines the slot triggered by **'Actions|Umbra|Components|core.iblSetsOutliner|Remove Ibl Set(s) ...'** action. :param checked: Action checked state. ( Boolean ) :return: Method success. ( Boolean ) @@ -1523,7 +1523,7 @@ def __views_removeIblSetsAction__triggered(self, checked): def __views_updateIblSetsLocationsAction__triggered(self, checked): """ - This method is triggered by + Defines the slot triggered by **'Actions|Umbra|Components|core.iblSetsOutliner|Update Ibl Set(s) Location(s) ...'** action. :param checked: Action checked state. ( Boolean ) @@ -1534,7 +1534,7 @@ def __views_updateIblSetsLocationsAction__triggered(self, checked): def __views_pushButtons__clicked(self, index, checked): """ - This method is triggered when **\*_View_pushButton** Widget is clicked. + Defines the slot triggered by **\*_View_pushButton** Widget when clicked. :param index: Button index. ( Integer ) :param checked: Checked state. ( Boolean ) @@ -1544,7 +1544,7 @@ def __views_pushButtons__clicked(self, index, checked): def __views__doubleClicked(self, index): """ - This method is triggered when a **\*_View** Widget is double clicked. + Defines the slot triggered by a **\*_View** Widget when double clicked. :param index: Clicked item index. ( QModelIndex ) """ @@ -1553,7 +1553,7 @@ def __views__doubleClicked(self, index): def __views__activeViewChanged(self, index): """ - This method is triggered when the active View has changed. + Defines the slot triggered by the active View changed. :param index: Current active View. ( integer ) """ @@ -1565,7 +1565,7 @@ def __views__activeViewChanged(self, index): def __Switch_Thumbnails_Type_pushButton__clicked(self, checked): """ - This method is triggered when **Switch_Thumbnails_Type_pushButton** Widget is clicked. + Defines the slot triggered by **Switch_Thumbnails_Type_pushButton** Widget when clicked. :param checked: Checked state. ( Boolean ) """ @@ -1574,7 +1574,7 @@ def __Switch_Thumbnails_Type_pushButton__clicked(self, checked): def __Search_Database_lineEdit__textChanged(self, text): """ - This method is triggered when **Search_Database_lineEdit** text changes. + Defines the slot triggered by **Search_Database_lineEdit** Widget when text changed. :param text: Current text value. ( QString ) """ @@ -1585,7 +1585,7 @@ def __Search_Database_lineEdit__textChanged(self, text): def __Thumbnails_Size_horizontalSlider__changed(self, value): """ - This method scales the View icons. + Scales the View icons. :param value: Thumbnails size. ( Integer ) """ @@ -1601,7 +1601,7 @@ def __Thumbnails_Size_horizontalSlider__changed(self, value): @umbra.engine.showProcessing("Retrieving Ibl Sets ...") def __engine__contentDropped(self, event): """ - This method is triggered when content is dropped into the engine. + Defines the slot triggered by content when dropped into the engine. :param event: Event. ( QEvent ) """ @@ -1646,7 +1646,7 @@ def __engine__contentDropped(self, event): def __engine_fileSystemEventsManager__fileChanged(self, file): """ - This method is triggered by the **fileSystemEventsManager** when a file is changed. + Defines the slot triggered by **fileSystemEventsManager** when a file is changed. :param file: File changed. ( String ) """ @@ -1663,7 +1663,7 @@ def __engine_fileSystemEventsManager__fileChanged(self, file): def __getCandidateCollectionId(self): """ - This method returns a Collection id. + Returns a Collection id. :return: Collection id. ( Integer ) """ @@ -1676,7 +1676,7 @@ def __getCandidateCollectionId(self): def __searchIblSets(self, pattern, attribute, flags=re.IGNORECASE): """ - This method filters the current Collection Ibl Sets. + Filters the current Collection Ibl Sets. :param pattern: Ibl Sets filter pattern. ( String ) :param attribute: Attribute to filter Ibl Sets on. ( String ) @@ -1703,7 +1703,7 @@ def __searchIblSets(self, pattern, attribute, flags=re.IGNORECASE): def getActiveView(self): """ - This method returns the current active View. + Returns the current active View. :return: Current active View. ( QWidget ) """ @@ -1712,7 +1712,7 @@ def getActiveView(self): def getActiveViewIndex(self): """ - This method returns the current active View index. + Returns the current active View index. :return: Current active View index. ( Integer ) """ @@ -1721,7 +1721,7 @@ def getActiveViewIndex(self): def setActiveView(self, view): """ - This method sets the active View to given View. + Sets the active View to given View. :param view: View. ( QWidget ) :return: Method success. ( Boolean ) @@ -1734,7 +1734,7 @@ def setActiveView(self, view): def setActiveViewIndex(self, index): """ - This method sets the active View to given index. + Sets the active View to given index. :param index: Index. ( Integer ) :return: Method success. ( Boolean ) @@ -1746,7 +1746,7 @@ def setActiveViewIndex(self, index): def setActiveSearchContext(self, context, *args): """ - This method sets the active search context. + Sets the active search context. :param context: Search context. ( String ) :param \*args: Arguments. ( \* ) @@ -1764,7 +1764,7 @@ def setActiveSearchContext(self, context, *args): def setPanoramicThumbnails(self, state): """ - This method sets the panoramic thumbnails. + Sets the panoramic thumbnails. :param state: Panoramic thumbnails. ( Boolean ) :return: Method succes. ( Boolean ) @@ -1789,7 +1789,7 @@ def setPanoramicThumbnails(self, state): @umbra.engine.showProcessing("Adding Content ...") def addContentUi(self): """ - This method adds user defined content to the Database. + Adds user defined content to the Database. :return: Method success. ( Boolean ) @@ -1813,7 +1813,7 @@ def addContentUi(self): @umbra.engine.showProcessing("Adding Ibl Set ...") def addIblSetUi(self): """ - This method adds an user defined Ibl Set to the Database. + Adds an user defined Ibl Set to the Database. :return: Method success. ( Boolean ) @@ -1842,7 +1842,7 @@ def addIblSetUi(self): @umbra.engine.encapsulateProcessing def removeIblSetsUi(self): """ - This method removes user selected Ibl Sets from the Database. + Removes user selected Ibl Sets from the Database. :return: Method success. ( Boolean ) @@ -1875,7 +1875,7 @@ def removeIblSetsUi(self): sibl_gui.components.core.database.exceptions.DatabaseOperationError) def updateIblSetLocationUi(self, iblSet): """ - This method updates given Ibl Set location. + Updates given Ibl Set location. :param iblSet: Ibl Set to update. ( IblSet ) :return: Method success. ( Boolean ) @@ -1903,7 +1903,7 @@ def updateIblSetLocationUi(self, iblSet): @umbra.engine.encapsulateProcessing def updateSelectedIblSetsLocationUi(self): """ - This method updates user selected Ibl Sets locations. + Updates user selected Ibl Sets locations. :return: Method success. ( Boolean ) @@ -1933,7 +1933,7 @@ def updateSelectedIblSetsLocationUi(self): sibl_gui.components.core.database.exceptions.DatabaseOperationError) def addIblSet(self, name, path, collectionId=None): """ - This method adds an Ibl Set to the Database. + Adds an Ibl Set to the Database. :param name: Ibl Set name. ( String ) :param path: Ibl Set path. ( String ) @@ -1958,7 +1958,7 @@ def addIblSet(self, name, path, collectionId=None): @umbra.engine.encapsulateProcessing def addDirectory(self, directory, collectionId=None): """ - This method adds directory Ibl Sets to the Database. + Adds directory Ibl Sets to the Database. :param directory: Directory to add. ( String ) :param collectionId: Target Collection id. ( Integer ) @@ -1992,7 +1992,7 @@ def addDirectory(self, directory, collectionId=None): @foundations.exceptions.handleExceptions(sibl_gui.components.core.database.exceptions.DatabaseOperationError) def removeIblSet(self, iblSet): """ - This method removes given Ibl Set from the Database. + Removes given Ibl Set from the Database. :param iblSet: Ibl Set to remove. ( IblSet ) :return: Method success. ( Boolean ) @@ -2010,7 +2010,7 @@ def removeIblSet(self, iblSet): @foundations.exceptions.handleExceptions(sibl_gui.components.core.database.exceptions.DatabaseOperationError) def updateIblSetLocation(self, iblSet, file): """ - This method updates given Ibl Set location. + Updates given Ibl Set location. :param iblSet: Ibl Set to update. ( IblSet ) :param iblSet: New Ibl Set file. ( String ) @@ -2029,7 +2029,7 @@ def updateIblSetLocation(self, iblSet, file): def getIblSets(self): """ - This method returns Database Ibl Sets. + Returns Database Ibl Sets. :return: Database Ibl Sets. ( List ) """ @@ -2038,7 +2038,7 @@ def getIblSets(self): def filterIblSets(self, pattern, attribute, flags=re.IGNORECASE): """ - This method filters the Database Ibl Sets on given attribute using given pattern. + Filters the Database Ibl Sets on given attribute using given pattern. :param pattern: Filter pattern. ( String ) :param attribute: Attribute to filter on. ( String ) @@ -2058,7 +2058,7 @@ def filterIblSets(self, pattern, attribute, flags=re.IGNORECASE): def iblSetExists(self, path): """ - This method returns if given Ibl Set path exists in the Database. + Returns if given Ibl Set path exists in the Database. :param path: Collection path. ( String ) :return: Collection exists. ( Boolean ) @@ -2068,7 +2068,7 @@ def iblSetExists(self, path): def listIblSets(self): """ - This method lists Database Ibl Sets names. + Lists Database Ibl Sets names. :return: Database Ibl Sets names. ( List ) @@ -2079,7 +2079,7 @@ def listIblSets(self): def setIblSets(self, iblSets=None): """ - This method sets the Ibl Sets Model nodes. + Sets the Ibl Sets Model nodes. :param iblSets: Ibl Sets to set. ( List ) :return: Method success. ( Boolean ) @@ -2123,7 +2123,7 @@ def setIblSets(self, iblSets=None): def getIblSetByName(self, name): """ - This method returns Database Ibl Set with given name. + Returns Database Ibl Set with given name. :param name: Ibl Set name. ( String ) :return: Database Ibl Set. ( IblSet ) @@ -2136,7 +2136,7 @@ def getIblSetByName(self, name): def getSelectedNodes(self): """ - This method returns the current active View selected nodes. + Returns the current active View selected nodes. :return: View selected nodes. ( Dictionary ) """ @@ -2145,7 +2145,7 @@ def getSelectedNodes(self): def getSelectedIblSetsNodes(self): """ - This method returns the current active View selected Ibl Sets nodes. + Returns the current active View selected Ibl Sets nodes. :return: View selected Ibl Sets nodes. ( List ) """ @@ -2154,7 +2154,7 @@ def getSelectedIblSetsNodes(self): def getSelectedIblSets(self): """ - This method returns the current active View selected Ibl Sets. + Returns the current active View selected Ibl Sets. :return: View selected Ibl Sets. ( List ) """ diff --git a/sibl_gui/components/core/iblSetsOutliner/models.py b/sibl_gui/components/core/iblSetsOutliner/models.py index e35dbd98..9a22e54d 100644 --- a/sibl_gui/components/core/iblSetsOutliner/models.py +++ b/sibl_gui/components/core/iblSetsOutliner/models.py @@ -57,7 +57,7 @@ class IblSetsModel(sibl_gui.ui.models.GraphModel): def __init__(self, parent=None, rootNode=None, horizontalHeaders=None, verticalHeaders=None): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param rootNode: Root node. ( AbstractCompositeNode ) @@ -78,7 +78,7 @@ def __init__(self, parent=None, rootNode=None, horizontalHeaders=None, verticalH #****************************************************************************************************************** def initializeModel(self, rootNode): """ - This method initializes the Model using given root node. + Initializes the Model using given root node. :param rootNode: Graph root node. ( DefaultNode ) :return: Method success ( Boolean ) @@ -94,7 +94,7 @@ def initializeModel(self, rootNode): def sort(self, column, order=Qt.AscendingOrder): """ - This method reimplements the :meth:`umbra.ui.models.GraphModel.sort` method. + Reimplements the :meth:`umbra.ui.models.GraphModel.sort` method. :param column: Column. ( Integer ) :param order: Order. ( Qt.SortOrder ) diff --git a/sibl_gui/components/core/iblSetsOutliner/views.py b/sibl_gui/components/core/iblSetsOutliner/views.py index 85f23fce..6419b824 100644 --- a/sibl_gui/components/core/iblSetsOutliner/views.py +++ b/sibl_gui/components/core/iblSetsOutliner/views.py @@ -59,7 +59,7 @@ class Thumbnails_QListView(sibl_gui.ui.views.Abstract_QListView): def __init__(self, parent, model=None, readOnly=False, message=None): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param model: Model. ( QObject ) @@ -83,7 +83,7 @@ def __init__(self, parent, model=None, readOnly=False, message=None): @property def listViewSpacing(self): """ - This method is the property for **self.__listViewSpacing** attribute. + Property for **self.__listViewSpacing** attribute. :return: self.__listViewSpacing. ( Integer ) """ @@ -94,7 +94,7 @@ def listViewSpacing(self): @foundations.exceptions.handleExceptions(AssertionError) def listViewSpacing(self, value): """ - This method is the setter method for **self.__listViewSpacing** attribute. + Setter for **self.__listViewSpacing** attribute. :param value: Attribute value. ( Integer ) """ @@ -108,7 +108,7 @@ def listViewSpacing(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def listViewSpacing(self): """ - This method is the deleter method for **self.__listViewSpacing** attribute. + Deleter for **self.__listViewSpacing** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -117,7 +117,7 @@ def listViewSpacing(self): @property def listViewMargin(self): """ - This method is the property for **self.__listViewMargin** attribute. + Property for **self.__listViewMargin** attribute. :return: self.__listViewMargin. ( Integer ) """ @@ -128,7 +128,7 @@ def listViewMargin(self): @foundations.exceptions.handleExceptions(AssertionError) def listViewMargin(self, value): """ - This method is the setter method for **self.__listViewMargin** attribute. + Setter for **self.__listViewMargin** attribute. :param value: Attribute value. ( Integer ) """ @@ -142,7 +142,7 @@ def listViewMargin(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def listViewMargin(self): """ - This method is the deleter method for **self.__listViewMargin** attribute. + Deleter for **self.__listViewMargin** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -153,7 +153,7 @@ def listViewMargin(self): #****************************************************************************************************************** def __initializeUi(self): """ - This method initializes the Widget ui. + Initializes the Widget ui. """ self.setAutoScroll(True) @@ -170,7 +170,7 @@ def __initializeUi(self): def __setDefaultUiState(self, iconsSize=None, iconsRatio=2): """ - This method sets the Widget default ui state. + Sets the Widget default ui state. :param iconsSize: Icons size. ( Integer ) :param iconRatio: Icons ratio. ( Integer ) @@ -192,7 +192,7 @@ class Details_QTreeView(sibl_gui.ui.views.Abstract_QTreeView): def __init__(self, parent, model=None, readOnly=False, message=None): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param model: Model. ( QObject ) @@ -215,7 +215,7 @@ def __init__(self, parent, model=None, readOnly=False, message=None): @property def treeViewIndentation(self): """ - This method is the property for **self.__treeViewIndentation** attribute. + Property for **self.__treeViewIndentation** attribute. :return: self.__treeViewIndentation. ( Integer ) """ @@ -226,7 +226,7 @@ def treeViewIndentation(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def treeViewIndentation(self, value): """ - This method is the setter method for **self.__treeViewIndentation** attribute. + Setter for **self.__treeViewIndentation** attribute. :param value: Attribute value. ( Integer ) """ @@ -238,7 +238,7 @@ def treeViewIndentation(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def treeViewIndentation(self): """ - This method is the deleter method for **self.__treeViewIndentation** attribute. + Deleter for **self.__treeViewIndentation** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -249,7 +249,7 @@ def treeViewIndentation(self): #****************************************************************************************************************** def __initializeUi(self): """ - This method initializes the Widget ui. + Initializes the Widget ui. """ self.setAutoScroll(True) @@ -268,7 +268,7 @@ def __initializeUi(self): def __setDefaultUiState(self): """ - This method sets the Widget default ui state. + Sets the Widget default ui state. """ LOGGER.debug("> Setting default View state!") diff --git a/sibl_gui/components/core/inspector/inspector.py b/sibl_gui/components/core/inspector/inspector.py index a04cdda9..1d2bf070 100644 --- a/sibl_gui/components/core/inspector/inspector.py +++ b/sibl_gui/components/core/inspector/inspector.py @@ -89,7 +89,7 @@ class Plate(foundations.dataStructures.Structure): def __init__(self, **kwargs): """ - This method initializes the class. + Initializes the class. :param kwargs: name, icon, previewImage, image ( Key / Value pairs ) """ @@ -105,7 +105,7 @@ class Light(foundations.dataStructures.Structure): def __init__(self, **kwargs): """ - This method initializes the class. + Initializes the class. :param kwargs: name, color, uCoordinate, vCoordinate ( Key / Value pairs ) """ @@ -140,7 +140,7 @@ class Inspector(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): def __init__(self, parent=None, name=None, *args, **kwargs): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param name: Component name. ( String ) @@ -245,7 +245,7 @@ def __init__(self, parent=None, name=None, *args, **kwargs): @property def uiResourcesDirectory(self): """ - This method is the property for **self.__uiResourcesDirectory** attribute. + Property for **self.__uiResourcesDirectory** attribute. :return: self.__uiResourcesDirectory. ( String ) """ @@ -256,7 +256,7 @@ def uiResourcesDirectory(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiResourcesDirectory(self, value): """ - This method is the setter method for **self.__uiResourcesDirectory** attribute. + Setter for **self.__uiResourcesDirectory** attribute. :param value: Attribute value. ( String ) """ @@ -268,7 +268,7 @@ def uiResourcesDirectory(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiResourcesDirectory(self): """ - This method is the deleter method for **self.__uiResourcesDirectory** attribute. + Deleter for **self.__uiResourcesDirectory** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -277,7 +277,7 @@ def uiResourcesDirectory(self): @property def uiPreviousImage(self): """ - This method is the property for **self.__uiPreviousImage** attribute. + Property for **self.__uiPreviousImage** attribute. :return: self.__uiPreviousImage. ( String ) """ @@ -288,7 +288,7 @@ def uiPreviousImage(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiPreviousImage(self, value): """ - This method is the setter method for **self.__uiPreviousImage** attribute. + Setter for **self.__uiPreviousImage** attribute. :param value: Attribute value. ( String ) """ @@ -300,7 +300,7 @@ def uiPreviousImage(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiPreviousImage(self): """ - This method is the deleter method for **self.__uiPreviousImage** attribute. + Deleter for **self.__uiPreviousImage** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -309,7 +309,7 @@ def uiPreviousImage(self): @property def uiNextImage(self): """ - This method is the property for **self.__uiNextImage** attribute. + Property for **self.__uiNextImage** attribute. :return: self.__uiNextImage. ( String ) """ @@ -320,7 +320,7 @@ def uiNextImage(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiNextImage(self, value): """ - This method is the setter method for **self.__uiNextImage** attribute. + Setter for **self.__uiNextImage** attribute. :param value: Attribute value. ( String ) """ @@ -332,7 +332,7 @@ def uiNextImage(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiNextImage(self): """ - This method is the deleter method for **self.__uiNextImage** attribute. + Deleter for **self.__uiNextImage** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -341,7 +341,7 @@ def uiNextImage(self): @property def uiLoadingImage(self): """ - This method is the property for **self.__uiLoadingImage** attribute. + Property for **self.__uiLoadingImage** attribute. :return: self.__uiLoadingImage. ( String ) """ @@ -352,7 +352,7 @@ def uiLoadingImage(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiLoadingImage(self, value): """ - This method is the setter method for **self.__uiLoadingImage** attribute. + Setter for **self.__uiLoadingImage** attribute. :param value: Attribute value. ( String ) """ @@ -364,7 +364,7 @@ def uiLoadingImage(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiLoadingImage(self): """ - This method is the deleter method for **self.__uiLoadingImage** attribute. + Deleter for **self.__uiLoadingImage** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -373,7 +373,7 @@ def uiLoadingImage(self): @property def dockArea(self): """ - This method is the property for **self.__dockArea** attribute. + Property for **self.__dockArea** attribute. :return: self.__dockArea. ( Integer ) """ @@ -384,7 +384,7 @@ def dockArea(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def dockArea(self, value): """ - This method is the setter method for **self.__dockArea** attribute. + Setter for **self.__dockArea** attribute. :param value: Attribute value. ( Integer ) """ @@ -396,7 +396,7 @@ def dockArea(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def dockArea(self): """ - This method is the deleter method for **self.__dockArea** attribute. + Deleter for **self.__dockArea** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -405,7 +405,7 @@ def dockArea(self): @property def listViewIconSize(self): """ - This method is the property for **self.__listViewIconSize** attribute. + Property for **self.__listViewIconSize** attribute. :return: self.__listViewIconSize. ( Integer ) """ @@ -416,7 +416,7 @@ def listViewIconSize(self): @foundations.exceptions.handleExceptions(AssertionError) def listViewIconSize(self, value): """ - This method is the setter method for **self.__listViewIconSize** attribute. + Setter for **self.__listViewIconSize** attribute. :param value: Attribute value. ( Integer ) """ @@ -430,7 +430,7 @@ def listViewIconSize(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def listViewIconSize(self): """ - This method is the deleter method for **self.__listViewIconSize** attribute. + Deleter for **self.__listViewIconSize** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -439,7 +439,7 @@ def listViewIconSize(self): @property def engine(self): """ - This method is the property for **self.__engine** attribute. + Property for **self.__engine** attribute. :return: self.__engine. ( QObject ) """ @@ -450,7 +450,7 @@ def engine(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self, value): """ - This method is the setter method for **self.__engine** attribute. + Setter for **self.__engine** attribute. :param value: Attribute value. ( QObject ) """ @@ -462,7 +462,7 @@ def engine(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self): """ - This method is the deleter method for **self.__engine** attribute. + Deleter for **self.__engine** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -471,7 +471,7 @@ def engine(self): @property def iblSetsOutliner(self): """ - This method is the property for **self.__iblSetsOutliner** attribute. + Property for **self.__iblSetsOutliner** attribute. :return: self.__iblSetsOutliner. ( QWidget ) """ @@ -482,7 +482,7 @@ def iblSetsOutliner(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iblSetsOutliner(self, value): """ - This method is the setter method for **self.__iblSetsOutliner** attribute. + Setter for **self.__iblSetsOutliner** attribute. :param value: Attribute value. ( QWidget ) """ @@ -494,7 +494,7 @@ def iblSetsOutliner(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iblSetsOutliner(self): """ - This method is the deleter method for **self.__iblSetsOutliner** attribute. + Deleter for **self.__iblSetsOutliner** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -503,7 +503,7 @@ def iblSetsOutliner(self): @property def sectionsFileParsersCache(self): """ - This method is the property for **self.__sectionsFileParsersCache** attribute. + Property for **self.__sectionsFileParsersCache** attribute. :return: self.__sectionsFileParsersCache. ( Cache ) """ @@ -514,7 +514,7 @@ def sectionsFileParsersCache(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def sectionsFileParsersCache(self, value): """ - This method is the setter method for **self.__sectionsFileParsersCache** attribute. + Setter for **self.__sectionsFileParsersCache** attribute. :param value: Attribute value. ( Cache ) """ @@ -526,7 +526,7 @@ def sectionsFileParsersCache(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def sectionsFileParsersCache(self): """ - This method is the deleter method for **self.__sectionsFileParsersCache** attribute. + Deleter for **self.__sectionsFileParsersCache** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -535,7 +535,7 @@ def sectionsFileParsersCache(self): @property def model(self): """ - This method is the property for **self.__model** attribute. + Property for **self.__model** attribute. :return: self.__model. ( PlatesModel ) """ @@ -546,7 +546,7 @@ def model(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def model(self, value): """ - This method is the setter method for **self.__model** attribute. + Setter for **self.__model** attribute. :param value: Attribute value. ( PlatesModel ) """ @@ -558,7 +558,7 @@ def model(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def model(self): """ - This method is the deleter method for **self.__model** attribute. + Deleter for **self.__model** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -567,7 +567,7 @@ def model(self): @property def view(self): """ - This method is the property for **self.__view** attribute. + Property for **self.__view** attribute. :return: self.__view. ( QWidget ) """ @@ -578,7 +578,7 @@ def view(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def view(self, value): """ - This method is the setter method for **self.__view** attribute. + Setter for **self.__view** attribute. :param value: Attribute value. ( QWidget ) """ @@ -590,7 +590,7 @@ def view(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def view(self): """ - This method is the deleter method for **self.__view** attribute. + Deleter for **self.__view** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -599,7 +599,7 @@ def view(self): @property def thumbnailsSize(self): """ - This method is the property for **self.__thumbnailsSize** attribute. + Property for **self.__thumbnailsSize** attribute. :return: self.__thumbnailsSize. ( String ) """ @@ -610,7 +610,7 @@ def thumbnailsSize(self): @foundations.exceptions.handleExceptions(AssertionError) def thumbnailsSize(self, value): """ - This method is the setter method for **self.__thumbnailsSize** attribute. + Setter for **self.__thumbnailsSize** attribute. :param value: Attribute value. ( String ) """ @@ -623,7 +623,7 @@ def thumbnailsSize(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def thumbnailsSize(self): """ - This method is the deleter method for **self.__thumbnailsSize** attribute. + Deleter for **self.__thumbnailsSize** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -632,7 +632,7 @@ def thumbnailsSize(self): @property def activeIblSet(self): """ - This method is the property for **self.__activeIblSet** attribute. + Property for **self.__activeIblSet** attribute. :return: self.__activeIblSet. ( IblSet ) """ @@ -643,7 +643,7 @@ def activeIblSet(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def activeIblSet(self, value): """ - This method is the setter method for **self.__activeIblSet** attribute. + Setter for **self.__activeIblSet** attribute. :param value: Attribute value. ( IblSet ) """ @@ -655,7 +655,7 @@ def activeIblSet(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def activeIblSet(self): """ - This method is the deleter method for **self.__activeIblSet** attribute. + Deleter for **self.__activeIblSet** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -664,7 +664,7 @@ def activeIblSet(self): @property def inspectorPlates(self): """ - This method is the property for **self.__inspectorPlates** attribute. + Property for **self.__inspectorPlates** attribute. :return: self.__inspectorPlates. ( Dictionary ) """ @@ -675,7 +675,7 @@ def inspectorPlates(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def inspectorPlates(self, value): """ - This method is the setter method for **self.__inspectorPlates** attribute. + Setter for **self.__inspectorPlates** attribute. :param value: Attribute value. ( Dictionary ) """ @@ -687,7 +687,7 @@ def inspectorPlates(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def inspectorPlates(self): """ - This method is the deleter method for **self.__inspectorPlates** attribute. + Deleter for **self.__inspectorPlates** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -696,7 +696,7 @@ def inspectorPlates(self): @property def noPreviewImageText(self): """ - This method is the property for **self.__noPreviewImageText** attribute. + Property for **self.__noPreviewImageText** attribute. :return: self.__noPreviewImageText. ( String ) """ @@ -707,7 +707,7 @@ def noPreviewImageText(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def noPreviewImageText(self, value): """ - This method is the setter method for **self.__noPreviewImageText** attribute. + Setter for **self.__noPreviewImageText** attribute. :param value: Attribute value. ( String ) """ @@ -719,7 +719,7 @@ def noPreviewImageText(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def noPreviewImageText(self): """ - This method is the deleter method for **self.__noPreviewImageText** attribute. + Deleter for **self.__noPreviewImageText** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -728,7 +728,7 @@ def noPreviewImageText(self): @property def noActiveIblSetText(self): """ - This method is the property for **self.__noActiveIblSetText** attribute. + Property for **self.__noActiveIblSetText** attribute. :return: self.__noActiveIblSetText. ( String ) """ @@ -739,7 +739,7 @@ def noActiveIblSetText(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def noActiveIblSetText(self, value): """ - This method is the setter method for **self.__noActiveIblSetText** attribute. + Setter for **self.__noActiveIblSetText** attribute. :param value: Attribute value. ( String ) """ @@ -751,7 +751,7 @@ def noActiveIblSetText(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def noActiveIblSetText(self): """ - This method is the deleter method for **self.__noActiveIblSetText** attribute. + Deleter for **self.__noActiveIblSetText** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -760,7 +760,7 @@ def noActiveIblSetText(self): @property def activeIblSetToolTipText(self): """ - This method is the property for **self.__activeIblSetToolTipText** attribute. + Property for **self.__activeIblSetToolTipText** attribute. :return: self.__activeIblSetToolTipText. ( String ) """ @@ -771,7 +771,7 @@ def activeIblSetToolTipText(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def activeIblSetToolTipText(self, value): """ - This method is the setter method for **self.__activeIblSetToolTipText** attribute. + Setter for **self.__activeIblSetToolTipText** attribute. :param value: Attribute value. ( String ) """ @@ -783,7 +783,7 @@ def activeIblSetToolTipText(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def activeIblSetToolTipText(self): """ - This method is the deleter method for **self.__activeIblSetToolTipText** attribute. + Deleter for **self.__activeIblSetToolTipText** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -792,7 +792,7 @@ def activeIblSetToolTipText(self): @property def lightLabelRadius(self): """ - This method is the property for **self.__lightLabelRadius** attribute. + Property for **self.__lightLabelRadius** attribute. :return: self.__lightLabelRadius. ( Integer ) """ @@ -803,7 +803,7 @@ def lightLabelRadius(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def lightLabelRadius(self, value): """ - This method is the setter method for **self.__lightLabelRadius** attribute. + Setter for **self.__lightLabelRadius** attribute. :param value: Attribute value. ( Integer ) """ @@ -815,7 +815,7 @@ def lightLabelRadius(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def lightLabelRadius(self): """ - This method is the deleter method for **self.__lightLabelRadius** attribute. + Deleter for **self.__lightLabelRadius** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -824,7 +824,7 @@ def lightLabelRadius(self): @property def lightLabelTextOffset(self): """ - This method is the property for **self.__lightLabelTextOffset** attribute. + Property for **self.__lightLabelTextOffset** attribute. :return: self.__lightLabelTextOffset. ( Integer ) """ @@ -835,7 +835,7 @@ def lightLabelTextOffset(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def lightLabelTextOffset(self, value): """ - This method is the setter method for **self.__lightLabelTextOffset** attribute. + Setter for **self.__lightLabelTextOffset** attribute. :param value: Attribute value. ( Integer ) """ @@ -847,7 +847,7 @@ def lightLabelTextOffset(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def lightLabelTextOffset(self): """ - This method is the deleter method for **self.__lightLabelTextOffset** attribute. + Deleter for **self.__lightLabelTextOffset** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -856,7 +856,7 @@ def lightLabelTextOffset(self): @property def lightLabelTextMargin(self): """ - This method is the property for **self.__lightLabelTextMargin** attribute. + Property for **self.__lightLabelTextMargin** attribute. :return: self.__lightLabelTextMargin. ( Integer ) """ @@ -867,7 +867,7 @@ def lightLabelTextMargin(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def lightLabelTextMargin(self, value): """ - This method is the setter method for **self.__lightLabelTextMargin** attribute. + Setter for **self.__lightLabelTextMargin** attribute. :param value: Attribute value. ( Integer ) """ @@ -879,7 +879,7 @@ def lightLabelTextMargin(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def lightLabelTextMargin(self): """ - This method is the deleter method for **self.__lightLabelTextMargin** attribute. + Deleter for **self.__lightLabelTextMargin** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -888,7 +888,7 @@ def lightLabelTextMargin(self): @property def lightLabelTextHeight(self): """ - This method is the property for **self.__lightLabelTextHeight** attribute. + Property for **self.__lightLabelTextHeight** attribute. :return: self.__lightLabelTextHeight. ( Integer ) """ @@ -899,7 +899,7 @@ def lightLabelTextHeight(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def lightLabelTextHeight(self, value): """ - This method is the setter method for **self.__lightLabelTextHeight** attribute. + Setter for **self.__lightLabelTextHeight** attribute. :param value: Attribute value. ( Integer ) """ @@ -911,7 +911,7 @@ def lightLabelTextHeight(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def lightLabelTextHeight(self): """ - This method is the deleter method for **self.__lightLabelTextHeight** attribute. + Deleter for **self.__lightLabelTextHeight** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -920,7 +920,7 @@ def lightLabelTextHeight(self): @property def lightLabelTextFont(self): """ - This method is the property for **self.__lightLabelTextFont** attribute. + Property for **self.__lightLabelTextFont** attribute. :return: self.__lightLabelTextFont. ( String ) """ @@ -931,7 +931,7 @@ def lightLabelTextFont(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def lightLabelTextFont(self, value): """ - This method is the setter method for **self.__lightLabelTextFont** attribute. + Setter for **self.__lightLabelTextFont** attribute. :param value: Attribute value. ( String ) """ @@ -943,7 +943,7 @@ def lightLabelTextFont(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def lightLabelTextFont(self): """ - This method is the deleter method for **self.__lightLabelTextFont** attribute. + Deleter for **self.__lightLabelTextFont** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -952,7 +952,7 @@ def lightLabelTextFont(self): @property def unnamedLightName(self): """ - This method is the property for **self.__unnamedLightName** attribute. + Property for **self.__unnamedLightName** attribute. :return: self.__unnamedLightName. ( String ) """ @@ -963,7 +963,7 @@ def unnamedLightName(self): @foundations.exceptions.handleExceptions(AssertionError) def unnamedLightName(self, value): """ - This method is the setter method for **self.__unnamedLightName** attribute. + Setter for **self.__unnamedLightName** attribute. :param value: Attribute value. ( String ) """ @@ -977,7 +977,7 @@ def unnamedLightName(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def unnamedLightName(self): """ - This method is the deleter method for **self.__unnamedLightName** attribute. + Deleter for **self.__unnamedLightName** attribute. """ raise foundations.exceptions.ProgrammingError( diff --git a/sibl_gui/components/core/inspector/models.py b/sibl_gui/components/core/inspector/models.py index 31b120ed..e66fd74f 100644 --- a/sibl_gui/components/core/inspector/models.py +++ b/sibl_gui/components/core/inspector/models.py @@ -51,7 +51,7 @@ class PlatesModel(sibl_gui.ui.models.GraphModel): def __init__(self, parent=None, rootNode=None, horizontalHeaders=None, verticalHeaders=None): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param rootNode: Root node. ( AbstractCompositeNode ) @@ -72,7 +72,7 @@ def __init__(self, parent=None, rootNode=None, horizontalHeaders=None, verticalH #****************************************************************************************************************** def initializeModel(self, rootNode): """ - This method initializes the Model using given root node. + Initializes the Model using given root node. :param rootNode: Graph root node. ( DefaultNode ) :return: Method success ( Boolean ) diff --git a/sibl_gui/components/core/inspector/nodes.py b/sibl_gui/components/core/inspector/nodes.py index 1ad781a0..e245095e 100644 --- a/sibl_gui/components/core/inspector/nodes.py +++ b/sibl_gui/components/core/inspector/nodes.py @@ -70,7 +70,7 @@ def __init__(self, iconPlaceholder=None, **kwargs): """ - This method initializes the class. + Initializes the class. :param plate: Plate object. ( Plate ) :param name: Node name. ( String ) @@ -111,7 +111,7 @@ def __init__(self, @property def plate(self): """ - This method is the property for **self.__plate** attribute. + Property for **self.__plate** attribute. :return: self.__plate. ( Plate ) """ @@ -122,7 +122,7 @@ def plate(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def plate(self, value): """ - This method is the setter method for **self.__plate** attribute. + Setter for **self.__plate** attribute. :param value: Attribute value. ( Plate ) """ @@ -134,7 +134,7 @@ def plate(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def plate(self): """ - This method is the deleter method for **self.__plate** attribute. + Deleter for **self.__plate** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -143,7 +143,7 @@ def plate(self): @property def toolTipText(self): """ - This method is the property for **self.__toolTipText** attribute. + Property for **self.__toolTipText** attribute. :return: self.__toolTipText. ( String ) """ @@ -154,7 +154,7 @@ def toolTipText(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def toolTipText(self, value): """ - This method is the setter method for **self.__toolTipText** attribute. + Setter for **self.__toolTipText** attribute. :param value: Attribute value. ( String ) """ @@ -166,7 +166,7 @@ def toolTipText(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def toolTipText(self): """ - This method is the deleter method for **self.__toolTipText** attribute. + Deleter for **self.__toolTipText** attribute. """ raise foundations.exceptions.ProgrammingError( diff --git a/sibl_gui/components/core/inspector/views.py b/sibl_gui/components/core/inspector/views.py index 256161c9..6d88bc98 100644 --- a/sibl_gui/components/core/inspector/views.py +++ b/sibl_gui/components/core/inspector/views.py @@ -59,7 +59,7 @@ class Plates_QListView(sibl_gui.ui.views.Abstract_QListView): def __init__(self, parent, model=None, readOnly=False, message=None): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param model: Model. ( QObject ) @@ -82,7 +82,7 @@ def __init__(self, parent, model=None, readOnly=False, message=None): @property def listViewIconSize(self): """ - This method is the property for **self.__listViewIconSize** attribute. + Property for **self.__listViewIconSize** attribute. :return: self.__listViewIconSize. ( Integer ) """ @@ -93,7 +93,7 @@ def listViewIconSize(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def listViewIconSize(self, value): """ - This method is the setter method for **self.__listViewIconSize** attribute. + Setter for **self.__listViewIconSize** attribute. :param value: Attribute value. ( Integer ) """ @@ -105,7 +105,7 @@ def listViewIconSize(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def listViewIconSize(self): """ - This method is the deleter method for **self.__listViewIconSize** attribute. + Deleter for **self.__listViewIconSize** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -116,7 +116,7 @@ def listViewIconSize(self): #****************************************************************************************************************** def __initializeUi(self): """ - This method initializes the Widget ui. + Initializes the Widget ui. """ self.setAcceptDrops(False) @@ -136,7 +136,7 @@ def __initializeUi(self): def __setDefaultUiState(self): """ - This method sets the Widget default ui state. + Sets the Widget default ui state. """ LOGGER.debug("> Setting default View state!") diff --git a/sibl_gui/components/core/templatesOutliner/models.py b/sibl_gui/components/core/templatesOutliner/models.py index 065f4f59..4d375677 100644 --- a/sibl_gui/components/core/templatesOutliner/models.py +++ b/sibl_gui/components/core/templatesOutliner/models.py @@ -51,7 +51,7 @@ class TemplatesModel(sibl_gui.ui.models.GraphModel): def __init__(self, parent=None, rootNode=None, horizontalHeaders=None, verticalHeaders=None): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param rootNode: Root node. ( AbstractCompositeNode ) @@ -72,7 +72,7 @@ def __init__(self, parent=None, rootNode=None, horizontalHeaders=None, verticalH #****************************************************************************************************************** def initializeModel(self, rootNode): """ - This method initializes the Model using given root node. + Initializes the Model using given root node. :param rootNode: Graph root node. ( DefaultNode ) :return: Method success ( Boolean ) diff --git a/sibl_gui/components/core/templatesOutliner/nodes.py b/sibl_gui/components/core/templatesOutliner/nodes.py index b3164076..f913aeb0 100644 --- a/sibl_gui/components/core/templatesOutliner/nodes.py +++ b/sibl_gui/components/core/templatesOutliner/nodes.py @@ -68,7 +68,7 @@ def __init__(self, iconPlaceholder=None, **kwargs): """ - This method initializes the class. + Initializes the class. :param name: Node name. ( String ) :param parent: Node parent. ( GraphModelNode ) @@ -100,7 +100,7 @@ def __init__(self, #****************************************************************************************************************** def __initializeNode(self, attributesFlags=int(Qt.ItemIsSelectable | Qt.ItemIsEnabled)): """ - This method initializes the node. + Initializes the node. :param attributesFlags: Attributes flags. ( Integer ) """ diff --git a/sibl_gui/components/core/templatesOutliner/templatesOutliner.py b/sibl_gui/components/core/templatesOutliner/templatesOutliner.py index c70e1be7..8d33db76 100644 --- a/sibl_gui/components/core/templatesOutliner/templatesOutliner.py +++ b/sibl_gui/components/core/templatesOutliner/templatesOutliner.py @@ -100,7 +100,7 @@ class TemplatesOutliner(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): def __init__(self, parent=None, name=None, *args, **kwargs): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param name: Component name. ( String ) @@ -175,7 +175,7 @@ def __init__(self, parent=None, name=None, *args, **kwargs): @property def uiResourcesDirectory(self): """ - This method is the property for **self.__uiResourcesDirectory** attribute. + Property for **self.__uiResourcesDirectory** attribute. :return: self.__uiResourcesDirectory. ( String ) """ @@ -186,7 +186,7 @@ def uiResourcesDirectory(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiResourcesDirectory(self, value): """ - This method is the setter method for **self.__uiResourcesDirectory** attribute. + Setter for **self.__uiResourcesDirectory** attribute. :param value: Attribute value. ( String ) """ @@ -198,7 +198,7 @@ def uiResourcesDirectory(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiResourcesDirectory(self): """ - This method is the deleter method for **self.__uiResourcesDirectory** attribute. + Deleter for **self.__uiResourcesDirectory** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -207,7 +207,7 @@ def uiResourcesDirectory(self): @property def uiSoftwareAffixe(self): """ - This method is the property for **self.__uiSoftwareAffixe** attribute. + Property for **self.__uiSoftwareAffixe** attribute. :return: self.__uiSoftwareAffixe. ( String ) """ @@ -218,7 +218,7 @@ def uiSoftwareAffixe(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiSoftwareAffixe(self, value): """ - This method is the setter method for **self.__uiSoftwareAffixe** attribute. + Setter for **self.__uiSoftwareAffixe** attribute. :param value: Attribute value. ( String ) """ @@ -230,7 +230,7 @@ def uiSoftwareAffixe(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiSoftwareAffixe(self): """ - This method is the deleter method for **self.__uiSoftwareAffixe** attribute. + Deleter for **self.__uiSoftwareAffixe** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -239,7 +239,7 @@ def uiSoftwareAffixe(self): @property def uiUnknownSoftwareImage(self): """ - This method is the property for **self.__uiUnknownSoftwareImage** attribute. + Property for **self.__uiUnknownSoftwareImage** attribute. :return: self.__uiUnknownSoftwareImage. ( String ) """ @@ -250,7 +250,7 @@ def uiUnknownSoftwareImage(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiUnknownSoftwareImage(self, value): """ - This method is the setter method for **self.__uiUnknownSoftwareImage** attribute. + Setter for **self.__uiUnknownSoftwareImage** attribute. :param value: Attribute value. ( String ) """ @@ -262,7 +262,7 @@ def uiUnknownSoftwareImage(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uiUnknownSoftwareImage(self): """ - This method is the deleter method for **self.__uiUnknownSoftwareImage** attribute. + Deleter for **self.__uiUnknownSoftwareImage** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -271,7 +271,7 @@ def uiUnknownSoftwareImage(self): @property def dockArea(self): """ - This method is the property for **self.__dockArea** attribute. + Property for **self.__dockArea** attribute. :return: self.__dockArea. ( Integer ) """ @@ -282,7 +282,7 @@ def dockArea(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def dockArea(self, value): """ - This method is the setter method for **self.__dockArea** attribute. + Setter for **self.__dockArea** attribute. :param value: Attribute value. ( Integer ) """ @@ -294,7 +294,7 @@ def dockArea(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def dockArea(self): """ - This method is the deleter method for **self.__dockArea** attribute. + Deleter for **self.__dockArea** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -303,7 +303,7 @@ def dockArea(self): @property def engine(self): """ - This method is the property for **self.__engine** attribute. + Property for **self.__engine** attribute. :return: self.__engine. ( QObject ) """ @@ -314,7 +314,7 @@ def engine(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self, value): """ - This method is the setter method for **self.__engine** attribute. + Setter for **self.__engine** attribute. :param value: Attribute value. ( QObject ) """ @@ -326,7 +326,7 @@ def engine(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def engine(self): """ - This method is the deleter method for **self.__engine** attribute. + Deleter for **self.__engine** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -335,7 +335,7 @@ def engine(self): @property def settings(self): """ - This method is the property for **self.__settings** attribute. + Property for **self.__settings** attribute. :return: self.__settings. ( QSettings ) """ @@ -346,7 +346,7 @@ def settings(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settings(self, value): """ - This method is the setter method for **self.__settings** attribute. + Setter for **self.__settings** attribute. :param value: Attribute value. ( QSettings ) """ @@ -358,7 +358,7 @@ def settings(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settings(self): """ - This method is the deleter method for **self.__settings** attribute. + Deleter for **self.__settings** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -367,7 +367,7 @@ def settings(self): @property def settingsSection(self): """ - This method is the property for **self.__settingsSection** attribute. + Property for **self.__settingsSection** attribute. :return: self.__settingsSection. ( String ) """ @@ -378,7 +378,7 @@ def settingsSection(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settingsSection(self, value): """ - This method is the setter method for **self.__settingsSection** attribute. + Setter for **self.__settingsSection** attribute. :param value: Attribute value. ( String ) """ @@ -390,7 +390,7 @@ def settingsSection(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settingsSection(self): """ - This method is the deleter method for **self.__settingsSection** attribute. + Deleter for **self.__settingsSection** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -399,7 +399,7 @@ def settingsSection(self): @property def settingsSeparator(self): """ - This method is the property for **self.__settingsSeparator** attribute. + Property for **self.__settingsSeparator** attribute. :return: self.__settingsSeparator. ( String ) """ @@ -410,7 +410,7 @@ def settingsSeparator(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settingsSeparator(self, value): """ - This method is the setter method for **self.__settingsSeparator** attribute. + Setter for **self.__settingsSeparator** attribute. :param value: Attribute value. ( String ) """ @@ -422,7 +422,7 @@ def settingsSeparator(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def settingsSeparator(self): """ - This method is the deleter method for **self.__settingsSeparator** attribute. + Deleter for **self.__settingsSeparator** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -431,7 +431,7 @@ def settingsSeparator(self): @property def scriptEditor(self): """ - This method is the property for **self.__scriptEditor** attribute. + Property for **self.__scriptEditor** attribute. :return: self.__scriptEditor. ( QWidget ) """ @@ -442,7 +442,7 @@ def scriptEditor(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def scriptEditor(self, value): """ - This method is the setter method for **self.__scriptEditor** attribute. + Setter for **self.__scriptEditor** attribute. :param value: Attribute value. ( QWidget ) """ @@ -454,7 +454,7 @@ def scriptEditor(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def scriptEditor(self): """ - This method is the deleter method for **self.__scriptEditor** attribute. + Deleter for **self.__scriptEditor** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -463,7 +463,7 @@ def scriptEditor(self): @property def database(self): """ - This method is the property for **self.__database** attribute. + Property for **self.__database** attribute. :return: self.__database. ( Object ) """ @@ -474,7 +474,7 @@ def database(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def database(self, value): """ - This method is the setter method for **self.__database** attribute. + Setter for **self.__database** attribute. :param value: Attribute value. ( Object ) """ @@ -486,7 +486,7 @@ def database(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def database(self): """ - This method is the deleter method for **self.__database** attribute. + Deleter for **self.__database** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -495,7 +495,7 @@ def database(self): @property def model(self): """ - This method is the property for **self.__model** attribute. + Property for **self.__model** attribute. :return: self.__model. ( TemplatesModel ) """ @@ -506,7 +506,7 @@ def model(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def model(self, value): """ - This method is the setter method for **self.__model** attribute. + Setter for **self.__model** attribute. :param value: Attribute value. ( TemplatesModel ) """ @@ -518,7 +518,7 @@ def model(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def model(self): """ - This method is the deleter method for **self.__model** attribute. + Deleter for **self.__model** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -527,7 +527,7 @@ def model(self): @property def view(self): """ - This method is the property for **self.__view** attribute. + Property for **self.__view** attribute. :return: self.__view. ( QWidget ) """ @@ -538,7 +538,7 @@ def view(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def view(self, value): """ - This method is the setter method for **self.__view** attribute. + Setter for **self.__view** attribute. :param value: Attribute value. ( QWidget ) """ @@ -550,7 +550,7 @@ def view(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def view(self): """ - This method is the deleter method for **self.__view** attribute. + Deleter for **self.__view** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -559,7 +559,7 @@ def view(self): @property def headers(self): """ - This method is the property for **self.__headers** attribute. + Property for **self.__headers** attribute. :return: self.__headers. ( OrderedDict ) """ @@ -570,7 +570,7 @@ def headers(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def headers(self, value): """ - This method is the setter method for **self.__headers** attribute. + Setter for **self.__headers** attribute. :param value: Attribute value. ( OrderedDict ) """ @@ -582,7 +582,7 @@ def headers(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def headers(self): """ - This method is the deleter method for **self.__headers** attribute. + Deleter for **self.__headers** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -591,7 +591,7 @@ def headers(self): @property def extension(self): """ - This method is the property for **self.__extension** attribute. + Property for **self.__extension** attribute. :return: self.__extension. ( String ) """ @@ -602,7 +602,7 @@ def extension(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def extension(self, value): """ - This method is the setter method for **self.__extension** attribute. + Setter for **self.__extension** attribute. :param value: Attribute value. ( String ) """ @@ -614,7 +614,7 @@ def extension(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def extension(self): """ - This method is the deleter method for **self.__extension** attribute. + Deleter for **self.__extension** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -623,7 +623,7 @@ def extension(self): @property def defaultCollections(self): """ - This method is the property for **self.__defaultCollections** attribute. + Property for **self.__defaultCollections** attribute. :return: self.__defaultCollections. ( Dictionary ) """ @@ -634,7 +634,7 @@ def defaultCollections(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def defaultCollections(self, value): """ - This method is the setter method for **self.__defaultCollections** attribute. + Setter for **self.__defaultCollections** attribute. :param value: Attribute value. ( Dictionary ) """ @@ -646,7 +646,7 @@ def defaultCollections(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def defaultCollections(self): """ - This method is the deleter method for **self.__defaultCollections** attribute. + Deleter for **self.__defaultCollections** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -655,7 +655,7 @@ def defaultCollections(self): @property def factoryCollection(self): """ - This method is the property for **self.__factoryCollection** attribute. + Property for **self.__factoryCollection** attribute. :return: self.__factoryCollection. ( String ) """ @@ -666,7 +666,7 @@ def factoryCollection(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def factoryCollection(self, value): """ - This method is the setter method for **self.__factoryCollection** attribute. + Setter for **self.__factoryCollection** attribute. :param value: Attribute value. ( String ) """ @@ -678,7 +678,7 @@ def factoryCollection(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def factoryCollection(self): """ - This method is the deleter method for **self.__factoryCollection** attribute. + Deleter for **self.__factoryCollection** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -687,7 +687,7 @@ def factoryCollection(self): @property def userCollection(self): """ - This method is the property for **self.__userCollection** attribute. + Property for **self.__userCollection** attribute. :return: self.__userCollection. ( String ) """ @@ -698,7 +698,7 @@ def userCollection(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def userCollection(self, value): """ - This method is the setter method for **self.__userCollection** attribute. + Setter for **self.__userCollection** attribute. :param value: Attribute value. ( String ) """ @@ -710,7 +710,7 @@ def userCollection(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def userCollection(self): """ - This method is the deleter method for **self.__userCollection** attribute. + Deleter for **self.__userCollection** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -719,7 +719,7 @@ def userCollection(self): @property def templatesInformationsDefaultText(self): """ - This method is the property for **self.__templatesInformationsDefaultText** attribute. + Property for **self.__templatesInformationsDefaultText** attribute. :return: self.__templatesInformationsDefaultText. ( String ) """ @@ -730,7 +730,7 @@ def templatesInformationsDefaultText(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templatesInformationsDefaultText(self, value): """ - This method is the setter method for **self.__templatesInformationsDefaultText** attribute. + Setter for **self.__templatesInformationsDefaultText** attribute. :param value: Attribute value. ( String ) """ @@ -742,7 +742,7 @@ def templatesInformationsDefaultText(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templatesInformationsDefaultText(self): """ - This method is the deleter method for **self.__templatesInformationsDefaultText** attribute. + Deleter for **self.__templatesInformationsDefaultText** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -751,7 +751,7 @@ def templatesInformationsDefaultText(self): @property def treeViewInnerMargins(self): """ - This method is the property for **self.__treeViewInnerMargins** attribute. + Property for **self.__treeViewInnerMargins** attribute. :return: self.__treeViewInnerMargins. ( Integer ) """ @@ -762,7 +762,7 @@ def treeViewInnerMargins(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def treeViewInnerMargins(self, value): """ - This method is the setter method for **self.__treeViewInnerMargins** attribute. + Setter for **self.__treeViewInnerMargins** attribute. :param value: Attribute value. ( Integer ) """ @@ -774,7 +774,7 @@ def treeViewInnerMargins(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def treeViewInnerMargins(self): """ - This method is the deleter method for **self.__treeViewInnerMargins** attribute. + Deleter for **self.__treeViewInnerMargins** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -783,7 +783,7 @@ def treeViewInnerMargins(self): @property def templatesInformationsText(self): """ - This method is the property for **self.__templatesInformationsText** attribute. + Property for **self.__templatesInformationsText** attribute. :return: self.__templatesInformationsText. ( String ) """ @@ -794,7 +794,7 @@ def templatesInformationsText(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templatesInformationsText(self, value): """ - This method is the setter method for **self.__templatesInformationsText** attribute. + Setter for **self.__templatesInformationsText** attribute. :param value: Attribute value. ( String ) """ @@ -806,7 +806,7 @@ def templatesInformationsText(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def templatesInformationsText(self): """ - This method is the deleter method for **self.__templatesInformationsText** attribute. + Deleter for **self.__templatesInformationsText** attribute. """ raise foundations.exceptions.ProgrammingError( diff --git a/sibl_gui/components/core/templatesOutliner/views.py b/sibl_gui/components/core/templatesOutliner/views.py index 7dd5db9c..5ab604ff 100644 --- a/sibl_gui/components/core/templatesOutliner/views.py +++ b/sibl_gui/components/core/templatesOutliner/views.py @@ -59,7 +59,7 @@ class Templates_QTreeView(sibl_gui.ui.views.Abstract_QTreeView): def __init__(self, parent, model=None, readOnly=False, message=None): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param model: Model. ( QObject ) @@ -84,7 +84,7 @@ def __init__(self, parent, model=None, readOnly=False, message=None): @property def container(self): """ - This method is the property for **self.__container** attribute. + Property for **self.__container** attribute. :return: self.__container. ( QObject ) """ @@ -95,7 +95,7 @@ def container(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def container(self, value): """ - This method is the setter method for **self.__container** attribute. + Setter for **self.__container** attribute. :param value: Attribute value. ( QObject ) """ @@ -107,7 +107,7 @@ def container(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def container(self): """ - This method is the deleter method for **self.__container** attribute. + Deleter for **self.__container** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -116,7 +116,7 @@ def container(self): @property def treeViewIndentation(self): """ - This method is the property for **self.__treeViewIndentation** attribute. + Property for **self.__treeViewIndentation** attribute. :return: self.__treeViewIndentation. ( Integer ) """ @@ -127,7 +127,7 @@ def treeViewIndentation(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def treeViewIndentation(self, value): """ - This method is the setter method for **self.__treeViewIndentation** attribute. + Setter for **self.__treeViewIndentation** attribute. :param value: Attribute value. ( Integer ) """ @@ -139,7 +139,7 @@ def treeViewIndentation(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def treeViewIndentation(self): """ - This method is the deleter method for **self.__treeViewIndentation** attribute. + Deleter for **self.__treeViewIndentation** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -150,7 +150,7 @@ def treeViewIndentation(self): #****************************************************************************************************************** def __initializeUi(self): """ - This method initializes the Widget ui. + Initializes the Widget ui. """ self.setAutoScroll(True) @@ -168,7 +168,7 @@ def __initializeUi(self): def __setDefaultUiState(self): """ - This method sets the Widget default ui state. + Sets the Widget default ui state. """ LOGGER.debug("> Setting default View state!") @@ -183,7 +183,7 @@ def __setDefaultUiState(self): def storeModelSelection(self): """ - This method stores the Model selection. + Stores the Model selection. :return: Method success. ( Boolean ) """ @@ -202,7 +202,7 @@ def storeModelSelection(self): def restoreModelSelection(self): """ - This method restores the Model selection. + Restores the Model selection. :return: Method success. ( Boolean ) """ diff --git a/sibl_gui/launcher.py b/sibl_gui/launcher.py index 47c8b6ed..96bff840 100644 --- a/sibl_gui/launcher.py +++ b/sibl_gui/launcher.py @@ -34,7 +34,7 @@ #********************************************************************************************************************** def _setPackageDirectory(): """ - This definition sets the Application package directory in the path. + Sets the Application package directory in the path. """ if hasattr(sys, "frozen"): @@ -74,7 +74,7 @@ def _setPackageDirectory(): def _overrideDependenciesGlobals(): """ - This definition overrides dependencies globals. + Overrides dependencies globals. """ foundations.globals.constants.Constants.logger = \ @@ -128,7 +128,7 @@ def __init__(self, *args, **kwargs): """ - This method initializes the class. + Initializes the class. :param componentsPaths: Components componentsPaths. ( Tuple / List ) :param requisiteComponents: Requisite components names. ( Tuple / List ) @@ -157,7 +157,7 @@ def __init__(self, @property def thumbnailsCacheDirectory(self): """ - This method is the property for **self.__thumbnailsCacheDirectory** attribute. + Property for **self.__thumbnailsCacheDirectory** attribute. :return: self.__thumbnailsCacheDirectory. ( String ) """ @@ -168,7 +168,7 @@ def thumbnailsCacheDirectory(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def thumbnailsCacheDirectory(self, value): """ - This method is the setter method for **self.__thumbnailsCacheDirectory** attribute. + Setter for **self.__thumbnailsCacheDirectory** attribute. :param value: Attribute value. ( String ) """ @@ -180,7 +180,7 @@ def thumbnailsCacheDirectory(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def thumbnailsCacheDirectory(self): """ - This method is the deleter method for **self.__thumbnailsCacheDirectory** attribute. + Deleter for **self.__thumbnailsCacheDirectory** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -189,7 +189,7 @@ def thumbnailsCacheDirectory(self): @property def imagesCaches(self): """ - This method is the property for **self.__imagesCaches** attribute. + Property for **self.__imagesCaches** attribute. :return: self.__imagesCaches. ( Structure ) """ @@ -200,7 +200,7 @@ def imagesCaches(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def imagesCaches(self, value): """ - This method is the setter method for **self.__imagesCaches** attribute. + Setter for **self.__imagesCaches** attribute. :param value: Attribute value. ( Structure ) """ @@ -212,7 +212,7 @@ def imagesCaches(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def imagesCaches(self): """ - This method is the deleter method for **self.__imagesCaches** attribute. + Deleter for **self.__imagesCaches** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -223,7 +223,7 @@ def imagesCaches(self): #****************************************************************************************************************** def __overrideApplicationToolbar(self): """ - This method overrides the Application toolbar. + Overrides the Application toolbar. """ umbra.ui.widgets.application_QToolBar.Application_QToolBar = \ @@ -231,7 +231,7 @@ def __overrideApplicationToolbar(self): def __setThumbnailsCacheDirectory(self): """ - This method sets the Application thumbnails cache directory. + Sets the Application thumbnails cache directory. """ self.__thumbnailsCacheDirectory = umbra.globals.runtimeGlobals.RuntimeGlobals.thumbnailsCacheDirectory = \ @@ -241,7 +241,7 @@ def __setThumbnailsCacheDirectory(self): def __setImagesCaches(self): """ - This method sets the Application images caches. + Sets the Application images caches. """ loadingImage = umbra.ui.common.getResourcePath(umbra.globals.uiConstants.UiConstants.loadingImage) @@ -257,7 +257,7 @@ def __setImagesCaches(self): def onPreInitialisation(self): """ - This method is called by the :class:`umbra.engine.Umbra` class before Application main class initialisation. + Called by :class:`umbra.engine.Umbra` class before Application main class initialisation. """ self.__overrideApplicationToolbar() @@ -266,14 +266,14 @@ def onPreInitialisation(self): def onInitialisation(self): """ - This method is called by the :class:`umbra.engine.Umbra` class on Application main class initialisation. + Called by :class:`umbra.engine.Umbra` class on Application main class initialisation. """ pass def onPostInitialisation(self): """ - This method is called by the :class:`umbra.engine.Umbra` class after Application main class initialisation. + Called by :class:`umbra.engine.Umbra` class after Application main class initialisation. """ for cache in self.__imagesCaches.itervalues(): @@ -287,7 +287,7 @@ def onPostInitialisation(self): def extendCommandLineParametersParser(parser): """ - This definition returns the command line parameters parser. + Returns the command line parameters parser. :param parser: Command line parameters parser. ( Parser ) :return: Definition success. ( Boolean ) @@ -319,7 +319,7 @@ def extendCommandLineParametersParser(parser): #********************************************************************************************************************** def main(): """ - This definition starts the Application. + Starts the Application. :return: Definition success. ( Boolean ) """ diff --git a/sibl_gui/libraries/freeImage/freeImage.py b/sibl_gui/libraries/freeImage/freeImage.py index fabfea43..a5b63af7 100644 --- a/sibl_gui/libraries/freeImage/freeImage.py +++ b/sibl_gui/libraries/freeImage/freeImage.py @@ -417,7 +417,7 @@ #********************************************************************************************************************** def pointer(data): """ - This definition converts None to a real NULL pointer to work around bugs + Converts None to a real NULL pointer to work around bugs in how ctypes handles None on 64-bit platforms. :param data: Data . ( Object ) @@ -437,7 +437,7 @@ def from_param(class_, value): def unchecked(type): """ - This definition ensures that all callbacks return primitive datatypes. + Ensures that all callbacks return primitive datatypes. As of ctypes 1.0, ctypes does not support custom error-checking functions on callbacks, nor does it support custom datatypes on callbacks, so we must ensure that all callbacks return primitive datatypes. @@ -2000,7 +2000,7 @@ class Plugin(ctypes.Structure): #********************************************************************************************************************** def getFreeImageLibraryPath(): """ - This definition returns the FreeImage library path. + Returns the FreeImage library path. :return: FreeImage library path. ( String ) """ @@ -2021,7 +2021,7 @@ class ImageInformationsHeader(foundations.dataStructures.Structure): def __init__(self, **kwargs): """ - This method initializes the class. + Initializes the class. :param kwargs: path, width, height, bpp, osStats. ( Key / Value pairs ) """ @@ -2037,7 +2037,7 @@ class Image(object): def __init__(self, imagePath=None): """ - This method initializes the class. + Initializes the class. :param imagePath: Image path. ( String ) """ @@ -2064,7 +2064,7 @@ def __init__(self, imagePath=None): @property def library(self): """ - This method is the property for **self.__library** attribute. + Property for **self.__library** attribute. :return: self.__library. ( Library ) """ @@ -2075,7 +2075,7 @@ def library(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def library(self, value): """ - This method is the setter method for **self.__library** attribute. + Setter for **self.__library** attribute. :param value: Attribute value. ( Library ) """ @@ -2087,7 +2087,7 @@ def library(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def library(self): """ - This method is the deleter method for **self.__library** attribute. + Deleter for **self.__library** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -2096,7 +2096,7 @@ def library(self): @property def errorsCallback(self): """ - This method is the property for **self.__errorsCallback** attribute. + Property for **self.__errorsCallback** attribute. :return: self.__errorsCallback. ( Object ) """ @@ -2107,7 +2107,7 @@ def errorsCallback(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def errorsCallback(self, value): """ - This method is the setter method for **self.__errorsCallback** attribute. + Setter for **self.__errorsCallback** attribute. :param value: Attribute value. ( Object ) """ @@ -2119,7 +2119,7 @@ def errorsCallback(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def errorsCallback(self): """ - This method is the deleter method for **self.__errorsCallback** attribute. + Deleter for **self.__errorsCallback** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -2128,7 +2128,7 @@ def errorsCallback(self): @property def imagePath(self): """ - This method is the property for **self.__imagePath** attribute. + Property for **self.__imagePath** attribute. :return: self.__imagePath. ( String ) """ @@ -2139,7 +2139,7 @@ def imagePath(self): @foundations.exceptions.handleExceptions(AssertionError) def imagePath(self, value): """ - This method is the setter method for **self.__imagePath** attribute. + Setter for **self.__imagePath** attribute. :param value: Attribute value. ( String ) """ @@ -2152,7 +2152,7 @@ def imagePath(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def imagePath(self): """ - This method is the deleter method for **self.__imagePath** attribute. + Deleter for **self.__imagePath** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -2161,7 +2161,7 @@ def imagePath(self): @property def bitmap(self): """ - This method is the property for **self.__bitmap** attribute. + Property for **self.__bitmap** attribute. :return: self.__bitmap. ( Object ) """ @@ -2172,7 +2172,7 @@ def bitmap(self): @foundations.exceptions.handleExceptions(AssertionError) def bitmap(self, value): """ - This method is the setter method for **self.__bitmap** attribute. + Setter for **self.__bitmap** attribute. :param value: Attribute value. ( Object ) """ @@ -2183,7 +2183,7 @@ def bitmap(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def bitmap(self): """ - This method is the deleter method for **self.__bitmap** attribute. + Deleter for **self.__bitmap** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -2195,7 +2195,7 @@ def bitmap(self): @foundations.exceptions.handleExceptions(foundations.exceptions.LibraryExecutionError) def __logLibraryErrors(self, errorCode, message): """ - This method logs the Library errors. + Logs the Library errors. """ raise foundations.exceptions.LibraryExecutionError("{0} | Exit code '{1}', message: '{2}'".format( @@ -2203,7 +2203,7 @@ def __logLibraryErrors(self, errorCode, message): def getImageFormat(self, imagePath=None): """ - This method gets the file format. + Gets the file format. :param imagePath: Image path. ( String ) :return: File format. ( FREE_IMAGE_FORMAT ) @@ -2221,7 +2221,7 @@ def getImageFormat(self, imagePath=None): @foundations.exceptions.handleExceptions(foundations.exceptions.LibraryExecutionError) def load(self): """ - This method loads the file. + Loads the file. :return: Method success. ( Boolean ) """ @@ -2241,7 +2241,7 @@ def load(self): def save(self): """ - This method saves the file. + Saves the file. :return: Method success. ( Boolean ) """ @@ -2251,7 +2251,7 @@ def save(self): @foundations.exceptions.handleExceptions(foundations.exceptions.LibraryExecutionError) def saveAs(self, imageFormat, imagePath, flags=FI_DEFAULT_NULL): """ - This method saves the image to the given file. + Saves the image to the given file. :param imageFormat: Image format. ( Integer ) :param imagePath: Image path. ( String ) @@ -2271,7 +2271,7 @@ def saveAs(self, imageFormat, imagePath, flags=FI_DEFAULT_NULL): def convertToType(self, targetType, linearScale=True): """ - This method converts the bitmap to given type. + Converts the bitmap to given type. :param targetType: Target type. ( Integer ) :param linearScale: Linear scale. ( Boolean ) @@ -2286,7 +2286,7 @@ def convertToType(self, targetType, linearScale=True): def convertToLdr(self, gamma=2.2): """ - This method converts the HDR bitmap to LDR. + Converts the HDR bitmap to LDR. :param gamma: Image conversion gamma. ( Float ) :return: Method success. ( Boolean ) @@ -2301,7 +2301,7 @@ def convertToLdr(self, gamma=2.2): @foundations.exceptions.handleExceptions(foundations.exceptions.LibraryExecutionError) def convertToQImage(self): """ - This method converts the bitmap to `QImage `_. + Converts the bitmap to `QImage `_. :return: Converted image. ( QImage ) """ diff --git a/sibl_gui/resources/patches/001_migrate_3-x-x_to_4-0-0.py b/sibl_gui/resources/patches/001_migrate_3-x-x_to_4-0-0.py index 0d5cbdcc..09300d56 100644 --- a/sibl_gui/resources/patches/001_migrate_3-x-x_to_4-0-0.py +++ b/sibl_gui/resources/patches/001_migrate_3-x-x_to_4-0-0.py @@ -59,7 +59,7 @@ #********************************************************************************************************************** def apply(): """ - This definition is called by the Application and triggers the patch execution. + Triggers the patch execution. :return: Definition success. ( Boolean ) """ diff --git a/sibl_gui/resources/patches/002_migrate_4-x-x_to_4-0-2.py b/sibl_gui/resources/patches/002_migrate_4-x-x_to_4-0-2.py index a415ce3a..2884e203 100644 --- a/sibl_gui/resources/patches/002_migrate_4-x-x_to_4-0-2.py +++ b/sibl_gui/resources/patches/002_migrate_4-x-x_to_4-0-2.py @@ -54,7 +54,7 @@ #********************************************************************************************************************** def apply(): """ - This definition is called by the Application and triggers the patch execution. + Triggers the patch execution. :return: Definition success. ( Boolean ) """ diff --git a/sibl_gui/resources/patches/003_migrate_4-x-x_to_4-0-3.py b/sibl_gui/resources/patches/003_migrate_4-x-x_to_4-0-3.py index 10875127..2dd2b936 100644 --- a/sibl_gui/resources/patches/003_migrate_4-x-x_to_4-0-3.py +++ b/sibl_gui/resources/patches/003_migrate_4-x-x_to_4-0-3.py @@ -55,7 +55,7 @@ #********************************************************************************************************************** def apply(): """ - This definition is called by the Application and triggers the patch execution. + Triggers the patch execution. :return: Definition success. ( Boolean ) """ diff --git a/sibl_gui/resources/patches/004_migrate_4-x-x_to_4-0-7.py b/sibl_gui/resources/patches/004_migrate_4-x-x_to_4-0-7.py index 4c3fe3b9..48407382 100644 --- a/sibl_gui/resources/patches/004_migrate_4-x-x_to_4-0-7.py +++ b/sibl_gui/resources/patches/004_migrate_4-x-x_to_4-0-7.py @@ -59,7 +59,7 @@ #********************************************************************************************************************** def apply(): """ - This definition is called by the Application and triggers the patch execution. + Triggers the patch execution. :return: Definition success. ( Boolean ) """ diff --git a/sibl_gui/tests/tests.py b/sibl_gui/tests/tests.py index d44b73e3..53d53694 100644 --- a/sibl_gui/tests/tests.py +++ b/sibl_gui/tests/tests.py @@ -46,7 +46,7 @@ #********************************************************************************************************************** def _setPackageDirectory(): """ - This definition sets the package directory in the path. + Sets the package directory in the path. :return: Definition success. ( Boolean ) """ @@ -59,7 +59,7 @@ def _setPackageDirectory(): def testsSuite(): """ - This definitions runs the tests suite. + Runs the tests suite. :return: Tests suite. ( TestSuite ) """ diff --git a/sibl_gui/tests/testsInternational.py b/sibl_gui/tests/testsInternational.py index 51fbf5b2..809fc5b1 100644 --- a/sibl_gui/tests/testsInternational.py +++ b/sibl_gui/tests/testsInternational.py @@ -56,7 +56,7 @@ #********************************************************************************************************************** def testsInternational(): """ - This definitions runs the international tests suite. + Runs the international tests suite. :return: Definition success. ( Boolean ) """ diff --git a/sibl_gui/tests/testsSibl_gui/testsExceptions.py b/sibl_gui/tests/testsSibl_gui/testsExceptions.py index 9bf71e22..75de44a1 100644 --- a/sibl_gui/tests/testsSibl_gui/testsExceptions.py +++ b/sibl_gui/tests/testsSibl_gui/testsExceptions.py @@ -50,7 +50,7 @@ def _gatherExceptions(): """ - This definition gathers the exceptions. + Gathers the exceptions. """ for attribute in dir(sibl_gui.exceptions): @@ -72,7 +72,7 @@ class ExceptionsTestCase(unittest.TestCase): def testRequiredAttributes(self): """ - This method tests presence of required attributes. + Tests presence of required attributes. """ requiredAttributes = ("value",) @@ -83,7 +83,7 @@ def testRequiredAttributes(self): def test__str__(self): """ - This method tests exceptions classes **__str__** method. + Tests exceptions classes **__str__** method. """ for exception in EXCEPTIONS: diff --git a/sibl_gui/tests/testsSibl_gui/testsGlobals/testsConstants.py b/sibl_gui/tests/testsSibl_gui/testsGlobals/testsConstants.py index 69515707..ee022bd3 100644 --- a/sibl_gui/tests/testsSibl_gui/testsGlobals/testsConstants.py +++ b/sibl_gui/tests/testsSibl_gui/testsGlobals/testsConstants.py @@ -55,7 +55,7 @@ class ConstantsTestCase(unittest.TestCase): def testRequiredAttributes(self): """ - This method tests presence of required attributes. + Tests presence of required attributes. """ requiredAttributes = ("applicationName", @@ -92,49 +92,49 @@ def testRequiredAttributes(self): def testApplicationNameAttribute(self): """ - This method tests :attr:`sibl_gui.globals.constants.Constants.applicationName` attribute. + Tests :attr:`sibl_gui.globals.constants.Constants.applicationName` attribute. """ self.assertRegexpMatches(Constants.applicationName, "\w+") def testMajorVersionAttribute(self): """ - This method tests :attr:`sibl_gui.globals.constants.Constants.majorVersion` attribute. + Tests :attr:`sibl_gui.globals.constants.Constants.majorVersion` attribute. """ self.assertRegexpMatches(Constants.releaseVersion, "\d") def testMinorVersionAttribute(self): """ - This method tests :attr:`sibl_gui.globals.constants.Constants.minorVersion` attribute. + Tests :attr:`sibl_gui.globals.constants.Constants.minorVersion` attribute. """ self.assertRegexpMatches(Constants.releaseVersion, "\d") def testChangeVersionAttribute(self): """ - This method tests :attr:`sibl_gui.globals.constants.Constants.changeVersion` attribute. + Tests :attr:`sibl_gui.globals.constants.Constants.changeVersion` attribute. """ self.assertRegexpMatches(Constants.releaseVersion, "\d") def testReleaseVersionAttribute(self): """ - This method tests :attr:`sibl_gui.globals.constants.Constants.releaseVersion` attribute. + Tests :attr:`sibl_gui.globals.constants.Constants.releaseVersion` attribute. """ self.assertRegexpMatches(Constants.releaseVersion, "\d\.\d\.\d") def testLoggerAttribute(self): """ - This method tests :attr:`sibl_gui.globals.constants.Constants.logger` attribute. + Tests :attr:`sibl_gui.globals.constants.Constants.logger` attribute. """ self.assertRegexpMatches(Constants.logger, "\w+") def testDefaultCodecAttribute(self): """ - This method tests :attr:`umbra.globals.constants.Constants.defaultCodec` attribute. + Tests :attr:`umbra.globals.constants.Constants.defaultCodec` attribute. """ validEncodings = ("utf-8", @@ -144,7 +144,7 @@ def testDefaultCodecAttribute(self): def testEncodingErrorAttribute(self): """ - This method tests :attr:`umbra.globals.constants.Constants.codecError` attribute. + Tests :attr:`umbra.globals.constants.Constants.codecError` attribute. """ validEncodingsErrors = ("strict", @@ -156,140 +156,140 @@ def testEncodingErrorAttribute(self): def testApplicationDirectoryAttribute(self): """ - This method tests :attr:`sibl_gui.globals.constants.Constants.applicationDirectory` attribute. + Tests :attr:`sibl_gui.globals.constants.Constants.applicationDirectory` attribute. """ self.assertRegexpMatches(Constants.applicationDirectory, "\w+") def testProviderDirectoryAttribute(self): """ - This method tests :attr:`sibl_gui.globals.constants.Constants.providerDirectory` attribute. + Tests :attr:`sibl_gui.globals.constants.Constants.providerDirectory` attribute. """ self.assertRegexpMatches(Constants.providerDirectory, "\w+") def testDatabaseDirectoryAttribute(self): """ - This method tests :attr:`sibl_gui.globals.constants.Constants.databaseDirectory` attribute. + Tests :attr:`sibl_gui.globals.constants.Constants.databaseDirectory` attribute. """ self.assertRegexpMatches(Constants.databaseDirectory, "\w+") def testPatchesDirectoryAttribute(self): """ - This method tests :attr:`sibl_gui.globals.constants.Constants.patchesDirectory` attribute. + Tests :attr:`sibl_gui.globals.constants.Constants.patchesDirectory` attribute. """ self.assertRegexpMatches(Constants.patchesDirectory, "\w+") def testSettingsDirectoryAttribute(self): """ - This method tests :attr:`sibl_gui.globals.constants.Constants.settingsDirectory` attribute. + Tests :attr:`sibl_gui.globals.constants.Constants.settingsDirectory` attribute. """ self.assertRegexpMatches(Constants.settingsDirectory, "\w+") def testUserComponentsDirectoryAttribute(self): """ - This method tests :attr:`sibl_gui.globals.constants.Constants.userComponentsDirectory` attribute. + Tests :attr:`sibl_gui.globals.constants.Constants.userComponentsDirectory` attribute. """ self.assertRegexpMatches(Constants.userComponentsDirectory, "\w+") def testLoggingDirectoryAttribute(self): """ - This method tests :attr:`sibl_gui.globals.constants.Constants.loggingDirectory` attribute. + Tests :attr:`sibl_gui.globals.constants.Constants.loggingDirectory` attribute. """ self.assertRegexpMatches(Constants.loggingDirectory, "\w+") def testTemplatesDirectoryAttribute(self): """ - This method tests :attr:`sibl_gui.globals.constants.Constants.templatesDirectory` attribute. + Tests :attr:`sibl_gui.globals.constants.Constants.templatesDirectory` attribute. """ self.assertRegexpMatches(Constants.templatesDirectory, "\w+") def testIoDirectoryAttribute(self): """ - This method tests :attr:`sibl_gui.globals.constants.Constants.ioDirectory` attribute. + Tests :attr:`sibl_gui.globals.constants.Constants.ioDirectory` attribute. """ self.assertRegexpMatches(Constants.ioDirectory, "\w+") def testPreferencesDirectoriesAttribute(self): """ - This method tests :attr:`sibl_gui.globals.constants.Constants.preferencesDirectories` attribute. + Tests :attr:`sibl_gui.globals.constants.Constants.preferencesDirectories` attribute. """ self.assertIsInstance(Constants.preferencesDirectories, tuple) def testCoreComponentsDirectoryAttribute(self): """ - This method tests :attr:`sibl_gui.globals.constants.Constants.coreComponentsDirectory` attribute. + Tests :attr:`sibl_gui.globals.constants.Constants.coreComponentsDirectory` attribute. """ self.assertRegexpMatches(Constants.coreComponentsDirectory, "\w+") def testAddonsComponentsDirectoryAttribute(self): """ - This method tests :attr:`sibl_gui.globals.constants.Constants.addonsComponentsDirectory` attribute. + Tests :attr:`sibl_gui.globals.constants.Constants.addonsComponentsDirectory` attribute. """ self.assertRegexpMatches(Constants.addonsComponentsDirectory, "\w+") def testResourcesDirectoryAttribute(self): """ - This method tests :attr:`sibl_gui.globals.constants.Constants.resourcesDirectory` attribute. + Tests :attr:`sibl_gui.globals.constants.Constants.resourcesDirectory` attribute. """ self.assertRegexpMatches(Constants.resourcesDirectory, "\w+") def testPatchesFileAttribute(self): """ - This method tests :attr:`sibl_gui.globals.constants.Constants.patchesFile` attribute. + Tests :attr:`sibl_gui.globals.constants.Constants.patchesFile` attribute. """ self.assertRegexpMatches(Constants.patchesFile, "\w+") def testDatabaseFileAttribute(self): """ - This method tests :attr:`sibl_gui.globals.constants.Constants.databaseFile` attribute. + Tests :attr:`sibl_gui.globals.constants.Constants.databaseFile` attribute. """ self.assertRegexpMatches(Constants.databaseFile, "\w+") def testSettingsFileAttribute(self): """ - This method tests :attr:`sibl_gui.globals.constants.Constants.settingsFile` attribute. + Tests :attr:`sibl_gui.globals.constants.Constants.settingsFile` attribute. """ self.assertRegexpMatches(Constants.settingsFile, "\w+") def testLoggingFileAttribute(self): """ - This method tests :attr:`sibl_gui.globals.constants.Constants.loggingFile` attribute. + Tests :attr:`sibl_gui.globals.constants.Constants.loggingFile` attribute. """ self.assertRegexpMatches(Constants.loggingFile, "\w+") def testDatabaseMigrationsFilesExtensionAttribute(self): """ - This method tests :attr:`sibl_gui.globals.constants.Constants.databaseMigrationsFilesExtension` attribute. + Tests :attr:`sibl_gui.globals.constants.Constants.databaseMigrationsFilesExtension` attribute. """ self.assertRegexpMatches(Constants.databaseMigrationsFilesExtension, "\w+") def testLibrariesDirectoryAttribute(self): """ - This method tests :attr:`sibl_gui.globals.constants.Constants.librariesDirectory` attribute. + Tests :attr:`sibl_gui.globals.constants.Constants.librariesDirectory` attribute. """ self.assertRegexpMatches(Constants.librariesDirectory, "\w+") def testFreeImageLibraryAttribute(self): """ - This method tests :attr:`sibl_gui.globals.constants.Constants.freeImageLibrary` attribute. + Tests :attr:`sibl_gui.globals.constants.Constants.freeImageLibrary` attribute. """ self.assertRegexpMatches(Constants.freeImageLibrary, "\w+") diff --git a/sibl_gui/tests/testsSibl_gui/testsGlobals/testsRuntimeGlobals.py b/sibl_gui/tests/testsSibl_gui/testsGlobals/testsRuntimeGlobals.py index b98e6f3e..774d5ab7 100644 --- a/sibl_gui/tests/testsSibl_gui/testsGlobals/testsRuntimeGlobals.py +++ b/sibl_gui/tests/testsSibl_gui/testsGlobals/testsRuntimeGlobals.py @@ -55,7 +55,7 @@ class RuntimeGlobalsTestCase(unittest.TestCase): def testRequiredAttributes(self): """ - This method tests presence of required attributes. + Tests presence of required attributes. """ requiredAttributes = ("templatesFactoryDirectory", diff --git a/sibl_gui/tests/testsSibl_gui/testsGlobals/testsUiConstants.py b/sibl_gui/tests/testsSibl_gui/testsGlobals/testsUiConstants.py index b99e6506..20b9e523 100644 --- a/sibl_gui/tests/testsSibl_gui/testsGlobals/testsUiConstants.py +++ b/sibl_gui/tests/testsSibl_gui/testsGlobals/testsUiConstants.py @@ -56,7 +56,7 @@ class UiConstantsTestCase(unittest.TestCase): def testRequiredAttributes(self): """ - This method tests presence of required attributes. + Tests presence of required attributes. """ requiredAttributes = ("uiFile", @@ -114,70 +114,70 @@ def testRequiredAttributes(self): def testUiFileAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.uiFile` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.uiFile` attribute. """ self.assertRegexpMatches(UiConstants.uiFile, "\w+") def testWindowsStylesheetFileAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.windowsStylesheetFile` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.windowsStylesheetFile` attribute. """ self.assertRegexpMatches(UiConstants.windowsStylesheetFile, "\w+") def testDarwinStylesheetFileAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.darwinStylesheetFile` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.darwinStylesheetFile` attribute. """ self.assertRegexpMatches(UiConstants.darwinStylesheetFile, "\w+") def testLinuxStylesheetFileAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.linuxStylesheetFile` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.linuxStylesheetFile` attribute. """ self.assertRegexpMatches(UiConstants.linuxStylesheetFile, "\w+") def testWindowsStyleAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.windowsStyle` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.windowsStyle` attribute. """ self.assertRegexpMatches(UiConstants.windowsStyle, "\w+") def testDarwinStyleAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.darwinStyle` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.darwinStyle` attribute. """ self.assertRegexpMatches(UiConstants.darwinStyle, "\w+") def testSettingsFileAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.settingsFile` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.settingsFile` attribute. """ self.assertRegexpMatches(UiConstants.settingsFile, "\w+") def testLinuxStyleAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.linuxStyle` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.linuxStyle` attribute. """ self.assertRegexpMatches(UiConstants.linuxStyle, "\w+") def testLayoutsFileAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.layoutsFile` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.layoutsFile` attribute. """ self.assertRegexpMatches(UiConstants.layoutsFile, "\w+") def testApplicationWindowsIconAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.applicationWindowsIcon` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.applicationWindowsIcon` attribute. """ self.assertRegexpMatches(UiConstants.applicationWindowsIcon, "\w+") @@ -185,7 +185,7 @@ def testApplicationWindowsIconAttribute(self): def testSplashscreemImageAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.splashScreenImage` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.splashScreenImage` attribute. """ self.assertRegexpMatches(UiConstants.splashScreenImage, "\w+") @@ -194,7 +194,7 @@ def testSplashscreemImageAttribute(self): def testLogoImageAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.logoImage` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.logoImage` attribute. """ self.assertRegexpMatches(UiConstants.logoImage, "\w+") @@ -203,7 +203,7 @@ def testLogoImageAttribute(self): def testDefaultToolbarIconSizeAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.defaultToolbarIconSize` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.defaultToolbarIconSize` attribute. """ self.assertIsInstance(UiConstants.defaultToolbarIconSize, int) @@ -212,175 +212,175 @@ def testDefaultToolbarIconSizeAttribute(self): def testCentralWidgetIconAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.centralWidgetIcon` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.centralWidgetIcon` attribute. """ self.assertRegexpMatches(UiConstants.centralWidgetIcon, "\w+") def testCentralWidgetHoverIconAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.centralWidgetHoverIcon` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.centralWidgetHoverIcon` attribute. """ self.assertRegexpMatches(UiConstants.centralWidgetHoverIcon, "\w+") def testCentralWidgetActiveIconAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.centralWidgetActiveIcon` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.centralWidgetActiveIcon` attribute. """ self.assertRegexpMatches(UiConstants.centralWidgetActiveIcon, "\w+") def testCustomLayoutsIconAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.customLayoutsIcon` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.customLayoutsIcon` attribute. """ self.assertRegexpMatches(UiConstants.customLayoutsIcon, "\w+") def testLayoutHoverIconAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.customLayoutsHoverIcon` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.customLayoutsHoverIcon` attribute. """ self.assertRegexpMatches(UiConstants.customLayoutsHoverIcon, "\w+") def testLayoutActiveIconAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.customLayoutsActiveIcon` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.customLayoutsActiveIcon` attribute. """ self.assertRegexpMatches(UiConstants.customLayoutsActiveIcon, "\w+") def testMiscellaneousIconAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.miscellaneousIcon` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.miscellaneousIcon` attribute. """ self.assertRegexpMatches(UiConstants.miscellaneousIcon, "\w+") def testMiscellaneousHoverIconAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.miscellaneousHoverIcon` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.miscellaneousHoverIcon` attribute. """ self.assertRegexpMatches(UiConstants.miscellaneousHoverIcon, "\w+") def testMiscellaneousActiveIconAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.miscellaneousActiveIcon` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.miscellaneousActiveIcon` attribute. """ self.assertRegexpMatches(UiConstants.miscellaneousActiveIcon, "\w+") def testLibraryIconAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.libraryIcon` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.libraryIcon` attribute. """ self.assertRegexpMatches(UiConstants.libraryIcon, "\w+") def testLibraryHoverIconAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.libraryHoverIcon` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.libraryHoverIcon` attribute. """ self.assertRegexpMatches(UiConstants.libraryHoverIcon, "\w+") def testLibraryActiveIconAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.libraryActiveIcon` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.libraryActiveIcon` attribute. """ self.assertRegexpMatches(UiConstants.libraryActiveIcon, "\w+") def testInspectIconAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.inspectIcon` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.inspectIcon` attribute. """ self.assertRegexpMatches(UiConstants.inspectIcon, "\w+") def testInspectHoverIconAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.inspectHoverIcon` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.inspectHoverIcon` attribute. """ self.assertRegexpMatches(UiConstants.inspectHoverIcon, "\w+") def testInspectActiveIconAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.inspectActiveIcon` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.inspectActiveIcon` attribute. """ self.assertRegexpMatches(UiConstants.inspectActiveIcon, "\w+") def testExportIconAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.exportIcon` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.exportIcon` attribute. """ self.assertRegexpMatches(UiConstants.exportIcon, "\w+") def testExportHoverIconAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.exportHoverIcon` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.exportHoverIcon` attribute. """ self.assertRegexpMatches(UiConstants.exportHoverIcon, "\w+") def testExportActiveIconAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.exportActiveIcon` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.exportActiveIcon` attribute. """ self.assertRegexpMatches(UiConstants.exportActiveIcon, "\w+") def testEditIconAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.editIcon` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.editIcon` attribute. """ self.assertRegexpMatches(UiConstants.editIcon, "\w+") def testEditHoverIconAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.editHoverIcon` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.editHoverIcon` attribute. """ self.assertRegexpMatches(UiConstants.editHoverIcon, "\w+") def testEditActiveIconAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.editActiveIcon` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.editActiveIcon` attribute. """ self.assertRegexpMatches(UiConstants.editActiveIcon, "\w+") def testPreferencesIconAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.preferencesIcon` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.preferencesIcon` attribute. """ self.assertRegexpMatches(UiConstants.preferencesIcon, "\w+") def testPreferencesHoverIconAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.preferencesHoverIcon` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.preferencesHoverIcon` attribute. """ self.assertRegexpMatches(UiConstants.preferencesHoverIcon, "\w+") def testPreferencesActiveIconAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.preferencesActiveIcon` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.preferencesActiveIcon` attribute. """ self.assertRegexpMatches(UiConstants.preferencesActiveIcon, "\w+") def testFormatErrorImageAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.formatErrorImage` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.formatErrorImage` attribute. """ self.assertRegexpMatches(UiConstants.formatErrorImage, "\w+") @@ -389,7 +389,7 @@ def testFormatErrorImageAttribute(self): def testMissingImageAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.missingImage` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.missingImage` attribute. """ self.assertRegexpMatches(UiConstants.missingImage, "\w+") @@ -398,7 +398,7 @@ def testMissingImageAttribute(self): def testLoadingImageAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.loadingImage` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.loadingImage` attribute. """ self.assertRegexpMatches(UiConstants.loadingImage, "\w+") @@ -407,35 +407,35 @@ def testLoadingImageAttribute(self): def testStartupLayoutAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.startupLayout` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.startupLayout` attribute. """ self.assertRegexpMatches(UiConstants.startupLayout, "\w+") def testDevelopmentLayoutAttribute(self): """ - This method tests :attr:`umbra.globals.uiConstants.UiConstants.developmentLayout` attribute. + Tests :attr:`umbra.globals.uiConstants.UiConstants.developmentLayout` attribute. """ self.assertRegexpMatches(UiConstants.developmentLayout, "\w+") def testHelpFileAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.helpFile` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.helpFile` attribute. """ self.assertRegexpMatches(UiConstants.helpFile, "(http|ftp|https)://([a-zA-Z0-9\-\.]+)/?") def testApiFileAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.apiFile` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.apiFile` attribute. """ self.assertRegexpMatches(UiConstants.apiFile, "(http|ftp|https)://([a-zA-Z0-9\-\.]+)/?") def testNativeImageFormatsAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.nativeImageFormats` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.nativeImageFormats` attribute. """ self.assertIsInstance(UiConstants.nativeImageFormats, dict) @@ -446,7 +446,7 @@ def testNativeImageFormatsAttribute(self): def testThirdPartyImageFormatsAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.thirdPartyImageFormats` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.thirdPartyImageFormats` attribute. """ self.assertIsInstance(UiConstants.thirdPartyImageFormats, dict) @@ -457,7 +457,7 @@ def testThirdPartyImageFormatsAttribute(self): def testThumbnailsSizesAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.thumbnailsSizes` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.thumbnailsSizes` attribute. """ self.assertIsInstance(UiConstants.thumbnailsSizes, dict) @@ -467,14 +467,14 @@ def testThumbnailsSizesAttribute(self): def testThumbnailsCacheDirectoryAttribute(self): """ - This method tests :attr:`sibl_gui.globals.uiConstants.UiConstants.thumbnailsCacheDirectory` attribute. + Tests :attr:`sibl_gui.globals.uiConstants.UiConstants.thumbnailsCacheDirectory` attribute. """ self.assertRegexpMatches(UiConstants.thumbnailsCacheDirectory, "\w+") def testCrittercismIdAttribute(self): """ - This method tests :attr:`umbra.globals.uiConstants.UiConstants.crittercismId` attribute. + Tests :attr:`umbra.globals.uiConstants.UiConstants.crittercismId` attribute. """ self.assertRegexpMatches(UiConstants.crittercismId, "\w+") diff --git a/sibl_gui/ui/caches.py b/sibl_gui/ui/caches.py index a02cbe95..e4f15e5b 100644 --- a/sibl_gui/ui/caches.py +++ b/sibl_gui/ui/caches.py @@ -62,7 +62,7 @@ class CacheMetrics(foundations.dataStructures.Structure): def __init__(self, **kwargs): """ - This method initializes the class. + Initializes the class. :param kwargs: type, content. ( Key / Value pairs ) """ @@ -94,7 +94,7 @@ class AbstractResourcesCache(QObject): def __init__(self, parent=None): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) """ @@ -109,7 +109,7 @@ def __init__(self, parent=None): @property def mapping(self): """ - This method is the property for **self.__mapping** attribute. + Property for **self.__mapping** attribute. :return: self.__mapping. ( Dictionary ) """ @@ -120,7 +120,7 @@ def mapping(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def mapping(self, value): """ - This method is the setter method for **self.__mapping** attribute. + Setter for **self.__mapping** attribute. :param value: Attribute value. ( Dictionary ) """ @@ -132,7 +132,7 @@ def mapping(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def mapping(self): """ - This method is the deleter method for **self.__mapping** attribute. + Deleter for **self.__mapping** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -143,7 +143,7 @@ def mapping(self): #****************************************************************************************************************** def __getitem__(self, item): """ - This method reimplements the :meth:`object.__getitem__` method. + Reimplements the :meth:`object.__getitem__` method. :param item: Item name. ( String ) :return: Item. ( Object ) @@ -153,7 +153,7 @@ def __getitem__(self, item): def __setitem__(self, key, value): """ - This method reimplements the :meth:`object.__setitem__` method. + Reimplements the :meth:`object.__setitem__` method. :param key: Key. ( String ) :param value: Item. ( Object ) @@ -163,7 +163,7 @@ def __setitem__(self, key, value): def __iter__(self): """ - This method reimplements the :meth:`object.__iter__` method. + Reimplements the :meth:`object.__iter__` method. :return: Paths iterator. ( Object ) """ @@ -172,7 +172,7 @@ def __iter__(self): def __contains__(self, item): """ - This method reimplements the :meth:`object.__contains__` method. + Reimplements the :meth:`object.__contains__` method. :param item: Item name. ( String ) :return: Item existence. ( Boolean ) @@ -182,7 +182,7 @@ def __contains__(self, item): def __len__(self): """ - This method reimplements the :meth:`object.__len__` method. + Reimplements the :meth:`object.__len__` method. :return: Paths count. ( Integer ) """ @@ -191,7 +191,7 @@ def __len__(self): def isCached(self, key): """ - This method returns if given content is cached. + Returns if given content is cached. :param key: Content to retrieve. ( Object ) :return: Is content cached. ( Boolean ) @@ -201,7 +201,7 @@ def isCached(self, key): def listContent(self): """ - This method lists the cache content. + Lists the cache content. :return: Cache content. ( List ) """ @@ -210,7 +210,7 @@ def listContent(self): def addContent(self, **content): """ - This method adds given content to the cache. + Adds given content to the cache. :param \*\*content: Content to add. ( \*\* ) :return: Method success. ( Boolean ) @@ -224,7 +224,7 @@ def addContent(self, **content): def removeContent(self, *keys): """ - This method removes given content from the cache. + Removes given content from the cache. :param \*keys: Content to remove. ( \* ) :return: Method success. ( Boolean ) @@ -242,7 +242,7 @@ def removeContent(self, *keys): def getContent(self, key): """ - This method gets given content from the cache. + Gets given content from the cache. :param key: Content to retrieve. ( Object ) :return: Content. ( Object ) @@ -254,7 +254,7 @@ def getContent(self, key): def flushContent(self): """ - This method flushes the cache content. + Flushes the cache content. :return: Method success. ( Boolean ) """ @@ -268,7 +268,7 @@ def flushContent(self): def getMetrics(self): """ - This method returns the cache metrics. + Returns the cache metrics. :return: Cache metrics. ( Dictionary ) """ @@ -285,7 +285,7 @@ class AsynchronousGraphicsItemsCache(AbstractResourcesCache): def __init__(self, parent=None, type=None, placeholder=None): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param type: Cache type. ( QImage / QPixmap / QIcon ) @@ -313,7 +313,7 @@ def __init__(self, parent=None, type=None, placeholder=None): @property def type(self): """ - This method is the property for **self.__type** attribute. + Property for **self.__type** attribute. :return: self.__type. ( QObject ) """ @@ -324,7 +324,7 @@ def type(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def type(self, value): """ - This method is the setter method for **self.__type** attribute. + Setter for **self.__type** attribute. :param value: Attribute value. ( QObject ) """ @@ -336,7 +336,7 @@ def type(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def type(self): """ - This method is the deleter method for **self.__type** attribute. + Deleter for **self.__type** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -345,7 +345,7 @@ def type(self): @property def placeholder(self): """ - This method is the property for **self.__placeholder** attribute. + Property for **self.__placeholder** attribute. :return: self.__placeholder. ( String ) """ @@ -356,7 +356,7 @@ def placeholder(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def placeholder(self, value): """ - This method is the setter method for **self.__placeholder** attribute. + Setter for **self.__placeholder** attribute. :param value: Attribute value. ( String ) """ @@ -368,7 +368,7 @@ def placeholder(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def placeholder(self): """ - This method is the deleter method for **self.__placeholder** attribute. + Deleter for **self.__placeholder** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -377,7 +377,7 @@ def placeholder(self): @property def placeholderGraphicsItem(self): """ - This method is the property for **self.__placeholderGraphicsItem** attribute. + Property for **self.__placeholderGraphicsItem** attribute. :return: self.__placeholderGraphicsItem. ( QObject ) """ @@ -388,7 +388,7 @@ def placeholderGraphicsItem(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def placeholderGraphicsItem(self, value): """ - This method is the setter method for **self.__placeholderGraphicsItem** attribute. + Setter for **self.__placeholderGraphicsItem** attribute. :param value: Attribute value. ( QObject ) """ @@ -400,7 +400,7 @@ def placeholderGraphicsItem(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def placeholderGraphicsItem(self): """ - This method is the deleter method for **self.__placeholderGraphicsItem** attribute. + Deleter for **self.__placeholderGraphicsItem** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -409,7 +409,7 @@ def placeholderGraphicsItem(self): @property def worker(self): """ - This method is the property for **self.__worker** attribute. + Property for **self.__worker** attribute. :return: self.__worker. ( QThread ) """ @@ -420,7 +420,7 @@ def worker(self): @foundations.exceptions.handleExceptions(AssertionError) def worker(self, value): """ - This method is the setter method for **self.__worker** attribute. + Setter for **self.__worker** attribute. :param value: Attribute value. ( QThread ) """ @@ -435,7 +435,7 @@ def worker(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def worker(self): """ - This method is the deleter method for **self.__worker** attribute. + Deleter for **self.__worker** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -446,7 +446,7 @@ def worker(self): #****************************************************************************************************************** def __worker__imageLoaded(self, image, size): """ - This method is triggered by the :obj:`AsynchronousGraphicsItemsCache.worker` method when an image has been loaded. + Defines the slot triggered by :obj:`AsynchronousGraphicsItemsCache.worker` method when an image has been loaded. :param image: Loaded image. ( QImage ) :param size: Image size. ( String ) @@ -463,7 +463,7 @@ def __worker__imageLoaded(self, image, size): def __setPlaceholderGraphicsItem(self, path): """ - This method sets the placeholderGraphicsItem graphics item. + Sets the placeholderGraphicsItem graphics item. :param path: Placeholder image path. ( String ) """ @@ -479,7 +479,7 @@ def __setPlaceholderGraphicsItem(self, path): def getContent(self, key, size="Default"): """ - This method reimplements the :meth:`AbstractResourcesCache.getContent` method. + Reimplements the :meth:`AbstractResourcesCache.getContent` method. :param key: Content to retrieve. ( Object ) :param size: Size to retrieve. ( String ) @@ -494,7 +494,7 @@ def getContent(self, key, size="Default"): def flushContent(self): """ - This method reimplements the :meth:`AbstractResourcesCache.flushContent` method. + Reimplements the :meth:`AbstractResourcesCache.flushContent` method. :return: Method success. ( Boolean ) """ @@ -510,7 +510,7 @@ def flushContent(self): def loadContent(self, **content): """ - This method loads given content into the cache. + Loads given content into the cache. :param \*\*content: Content to add. ( \*\* ) :return: Method success. ( Boolean ) @@ -539,7 +539,7 @@ def loadContent(self, **content): @foundations.exceptions.handleExceptions(foundations.exceptions.FileExistsError) def loadAsynchronousContent(self, **content): """ - This method loads given content asynchronously into the cache. + Loads given content asynchronously into the cache. :param \*\*content: Content to add. ( \*\* ) :return: Method success. ( Boolean ) @@ -580,7 +580,7 @@ def loadAsynchronousContent(self, **content): def getMetrics(self): """ - This method reimplements the :meth:`AbstractResourcesCache.getMetrics` method. + Reimplements the :meth:`AbstractResourcesCache.getMetrics` method. :return: Cache metrics. ( Dictionary ) """ diff --git a/sibl_gui/ui/common.py b/sibl_gui/ui/common.py index 4b92a511..81c492e3 100644 --- a/sibl_gui/ui/common.py +++ b/sibl_gui/ui/common.py @@ -79,7 +79,7 @@ #********************************************************************************************************************** def convertImage(image, type): """ - This definition converts given image to given type. + Converts given image to given type. :param image: Image to convert. ( QImage ) :param type: Type to convert to. ( QImage / QPixmap / QIcon ) @@ -96,7 +96,7 @@ def convertImage(image, type): def getThumbnailPath(path, size, cacheDirectory=None): """ - This definition returns given image thumbnail cached path at given size. + Returns given image thumbnail cached path at given size. :param path: Image path. ( String ) :param size: Thumbnail size. ( String ) @@ -115,7 +115,7 @@ def extractThumbnail(path, quality= -1, cacheDirectory=None): """ - This definition extract given image thumbnail at given size. + Extract given image thumbnail at given size. :param path: Image path. ( String ) :param size: Thumbnail size. ( String ) @@ -145,7 +145,7 @@ def extractThumbnail(path, def loadGraphicsItem(path, type, size="Default"): """ - This definition loads a graphic item: `QIcon `_, + Loads a graphic item: `QIcon `_, `QImage `_, `QPixmap `_. :param path: Image path. ( String ) @@ -184,7 +184,7 @@ def loadGraphicsItem(path, type, size="Default"): def getGraphicsItem(path, type, size="Default", asynchronousLoading=True, placeholder=None, imagesCache=None): """ - This definition returns a display item: `QIcon `_, + Returns a display item: `QIcon `_, `QImage `_, `QPixmap `_ instance. :param path: Image path. ( String ) @@ -215,7 +215,7 @@ def getGraphicsItem(path, type, size="Default", asynchronousLoading=True, placeh def getIcon(path, size="Default", asynchronousLoading=True, placeholder=None, imagesCache=None): """ - This definition returns a `QIcon `_ instance. + Returns a `QIcon `_ instance. :param path: Icon image path. ( String ) :param size: Image size. ( String ) @@ -230,7 +230,7 @@ def getIcon(path, size="Default", asynchronousLoading=True, placeholder=None, im def getPixmap(path, size="Default", asynchronousLoading=True, placeholder=None, imagesCache=None): """ - This definition returns a `QPixmap `_ instance. + Returns a `QPixmap `_ instance. :param path: Icon image path. ( String ) :param size: Image size. ( String ) @@ -245,7 +245,7 @@ def getPixmap(path, size="Default", asynchronousLoading=True, placeholder=None, def getImage(path, size="Default", asynchronousLoading=True, placeholder=None, imagesCache=None): """ - This definition returns a `QImage `_ instance. + Returns a `QImage `_ instance. :param path: Icon image path. ( String ) :param size: Image size. ( String ) @@ -260,7 +260,7 @@ def getImage(path, size="Default", asynchronousLoading=True, placeholder=None, i def createPixmap(width=128, height=128, text=None): """ - This definition create a default `QPixmap `_ instance. + Create a default `QPixmap `_ instance. :param width: Pixmap width. ( Integer ) :param height: Pixmap height. ( Integer ) @@ -281,7 +281,7 @@ def createPixmap(width=128, height=128, text=None): @foundations.exceptions.handleExceptions(foundations.exceptions.FileExistsError) def getImageInformationsHeader(path, graphicsItem): """ - This definition returns a :class:`sibl_gui.libraries.freeImage.freeImage.ImageInformationsHeader` class + Returns a :class:`sibl_gui.libraries.freeImage.freeImage.ImageInformationsHeader` class from given path and graphics item. :param path: Image path. ( String ) @@ -303,7 +303,7 @@ def getImageInformationsHeader(path, graphicsItem): def filterImagePath(path): """ - This definition filters the image path. + Filters the image path. :param path: Image path. ( String ) :return: Path. ( String ) @@ -321,7 +321,7 @@ def filterImagePath(path): def getFormatedShotDate(date, time): """ - This definition returns a formated shot date. + Returns a formated shot date. :param date: Ibl Set date key value. ( String ) :param time: Ibl Set time key value. ( String ) diff --git a/sibl_gui/ui/models.py b/sibl_gui/ui/models.py index c95632d8..00a1e992 100644 --- a/sibl_gui/ui/models.py +++ b/sibl_gui/ui/models.py @@ -58,7 +58,7 @@ class GraphModel(umbra.ui.models.GraphModel): def __init__(self, parent=None, rootNode=None, horizontalHeaders=None, verticalHeaders=None, defaultNode=None): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param rootNode: Root node. ( AbstractCompositeNode ) @@ -76,7 +76,7 @@ def __init__(self, parent=None, rootNode=None, horizontalHeaders=None, verticalH #****************************************************************************************************************** def data(self, index, role=Qt.DisplayRole): """ - This method reimplements the :meth:`umbra.ui.models.GraphModel.data` method. + Reimplements the :meth:`umbra.ui.models.GraphModel.data` method. :param index: Index. ( QModelIndex ) :param role: Role. ( Integer ) diff --git a/sibl_gui/ui/nodes.py b/sibl_gui/ui/nodes.py index 3d7e5124..f4fe5bb1 100644 --- a/sibl_gui/ui/nodes.py +++ b/sibl_gui/ui/nodes.py @@ -58,7 +58,7 @@ class Mixin_GraphModelObject(object): def __init__(self): """ - This method initializes the class. + Initializes the class. """ @@ -74,7 +74,7 @@ def __init__(self): @property def iconSize(self): """ - This method is the property for **self.__iconSize** attribute. + Property for **self.__iconSize** attribute. :return: self.__iconSize. ( String ) """ @@ -85,7 +85,7 @@ def iconSize(self): @foundations.exceptions.handleExceptions(AssertionError) def iconSize(self, value): """ - This method is the setter method for **self.__iconSize** attribute. + Setter for **self.__iconSize** attribute. :param value: Attribute value. ( String ) """ @@ -99,7 +99,7 @@ def iconSize(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iconSize(self): """ - This method is the deleter method for **self.__iconSize** attribute. + Deleter for **self.__iconSize** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -108,7 +108,7 @@ def iconSize(self): @property def iconPlaceholder(self): """ - This method is the property for **self.__iconPlaceholder** attribute. + Property for **self.__iconPlaceholder** attribute. :return: self.__iconPlaceholder. ( QIcon ) """ @@ -119,7 +119,7 @@ def iconPlaceholder(self): @foundations.exceptions.handleExceptions(AssertionError) def iconPlaceholder(self, value): """ - This method is the setter method for **self.__iconPlaceholder** attribute. + Setter for **self.__iconPlaceholder** attribute. :param value: Attribute value. ( QIcon ) """ @@ -133,7 +133,7 @@ def iconPlaceholder(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def iconPlaceholder(self): """ - This method is the deleter method for **self.__iconPlaceholder** attribute. + Deleter for **self.__iconPlaceholder** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -153,7 +153,7 @@ def __init__(self, iconPlaceholder=None, **kwargs): """ - This method initializes the class. + Initializes the class. :param name: Attribute name. ( String ) :param value: Attribute value. ( Object ) @@ -191,7 +191,7 @@ def __init__(self, iconPlaceholder=None, **kwargs): """ - This method initializes the class. + Initializes the class. :param name: Node name. ( String ) :param parent: Node parent. ( AbstractNode / AbstractCompositeNode ) diff --git a/sibl_gui/ui/views.py b/sibl_gui/ui/views.py index 85d04043..f374a1b8 100644 --- a/sibl_gui/ui/views.py +++ b/sibl_gui/ui/views.py @@ -54,7 +54,7 @@ class Mixin_AbstractView(object): def __init__(self, model=None): """ - This method initializes the class. + Initializes the class. :param model: Model. ( QObject ) """ @@ -72,7 +72,7 @@ def __init__(self, model=None): @property def modelSelection(self): """ - This method is the property for **self.__modelSelection** attribute. + Property for **self.__modelSelection** attribute. :return: self.__modelSelection. ( Dictionary ) """ @@ -83,7 +83,7 @@ def modelSelection(self): @foundations.exceptions.handleExceptions(AssertionError) def modelSelection(self, value): """ - This method is the setter method for **self.__modelSelection** attribute. + Setter for **self.__modelSelection** attribute. :param value: Attribute value. ( Dictionary ) """ @@ -101,7 +101,7 @@ def modelSelection(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def modelSelection(self): """ - This method is the deleter method for **self.__modelSelection** attribute. + Deleter for **self.__modelSelection** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -112,7 +112,7 @@ def modelSelection(self): #****************************************************************************************************************** def setModel(self, model): """ - This method reimplements the **umbra.ui.views.Abstract_QListView.setModel** method. + Reimplements the **umbra.ui.views.Abstract_QListView.setModel** method. :param model: Model to set. ( QObject ) """ @@ -130,21 +130,21 @@ def setModel(self, model): def __model__modelAboutToBeReset(self): """ - This method is triggered when the Model is about to be reset. + Defines the slot triggered by the Model when about to be reset. """ self.storeModelSelection() def __model__modelReset(self): """ - This method is triggered when the Model is changed. + Defines the slot triggered by the Model when reset. """ self.restoreModelSelection() def storeModelSelection(self): """ - This method stores the Model selection. + Stores the Model selection. :return: Method success. ( Boolean ) """ @@ -158,7 +158,7 @@ def storeModelSelection(self): def restoreModelSelection(self): """ - This method restores the Model selection. + Restores the Model selection. :return: Method success. ( Boolean ) """ @@ -185,7 +185,7 @@ class Abstract_QListView(umbra.ui.views.Abstract_QListView, Mixin_AbstractView): def __init__(self, parent=None, model=None, readOnly=False, message=None): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param model: Model. ( QObject ) @@ -205,7 +205,7 @@ class Abstract_QTreeView(umbra.ui.views.Abstract_QTreeView, Mixin_AbstractView): def __init__(self, parent=None, model=None, readOnly=False, message=None): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) :param model: Model. ( QObject ) diff --git a/sibl_gui/ui/widgets/application_QToolBar.py b/sibl_gui/ui/widgets/application_QToolBar.py index a4504087..a57e01bd 100644 --- a/sibl_gui/ui/widgets/application_QToolBar.py +++ b/sibl_gui/ui/widgets/application_QToolBar.py @@ -68,7 +68,7 @@ class Application_QToolBar(umbra.ui.widgets.application_QToolBar.Application_QTo #****************************************************************************************************************** def __centralWidgetButton__clicked(self): """ - This method sets the **Central** Widget visibility. + Sets the **Central** Widget visibility. """ LOGGER.debug("> Central Widget button clicked!") @@ -80,7 +80,7 @@ def __centralWidgetButton__clicked(self): def setToolBarChildrenWidgets(self): """ - This method sets the toolBar children widgets. + Sets the toolBar children widgets. :return: Method success. ( Boolean ) """ @@ -117,7 +117,7 @@ def setToolBarChildrenWidgets(self): def getLayoutsActiveLabels(self): """ - This method returns the layouts **Active_QLabel** widgets. + Returns the layouts **Active_QLabel** widgets. :return: Layouts active labels. ( List ) """ @@ -166,7 +166,7 @@ def getLayoutsActiveLabels(self): return self.__layoutsActiveLabelsCollection.activeLabels def getCentralWidgetActiveLabel(self): """ - This method provides the default **Central_Widget_activeLabel** widget. + Provides the default **Central_Widget_activeLabel** widget. :return: Central Widget active label. ( Active_QLabel ) """ @@ -183,7 +183,7 @@ def getCentralWidgetActiveLabel(self): def extendMiscellaneousActiveLabel(self): """ - This method extends the default **Miscellaneous_activeLabel** widget. + Extends the default **Miscellaneous_activeLabel** widget. :return: Method success. ( Boolean ) """ @@ -196,7 +196,7 @@ def extendMiscellaneousActiveLabel(self): def __makeDonationDisplayMiscAction__triggered(self, checked): """ - This method is triggered by **'Actions|Umbra|ToolBar|Miscellaneous|Make A Donation ...'** action. + Defines the slot triggered by **'Actions|Umbra|ToolBar|Miscellaneous|Make A Donation ...'** action. :param checked: Checked state. ( Boolean ) :return: Method success. ( Boolean ) diff --git a/sibl_gui/ui/workers.py b/sibl_gui/ui/workers.py index 62939b5e..6233ec63 100644 --- a/sibl_gui/ui/workers.py +++ b/sibl_gui/ui/workers.py @@ -67,7 +67,7 @@ class GraphicsItem_worker(QThread): def __init__(self, parent=None): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. ( QObject ) """ @@ -86,7 +86,7 @@ def __init__(self, parent=None): @property def requests(self): """ - This method is the property for **self.__requests** attribute. + Property for **self.__requests** attribute. :return: self.__requests. ( Queue ) """ @@ -97,7 +97,7 @@ def requests(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def requests(self, value): """ - This method is the setter method for **self.__requests** attribute. + Setter for **self.__requests** attribute. :param value: Attribute value. ( Queue ) """ @@ -109,7 +109,7 @@ def requests(self, value): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def requests(self): """ - This method is the deleter method for **self.__requests** attribute. + Deleter for **self.__requests** attribute. """ raise foundations.exceptions.ProgrammingError( @@ -121,7 +121,7 @@ def requests(self): @foundations.exceptions.handleExceptions(foundations.exceptions.FileExistsError) def addRequest(self, request): """ - This method adds given request to the requests queue. + Adds given request to the requests queue. :param request: Request. ( Tuple / List ) :return: Method success. ( Boolean ) @@ -138,7 +138,7 @@ def addRequest(self, request): def flushRequests(self): """ - This method flushes the requests queue. + Flushes the requests queue. :return: Method success. ( Boolean ) """ @@ -149,7 +149,7 @@ def flushRequests(self): def run(self): """ - This method reimplements the :meth:`QThread.run` method. + Reimplements the :meth:`QThread.run` method. """ while True: @@ -165,7 +165,7 @@ def run(self): def quit(self): """ - This method reimplements the :meth:`QThread.quit` method. + Reimplements the :meth:`QThread.quit` method. """ self.__interrupt = True diff --git a/utilities/__init__.py b/utilities/__init__.py index 269d6572..3fb4857c 100644 --- a/utilities/__init__.py +++ b/utilities/__init__.py @@ -32,7 +32,7 @@ #********************************************************************************************************************** def _setEncoding(): """ - This definition sets the Package encoding. + Sets the Package encoding. """ import sys diff --git a/utilities/getDependenciesInformations.py b/utilities/getDependenciesInformations.py index 8ca25737..1032ddb5 100755 --- a/utilities/getDependenciesInformations.py +++ b/utilities/getDependenciesInformations.py @@ -77,7 +77,7 @@ #********************************************************************************************************************** def getDependenciesInformations(): """ - This definition gets sIBL_GUI dependencies informations file. + Gets sIBL_GUI dependencies informations file. """ content = ["[Dependencies]\n"] diff --git a/utilities/getHDRLabsDocumentation.py b/utilities/getHDRLabsDocumentation.py index 80ee73a6..c03c466d 100644 --- a/utilities/getHDRLabsDocumentation.py +++ b/utilities/getHDRLabsDocumentation.py @@ -53,7 +53,7 @@ #********************************************************************************************************************** def getHDRLabsDocumentation(fileIn, fileOut): """ - This definition extracts sIBL_GUI Documentation body for HDRLabs.com. + Extracts sIBL_GUI Documentation body for HDRLabs.com. :param fileIn: File to convert. ( String ) :param fileOut: Output file. ( String ) diff --git a/utilities/getSphinxDocumentationApi.py b/utilities/getSphinxDocumentationApi.py index 55888802..b7d6ac99 100755 --- a/utilities/getSphinxDocumentationApi.py +++ b/utilities/getSphinxDocumentationApi.py @@ -110,7 +110,7 @@ #********************************************************************************************************************** def getSphinxDocumentationApi(packages, cloneDirectory, outputDirectory, apiFile): """ - This definition gets Sphinx documentation API. + Gets Sphinx documentation API. :param packages: Packages. ( String ) :param cloneDirectory: Source clone directory. ( String ) diff --git a/utilities/getSphinxDocumentationTocTree.py b/utilities/getSphinxDocumentationTocTree.py index 0645f248..c9333a28 100644 --- a/utilities/getSphinxDocumentationTocTree.py +++ b/utilities/getSphinxDocumentationTocTree.py @@ -81,7 +81,7 @@ #********************************************************************************************************************** def getSphinxDocumentationTocTree(title, fileIn, fileOut, contentDirectory): """ - This definition gets Sphinx documentation index file. + Gets Sphinx documentation index file. :param title: Package title. ( String ) :param fileIn: File to convert. ( String ) diff --git a/utilities/listImports.py b/utilities/listImports.py index 3f79a8ac..f91eec96 100644 --- a/utilities/listImports.py +++ b/utilities/listImports.py @@ -59,7 +59,7 @@ #********************************************************************************************************************** def listImports(packages, filtersIn, filtersOut): """ - This definition lists Application imports. + Lists Application imports. :param packages: Packages. ( List ) :param filtersIn: Filters in. ( Tuple / List ) diff --git a/utilities/reStructuredTextToHtml.py b/utilities/reStructuredTextToHtml.py index bffe7c45..37f6a81b 100644 --- a/utilities/reStructuredTextToHtml.py +++ b/utilities/reStructuredTextToHtml.py @@ -64,7 +64,7 @@ #********************************************************************************************************************** def reStructuredTextToHtml(fileIn, fileOut): """ - This definition outputs a reStructuredText file to html. + Outputs a reStructuredText file to html. :param fileIn: File to convert. ( String ) :param fileOut: Output file. ( String ) diff --git a/utilities/recursiveRemove.py b/utilities/recursiveRemove.py index ab86b66c..8c65b184 100644 --- a/utilities/recursiveRemove.py +++ b/utilities/recursiveRemove.py @@ -42,7 +42,7 @@ #********************************************************************************************************************** def recursiveRemove(rootDirectory, pattern): """ - This definition recursively deletes the matching items. + Recursively deletes the matching items. :param rootDirectory: Directory to recurse. ( String ) :param pattern: Pattern to match. ( String ) @@ -59,7 +59,7 @@ def recursiveRemove(rootDirectory, pattern): def remove(item): """ - This definition deletes given item. + Deletes given item. :param item: Item to delete. ( String ) """ From 72a239050cd24551a2c11bdc42c754a36899f86b Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Sat, 1 Mar 2014 16:12:53 +0100 Subject: [PATCH 15/54] Update various docstrings. --- utilities/getPackagePath.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/utilities/getPackagePath.py b/utilities/getPackagePath.py index acf02ee1..e7e07b22 100755 --- a/utilities/getPackagePath.py +++ b/utilities/getPackagePath.py @@ -41,7 +41,7 @@ #********************************************************************************************************************** def getPackagePath(package): """ - This writes given package path to stdout. + Writes given package path to stdout. """ package = __import__(package) From 855e8537b58c63d1f78f4714268ebc132629b9de Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Wed, 5 Mar 2014 21:13:23 +0100 Subject: [PATCH 16/54] Change copyrights dates in "docs.sphinx.source.conf" module. --- docs/sphinx/source/conf.py | 78 +++++++++++++++++++------------------- 1 file changed, 39 insertions(+), 39 deletions(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 3c8cccbc..cb3a7789 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -18,12 +18,12 @@ # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath(".")) +# sys.path.insert(0, os.path.abspath(".")) # -- General configuration ----------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = "1.0" +# needs_sphinx = "1.0" # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named "sphinx.ext.*") or your custom ones. @@ -41,14 +41,14 @@ source_suffix = ".rst" # The encoding of source files. -#source_encoding = "utf-8-sig" +# source_encoding = "utf-8-sig" # The master toctree document. master_doc = "index" # General information about the project. project = u"sIBL_GUI" -copyright = u"2011, Thomas Mansencal" +copyright = u"2011 - 2014, Thomas Mansencal" # The version info for the project you"re documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -61,37 +61,37 @@ # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -#language = None +# language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: -#today = "" +# today = "" # Else, today_fmt is used as the format for a strftime call. -#today_fmt = "%B %d, %Y" +# today_fmt = "%B %d, %Y" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = [] # The reST default role (used for this markup: `text`) to use for all documents. -#default_role = None +# default_role = None # If true, "()" will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +# add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). -#add_module_names = True +# add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -#show_authors = False +# show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = "sphinx" # A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] +# modindex_common_prefix = [] # -- Options for HTML output --------------------------------------------------- @@ -102,26 +102,26 @@ # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} +# html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +# html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -#html_title = None +# html_title = None # A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None +# html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = None +# html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None +# html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, @@ -130,44 +130,44 @@ # If not "", a "Last updated on:" timestamp is inserted at every page bottom, # using the given strftime format. -#html_last_updated_fmt = "%b %d, %Y" +# html_last_updated_fmt = "%b %d, %Y" # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. -#html_use_smartypants = True +# html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +# html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. -#html_additional_pages = {} +# html_additional_pages = {} # If false, no module index is generated. -#html_domain_indices = True +# html_domain_indices = True # If false, no index is generated. -#html_use_index = True +# html_use_index = True # If true, the index is split into individual pages for each letter. -#html_split_index = False +# html_split_index = False # If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +# html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +# html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True +# html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. -#html_use_opensearch = "" +# html_use_opensearch = "" # This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None +# html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = "sIBL_GUIdoc" @@ -175,10 +175,10 @@ # -- Options for LaTeX output -------------------------------------------------- # The paper size ("letter" or "a4"). -#latex_paper_size = "letter" +# latex_paper_size = "letter" # The font size ("10pt", "11pt" or "12pt"). -#latex_font_size = "10pt" +# latex_font_size = "10pt" # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). @@ -189,26 +189,26 @@ # The name of an image file (relative to this directory) to place at the top of # the title page. -#latex_logo = None +# latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. -#latex_use_parts = False +# latex_use_parts = False # If true, show page references after internal links. -#latex_show_pagerefs = False +# latex_show_pagerefs = False # If true, show URL addresses after external links. -#latex_show_urls = False +# latex_show_urls = False # Additional stuff for the LaTeX preamble. -#latex_preamble = "" +# latex_preamble = "" # Documents to append as an appendix to all manuals. -#latex_appendices = [] +# latex_appendices = [] # If false, no module index is generated. -#latex_domain_indices = True +# latex_domain_indices = True # -- Options for manual page output -------------------------------------------- From bad713e24802bac65afa1a8b0121d64a66c9527d Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Thu, 6 Mar 2014 01:14:07 +0100 Subject: [PATCH 17/54] Update docstrings parameters. --- docs/sphinx/source/resources/pages/api.rst | 151 +------ setup.py | 3 +- sibl_gui/components/addons/about/about.py | 69 ++- .../cachesOperations/cachesOperations.py | 69 ++- .../databaseOperations/databaseOperations.py | 90 ++-- sibl_gui/components/addons/gpsMap/gpsMap.py | 120 +++-- sibl_gui/components/addons/gpsMap/views.py | 39 +- .../addons/iblSetsScanner/iblSetsScanner.py | 57 ++- .../addons/iblSetsScanner/workers.py | 33 +- .../addons/loaderScript/loaderScript.py | 162 ++++--- .../loaderScriptOptions.py | 165 ++++--- .../locationsBrowser/locationsBrowser.py | 156 ++++--- .../addons/loggingNotifier/loggingNotifier.py | 30 +- .../addons/onlineUpdater/downloadManager.py | 102 +++-- .../addons/onlineUpdater/onlineUpdater.py | 129 ++++-- .../addons/onlineUpdater/remoteUpdater.py | 117 +++-- .../addons/preview/imagesPreviewer.py | 201 ++++++--- sibl_gui/components/addons/preview/preview.py | 204 ++++++--- .../rawEditingUtilities.py | 150 ++++--- .../addons/rewiringTool/rewiringTool.py | 93 ++-- .../sIBLeditUtilities/sIBLeditUtilities.py | 108 +++-- .../addons/searchDatabase/searchDatabase.py | 120 +++-- .../collectionsOutliner.py | 225 ++++++---- .../core/collectionsOutliner/models.py | 18 +- .../core/collectionsOutliner/nodes.py | 36 +- .../core/collectionsOutliner/views.py | 39 +- sibl_gui/components/core/database/database.py | 69 ++- sibl_gui/components/core/database/nodes.py | 204 ++++++--- .../components/core/database/operations.py | 423 ++++++++++++------ sibl_gui/components/core/database/types.py | 117 +++-- .../core/iblSetsOutliner/iblSetsOutliner.py | 420 +++++++++++------ .../components/core/iblSetsOutliner/models.py | 24 +- .../components/core/iblSetsOutliner/views.py | 48 +- .../components/core/inspector/inspector.py | 222 ++++++--- sibl_gui/components/core/inspector/models.py | 18 +- sibl_gui/components/core/inspector/nodes.py | 45 +- sibl_gui/components/core/inspector/views.py | 18 +- .../core/templatesOutliner/models.py | 18 +- .../core/templatesOutliner/nodes.py | 30 +- .../templatesOutliner/templatesOutliner.py | 327 +++++++++----- .../core/templatesOutliner/views.py | 30 +- sibl_gui/launcher.py | 36 +- sibl_gui/libraries/freeImage/freeImage.py | 87 ++-- .../patches/001_migrate_3-x-x_to_4-0-0.py | 3 +- .../patches/002_migrate_4-x-x_to_4-0-2.py | 3 +- .../patches/003_migrate_4-x-x_to_4-0-3.py | 3 +- .../patches/004_migrate_4-x-x_to_4-0-7.py | 3 +- sibl_gui/tests/tests.py | 6 +- sibl_gui/tests/testsInternational.py | 3 +- sibl_gui/ui/caches.py | 144 ++++-- sibl_gui/ui/common.py | 153 ++++--- sibl_gui/ui/models.py | 24 +- sibl_gui/ui/nodes.py | 54 ++- sibl_gui/ui/views.py | 42 +- sibl_gui/ui/widgets/application_QToolBar.py | 18 +- sibl_gui/ui/workers.py | 21 +- utilities/getHDRLabsDocumentation.py | 6 +- utilities/getSphinxDocumentationApi.py | 14 +- utilities/getSphinxDocumentationTocTree.py | 12 +- utilities/listImports.py | 12 +- utilities/reStructuredTextToHtml.py | 6 +- utilities/recursiveRemove.py | 9 +- utilities/sliceDocumentation.py | 6 +- 63 files changed, 3480 insertions(+), 1884 deletions(-) diff --git a/docs/sphinx/source/resources/pages/api.rst b/docs/sphinx/source/resources/pages/api.rst index 3e318ae2..fda3a2d3 100644 --- a/docs/sphinx/source/resources/pages/api.rst +++ b/docs/sphinx/source/resources/pages/api.rst @@ -1,150 +1,9 @@ Api -==== +=== -Modules Summary: +**sIBL_GUI** Api documentation is available here: `sIBL_GUI - Api `_ -.. toctree:: - :maxdepth: 1 +.. raw:: html + +
- foundations.cache - foundations.common - foundations.core - foundations.dataStructures - foundations.decorators - foundations.environment - foundations.exceptions - foundations.globals.constants - foundations.io - foundations.library - foundations.namespace - foundations.nodes - foundations.parsers - foundations.pkzip - foundations.rotatingBackup - foundations.strings - foundations.tcpServer - foundations.trace - foundations.ui.common - foundations.verbose - foundations.walkers - manager.component - manager.componentsManager - manager.exceptions - manager.globals.constants - manager.qobjectComponent - manager.qwidgetComponent - umbra.components.addons.projectsExplorer.models - umbra.components.addons.projectsExplorer.projectsExplorer - umbra.components.addons.projectsExplorer.views - umbra.components.addons.tcpClientUi.tcpClientUi - umbra.components.addons.tcpServerUi.tcpServerUi - umbra.components.addons.traceUi.models - umbra.components.addons.traceUi.nodes - umbra.components.addons.traceUi.traceUi - umbra.components.addons.traceUi.views - umbra.components.factory.componentsManagerUi.componentsManagerUi - umbra.components.factory.componentsManagerUi.models - umbra.components.factory.componentsManagerUi.nodes - umbra.components.factory.componentsManagerUi.views - umbra.components.factory.preferencesManager.preferencesManager - umbra.components.factory.scriptEditor.editor - umbra.components.factory.scriptEditor.editorStatus - umbra.components.factory.scriptEditor.models - umbra.components.factory.scriptEditor.nodes - umbra.components.factory.scriptEditor.scriptEditor - umbra.components.factory.scriptEditor.searchAndReplace - umbra.components.factory.scriptEditor.searchInFiles - umbra.components.factory.scriptEditor.views - umbra.components.factory.scriptEditor.workers - umbra.engine - umbra.exceptions - umbra.globals.constants - umbra.globals.runtimeGlobals - umbra.globals.uiConstants - umbra.guerilla - umbra.launcher - umbra.managers.actionsManager - umbra.managers.fileSystemEventsManager - umbra.managers.layoutsManager - umbra.managers.notificationsManager - umbra.managers.patchesManager - umbra.preferences - umbra.processing - umbra.reporter - umbra.ui.common - umbra.ui.completers - umbra.ui.delegates - umbra.ui.highlighters - umbra.ui.inputAccelerators - umbra.ui.languages - umbra.ui.models - umbra.ui.nodes - umbra.ui.themes - umbra.ui.views - umbra.ui.visualAccelerators - umbra.ui.widgets.active_QLabel - umbra.ui.widgets.active_QLabelsCollection - umbra.ui.widgets.application_QToolBar - umbra.ui.widgets.basic_QPlainTextEdit - umbra.ui.widgets.codeEditor_QPlainTextEdit - umbra.ui.widgets.delayed_QSplashScreen - umbra.ui.widgets.messageBox - umbra.ui.widgets.notification_QLabel - umbra.ui.widgets.search_QLineEdit - umbra.ui.widgets.variable_QPushButton - sibl_gui.components.addons.about.about - sibl_gui.components.addons.cachesOperations.cachesOperations - sibl_gui.components.addons.databaseOperations.databaseOperations - sibl_gui.components.addons.gpsMap.gpsMap - sibl_gui.components.addons.gpsMap.views - sibl_gui.components.addons.iblSetsScanner.iblSetsScanner - sibl_gui.components.addons.iblSetsScanner.workers - sibl_gui.components.addons.loaderScript.loaderScript - sibl_gui.components.addons.loaderScriptOptions.loaderScriptOptions - sibl_gui.components.addons.loaderScriptOptions.views - sibl_gui.components.addons.locationsBrowser.locationsBrowser - sibl_gui.components.addons.loggingNotifier.loggingNotifier - sibl_gui.components.addons.onlineUpdater.downloadManager - sibl_gui.components.addons.onlineUpdater.onlineUpdater - sibl_gui.components.addons.onlineUpdater.remoteUpdater - sibl_gui.components.addons.onlineUpdater.views - sibl_gui.components.addons.preview.imagesPreviewer - sibl_gui.components.addons.preview.preview - sibl_gui.components.addons.rawEditingUtilities.rawEditingUtilities - sibl_gui.components.addons.rewiringTool.rewiringTool - sibl_gui.components.addons.sIBLeditUtilities.sIBLeditUtilities - sibl_gui.components.addons.searchDatabase.searchDatabase - sibl_gui.components.addons.searchDatabase.views - sibl_gui.components.core.collectionsOutliner.collectionsOutliner - sibl_gui.components.core.collectionsOutliner.models - sibl_gui.components.core.collectionsOutliner.nodes - sibl_gui.components.core.collectionsOutliner.views - sibl_gui.components.core.database.database - sibl_gui.components.core.database.exceptions - sibl_gui.components.core.database.nodes - sibl_gui.components.core.database.operations - sibl_gui.components.core.database.types - sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner - sibl_gui.components.core.iblSetsOutliner.models - sibl_gui.components.core.iblSetsOutliner.views - sibl_gui.components.core.inspector.inspector - sibl_gui.components.core.inspector.models - sibl_gui.components.core.inspector.nodes - sibl_gui.components.core.inspector.views - sibl_gui.components.core.templatesOutliner.models - sibl_gui.components.core.templatesOutliner.nodes - sibl_gui.components.core.templatesOutliner.templatesOutliner - sibl_gui.components.core.templatesOutliner.views - sibl_gui.exceptions - sibl_gui.globals.constants - sibl_gui.globals.runtimeGlobals - sibl_gui.globals.uiConstants - sibl_gui.launcher - sibl_gui.libraries.freeImage.freeImage - sibl_gui.ui.caches - sibl_gui.ui.common - sibl_gui.ui.models - sibl_gui.ui.nodes - sibl_gui.ui.views - sibl_gui.ui.widgets.application_QToolBar - sibl_gui.ui.workers diff --git a/setup.py b/setup.py index 1a76bc48..77bc0d4d 100644 --- a/setup.py +++ b/setup.py @@ -65,7 +65,8 @@ def getLongDescription(): """ Returns the Package long description. - :return: Package long description. ( String ) + :return: Package long description. + :rtype: unicode """ description = [] diff --git a/sibl_gui/components/addons/about/about.py b/sibl_gui/components/addons/about/about.py index 1ff146b8..c8e9c32e 100644 --- a/sibl_gui/components/addons/about/about.py +++ b/sibl_gui/components/addons/about/about.py @@ -129,10 +129,14 @@ def __init__(self, parent=None, name=None, *args, **kwargs): """ This method initializes the class. - :param parent: Object parent. ( QObject ) - :param name: Component name. ( String ) - :param \*args: Arguments. ( \* ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param parent: Object parent. + :type parent: QObject + :param name: Component name. + :type name: unicode + :param \*args: Arguments. + :type \*args: \* + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -157,7 +161,8 @@ def uiResourcesDirectory(self): """ Property for **self.__uiResourcesDirectory** attribute. - :return: self.__uiResourcesDirectory. ( String ) + :return: self.__uiResourcesDirectory. + :rtype: unicode """ return self.__uiResourcesDirectory @@ -168,7 +173,8 @@ def uiResourcesDirectory(self, value): """ Setter for **self.__uiResourcesDirectory** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -189,7 +195,8 @@ def uiLogoImage(self): """ Property for **self.__uiLogoImage** attribute. - :return: self.__uiLogoImage. ( String ) + :return: self.__uiLogoImage. + :rtype: unicode """ return self.__uiLogoImage @@ -200,7 +207,8 @@ def uiLogoImage(self, value): """ Setter for **self.__uiLogoImage** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -221,7 +229,8 @@ def uiGpl3Image(self): """ Property for **self.__uiGpl3Image** attribute. - :return: self.__uiGpl3Image. ( String ) + :return: self.__uiGpl3Image. + :rtype: unicode """ return self.__uiGpl3Image @@ -232,7 +241,8 @@ def uiGpl3Image(self, value): """ Setter for **self.__uiGpl3Image** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -253,7 +263,8 @@ def engine(self): """ Property for **self.__engine** attribute. - :return: self.__engine. ( QObject ) + :return: self.__engine. + :rtype: QObject """ return self.__engine @@ -264,7 +275,8 @@ def engine(self, value): """ Setter for **self.__engine** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -285,7 +297,8 @@ def miscellaneousMenu(self): """ Property for **self.__miscellaneousMenu** attribute. - :return: self.__miscellaneousMenu. ( QMenu ) + :return: self.__miscellaneousMenu. + :rtype: QMenu """ return self.__miscellaneousMenu @@ -296,7 +309,8 @@ def miscellaneousMenu(self, value): """ Setter for **self.__miscellaneousMenu** attribute. - :param value: Attribute value. ( QMenu ) + :param value: Attribute value. + :type value: QMenu """ raise foundations.exceptions.ProgrammingError( @@ -319,8 +333,10 @@ def activate(self, engine): """ This method activates the Component. - :param engine: Engine to attach the Component to. ( QObject ) - :return: Method success. ( Boolean ) + :param engine: Engine to attach the Component to. + :type engine: QObject + :return: Method success. + :rtype: bool """ LOGGER.debug("> Activating '{0}' Component.".format(self.__class__.__name__)) @@ -338,7 +354,8 @@ def deactivate(self): """ This method deactivates the Component. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Deactivating '{0}' Component.".format(self.__class__.__name__)) @@ -356,7 +373,8 @@ def initializeUi(self): """ This method initializes the Component ui. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Initializing '{0}' Component ui.".format(self.__class__.__name__)) @@ -368,7 +386,8 @@ def uninitializeUi(self): """ This method uninitializes the Component ui. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Uninitializing '{0}' Component ui.".format(self.__class__.__name__)) @@ -380,7 +399,8 @@ def addWidget(self): """ This method adds the Component Widget to the engine. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Adding '{0}' Component Widget.".format(self.__class__.__name__)) @@ -391,7 +411,8 @@ def removeWidget(self): """ This method removes the Component Widget from the engine. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Removing '{0}' Component Widget.".format(self.__class__.__name__)) @@ -424,8 +445,10 @@ def __miscellaneousMenu_aboutAction__triggered(self, checked): """ This method is triggered by **'Actions|Umbra|ToolBar|Miscellaneous|About {0} ...'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ LOGGER.debug("> Initializing '{0}' window.".format("About")) diff --git a/sibl_gui/components/addons/cachesOperations/cachesOperations.py b/sibl_gui/components/addons/cachesOperations/cachesOperations.py index 62feadd9..82e6a008 100644 --- a/sibl_gui/components/addons/cachesOperations/cachesOperations.py +++ b/sibl_gui/components/addons/cachesOperations/cachesOperations.py @@ -68,10 +68,14 @@ def __init__(self, parent=None, name=None, *args, **kwargs): """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param name: Component name. ( String ) - :param \*args: Arguments. ( \* ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param parent: Object parent. + :type parent: QObject + :param name: Component name. + :type name: unicode + :param \*args: Arguments. + :type \*args: \* + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -94,7 +98,8 @@ def engine(self): """ Property for **self.__engine** attribute. - :return: self.__engine. ( QObject ) + :return: self.__engine. + :rtype: QObject """ return self.__engine @@ -105,7 +110,8 @@ def engine(self, value): """ Setter for **self.__engine** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -126,7 +132,8 @@ def scriptEditor(self): """ Property for **self.__scriptEditor** attribute. - :return: self.__scriptEditor. ( QWidget ) + :return: self.__scriptEditor. + :rtype: QWidget """ return self.__scriptEditor @@ -137,7 +144,8 @@ def scriptEditor(self, value): """ Setter for **self.__scriptEditor** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -158,7 +166,8 @@ def preferencesManager(self): """ Property for **self.__preferencesManager** attribute. - :return: self.__preferencesManager. ( QWidget ) + :return: self.__preferencesManager. + :rtype: QWidget """ return self.__preferencesManager @@ -169,7 +178,8 @@ def preferencesManager(self, value): """ Setter for **self.__preferencesManager** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -192,8 +202,10 @@ def activate(self, engine): """ Activates the Component. - :param engine: Engine to attach the Component to. ( QObject ) - :return: Method success. ( Boolean ) + :param engine: Engine to attach the Component to. + :type engine: QObject + :return: Method success. + :rtype: bool """ LOGGER.debug("> Activating '{0}' Component.".format(self.__class__.__name__)) @@ -210,7 +222,8 @@ def deactivate(self): """ Deactivates the Component. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Deactivating '{0}' Component.".format(self.__class__.__name__)) @@ -227,7 +240,8 @@ def initializeUi(self): """ Initializes the Component ui. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Initializing '{0}' Component ui.".format(self.__class__.__name__)) @@ -244,7 +258,8 @@ def uninitializeUi(self): """ Uninitializes the Component ui. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Uninitializing '{0}' Component ui.".format(self.__class__.__name__)) @@ -261,7 +276,8 @@ def addWidget(self): """ Adds the Component Widget to the engine. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Adding '{0}' Component Widget.".format(self.__class__.__name__)) @@ -274,7 +290,8 @@ def removeWidget(self): """ Removes the Component Widget from the engine. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Removing '{0}' Component Widget.".format(self.__class__.__name__)) @@ -288,7 +305,8 @@ def __Clear_Thumbnails_Cache_pushButton__clicked(self, checked): """ Defines the slot triggered by **Thumbnails_Cache_pushButton** Widget when clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ self.clearThumbnailsCache() @@ -297,7 +315,8 @@ def __Clear_Images_Caches_pushButton__clicked(self, checked): """ Defines the slot triggered by **Clear_Images_Caches_pushButton** Widget when clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ self.clearImagesCaches() @@ -306,7 +325,8 @@ def __Output_Caches_Metrics_pushButton__clicked(self, checked): """ Defines the slot triggered by **Output_Caches_Metrics_pushButton** Widget when clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ self.outputCachesMetrics() @@ -316,7 +336,8 @@ def outputCachesMetrics(self): """ Outputs caches metrics. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ separator = "{0}".format(Constants.loggingSeparators.replace("*", "-")) @@ -358,7 +379,8 @@ def clearThumbnailsCache(self): """ Clears the thumbnails cache. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ thumbnails = list(foundations.walkers.filesWalker(RuntimeGlobals.thumbnailsCacheDirectory)) @@ -382,7 +404,8 @@ def clearImagesCaches(self): """ Clears the images caches. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ success = True diff --git a/sibl_gui/components/addons/databaseOperations/databaseOperations.py b/sibl_gui/components/addons/databaseOperations/databaseOperations.py index ee299120..a767a581 100644 --- a/sibl_gui/components/addons/databaseOperations/databaseOperations.py +++ b/sibl_gui/components/addons/databaseOperations/databaseOperations.py @@ -69,7 +69,8 @@ def __init__(self, **kwargs): """ Initializes the class. - :param kwargs: type, getMethod, updateContentMethod, removeMethod, modelContainer, updateLocationMethod ( Key / Value pairs ) + :param kwargs: type, getMethod, updateContentMethod, removeMethod, modelContainer, updateLocationMethod + :type kwargs: dict """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -86,10 +87,14 @@ def __init__(self, parent=None, name=None, *args, **kwargs): """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param name: Component name. ( String ) - :param \*args: Arguments. ( \* ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param parent: Object parent. + :type parent: QObject + :param name: Component name. + :type name: unicode + :param \*args: Arguments. + :type \*args: \* + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -117,7 +122,8 @@ def engine(self): """ Property for **self.__engine** attribute. - :return: self.__engine. ( QObject ) + :return: self.__engine. + :rtype: QObject """ return self.__engine @@ -128,7 +134,8 @@ def engine(self, value): """ Setter for **self.__engine** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -149,7 +156,8 @@ def settings(self): """ Property for **self.__settings** attribute. - :return: self.__settings. ( QSettings ) + :return: self.__settings. + :rtype: QSettings """ return self.__settings @@ -160,7 +168,8 @@ def settings(self, value): """ Setter for **self.__settings** attribute. - :param value: Attribute value. ( QSettings ) + :param value: Attribute value. + :type value: QSettings """ raise foundations.exceptions.ProgrammingError( @@ -181,7 +190,8 @@ def settingsSection(self): """ Property for **self.__settingsSection** attribute. - :return: self.__settingsSection. ( String ) + :return: self.__settingsSection. + :rtype: unicode """ return self.__settingsSection @@ -192,7 +202,8 @@ def settingsSection(self, value): """ Setter for **self.__settingsSection** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -213,7 +224,8 @@ def preferencesManager(self): """ Property for **self.__preferencesManager** attribute. - :return: self.__preferencesManager. ( QWidget ) + :return: self.__preferencesManager. + :rtype: QWidget """ return self.__preferencesManager @@ -224,7 +236,8 @@ def preferencesManager(self, value): """ Setter for **self.__preferencesManager** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -245,7 +258,8 @@ def iblSetsOutliner(self): """ Property for **self.__iblSetsOutliner** attribute. - :return: self.__iblSetsOutliner. ( QWidget ) + :return: self.__iblSetsOutliner. + :rtype: QWidget """ return self.__iblSetsOutliner @@ -256,7 +270,8 @@ def iblSetsOutliner(self, value): """ Setter for **self.__iblSetsOutliner** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -277,7 +292,8 @@ def templatesOutliner(self): """ Property for **self.__templatesOutliner** attribute. - :return: self.__templatesOutliner. ( QWidget ) + :return: self.__templatesOutliner. + :rtype: QWidget """ return self.__templatesOutliner @@ -288,7 +304,8 @@ def templatesOutliner(self, value): """ Setter for **self.__templatesOutliner** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -309,7 +326,8 @@ def types(self): """ Property for **self.__types** attribute. - :return: self.__types. ( Tuple ) + :return: self.__types. + :rtype: tuple """ return self.__types @@ -320,7 +338,8 @@ def types(self, value): """ Setter for **self.__types** attribute. - :param value: Attribute value. ( Tuple ) + :param value: Attribute value. + :type value: tuple """ raise foundations.exceptions.ProgrammingError( @@ -343,8 +362,10 @@ def activate(self, engine): """ Activates the Component. - :param engine: Engine to attach the Component to. ( QObject ) - :return: Method success. ( Boolean ) + :param engine: Engine to attach the Component to. + :type engine: QObject + :return: Method success. + :rtype: bool """ LOGGER.debug("> Activating '{0}' Component.".format(self.__class__.__name__)) @@ -377,7 +398,8 @@ def deactivate(self): """ Deactivates the Component. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Deactivating '{0}' Component.".format(self.__class__.__name__)) @@ -397,7 +419,8 @@ def initializeUi(self): """ Initializes the Component ui. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Initializing '{0}' Component ui.".format(self.__class__.__name__)) @@ -418,7 +441,8 @@ def uninitializeUi(self): """ Uninitializes the Component ui. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Uninitializing '{0}' Component ui.".format(self.__class__.__name__)) @@ -435,7 +459,8 @@ def addWidget(self): """ Adds the Component Widget to the engine. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Adding '{0}' Component Widget.".format(self.__class__.__name__)) @@ -448,7 +473,8 @@ def removeWidget(self): """ Removes the Component Widget from the engine. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Removing '{0}' Component Widget.".format(self.__class__.__name__)) @@ -462,7 +488,8 @@ def __Update_Database_pushButton__clicked(self, checked): """ Defines the slot triggered by **Update_Database_pushButton** Widget when clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ self.updateDatabase() @@ -471,7 +498,8 @@ def __Remove_Invalid_Data_pushButton__clicked(self, checked): """ Defines the slot triggered by **Remove_Invalid_Data_pushButton** Widget when clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ self.removeInvalidData() @@ -483,7 +511,8 @@ def updateDatabase(self): | Each type defined by :meth:`DatabaseOperations.sibl_gui.components.core.database.types` attribute will have its instances checked and updated by their associated methods. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ for type in self.__types: @@ -516,7 +545,8 @@ def removeInvalidData(self): """ Removes invalid data from the Database. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ if messageBox.messageBox("Question", "Question", diff --git a/sibl_gui/components/addons/gpsMap/gpsMap.py b/sibl_gui/components/addons/gpsMap/gpsMap.py index d4e664f8..3aee571d 100644 --- a/sibl_gui/components/addons/gpsMap/gpsMap.py +++ b/sibl_gui/components/addons/gpsMap/gpsMap.py @@ -70,10 +70,14 @@ def __init__(self, parent=None, name=None, *args, **kwargs): """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param name: Component name. ( String ) - :param \*args: Arguments. ( \* ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param parent: Object parent. + :type parent: QObject + :param name: Component name. + :type name: unicode + :param \*args: Arguments. + :type \*args: \* + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -105,7 +109,8 @@ def uiResourcesDirectory(self): """ Property for **self.__uiResourcesDirectory** attribute. - :return: self.__uiResourcesDirectory. ( String ) + :return: self.__uiResourcesDirectory. + :rtype: unicode """ return self.__uiResourcesDirectory @@ -116,7 +121,8 @@ def uiResourcesDirectory(self, value): """ Setter for **self.__uiResourcesDirectory** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -137,7 +143,8 @@ def uiZoomInImage(self): """ Property for **self.__uiZoomInImage** attribute. - :return: self.__uiZoomInImage. ( String ) + :return: self.__uiZoomInImage. + :rtype: unicode """ return self.__uiZoomInImage @@ -148,7 +155,8 @@ def uiZoomInImage(self, value): """ Setter for **self.__uiZoomInImage** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -169,7 +177,8 @@ def uiZoomOutImage(self): """ Property for **self.__uiZoomOutImage** attribute. - :return: self.__uiZoomOutImage. ( String ) + :return: self.__uiZoomOutImage. + :rtype: unicode """ return self.__uiZoomOutImage @@ -180,7 +189,8 @@ def uiZoomOutImage(self, value): """ Setter for **self.__uiZoomOutImage** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -201,7 +211,8 @@ def gpsMapHtmlFile(self): """ Property for **self.__gpsMapHtmlFile** attribute. - :return: self.__gpsMapHtmlFile. ( String ) + :return: self.__gpsMapHtmlFile. + :rtype: unicode """ return self.__gpsMapHtmlFile @@ -212,7 +223,8 @@ def gpsMapHtmlFile(self, value): """ Setter for **self.__gpsMapHtmlFile** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -265,7 +277,8 @@ def dockArea(self): """ Property for **self.__dockArea** attribute. - :return: self.__dockArea. ( Integer ) + :return: self.__dockArea. + :rtype: int """ return self.__dockArea @@ -276,7 +289,8 @@ def dockArea(self, value): """ Setter for **self.__dockArea** attribute. - :param value: Attribute value. ( Integer ) + :param value: Attribute value. + :type value: int """ raise foundations.exceptions.ProgrammingError( @@ -297,7 +311,8 @@ def engine(self): """ Property for **self.__engine** attribute. - :return: self.__engine. ( QObject ) + :return: self.__engine. + :rtype: QObject """ return self.__engine @@ -308,7 +323,8 @@ def engine(self, value): """ Setter for **self.__engine** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -329,7 +345,8 @@ def iblSetsOutliner(self): """ Property for **self.__iblSetsOutliner** attribute. - :return: self.__iblSetsOutliner. ( QWidget ) + :return: self.__iblSetsOutliner. + :rtype: QWidget """ return self.__iblSetsOutliner @@ -340,7 +357,8 @@ def iblSetsOutliner(self, value): """ Setter for **self.__iblSetsOutliner** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -361,7 +379,8 @@ def map(self): """ Property for **self.__map** attribute. - :return: self.__map. ( QObject ) + :return: self.__map. + :rtype: QObject """ return self.__map @@ -372,7 +391,8 @@ def map(self, value): """ Setter for **self.__map** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -393,7 +413,8 @@ def mapTypeIds(self): """ Property for **self.__mapTypeIds** attribute. - :return: self.__mapTypeIds. ( Tuple ) + :return: self.__mapTypeIds. + :rtype: tuple """ return self.__mapTypeIds @@ -404,7 +425,8 @@ def mapTypeIds(self, value): """ Setter for **self.__mapTypeIds** attribute. - :param value: Attribute value. ( Tuple ) + :param value: Attribute value. + :type value: tuple """ raise foundations.exceptions.ProgrammingError( @@ -427,8 +449,10 @@ def activate(self, engine): """ Activates the Component. - :param engine: Engine to attach the Component to. ( QObject ) - :return: Method success. ( Boolean ) + :param engine: Engine to attach the Component to. + :type engine: QObject + :return: Method success. + :rtype: bool """ LOGGER.debug("> Activating '{0}' Component.".format(self.__class__.__name__)) @@ -446,7 +470,8 @@ def deactivate(self): """ Deactivates the Component. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Deactivating '{0}' Component.".format(self.__class__.__name__)) @@ -464,7 +489,8 @@ def initializeUi(self): """ Initializes the Component ui. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Initializing '{0}' Component ui.".format(self.__class__.__name__)) @@ -498,7 +524,8 @@ def uninitializeUi(self): """ Uninitializes the Component ui. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ # Signals / Slots. @@ -520,7 +547,8 @@ def addWidget(self): """ Adds the Component Widget to the engine. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Adding '{0}' Component Widget.".format(self.__class__.__name__)) @@ -533,7 +561,8 @@ def removeWidget(self): """ Removes the Component Widget from the engine. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Removing '{0}' Component Widget.".format(self.__class__.__name__)) @@ -547,7 +576,8 @@ def onClose(self): """ Defines the slot triggered on Framework close. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Calling '{0}' Component Framework 'onClose' method.".format(self.__class__.__name__)) @@ -559,8 +589,10 @@ def __iblSetsOutliner_view_selectionModel__selectionChanged(self, selectedItems, """ Defines the slot triggered by **Data** Model when selection changed - :param selectedItems: Selected items. ( QItemSelection ) - :param deselectedItems: Deselected items. ( QItemSelection ) + :param selectedItems: Selected items. + :type selectedItems: QItemSelection + :param deselectedItems: Deselected items. + :type deselectedItems: QItemSelection """ self.setMarkersUi() @@ -569,7 +601,8 @@ def __Map_Type_comboBox__activated(self, index): """ Defines the slot triggered by **Map_Type_comboBox** when activated. - :param index: ComboBox activated item index. ( Integer ) + :param index: ComboBox activated item index. + :type index: int """ self.__map.setMapType(self.__mapTypeIds[index][1]) @@ -578,7 +611,8 @@ def __Zoom_In_pushButton__clicked(self, checked): """ Defines the slot triggered by **Zoom_In_pushButton** Widget when clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ self.__map.setZoom("In") @@ -587,7 +621,8 @@ def __Zoom_Out_pushButton__clicked(self, checked): """ Defines the slot triggered by **Zoom_Out_pushButton** Widget when clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ self.__map.setZoom("Out") @@ -596,7 +631,8 @@ def __map__loadFinished(self, state): """ Defines the slot triggered by the GPS map when load finished. - :param state: Loading state. ( Boolean ) + :param state: Loading state. + :type state: bool """ self.setMarkersUi() @@ -606,7 +642,8 @@ def setMarkersUi(self): """ Sets selected Ibl Sets markers. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -628,8 +665,10 @@ def setMarker(self, iblSet): """ Sets given Ibl Set marker. - :param iblSet: Ibl Set to display marker. ( IblSet ) - :return: Method success. ( Boolean ) + :param iblSet: Ibl Set to display marker. + :type iblSet: IblSet + :return: Method success. + :rtype: bool """ if not iblSet.latitude and not iblSet.longitude: @@ -650,7 +689,8 @@ def removeMarkers(self): """ Removes the GPS map markers. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ self.__map.removeMarkers() diff --git a/sibl_gui/components/addons/gpsMap/views.py b/sibl_gui/components/addons/gpsMap/views.py index 631aec74..5ed989b5 100644 --- a/sibl_gui/components/addons/gpsMap/views.py +++ b/sibl_gui/components/addons/gpsMap/views.py @@ -59,7 +59,8 @@ def __init__(self, parent=None): """ Initializes the class. - :param parent: Object parent. ( QObject ) + :param parent: Object parent. + :type parent: QObject """ QWebView.__init__(self, parent) @@ -68,7 +69,8 @@ def __evaluateJavascript(self, javascript): """ Evaluates given javascript content in the View. - :param javascript: Javascript. ( String ) + :param javascript: Javascript. + :type javascript: unicode """ self.page().mainFrame().evaluateJavaScript(javascript) @@ -77,11 +79,16 @@ def addMarker(self, coordinates, title, icon, content): """ Adds a marker to the GPS map. - :param coordinates: Marker coordinates. ( Tuple ) - :param title: Marker title. ( String ) - :param icon: Marker icon. ( String ) - :param content: Marker popup window content. ( String ) - :return: Method success. ( Boolean ) + :param coordinates: Marker coordinates. + :type coordinates: tuple + :param title: Marker title. + :type title: unicode + :param icon: Marker icon. + :type icon: unicode + :param content: Marker popup window content. + :type content: unicode + :return: Method success. + :rtype: bool """ LOGGER.debug("> Adding '{0}' marker to gps map with '{1}' coordinates.".format(title, coordinates)) @@ -99,7 +106,8 @@ def removeMarkers(self): """ Removes the GPS map markers. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Removing GPS map markers.") @@ -111,7 +119,8 @@ def setCenter(self): """ Centers the GPS map. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Centering GPS map.") @@ -129,8 +138,10 @@ def setMapType(self, mapTypeId): - MapTypeId.aerial - MapTypeId.road - :param mapTypeId: GPS map type. ( String ) - :return: Method success. ( Boolean ) + :param mapTypeId: GPS map type. + :type mapTypeId: unicode + :return: Method success. + :rtype: bool """ LOGGER.debug("> Setting GPS map type to '{0}'.".format(mapTypeId)) @@ -142,8 +153,10 @@ def setZoom(self, type): """ Sets the GPS map zoom. - :param type: Zoom type. ( String ) - :return: Method success. ( Boolean ) + :param type: Zoom type. + :type type: unicode + :return: Method success. + :rtype: bool """ LOGGER.debug("> Zooming '{0}' GPS map.".format(type)) diff --git a/sibl_gui/components/addons/iblSetsScanner/iblSetsScanner.py b/sibl_gui/components/addons/iblSetsScanner/iblSetsScanner.py index 0614ab21..d531effc 100644 --- a/sibl_gui/components/addons/iblSetsScanner/iblSetsScanner.py +++ b/sibl_gui/components/addons/iblSetsScanner/iblSetsScanner.py @@ -64,10 +64,14 @@ def __init__(self, parent=None, name=None, *args, **kwargs): """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param name: Component name. ( String ) - :param \*args: Arguments. ( \* ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param parent: Object parent. + :type parent: QObject + :param name: Component name. + :type name: unicode + :param \*args: Arguments. + :type \*args: \* + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -92,7 +96,8 @@ def engine(self): """ Property for **self.__engine** attribute. - :return: self.__engine. ( QObject ) + :return: self.__engine. + :rtype: QObject """ return self.__engine @@ -103,7 +108,8 @@ def engine(self, value): """ Setter for **self.__engine** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -124,7 +130,8 @@ def collectionsOutliner(self): """ Property for **self.__collectionsOutliner** attribute. - :return: self.__collectionsOutliner. ( QWidget ) + :return: self.__collectionsOutliner. + :rtype: QWidget """ return self.__collectionsOutliner @@ -135,7 +142,8 @@ def collectionsOutliner(self, value): """ Setter for **self.__collectionsOutliner** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -156,7 +164,8 @@ def iblSetsOutliner(self): """ Property for **self.__iblSetsOutliner** attribute. - :return: self.__iblSetsOutliner. ( QWidget ) + :return: self.__iblSetsOutliner. + :rtype: QWidget """ return self.__iblSetsOutliner @@ -167,7 +176,8 @@ def iblSetsOutliner(self, value): """ Setter for **self.__iblSetsOutliner** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -188,7 +198,8 @@ def iblSetsScannerWorkerThread(self): """ Property for **self.__iblSetsScannerWorkerThread** attribute. - :return: self.__iblSetsScannerWorkerThread. ( QThread ) + :return: self.__iblSetsScannerWorkerThread. + :rtype: QThread """ return self.__iblSetsScannerWorkerThread @@ -199,7 +210,8 @@ def iblSetsScannerWorkerThread(self, value): """ Setter for **self.__iblSetsScannerWorkerThread** attribute. - :param value: Attribute value. ( QThread ) + :param value: Attribute value. + :type value: QThread """ raise foundations.exceptions.ProgrammingError( @@ -222,8 +234,10 @@ def activate(self, engine): """ Activates the Component. - :param engine: Engine to attach the Component to. ( QObject ) - :return: Method success. ( Boolean ) + :param engine: Engine to attach the Component to. + :type engine: QObject + :return: Method success. + :rtype: bool """ LOGGER.debug("> Activating '{0}' Component.".format(self.__class__.__name__)) @@ -240,7 +254,8 @@ def deactivate(self): """ Deactivates the Component. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Deactivating '{0}' Component.".format(self.__class__.__name__)) @@ -257,7 +272,8 @@ def initialize(self): """ Initializes the Component. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Initializing '{0}' Component.".format(self.__class__.__name__)) @@ -283,7 +299,8 @@ def uninitialize(self): """ Uninitializes the Component. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Uninitializing '{0}' Component.".format(self.__class__.__name__)) @@ -305,7 +322,8 @@ def onStartup(self): """ Defines the slot triggered on Framework startup. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Calling '{0}' Component Framework 'onStartup' method.".format(self.__class__.__name__)) @@ -319,7 +337,8 @@ def __iblSetsScannerWorkerThread__iblSetsRetrieved(self, iblSets): """ Defines the slot triggered by **IblSetsScanner_worker** when the Database has changed. - :param iblSets: Retrieve Ibl Sets. ( Dictionary ) + :param iblSets: Retrieve Ibl Sets. + :type iblSets: dict """ if messageBox.messageBox("Question", "Question", diff --git a/sibl_gui/components/addons/iblSetsScanner/workers.py b/sibl_gui/components/addons/iblSetsScanner/workers.py index 93b89853..091a6cc0 100644 --- a/sibl_gui/components/addons/iblSetsScanner/workers.py +++ b/sibl_gui/components/addons/iblSetsScanner/workers.py @@ -67,14 +67,16 @@ class IblSetsScanner_worker(QThread): """ This signal is emited by the :class:`IblSetsScanner_worker` class when new Ibl Sets are retrieved. ( pyqtSignal ) - :return: New Ibl Sets. ( List ) + :return: New Ibl Sets. + :rtype: list """ def __init__(self, parent): """ Initializes the class. - :param parent: Object parent. ( QObject ) + :param parent: Object parent. + :type parent: QObject """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -98,7 +100,8 @@ def container(self): """ Property for **self.__container** attribute. - :return: self.__container. ( QObject ) + :return: self.__container. + :rtype: QObject """ return self.__container @@ -109,7 +112,8 @@ def container(self, value): """ Setter for **self.__container** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -130,7 +134,8 @@ def databaseSession(self): """ Property for **self.__databaseSession** attribute. - :return: self.__databaseSession. ( Object ) + :return: self.__databaseSession. + :rtype: object """ return self.__databaseSession @@ -141,7 +146,8 @@ def databaseSession(self, value): """ Setter for **self.__databaseSession** attribute. - :param value: Attribute value. ( Object ) + :param value: Attribute value. + :type value: object """ raise foundations.exceptions.ProgrammingError( @@ -162,7 +168,8 @@ def extension(self): """ Property for **self.__extension** attribute. - :return: self.__extension. ( String ) + :return: self.__extension. + :rtype: unicode """ return self.__extension @@ -173,7 +180,8 @@ def extension(self, value): """ Setter for **self.__extension** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -194,7 +202,8 @@ def newIblSets(self): """ Property for **self.__newIblSets** attribute. - :return: self.__newIblSets. ( List ) + :return: self.__newIblSets. + :rtype: list """ return self.__newIblSets @@ -205,7 +214,8 @@ def newIblSets(self, value): """ Setter for **self.__newIblSets** attribute. - :param value: Attribute value. ( List ) + :param value: Attribute value. + :type value: list """ raise foundations.exceptions.ProgrammingError( @@ -235,7 +245,8 @@ def scanIblSetsDirectories(self): """ Scans Ibl Sets directories. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.info("{0} | Scanning Ibl Sets directories for new Ibl Sets!".format(self.__class__.__name__)) diff --git a/sibl_gui/components/addons/loaderScript/loaderScript.py b/sibl_gui/components/addons/loaderScript/loaderScript.py index 7b4311da..9f6c2773 100644 --- a/sibl_gui/components/addons/loaderScript/loaderScript.py +++ b/sibl_gui/components/addons/loaderScript/loaderScript.py @@ -81,10 +81,14 @@ def __init__(self, parent=None, name=None, *args, **kwargs): """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param name: Component name. ( String ) - :param \*args: Arguments. ( \* ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param parent: Object parent. + :type parent: QObject + :param name: Component name. + :type name: unicode + :param \*args: Arguments. + :type \*args: \* + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -124,7 +128,8 @@ def dockArea(self): """ Property for **self.__dockArea** attribute. - :return: self.__dockArea. ( Integer ) + :return: self.__dockArea. + :rtype: int """ return self.__dockArea @@ -135,7 +140,8 @@ def dockArea(self, value): """ Setter for **self.__dockArea** attribute. - :param value: Attribute value. ( Integer ) + :param value: Attribute value. + :type value: int """ raise foundations.exceptions.ProgrammingError( @@ -156,7 +162,8 @@ def engine(self): """ Property for **self.__engine** attribute. - :return: self.__engine. ( QObject ) + :return: self.__engine. + :rtype: QObject """ return self.__engine @@ -167,7 +174,8 @@ def engine(self, value): """ Setter for **self.__engine** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -188,7 +196,8 @@ def iblSetsOutliner(self): """ Property for **self.__iblSetsOutliner** attribute. - :return: self.__iblSetsOutliner. ( QWidget ) + :return: self.__iblSetsOutliner. + :rtype: QWidget """ return self.__iblSetsOutliner @@ -199,7 +208,8 @@ def iblSetsOutliner(self, value): """ Setter for **self.__iblSetsOutliner** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -220,7 +230,8 @@ def templatesOutliner(self): """ Property for **self.__templatesOutliner** attribute. - :return: self.__templatesOutliner. ( QWidget ) + :return: self.__templatesOutliner. + :rtype: QWidget """ return self.__templatesOutliner @@ -231,7 +242,8 @@ def templatesOutliner(self, value): """ Setter for **self.__templatesOutliner** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -252,7 +264,8 @@ def tcpClientUi(self): """ Property for **self.__tcpClientUi** attribute. - :return: self.__tcpClientUi. ( QWidget ) + :return: self.__tcpClientUi. + :rtype: QWidget """ return self.__tcpClientUi @@ -263,7 +276,8 @@ def tcpClientUi(self, value): """ Setter for **self.__tcpClientUi** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -284,7 +298,8 @@ def ioDirectory(self): """ Property for **self.__ioDirectory** attribute. - :return: self.__ioDirectory. ( String ) + :return: self.__ioDirectory. + :rtype: unicode """ return self.__ioDirectory @@ -295,7 +310,8 @@ def ioDirectory(self, value): """ Setter for **self.__ioDirectory** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -316,7 +332,8 @@ def bindingIdentifierPattern(self): """ Property for **self.__bindingIdentifierPattern** attribute. - :return: self.__bindingIdentifierPattern. ( String ) + :return: self.__bindingIdentifierPattern. + :rtype: unicode """ return self.__bindingIdentifierPattern @@ -327,7 +344,8 @@ def bindingIdentifierPattern(self, value): """ Setter for **self.__bindingIdentifierPattern** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -348,7 +366,8 @@ def templateScriptSection(self): """ Property for **self.__templateScriptSection** attribute. - :return: self.__templateScriptSection. ( String ) + :return: self.__templateScriptSection. + :rtype: unicode """ return self.__templateScriptSection @@ -359,7 +378,8 @@ def templateScriptSection(self, value): """ Setter for **self.__templateScriptSection** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -380,7 +400,8 @@ def templateIblSetAttributesSection(self): """ Property for **self.__templateIblSetAttributesSection** attribute. - :return: self.__templateIblSetAttributesSection. ( String ) + :return: self.__templateIblSetAttributesSection. + :rtype: unicode """ return self.__templateIblSetAttributesSection @@ -391,7 +412,8 @@ def templateIblSetAttributesSection(self, value): """ Setter for **self.__templateIblSetAttributesSection** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -412,7 +434,8 @@ def templateRemoteConnectionSection(self): """ Property for **self.__templateRemoteConnectionSection** attribute. - :return: self.__templateRemoteConnectionSection. ( String ) + :return: self.__templateRemoteConnectionSection. + :rtype: unicode """ return self.__templateRemoteConnectionSection @@ -423,7 +446,8 @@ def templateRemoteConnectionSection(self, value): """ Setter for **self.__templateRemoteConnectionSection** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -444,7 +468,8 @@ def overrideKeys(self): """ Property for **self.__overrideKeys** attribute. - :return: self.__overrideKeys. ( Dictionary ) + :return: self.__overrideKeys. + :rtype: dict """ return self.__overrideKeys @@ -455,7 +480,8 @@ def overrideKeys(self, value): """ Setter for **self.__overrideKeys** attribute. - :param value: Attribute value. ( Dictionary ) + :param value: Attribute value. + :type value: dict """ if value is not None: @@ -483,7 +509,8 @@ def defaultStringSeparator(self): """ Property for **self.__defaultStringSeparator** attribute. - :return: self.__defaultStringSeparator. ( String ) + :return: self.__defaultStringSeparator. + :rtype: unicode """ return self.__defaultStringSeparator @@ -494,7 +521,8 @@ def defaultStringSeparator(self, value): """ Setter for **self.__defaultStringSeparator** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ if value is not None: @@ -521,7 +549,8 @@ def unnamedLightName(self): """ Property for **self.__unnamedLightName** attribute. - :return: self.__unnamedLightName. ( String ) + :return: self.__unnamedLightName. + :rtype: unicode """ return self.__unnamedLightName @@ -532,7 +561,8 @@ def unnamedLightName(self, value): """ Setter for **self.__unnamedLightName** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ if value is not None: @@ -557,8 +587,10 @@ def activate(self, engine): """ Activates the Component. - :param engine: Engine to attach the Component to. ( QObject ) - :return: Method success. ( Boolean ) + :param engine: Engine to attach the Component to. + :type engine: QObject + :return: Method success. + :rtype: bool """ LOGGER.debug("> Activating '{0}' Component.".format(self.__class__.__name__)) @@ -581,7 +613,8 @@ def deactivate(self): """ Deactivates the Component. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Deactivating '{0}' Component.".format(self.__class__.__name__)) @@ -601,7 +634,8 @@ def initializeUi(self): """ Initializes the Component ui. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Initializing '{0}' Component ui.".format(self.__class__.__name__)) @@ -622,7 +656,8 @@ def uninitializeUi(self): """ Uninitializes the Component ui. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Uninitializing '{0}' Component ui.".format(self.__class__.__name__)) @@ -640,7 +675,8 @@ def addWidget(self): """ Adds the Component Widget to the engine. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Adding '{0}' Component Widget.".format(self.__class__.__name__)) @@ -653,7 +689,8 @@ def removeWidget(self): """ Removes the Component Widget from the engine. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Removing '{0}' Component Widget.".format(self.__class__.__name__)) @@ -667,7 +704,8 @@ def __Output_Loader_Script_pushButton__clicked(self, checked): """ Defines the slot triggered by **Output_Loader_Script_pushButton** Widget when clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ self.outputLoaderScriptUi() @@ -676,7 +714,8 @@ def __Send_To_Software_pushButton__clicked(self, checked): """ Defines the slot triggered by **Send_To_Software_pushButton** Widget when clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ self.sendLoaderScriptToSoftwareUi() @@ -685,8 +724,10 @@ def __templatesOutliner_view_selectionModel__selectionChanged(self, selectedItem """ Defines the slot triggered by **templatesOutliner.view** Model when selection changed - :param selectedItems: Selected items. ( QItemSelection ) - :param deselectedItems: Deselected items. ( QItemSelection ) + :param selectedItems: Selected items. + :type selectedItems: QItemSelection + :param deselectedItems: Deselected items. + :type deselectedItems: QItemSelection """ selectedTemplates = self.__templatesOutliner.getSelectedTemplates() @@ -724,7 +765,8 @@ def outputLoaderScriptUi(self): """ Outputs the Loader Script. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -775,7 +817,8 @@ def sendLoaderScriptToSoftwareUi(self): """ Sends the Loader Script to associated 3d package. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -802,9 +845,12 @@ def outputLoaderScript(self, template, iblSet): """ Outputs the Loader Script. - :param template: Template. ( Template ) - :param iblSet: Ibl Set. ( IblSet ) - :return: Loader Script file. ( String ) + :param template: Template. + :type template: Template + :param iblSet: Ibl Set. + :type iblSet: IblSet + :return: Loader Script file. + :rtype: unicode """ self.__overrideKeys = self.getDefaultOverrideKeys() @@ -839,9 +885,12 @@ def sendLoaderScriptToSoftware(self, template, loaderScriptPath): """ Sends the Loader Script to associated 3d package. - :param template: Template. ( Template ) - :param loaderScriptPath: Loader Script path. ( String ) - :return: Method success. ( Boolean ) + :param template: Template. + :type template: Template + :param loaderScriptPath: Loader Script path. + :type loaderScriptPath: unicode + :return: Method success. + :rtype: bool """ LOGGER.info("{0} | Starting remote connection!".format(self.__class__.__name__)) @@ -898,7 +947,8 @@ def getDefaultOverrideKeys(self): """ Gets default override keys. - :return: Override keys. ( Dictionary ) + :return: Override keys. + :rtype: dict """ LOGGER.debug("> Constructing default override keys.") @@ -945,10 +995,14 @@ def getLoaderScript(self, template, iblSet, overrideKeys): """ Builds a Loader Script. - :param template: Template path. ( String ) - :param iblSet: Ibl Set path. ( String ) - :param overrideKeys: Override keys. ( Dictionary ) - :return: Loader Script. ( List ) + :param template: Template path. + :type template: unicode + :param iblSet: Ibl Set path. + :type iblSet: unicode + :param overrideKeys: Override keys. + :type overrideKeys: dict + :return: Loader Script. + :rtype: list """ LOGGER.debug("> Parsing Template file: '{0}'.".format(template)) diff --git a/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py b/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py index 1bf8dc7e..9525b01d 100644 --- a/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py +++ b/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py @@ -86,10 +86,14 @@ def __init__(self, parent=None, name=None, *args, **kwargs): """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param name: Component name. ( String ) - :param \*args: Arguments. ( \* ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param parent: Object parent. + :type parent: QObject + :param name: Component name. + :type name: unicode + :param \*args: Arguments. + :type \*args: \* + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -132,7 +136,8 @@ def dockArea(self): """ Property for **self.__dockArea** attribute. - :return: self.__dockArea. ( Integer ) + :return: self.__dockArea. + :rtype: int """ return self.__dockArea @@ -143,7 +148,8 @@ def dockArea(self, value): """ Setter for **self.__dockArea** attribute. - :param value: Attribute value. ( Integer ) + :param value: Attribute value. + :type value: int """ raise foundations.exceptions.ProgrammingError( @@ -164,7 +170,8 @@ def engine(self): """ Property for **self.__engine** attribute. - :return: self.__engine. ( QObject ) + :return: self.__engine. + :rtype: QObject """ return self.__engine @@ -175,7 +182,8 @@ def engine(self, value): """ Setter for **self.__engine** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -196,7 +204,8 @@ def templatesOutliner(self): """ Property for **self.__templatesOutliner** attribute. - :return: self.__templatesOutliner. ( QWidget ) + :return: self.__templatesOutliner. + :rtype: QWidget """ return self.__templatesOutliner @@ -207,7 +216,8 @@ def templatesOutliner(self, value): """ Setter for **self.__templatesOutliner** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -228,7 +238,8 @@ def loaderScript(self): """ Property for **self.__loaderScript** attribute. - :return: self.__loaderScript. ( QWidget ) + :return: self.__loaderScript. + :rtype: QWidget """ return self.__loaderScript @@ -239,7 +250,8 @@ def loaderScript(self, value): """ Setter for **self.__loaderScript** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -260,7 +272,8 @@ def views(self): """ Property for **self.__views** attribute. - :return: self.__views. ( Tuple ) + :return: self.__views. + :rtype: tuple """ return self.__views @@ -271,7 +284,8 @@ def views(self, value): """ Setter for **self.__views** attribute. - :param value: Attribute value. ( Tuple ) + :param value: Attribute value. + :type value: tuple """ raise foundations.exceptions.ProgrammingError( @@ -292,7 +306,8 @@ def commonView(self): """ Property for **self.__commonView** attribute. - :return: self.__commonView. ( QListView ) + :return: self.__commonView. + :rtype: QListView """ return self.__commonView @@ -303,7 +318,8 @@ def commonView(self, value): """ Setter for **self.__commonView** attribute. - :param value: Attribute value. ( QListView ) + :param value: Attribute value. + :type value: QListView """ raise foundations.exceptions.ProgrammingError( @@ -324,7 +340,8 @@ def additionalView(self): """ Property for **self.__additionalView** attribute. - :return: self.__additionalView. ( QListView ) + :return: self.__additionalView. + :rtype: QListView """ return self.__additionalView @@ -335,7 +352,8 @@ def additionalView(self, value): """ Setter for **self.__additionalView** attribute. - :param value: Attribute value. ( QListView ) + :param value: Attribute value. + :type value: QListView """ raise foundations.exceptions.ProgrammingError( @@ -356,7 +374,8 @@ def namespaceSplitter(self): """ Property for **self.__namespaceSplitter** attribute. - :return: self.__namespaceSplitter. ( String ) + :return: self.__namespaceSplitter. + :rtype: unicode """ return self.__namespaceSplitter @@ -367,7 +386,8 @@ def namespaceSplitter(self, value): """ Setter for **self.__namespaceSplitter** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ if value is not None: @@ -394,7 +414,8 @@ def templatesSettingsDirectory(self): """ Property for **self.__templatesSettingsDirectory** attribute. - :return: self.__templatesSettingsDirectory. ( String ) + :return: self.__templatesSettingsDirectory. + :rtype: unicode """ return self.__templatesSettingsDirectory @@ -405,7 +426,8 @@ def templatesSettingsDirectory(self, value): """ Setter for **self.__templatesSettingsDirectory** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -426,7 +448,8 @@ def templateSettingsFile(self): """ Property for **self.__templateSettingsFile** attribute. - :return: self.__templateSettingsFile. ( String ) + :return: self.__templateSettingsFile. + :rtype: unicode """ return self.__templateSettingsFile @@ -437,7 +460,8 @@ def templateSettingsFile(self, value): """ Setter for **self.__templateSettingsFile** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -458,7 +482,8 @@ def templateCommonAttributesSection(self): """ Property for **self.__templateCommonAttributesSection** attribute. - :return: self.__templateCommonAttributesSection. ( String ) + :return: self.__templateCommonAttributesSection. + :rtype: unicode """ return self.__templateCommonAttributesSection @@ -469,7 +494,8 @@ def templateCommonAttributesSection(self, value): """ Setter for **self.__templateCommonAttributesSection** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -490,7 +516,8 @@ def templateAdditionalAttributesSection(self): """ Property for **self.__templateAdditionalAttributesSection** attribute. - :return: self.__templateAdditionalAttributesSection. ( String ) + :return: self.__templateAdditionalAttributesSection. + :rtype: unicode """ return self.__templateAdditionalAttributesSection @@ -501,7 +528,8 @@ def templateAdditionalAttributesSection(self, value): """ Setter for **self.__templateAdditionalAttributesSection** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -523,7 +551,8 @@ def templateScriptSection(self): """ Property for **self.__templateScriptSection** attribute. - :return: self.__templateScriptSection. ( String ) + :return: self.__templateScriptSection. + :rtype: unicode """ return self.__templateScriptSection @@ -534,7 +563,8 @@ def templateScriptSection(self, value): """ Setter for **self.__templateScriptSection** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -555,7 +585,8 @@ def optionsToolboxesHeaders(self): """ Property for **self.__optionsToolboxesHeaders** attribute. - :return: self.__optionsToolboxesHeaders. ( List ) + :return: self.__optionsToolboxesHeaders. + :rtype: list """ return self.__optionsToolboxesHeaders @@ -566,7 +597,8 @@ def optionsToolboxesHeaders(self, value): """ Setter for **self.__optionsToolboxesHeaders** attribute. - :param value: Attribute value. ( List ) + :param value: Attribute value. + :type value: list """ raise foundations.exceptions.ProgrammingError( @@ -587,7 +619,8 @@ def uiLightGrayColor(self): """ Property for **self.__uiLightGrayColor** attribute. - :return: self.__uiLightGrayColor. ( QColor ) + :return: self.__uiLightGrayColor. + :rtype: QColor """ return self.__uiLightGrayColor @@ -598,7 +631,8 @@ def uiLightGrayColor(self, value): """ Setter for **self.__uiLightGrayColor** attribute. - :param value: Attribute value. ( QColor ) + :param value: Attribute value. + :type value: QColor """ raise foundations.exceptions.ProgrammingError( @@ -619,7 +653,8 @@ def uiDarkGrayColor(self): """ Property for **self.__uiDarkGrayColor** attribute. - :return: self.__uiDarkGrayColor. ( QColor ) + :return: self.__uiDarkGrayColor. + :rtype: QColor """ return self.__uiDarkGrayColor @@ -630,7 +665,8 @@ def uiDarkGrayColor(self, value): """ Setter for **self.__uiDarkGrayColor** attribute. - :param value: Attribute value. ( QColor ) + :param value: Attribute value. + :type value: QColor """ raise foundations.exceptions.ProgrammingError( @@ -651,7 +687,8 @@ def enumSplitter(self): """ Property for **self.__enumSplitter** attribute. - :return: self.__enumSplitter. ( String ) + :return: self.__enumSplitter. + :rtype: unicode """ return self.__enumSplitter @@ -662,7 +699,8 @@ def enumSplitter(self, value): """ Setter for **self.__enumSplitter** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ if value is not None: @@ -690,8 +728,10 @@ def activate(self, engine): """ Activates the Component. - :param engine: Engine to attach the Component to. ( QObject ) - :return: Method success. ( Boolean ) + :param engine: Engine to attach the Component to. + :type engine: QObject + :return: Method success. + :rtype: bool """ LOGGER.debug("> Activating '{0}' Component.".format(self.__class__.__name__)) @@ -715,7 +755,8 @@ def deactivate(self): """ Deactivates the Component. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Deactivating '{0}' Component.".format(self.__class__.__name__)) @@ -735,7 +776,8 @@ def initializeUi(self): """ Initializes the Component ui. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Initializing '{0}' Component ui.".format(self.__class__.__name__)) @@ -767,7 +809,8 @@ def uninitializeUi(self): """ Uninitializes the Component ui. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Uninitializing '{0}' Component ui.".format(self.__class__.__name__)) @@ -787,7 +830,8 @@ def addWidget(self): """ Adds the Component Widget to the engine. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Adding '{0}' Component Widget.".format(self.__class__.__name__)) @@ -800,7 +844,8 @@ def removeWidget(self): """ Removes the Component Widget from the engine. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Removing '{0}' Component Widget.".format(self.__class__.__name__)) @@ -814,9 +859,12 @@ def __view_setUi(self, section, view, overrides): """ Defines and sets the given View. - :param section: Section attributes. ( Dictionary ) - :param view: Table Widget. ( QTableWidget ) - :param overrides: Attributes overrides. ( Dictionary ) + :param section: Section attributes. + :type section: dict + :param view: Table Widget. + :type view: QTableWidget + :param overrides: Attributes overrides. + :type overrides: dict """ LOGGER.debug("> Updating '{0}'.".format(view.objectName())) @@ -898,7 +946,8 @@ def __view_clearUi(self, view): """ Defines and sets the given View. - :param view: Table Widget. ( QTableWidget ) + :param view: Table Widget. + :type view: QTableWidget """ LOGGER.debug("> Clearing '{0}'.".format(view.objectName())) @@ -969,7 +1018,8 @@ def __view__valueChanged(self, *args): """ Defines the slot triggered by a View when value changed. - :param \*args: Arguments. ( \* ) + :param \*args: Arguments. + :type \*args: \* """ LOGGER.debug("> Initializing '{0}' Template settings file content.".format(self.__templateSettingsFile)) @@ -998,8 +1048,10 @@ def __templatesOutliner_view_selectionModel__selectionChanged(self, selectedItem """ Defines the slot triggered by **templatesOutliner.view** Model when selection changed - :param selectedItems: Selected items. ( QItemSelection ) - :param deselectedItems: Deselected items. ( QItemSelection ) + :param selectedItems: Selected items. + :type selectedItems: QItemSelection + :param deselectedItems: Deselected items. + :type deselectedItems: QItemSelection """ self.__views_setUi() @@ -1008,8 +1060,10 @@ def __updateOverrideKeys(self, view): """ Updates the Loader Script Component override keys. - :param view: Table Widget. ( QTableWidget ) - :return: Method success. ( Boolean ) + :param view: Table Widget. + :type view: QTableWidget + :return: Method success. + :rtype: bool """ LOGGER.debug("> Updating override keys with '{0}' attributes.".format(view.objectName())) @@ -1035,7 +1089,8 @@ def getOverrideKeys(self): """ Gets override keys. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.info("{0} | Updating Loader Script override keys!".format(self.__class__.__name__)) diff --git a/sibl_gui/components/addons/locationsBrowser/locationsBrowser.py b/sibl_gui/components/addons/locationsBrowser/locationsBrowser.py index 0ac6d50b..ecdade83 100644 --- a/sibl_gui/components/addons/locationsBrowser/locationsBrowser.py +++ b/sibl_gui/components/addons/locationsBrowser/locationsBrowser.py @@ -90,10 +90,14 @@ def __init__(self, parent=None, name=None, *args, **kwargs): """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param name: Component name. ( String ) - :param \*args: Arguments. ( \* ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param parent: Object parent. + :type parent: QObject + :param name: Component name. + :type name: unicode + :param \*args: Arguments. + :type \*args: \* + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -126,7 +130,8 @@ def engine(self): """ Property for **self.__engine** attribute. - :return: self.__engine. ( QObject ) + :return: self.__engine. + :rtype: QObject """ return self.__engine @@ -137,7 +142,8 @@ def engine(self, value): """ Setter for **self.__engine** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -158,7 +164,8 @@ def settings(self): """ Property for **self.__settings** attribute. - :return: self.__settings. ( QSettings ) + :return: self.__settings. + :rtype: QSettings """ return self.__settings @@ -169,7 +176,8 @@ def settings(self, value): """ Setter for **self.__settings** attribute. - :param value: Attribute value. ( QSettings ) + :param value: Attribute value. + :type value: QSettings """ raise foundations.exceptions.ProgrammingError( @@ -190,7 +198,8 @@ def settingsSection(self): """ Property for **self.__settingsSection** attribute. - :return: self.__settingsSection. ( String ) + :return: self.__settingsSection. + :rtype: unicode """ return self.__settingsSection @@ -201,7 +210,8 @@ def settingsSection(self, value): """ Setter for **self.__settingsSection** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -222,7 +232,8 @@ def componentsManagerUi(self): """ Property for **self.__componentsManagerUi** attribute. - :return: self.__componentsManagerUi. ( QWidget ) + :return: self.__componentsManagerUi. + :rtype: QWidget """ return self.__componentsManagerUi @@ -233,7 +244,8 @@ def componentsManagerUi(self, value): """ Setter for **self.__componentsManagerUi** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -254,7 +266,8 @@ def preferencesManager(self): """ Property for **self.__preferencesManager** attribute. - :return: self.__preferencesManager. ( QWidget ) + :return: self.__preferencesManager. + :rtype: QWidget """ return self.__preferencesManager @@ -265,7 +278,8 @@ def preferencesManager(self, value): """ Setter for **self.__preferencesManager** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -286,7 +300,8 @@ def iblSetsOutliner(self): """ Property for **self.__iblSetsOutliner** attribute. - :return: self.__iblSetsOutliner. ( QWidget ) + :return: self.__iblSetsOutliner. + :rtype: QWidget """ return self.__iblSetsOutliner @@ -297,7 +312,8 @@ def iblSetsOutliner(self, value): """ Setter for **self.__iblSetsOutliner** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -318,7 +334,8 @@ def templatesOutliner(self): """ Property for **self.__templatesOutliner** attribute. - :return: self.__templatesOutliner. ( QWidget ) + :return: self.__templatesOutliner. + :rtype: QWidget """ return self.__templatesOutliner @@ -329,7 +346,8 @@ def templatesOutliner(self, value): """ Setter for **self.__templatesOutliner** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -350,7 +368,8 @@ def loaderScript(self): """ Property for **self.__loaderScript** attribute. - :return: self.__loaderScript. ( QWidget ) + :return: self.__loaderScript. + :rtype: QWidget """ return self.__loaderScript @@ -361,7 +380,8 @@ def loaderScript(self, value): """ Setter for **self.__loaderScript** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -382,7 +402,8 @@ def Open_Output_Directory_pushButton(self): """ Property for **self.__Open_Output_Directory_pushButton** attribute. - :return: self.__Open_Output_Directory_pushButton. ( QPushButton ) + :return: self.__Open_Output_Directory_pushButton. + :rtype: QPushButton """ return self.__Open_Output_Directory_pushButton @@ -393,7 +414,8 @@ def Open_Output_Directory_pushButton(self, value): """ Setter for **self.__Open_Output_Directory_pushButton** attribute. - :param value: Attribute value. ( QPushButton ) + :param value: Attribute value. + :type value: QPushButton """ raise foundations.exceptions.ProgrammingError( @@ -414,7 +436,8 @@ def linuxBrowsers(self): """ Property for **self.__linuxBrowsers** attribute. - :return: self.__linuxBrowsers. ( QObject ) + :return: self.__linuxBrowsers. + :rtype: QObject """ return self.__linuxBrowsers @@ -425,7 +448,8 @@ def linuxBrowsers(self, value): """ Setter for **self.__linuxBrowsers** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -448,8 +472,10 @@ def activate(self, engine): """ Activates the Component. - :param engine: Container to attach the Component to. ( QObject ) - :return: Method success. ( Boolean ) + :param engine: Container to attach the Component to. + :type engine: QObject + :return: Method success. + :rtype: bool """ LOGGER.debug("> Activating '{0}' Component.".format(self.__class__.__name__)) @@ -472,7 +498,8 @@ def deactivate(self): """ Deactivates the Component. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Deactivating '{0}' Component.".format(self.__class__.__name__)) @@ -495,7 +522,8 @@ def initializeUi(self): """ Initializes the Component ui. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Initializing '{0}' Component ui.".format(self.__class__.__name__)) @@ -524,7 +552,8 @@ def uninitializeUi(self): """ Uninitializes the Component ui. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Uninitializing '{0}' Component ui.".format(self.__class__.__name__)) @@ -551,7 +580,8 @@ def addWidget(self): """ Adds the Component Widget to the engine. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Adding '{0}' Component Widget.".format(self.__class__.__name__)) @@ -564,7 +594,8 @@ def removeWidget(self): """ Removes the Component Widget from the engine. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Removing '{0}' Component Widget.".format(self.__class__.__name__)) @@ -630,8 +661,10 @@ def __iblSetsOutliner_views_openIblSetsLocationsAction__triggered(self, checked) Defines the slot triggered by **'Actions|Umbra|Components|core.iblSetsOutliner|Open Ibl Set(s) Location(s) ...'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ return self.openIblSetsLocationsUi() @@ -640,8 +673,10 @@ def __inspector_openActiveIblSetLocationsAction__triggered(self, checked): """ Defines the slot triggered by **'Actions|Umbra|Components|core.inspector|Open Ibl Set location ...'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ return self.openActiveIblSetLocationsUi() @@ -651,8 +686,10 @@ def __componentsManagerUi_view_openComponentsLocationsAction__triggered(self, ch Defines the slot triggered by **'Actions|Umbra|Components|factory.ComponentsManagerUi|Open Component(s) Location(s) ...'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ return self.openComponentsLocationsUi() @@ -662,8 +699,10 @@ def __templatesOutliner_view_openTemplatesLocationsAction__triggered(self, check Defines the slot triggered by **'Actions|Umbra|Components|core.templatesOutliner|Open Template(s) Location(s) ...'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ return self.openTemplatesLocationsUi() @@ -682,7 +721,8 @@ def __Custom_File_Browser_Path_toolButton__clicked(self, checked): """ Defines the slot triggered by **Custom_File_Browser_Path_toolButton** Widget when clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ customFileBrowserExecutable = umbra.ui.common.storeLastBrowsedPath( @@ -718,7 +758,8 @@ def __Open_Output_Directory_pushButton__clicked(self, checked): """ Defines the slot triggered by **Open_Output_Directory_pushButton** Widget when clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ self.openOutputDirectoryUi() @@ -728,7 +769,8 @@ def openIblSetsLocationsUi(self): """ Open selected Ibl Sets directories. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -757,7 +799,8 @@ def openActiveIblSetLocationsUi(self): """ Opens :mod:`sibl_gui.components.core.inspector.inspector` Component Ibl Set directory. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -779,7 +822,8 @@ def openComponentsLocationsUi(self): """ Opens selected Components directories. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -807,7 +851,8 @@ def openTemplatesLocationsUi(self): """ Opens selected Templates directories. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -837,7 +882,8 @@ def openOutputDirectoryUi(self): """ Opens output directory. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -860,9 +906,12 @@ def getProcessCommand(self, directory, customBrowser=None): """ Gets process command. - :param directory: Directory to explore. ( String ) - :param customBrowser: Custom browser. ( String ) - :return: Process command. ( String ) + :param directory: Directory to explore. + :type directory: unicode + :param customBrowser: Custom browser. + :type customBrowser: unicode + :return: Process command. + :rtype: unicode """ processCommand = None @@ -907,9 +956,12 @@ def exploreDirectory(self, directory, customBrowser=None): """ Provides directory exploring capability. - :param directory: Directory to explore. ( String ) - :param customBrowser: Custom browser. ( String ) - :return: Method success. ( Boolean ) + :param directory: Directory to explore. + :type directory: unicode + :param customBrowser: Custom browser. + :type customBrowser: unicode + :return: Method success. + :rtype: bool """ browserCommand = self.getProcessCommand(directory, customBrowser) diff --git a/sibl_gui/components/addons/loggingNotifier/loggingNotifier.py b/sibl_gui/components/addons/loggingNotifier/loggingNotifier.py index d8994627..fbe63ed6 100644 --- a/sibl_gui/components/addons/loggingNotifier/loggingNotifier.py +++ b/sibl_gui/components/addons/loggingNotifier/loggingNotifier.py @@ -55,7 +55,8 @@ def __init__(self, name=None): """ Initializes the class. - :param name: Component name. ( String ) + :param name: Component name. + :type name: unicode """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -77,7 +78,8 @@ def engine(self): """ Property for **self.__engine** attribute. - :return: self.__engine. ( QObject ) + :return: self.__engine. + :rtype: QObject """ return self.__engine @@ -88,7 +90,8 @@ def engine(self, value): """ Setter for **self.__engine** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -109,7 +112,8 @@ def memoryHandlerStackDepth(self): """ Property for **self.__memoryHandlerStackDepth** attribute. - :return: self.__memoryHandlerStackDepth. ( Integer ) + :return: self.__memoryHandlerStackDepth. + :rtype: int """ return self.__memoryHandlerStackDepth @@ -120,7 +124,8 @@ def memoryHandlerStackDepth(self, value): """ Setter for **self.__memoryHandlerStackDepth** attribute. - :param value: Attribute value. ( Integer ) + :param value: Attribute value. + :type value: int """ raise foundations.exceptions.ProgrammingError( @@ -143,8 +148,10 @@ def activate(self, engine): """ Activates the Component. - :param engine: Engine to attach the Component to. ( QObject ) - :return: Method success. ( Boolean ) + :param engine: Engine to attach the Component to. + :type engine: QObject + :return: Method success. + :rtype: bool """ LOGGER.debug("> Activating '{0}' Component.".format(self.__class__.__name__)) @@ -158,7 +165,8 @@ def deactivate(self): """ Deactivates the Component. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Deactivating '{0}' Component.".format(self.__class__.__name__)) @@ -172,7 +180,8 @@ def initialize(self): """ Initializes the Component. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Initializing '{0}' Component.".format(self.__class__.__name__)) @@ -187,7 +196,8 @@ def uninitialize(self): """ Uninitializes the Component. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Uninitializing '{0}' Component.".format(self.__class__.__name__)) diff --git a/sibl_gui/components/addons/onlineUpdater/downloadManager.py b/sibl_gui/components/addons/onlineUpdater/downloadManager.py index 1f9fe7be..8fff30f3 100644 --- a/sibl_gui/components/addons/onlineUpdater/downloadManager.py +++ b/sibl_gui/components/addons/onlineUpdater/downloadManager.py @@ -77,12 +77,18 @@ def __init__(self, parent, networkAccessManager, downloadDirectory, requests=Non """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param networkAccessManager: Network access manager. ( QNetworkAccessManager ) - :param downloadDirectory: Download directory. ( String ) - :param requests: Download requests. ( List ) - :param \*args: Arguments. ( \* ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param parent: Object parent. + :type parent: QObject + :param networkAccessManager: Network access manager. + :type networkAccessManager: QNetworkAccessManager + :param downloadDirectory: Download directory. + :type downloadDirectory: unicode + :param requests: Download requests. + :type requests: list + :param \*args: Arguments. + :type \*args: \* + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -118,7 +124,8 @@ def container(self): """ Property for **self.__container** attribute. - :return: self.__container. ( QObject ) + :return: self.__container. + :rtype: QObject """ return self.__container @@ -129,7 +136,8 @@ def container(self, value): """ Setter for **self.__container** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -150,7 +158,8 @@ def networkAccessManager(self): """ Property for **self.__networkAccessManager** attribute. - :return: self.__networkAccessManager. ( QNetworkAccessManager ) + :return: self.__networkAccessManager. + :rtype: QNetworkAccessManager """ return self.__networkAccessManager @@ -161,7 +170,8 @@ def networkAccessManager(self, value): """ Setter for **self.__networkAccessManager** attribute. - :param value: Attribute value. ( QNetworkAccessManager ) + :param value: Attribute value. + :type value: QNetworkAccessManager """ raise foundations.exceptions.ProgrammingError( @@ -182,7 +192,8 @@ def downloadDirectory(self): """ Property for **self.__downloadDirectory** attribute. - :return: self.__downloadDirectory. ( String ) + :return: self.__downloadDirectory. + :rtype: unicode """ return self.__downloadDirectory @@ -193,7 +204,8 @@ def downloadDirectory(self, value): """ Setter for **self.__downloadDirectory** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -214,7 +226,8 @@ def uiResourcesDirectory(self): """ Property for **self.__uiResourcesDirectory** attribute. - :return: self.__uiResourcesDirectory. ( String ) + :return: self.__uiResourcesDirectory. + :rtype: unicode """ return self.__uiResourcesDirectory @@ -225,7 +238,8 @@ def uiResourcesDirectory(self, value): """ Setter for **self.__uiResourcesDirectory** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -246,7 +260,8 @@ def uiLogoImage(self): """ Property for **self.__uiLogoImage** attribute. - :return: self.__uiLogoImage. ( String ) + :return: self.__uiLogoImage. + :rtype: unicode """ return self.__uiLogoImage @@ -257,7 +272,8 @@ def uiLogoImage(self, value): """ Setter for **self.__uiLogoImage** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -278,7 +294,8 @@ def requests(self): """ Property for **self.__requests** attribute. - :return: self.__requests. ( List ) + :return: self.__requests. + :rtype: list """ return self.__requests @@ -289,7 +306,8 @@ def requests(self, value): """ Setter for **self.__requests** attribute. - :param value: Attribute value. ( List ) + :param value: Attribute value. + :type value: list """ if value is not None: @@ -314,7 +332,8 @@ def downloads(self): """ Property for **self.__downloads** attribute. - :return: self.__downloads. ( Dictionary ) + :return: self.__downloads. + :rtype: dict """ return self.__downloads @@ -325,7 +344,8 @@ def downloads(self, value): """ Setter for **self.__downloads** attribute. - :param value: Attribute value. ( Dictionary ) + :param value: Attribute value. + :type value: dict """ raise foundations.exceptions.ProgrammingError( @@ -346,7 +366,8 @@ def currentRequest(self): """ Property for **self.__currentRequest** attribute. - :return: self.__currentRequest. ( QNetworkReply ) + :return: self.__currentRequest. + :rtype: QNetworkReply """ return self.__currentRequest @@ -357,7 +378,8 @@ def currentRequest(self, value): """ Setter for **self.__currentRequest** attribute. - :param value: Attribute value. ( QNetworkReply ) + :param value: Attribute value. + :type value: QNetworkReply """ raise foundations.exceptions.ProgrammingError( @@ -378,7 +400,8 @@ def currentFile(self): """ Property for **self.__currentFile** attribute. - :return: self.__currentFile. ( QFile ) + :return: self.__currentFile. + :rtype: QFile """ return self.__currentFile @@ -389,7 +412,8 @@ def currentFile(self, value): """ Setter for **self.__currentFile** attribute. - :param value: Attribute value. ( QFile ) + :param value: Attribute value. + :type value: QFile """ raise foundations.exceptions.ProgrammingError( @@ -410,7 +434,8 @@ def currentFilePath(self): """ Property for **self.__currentFilePath** attribute. - :return: self.__currentFilePath. ( String ) + :return: self.__currentFilePath. + :rtype: unicode """ return self.__currentFilePath @@ -421,7 +446,8 @@ def currentFilePath(self, value): """ Setter for **self.__currentFilePath** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -442,7 +468,8 @@ def downloadStatus(self): """ Property for **self.__downloadStatus** attribute. - :return: self.__downloadStatus. ( QObject ) + :return: self.__downloadStatus. + :rtype: QObject """ return self.__downloadStatus @@ -453,7 +480,8 @@ def downloadStatus(self, value): """ Setter for **self.__downloadStatus** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -476,7 +504,8 @@ def closeEvent(self, event): """ Reimplements the :meth:`QWidget.closeEvent` method. - :param event: QEvent. ( QEvent ) + :param event: QEvent. + :type event: QEvent """ self.__downloadStatus or self.abortDownload() @@ -502,7 +531,8 @@ def __Cancel_Close_pushButton__clicked(self, checked): """ Defines the slot triggered by **Cancel_Close_pushButton** Widget when clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ self.close() @@ -544,8 +574,10 @@ def __downloadProgress(self, bytesReceived, bytesTotal): """ Updates the download progress. - :param bytesReceived: Bytes received. ( Integer ) - :param bytesTotal: Bytes total. ( Integer ) + :param bytesReceived: Bytes received. + :type bytesReceived: int + :param bytesTotal: Bytes total. + :type bytesTotal: int """ LOGGER.debug("> Updating download progress: '{0}' bytes received, '{1}' bytes total.".format(bytesReceived, @@ -591,7 +623,8 @@ def startDownload(self): """ Triggers the download. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ self.__downloadStatus = False @@ -602,7 +635,8 @@ def abortDownload(self): """ Aborts the current download. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ self.__currentRequest.abort() diff --git a/sibl_gui/components/addons/onlineUpdater/onlineUpdater.py b/sibl_gui/components/addons/onlineUpdater/onlineUpdater.py index 2d1da3cc..f2bffd41 100644 --- a/sibl_gui/components/addons/onlineUpdater/onlineUpdater.py +++ b/sibl_gui/components/addons/onlineUpdater/onlineUpdater.py @@ -76,10 +76,14 @@ def __init__(self, parent=None, name=None, *args, **kwargs): """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param name: Component name. ( String ) - :param \*args: Arguments. ( \* ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param parent: Object parent. + :type parent: QObject + :param name: Component name. + :type name: unicode + :param \*args: Arguments. + :type \*args: \* + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -116,7 +120,8 @@ def engine(self): """ Property for **self.__engine** attribute. - :return: self.__engine. ( QObject ) + :return: self.__engine. + :rtype: QObject """ return self.__engine @@ -127,7 +132,8 @@ def engine(self, value): """ Setter for **self.__engine** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -148,7 +154,8 @@ def settings(self): """ Property for **self.__settings** attribute. - :return: self.__settings. ( QSettings ) + :return: self.__settings. + :rtype: QSettings """ return self.__settings @@ -159,7 +166,8 @@ def settings(self, value): """ Setter for **self.__settings** attribute. - :param value: Attribute value. ( QSettings ) + :param value: Attribute value. + :type value: QSettings """ raise foundations.exceptions.ProgrammingError( @@ -180,7 +188,8 @@ def settingsSection(self): """ Property for **self.__settingsSection** attribute. - :return: self.__settingsSection. ( String ) + :return: self.__settingsSection. + :rtype: unicode """ return self.__settingsSection @@ -191,7 +200,8 @@ def settingsSection(self, value): """ Setter for **self.__settingsSection** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -212,7 +222,8 @@ def preferencesManager(self): """ Property for **self.__preferencesManager** attribute. - :return: self.__preferencesManager. ( QWidget ) + :return: self.__preferencesManager. + :rtype: QWidget """ return self.__preferencesManager @@ -223,7 +234,8 @@ def preferencesManager(self, value): """ Setter for **self.__preferencesManager** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -244,7 +256,8 @@ def templatesOutliner(self): """ Property for **self.__templatesOutliner** attribute. - :return: self.__templatesOutliner. ( QWidget ) + :return: self.__templatesOutliner. + :rtype: QWidget """ return self.__templatesOutliner @@ -255,7 +268,8 @@ def templatesOutliner(self, value): """ Setter for **self.__templatesOutliner** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -276,7 +290,8 @@ def locationsBrowser(self): """ Property for **self.__locationsBrowser** attribute. - :return: self.__locationsBrowser. ( QWidget ) + :return: self.__locationsBrowser. + :rtype: QWidget """ return self.__locationsBrowser @@ -287,7 +302,8 @@ def locationsBrowser(self, value): """ Setter for **self.__locationsBrowser** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -308,7 +324,8 @@ def ioDirectory(self): """ Property for **self.__ioDirectory** attribute. - :return: self.__ioDirectory. ( String ) + :return: self.__ioDirectory. + :rtype: unicode """ return self.__ioDirectory @@ -319,7 +336,8 @@ def ioDirectory(self, value): """ Setter for **self.__ioDirectory** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -340,7 +358,8 @@ def repositoryUrl(self): """ Property for **self.__repositoryUrl** attribute. - :return: self.__repositoryUrl. ( String ) + :return: self.__repositoryUrl. + :rtype: unicode """ return self.__repositoryUrl @@ -351,7 +370,8 @@ def repositoryUrl(self, value): """ Setter for **self.__repositoryUrl** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -372,7 +392,8 @@ def releasesFileUrl(self): """ Property for **self.__releasesFileUrl** attribute. - :return: self.__releasesFileUrl. ( String ) + :return: self.__releasesFileUrl. + :rtype: unicode """ return self.__releasesFileUrl @@ -383,7 +404,8 @@ def releasesFileUrl(self, value): """ Setter for **self.__releasesFileUrl** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -404,7 +426,8 @@ def networkAccessManager(self): """ Property for **self.__networkAccessManager** attribute. - :return: self.__networkAccessManager. ( QNetworkAccessManager ) + :return: self.__networkAccessManager. + :rtype: QNetworkAccessManager """ return self.__networkAccessManager @@ -415,7 +438,8 @@ def networkAccessManager(self, value): """ Setter for **self.__networkAccessManager** attribute. - :param value: Attribute value. ( QNetworkAccessManager ) + :param value: Attribute value. + :type value: QNetworkAccessManager """ raise foundations.exceptions.ProgrammingError( @@ -436,7 +460,8 @@ def releaseReply(self): """ Property for **self.__releasesFileReply** attribute. - :return: self.__releasesFileReply. ( QNetworkReply ) + :return: self.__releasesFileReply. + :rtype: QNetworkReply """ return self.__releasesFileReply @@ -447,7 +472,8 @@ def releaseReply(self, value): """ Setter for **self.__releasesFileReply** attribute. - :param value: Attribute value. ( QNetworkReply ) + :param value: Attribute value. + :type value: QNetworkReply """ raise foundations.exceptions.ProgrammingError( @@ -468,7 +494,8 @@ def remoteUpdater(self): """ Property for **self.__remoteUpdater** attribute. - :return: self.__remoteUpdater. ( Object ) + :return: self.__remoteUpdater. + :rtype: object """ return self.__remoteUpdater @@ -479,7 +506,8 @@ def remoteUpdater(self, value): """ Setter for **self.__remoteUpdater** attribute. - :param value: Attribute value. ( Object ) + :param value: Attribute value. + :type value: object """ raise foundations.exceptions.ProgrammingError( @@ -500,7 +528,8 @@ def reportUpdateStatus(self): """ Property for **self.__reportUpdateStatus** attribute. - :return: self.__reportUpdateStatus. ( Boolean ) + :return: self.__reportUpdateStatus. + :rtype: bool """ return self.__reportUpdateStatus @@ -511,7 +540,8 @@ def reportUpdateStatus(self, value): """ Setter for **self.__reportUpdateStatus** attribute. - :param value: Attribute value. ( Boolean ) + :param value: Attribute value. + :type value: bool """ raise foundations.exceptions.ProgrammingError( @@ -534,8 +564,10 @@ def activate(self, engine): """ Activates the Component. - :param engine: Engine to attach the Component to. ( QObject ) - :return: Method success. ( Boolean ) + :param engine: Engine to attach the Component to. + :type engine: QObject + :return: Method success. + :rtype: bool """ LOGGER.debug("> Activating '{0}' Component.".format(self.__class__.__name__)) @@ -563,7 +595,8 @@ def deactivate(self): """ Deactivates the Component. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Deactivating '{0}' Component.".format(self.__class__.__name__)) @@ -589,7 +622,8 @@ def initializeUi(self): """ Initializes the Component ui. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Initializing '{0}' Component ui.".format(self.__class__.__name__)) @@ -616,7 +650,8 @@ def uninitializeUi(self): """ Uninitializes the Component ui. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Uninitializing '{0}' Component ui.".format(self.__class__.__name__)) @@ -635,7 +670,8 @@ def onStartup(self): """ Defines the slot triggered on Framework startup. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Calling '{0}' Component Framework 'onStartup' method.".format(self.__class__.__name__)) @@ -650,7 +686,8 @@ def addWidget(self): """ Adds the Component Widget to the engine. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Adding '{0}' Component Widget.".format(self.__class__.__name__)) @@ -661,7 +698,8 @@ def removeWidget(self): """ Removes the Component Widget from the engine. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Removing '{0}' Component Widget.".format(self.__class__.__name__)) @@ -687,7 +725,8 @@ def __Check_For_New_Releases_On_Startup_checkBox__stateChanged(self, state): """ Defines the slot triggered by **Check_For_New_Releases_On_Startup_checkBox** Widget when state changed. - :param state: Checkbox state. ( Integer ) + :param state: Checkbox state. + :type state: int """ LOGGER.debug("> Check for new releases on startup state: '{0}'.".format(state)) @@ -712,7 +751,8 @@ def __Ignore_Non_Existing_Templates_checkBox__stateChanged(self, state): """ Defines the slot triggered by **Ignore_Non_Existing_Templates_checkBox** Widget when state changed. - :param state: Checkbox state. ( Integer ) + :param state: Checkbox state. + :type state: int """ LOGGER.debug("> Ignore non existing Templates state: '{0}'.".format(state)) @@ -722,7 +762,8 @@ def __Check_For_New_Releases_pushButton__clicked(self, checked): """ Defines the slot triggered by **Check_For_New_Releases_pushButton** Widget when clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ self.checkForNewReleasesUi() @@ -821,7 +862,8 @@ def checkForNewReleasesUi(self): """ Checks for new releases. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -840,7 +882,8 @@ def checkForNewReleases(self): """ Checks for new releases. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ if not self.__networkAccessManager.networkAccessible(): diff --git a/sibl_gui/components/addons/onlineUpdater/remoteUpdater.py b/sibl_gui/components/addons/onlineUpdater/remoteUpdater.py index c99c926a..20133b05 100644 --- a/sibl_gui/components/addons/onlineUpdater/remoteUpdater.py +++ b/sibl_gui/components/addons/onlineUpdater/remoteUpdater.py @@ -81,7 +81,8 @@ def __init__(self, **kwargs): """ Initializes the class. - :param kwargs: name, repositoryVersion, localVersion, type, url, comment. ( Key / Value pairs ) + :param kwargs: name, repositoryVersion, localVersion, type, url, comment. + :type kwargs: dict """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -99,10 +100,14 @@ def __init__(self, parent, releases=None, *args, **kwargs): """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param releases: Releases. ( Dictionary ) - :param \*args: Arguments. ( \* ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param parent: Object parent. + :type parent: QObject + :param releases: Releases. + :type releases: dict + :param \*args: Arguments. + :type \*args: \* + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -146,7 +151,8 @@ def container(self): """ Property for **self.__container** attribute. - :return: self.__container. ( QObject ) + :return: self.__container. + :rtype: QObject """ return self.__container @@ -157,7 +163,8 @@ def container(self, value): """ Setter for **self.__container** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -178,7 +185,8 @@ def releases(self): """ Property for **self.__releases** attribute. - :return: self.__releases. ( Dictionary ) + :return: self.__releases. + :rtype: dict """ return self.__releases @@ -189,7 +197,8 @@ def releases(self, value): """ Setter for **self.__releases** attribute. - :param value: Attribute value. ( Dictionary ) + :param value: Attribute value. + :type value: dict """ if value is not None: @@ -216,7 +225,8 @@ def uiResourcesDirectory(self): """ Property for **self.__uiResourcesDirectory** attribute. - :return: self.__uiResourcesDirectory. ( String ) + :return: self.__uiResourcesDirectory. + :rtype: unicode """ return self.__uiResourcesDirectory @@ -227,7 +237,8 @@ def uiResourcesDirectory(self, value): """ Setter for **self.__uiResourcesDirectory** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -248,7 +259,8 @@ def uiLogoImage(self): """ Property for **self.__uiLogoImage** attribute. - :return: self.__uiLogoImage. ( String ) + :return: self.__uiLogoImage. + :rtype: unicode """ return self.__uiLogoImage @@ -259,7 +271,8 @@ def uiLogoImage(self, value): """ Setter for **self.__uiLogoImage** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -280,7 +293,8 @@ def uiTemplatesImage(self): """ Property for **self.__uiTemplatesImage** attribute. - :return: self.__uiTemplatesImage. ( String ) + :return: self.__uiTemplatesImage. + :rtype: unicode """ return self.__uiTemplatesImage @@ -291,7 +305,8 @@ def uiTemplatesImage(self, value): """ Setter for **self.__uiTemplatesImage** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -312,7 +327,8 @@ def uiLightGrayColor(self): """ Property for **self.__uiLightGrayColor** attribute. - :return: self.__uiLightGrayColor. ( QColor ) + :return: self.__uiLightGrayColor. + :rtype: QColor """ return self.__uiLightGrayColor @@ -323,7 +339,8 @@ def uiLightGrayColor(self, value): """ Setter for **self.__uiLightGrayColor** attribute. - :param value: Attribute value. ( QColor ) + :param value: Attribute value. + :type value: QColor """ raise foundations.exceptions.ProgrammingError( @@ -344,7 +361,8 @@ def uiDarkGrayColor(self): """ Property for **self.__uiDarkGrayColor** attribute. - :return: self.__uiDarkGrayColor. ( QColor ) + :return: self.__uiDarkGrayColor. + :rtype: QColor """ return self.__uiDarkGrayColor @@ -355,7 +373,8 @@ def uiDarkGrayColor(self, value): """ Setter for **self.__uiDarkGrayColor** attribute. - :param value: Attribute value. ( QColor ) + :param value: Attribute value. + :type value: QColor """ raise foundations.exceptions.ProgrammingError( @@ -376,7 +395,8 @@ def view(self): """ Property for **self.__view** attribute. - :return: self.__view. ( QWidget ) + :return: self.__view. + :rtype: QWidget """ return self.__view @@ -387,7 +407,8 @@ def view(self, value): """ Setter for **self.__view** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -408,7 +429,8 @@ def splitter(self): """ Property for **self.__splitter** attribute. - :return: self.__splitter. ( String ) + :return: self.__splitter. + :rtype: unicode """ return self.__splitter @@ -419,7 +441,8 @@ def splitter(self, value): """ Setter for **self.__splitter** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -440,7 +463,8 @@ def headers(self): """ Property for **self.__headers** attribute. - :return: self.__headers. ( String ) + :return: self.__headers. + :rtype: unicode """ return self.__headers @@ -451,7 +475,8 @@ def headers(self, value): """ Setter for **self.__headers** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -472,7 +497,8 @@ def applicationChangesUrl(self): """ Property for **self.__applicationChangesUrl** attribute. - :return: self.__applicationChangesUrl. ( String ) + :return: self.__applicationChangesUrl. + :rtype: unicode """ return self.__applicationChangesUrl @@ -483,7 +509,8 @@ def applicationChangesUrl(self, value): """ Setter for **self.__applicationChangesUrl** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -504,7 +531,8 @@ def repositoryUrl(self): """ Property for **self.__repositoryUrl** attribute. - :return: self.__repositoryUrl. ( String ) + :return: self.__repositoryUrl. + :rtype: unicode """ return self.__repositoryUrl @@ -515,7 +543,8 @@ def repositoryUrl(self, value): """ Setter for **self.__repositoryUrl** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -536,7 +565,8 @@ def downloadManager(self): """ Property for **self.__downloadManager** attribute. - :return: self.__downloadManager. ( Object ) + :return: self.__downloadManager. + :rtype: object """ return self.__downloadManager @@ -547,7 +577,8 @@ def downloadManager(self, value): """ Setter for **self.__downloadManager** attribute. - :param value: Attribute value. ( Object ) + :param value: Attribute value. + :type value: object """ raise foundations.exceptions.ProgrammingError( @@ -568,7 +599,8 @@ def networkAccessManager(self): """ Property for **self.__networkAccessManager** attribute. - :return: self.__networkAccessManager. ( QNetworkAccessManager ) + :return: self.__networkAccessManager. + :rtype: QNetworkAccessManager """ return self.__networkAccessManager @@ -579,7 +611,8 @@ def networkAccessManager(self, value): """ Setter for **self.__networkAccessManager** attribute. - :param value: Attribute value. ( QNetworkAccessManager ) + :param value: Attribute value. + :type value: QNetworkAccessManager """ raise foundations.exceptions.ProgrammingError( @@ -685,7 +718,8 @@ def __Get_sIBL_GUI_pushButton__clicked(self, checked): """ Defines the slot triggered by **Get_sIBL_GUI_pushButton** Widget when clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ urlTokens = self.releases[Constants.applicationName].url.split(self.__splitter) builds = dict(((urlTokens[i].strip(), urlTokens[i + 1].strip(" \"")) for i in range(0, len(urlTokens), 2))) @@ -710,7 +744,8 @@ def __Get_Latest_Templates_pushButton__clicked(self, checked): """ Defines the slot triggered by **Get_Latest_Templates_pushButton** Widget when clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ requests = [] @@ -739,7 +774,8 @@ def __Open_Repository_pushButton__clicked(self, checked): """ Defines the slot triggered by **Open_Repository_pushButton** Widget when clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ LOGGER.debug("> Opening url: '{0}'.".format(self.__repositoryUrl)) @@ -749,7 +785,8 @@ def __Close_pushButton__clicked(self, checked): """ Closes the RemoteUpdater. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ LOGGER.info("{0} | Closing '{1}' updater!".format(self.__class__.__name__, Constants.applicationName)) @@ -810,8 +847,10 @@ def extractZipFile(self, file): """ Uncompress the given zip file. - :param file: File to extract. ( String ) - :return: Extraction success. ( Boolean ) + :param file: File to extract. + :type file: unicode + :return: Extraction success. + :rtype: bool """ LOGGER.debug("> Initializing '{0}' file uncompress.".format(file)) diff --git a/sibl_gui/components/addons/preview/imagesPreviewer.py b/sibl_gui/components/addons/preview/imagesPreviewer.py index 6d24b963..862f870c 100644 --- a/sibl_gui/components/addons/preview/imagesPreviewer.py +++ b/sibl_gui/components/addons/preview/imagesPreviewer.py @@ -73,8 +73,10 @@ def __init__(self, parent=None, image=None): """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param image: Image. ( QImage ) + :param parent: Object parent. + :type parent: QObject + :param image: Image. + :type image: QImage """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -95,7 +97,8 @@ def image(self): """ Property for **self.__image** attribute. - :return: self.__image. ( QImage ) + :return: self.__image. + :rtype: QImage """ return self.__image @@ -106,7 +109,8 @@ def image(self, value): """ Setter for **self.__image** attribute. - :param value: Attribute value. ( QImage ) + :param value: Attribute value. + :type value: QImage """ if value is not None: @@ -128,7 +132,8 @@ def width(self): """ Property for **self.__width** attribute. - :return: self.__width. ( Integer ) + :return: self.__width. + :rtype: int """ return self.__width @@ -139,7 +144,8 @@ def width(self, value): """ Setter for **self.__width** attribute. - :param value: Attribute value. ( Integer ) + :param value: Attribute value. + :type value: int """ if value is not None: @@ -161,7 +167,8 @@ def height(self): """ Property for **self.__height** attribute. - :return: self.__height. ( Integer ) + :return: self.__height. + :rtype: int """ return self.__height @@ -172,7 +179,8 @@ def height(self, value): """ Setter for **self.__height** attribute. - :param value: Attribute value. ( Integer ) + :param value: Attribute value. + :type value: int """ if value is not None: @@ -206,9 +214,12 @@ def paint(self, painter, options, widget): """ Reimplements the :meth:`QGraphicsItem.paint` method. - :param painter: QPainter ( QPainter ) - :param options: QStyleOptionGraphicsItem ( QStyleOptionGraphicsItem ) - :param widget: QWidget ( QWidget ) + :param painter: QPainter + :type painter: QPainter + :param options: QStyleOptionGraphicsItem + :type options: QStyleOptionGraphicsItem + :param widget: QWidget + :type widget: QWidget """ painter.drawImage(-(self.__image.width() / 2), -(self.__image.height() / 2), self.__image) @@ -224,10 +235,14 @@ def __init__(self, parent, paths=None, *args, **kwargs): """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param paths: Images paths. ( Tuple / List ) - :param \*args: Arguments. ( \* ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param parent: Object parent. + :type parent: QObject + :param paths: Images paths. + :type paths: tuple or list + :param \*args: Arguments. + :type \*args: \* + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -276,7 +291,8 @@ def container(self): """ Property for **self.__container** attribute. - :return: self.__container. ( QObject ) + :return: self.__container. + :rtype: QObject """ return self.__container @@ -287,7 +303,8 @@ def container(self, value): """ Setter for **self.__container** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -308,7 +325,8 @@ def paths(self): """ Property for **self.__paths** attribute. - :return: self.__paths. ( Tuple / List ) + :return: self.__paths. + :rtype: tuple or list """ return self.__paths @@ -319,7 +337,8 @@ def paths(self, value): """ Setter for **self.__paths** attribute. - :param value: Attribute value. ( Tuple / List ) + :param value: Attribute value. + :type value: tuple or list """ if value is not None: @@ -344,7 +363,8 @@ def uiResourcesDirectory(self): """ Property for **self.__uiResourcesDirectory** attribute. - :return: self.__uiResourcesDirectory. ( String ) + :return: self.__uiResourcesDirectory. + :rtype: unicode """ return self.__uiResourcesDirectory @@ -355,7 +375,8 @@ def uiResourcesDirectory(self, value): """ Setter for **self.__uiResourcesDirectory** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -376,7 +397,8 @@ def uiPreviousImage(self): """ Property for **self.__uiPreviousImage** attribute. - :return: self.__uiPreviousImage. ( String ) + :return: self.__uiPreviousImage. + :rtype: unicode """ return self.__uiPreviousImage @@ -387,7 +409,8 @@ def uiPreviousImage(self, value): """ Setter for **self.__uiPreviousImage** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -408,7 +431,8 @@ def uiNextImage(self): """ Property for **self.__uiNextImage** attribute. - :return: self.__uiNextImage. ( String ) + :return: self.__uiNextImage. + :rtype: unicode """ return self.__uiNextImage @@ -419,7 +443,8 @@ def uiNextImage(self, value): """ Setter for **self.__uiNextImage** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -440,7 +465,8 @@ def uiZoomOutImage(self): """ Property for **self.__uiZoomOutImage** attribute. - :return: self.__uiZoomOutImage. ( String ) + :return: self.__uiZoomOutImage. + :rtype: unicode """ return self.__uiZoomOutImage @@ -451,7 +477,8 @@ def uiZoomOutImage(self, value): """ Setter for **self.__uiZoomOutImage** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -472,7 +499,8 @@ def uiZoomInImage(self): """ Property for **self.__uiZoomInImage** attribute. - :return: self.__uiZoomInImage. ( String ) + :return: self.__uiZoomInImage. + :rtype: unicode """ return self.__uiZoomInImage @@ -483,7 +511,8 @@ def uiZoomInImage(self, value): """ Setter for **self.__uiZoomInImage** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -504,7 +533,8 @@ def graphicsSceneBackgroundColor(self): """ Property for **self.__graphicsSceneBackgroundColor** attribute. - :return: self.__graphicsSceneBackgroundColor. ( QColors ) + :return: self.__graphicsSceneBackgroundColor. + :rtype: QColor """ return self.__graphicsSceneBackgroundColor @@ -515,7 +545,8 @@ def graphicsSceneBackgroundColor(self, value): """ Setter for **self.__graphicsSceneBackgroundColor** attribute. - :param value: Attribute value. ( QColors ) + :param value: Attribute value. + :type value: QColor """ raise foundations.exceptions.ProgrammingError( @@ -536,7 +567,8 @@ def graphicsSceneWidth(self): """ Property for **self.__graphicsSceneWidth** attribute. - :return: self.__graphicsSceneWidth. ( Integer ) + :return: self.__graphicsSceneWidth. + :rtype: int """ return self.__graphicsSceneWidth @@ -547,7 +579,8 @@ def graphicsSceneWidth(self, value): """ Setter for **self.__graphicsSceneWidth** attribute. - :param value: Attribute value. ( Integer ) + :param value: Attribute value. + :type value: int """ raise foundations.exceptions.ProgrammingError( @@ -568,7 +601,8 @@ def graphicsSceneHeight(self): """ Property for **self.__graphicsSceneHeight** attribute. - :return: self.__graphicsSceneHeight. ( Object ) + :return: self.__graphicsSceneHeight. + :rtype: object """ return self.__graphicsSceneHeight @@ -579,7 +613,8 @@ def graphicsSceneHeight(self, value): """ Setter for **self.__graphicsSceneHeight** attribute. - :param value: Attribute value. ( Object ) + :param value: Attribute value. + :type value: object """ raise foundations.exceptions.ProgrammingError( @@ -600,7 +635,8 @@ def minimumZoomFactor(self): """ Property for **self.__minimumZoomFactor** attribute. - :return: self.__minimumZoomFactor. ( Float ) + :return: self.__minimumZoomFactor. + :rtype: float """ return self.__minimumZoomFactor @@ -611,7 +647,8 @@ def minimumZoomFactor(self, value): """ Setter for **self.__minimumZoomFactor** attribute. - :param value: Attribute value. ( Float ) + :param value: Attribute value. + :type value: float """ raise foundations.exceptions.ProgrammingError( @@ -632,7 +669,8 @@ def maximumZoomFactor(self): """ Property for **self.__maximumZoomFactor** attribute. - :return: self.__maximumZoomFactor. ( Float ) + :return: self.__maximumZoomFactor. + :rtype: float """ return self.__maximumZoomFactor @@ -643,7 +681,8 @@ def maximumZoomFactor(self, value): """ Setter for **self.__maximumZoomFactor** attribute. - :param value: Attribute value. ( Float ) + :param value: Attribute value. + :type value: float """ raise foundations.exceptions.ProgrammingError( @@ -664,7 +703,8 @@ def wheelZoomFactor(self): """ Property for **self.__wheelZoomFactor** attribute. - :return: self.__wheelZoomFactor. ( Float ) + :return: self.__wheelZoomFactor. + :rtype: float """ return self.__wheelZoomFactor @@ -675,7 +715,8 @@ def wheelZoomFactor(self, value): """ Setter for **self.__wheelZoomFactor** attribute. - :param value: Attribute value. ( Float ) + :param value: Attribute value. + :type value: float """ raise foundations.exceptions.ProgrammingError( @@ -696,7 +737,8 @@ def keyZoomFactor(self): """ Property for **self.__keyZoomFactor** attribute. - :return: self.__keyZoomFactor. ( Float ) + :return: self.__keyZoomFactor. + :rtype: float """ return self.__keyZoomFactor @@ -707,7 +749,8 @@ def keyZoomFactor(self, value): """ Setter for **self.__keyZoomFactor** attribute. - :param value: Attribute value. ( Float ) + :param value: Attribute value. + :type value: float """ raise foundations.exceptions.ProgrammingError( @@ -728,7 +771,8 @@ def graphicsView(self): """ Property for **self.__graphicsView** attribute. - :return: self.__graphicsView. ( QGraphicsView ) + :return: self.__graphicsView. + :rtype: QGraphicsView """ return self.__graphicsView @@ -739,7 +783,8 @@ def graphicsView(self, value): """ Setter for **self.__graphicsView** attribute. - :param value: Attribute value. ( QGraphicsView ) + :param value: Attribute value. + :type value: QGraphicsView """ raise foundations.exceptions.ProgrammingError( @@ -760,7 +805,8 @@ def graphicsScene(self): """ Property for **self.__graphicsScene** attribute. - :return: self.__graphicsScene. ( QGraphicsScene ) + :return: self.__graphicsScene. + :rtype: QGraphicsScene """ return self.__graphicsScene @@ -771,7 +817,8 @@ def graphicsScene(self, value): """ Setter for **self.__graphicsScene** attribute. - :param value: Attribute value. ( QGraphicsScene ) + :param value: Attribute value. + :type value: QGraphicsScene """ raise foundations.exceptions.ProgrammingError( @@ -792,7 +839,8 @@ def displayGraphicsItem(self): """ Property for **self.__displayGraphicsItem** attribute. - :return: self.__displayGraphicsItem. ( QGraphicsItem ) + :return: self.__displayGraphicsItem. + :rtype: QGraphicsItem """ return self.__displayGraphicsItem @@ -803,7 +851,8 @@ def displayGraphicsItem(self, value): """ Setter for **self.__displayGraphicsItem** attribute. - :param value: Attribute value. ( QGraphicsItem ) + :param value: Attribute value. + :type value: QGraphicsItem """ raise foundations.exceptions.ProgrammingError( @@ -835,7 +884,8 @@ def closeEvent(self, event): """ Reimplements the :meth:`QWidget.closeEvent` method. - :param event: QEvent ( QEvent ) + :param event: QEvent + :type event: QEvent """ LOGGER.debug("> Removing '{0}' from Images Previewers list.".format(self)) @@ -847,7 +897,8 @@ def wheelEvent(self, event): """ Reimplements the :meth:`QWidget.wheelEvent` method. - :param event: QEvent ( QEvent ) + :param event: QEvent + :type event: QEvent """ self.scaleView(pow(1.5, event.delta() / self.__wheelZoomFactor)) @@ -856,7 +907,8 @@ def keyPressEvent(self, event): """ Reimplements the :meth:`QWidget.keyPressEvent` method. - :param event: QEvent ( QEvent ) + :param event: QEvent + :type event: QEvent """ key = event.key() @@ -928,7 +980,8 @@ def __engine_imagesCaches_QImage__contentAdded(self, content): """ Defines the slot triggered by Application **QImage** images cache when content has been added. - :param content: Cache added content. ( List ) + :param content: Cache added content. + :type content: list """ if not self.__paths: @@ -945,7 +998,8 @@ def __Previous_Image_pushButton__clicked(self, checked): """ Defines the slot triggered by **Previous_Image_pushButton** Widget when clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ self.loopThroughImages(True) @@ -954,7 +1008,8 @@ def __Next_Image_pushButton__clicked(self, checked): """ Defines the slot triggered by **Next_Image_pushButton** Widget when clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ self.loopThroughImages() @@ -963,7 +1018,8 @@ def __Zoom_In_pushButton__clicked(self, checked): """ Defines the slot triggered by **Zoom_In_pushButton** Widget when clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ self.scaleView(self.__keyZoomFactor) @@ -972,7 +1028,8 @@ def __Zoom_Out_pushButton__clicked(self, checked): """ Defines the slot triggered by **Zoom_Out_pushButton** Widget when clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ self.scaleView(1 / self.__keyZoomFactor) @@ -981,7 +1038,8 @@ def __Zoom_Fit_pushButton__clicked(self, checked): """ Defines the slot triggered by **Zoom_Fit_pushButton** Widget when clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ self.fitImage() @@ -998,7 +1056,8 @@ def __setDisplayGraphicsItem(self, image): """ Sets the View using given image. - :param image: Image to display. ( Qimage ) + :param image: Image to display. + :type image: QImage """ self.__clearGraphicsScene() @@ -1013,8 +1072,10 @@ def loadImage(self, index=0): """ Loads the display image in the View. - :param index: Index to load. ( Integer ) - :return: Method success. ( Boolean ) + :param index: Index to load. + :type index: int + :return: Method success. + :rtype: bool """ if not self.__paths: @@ -1029,8 +1090,10 @@ def scaleView(self, scaleFactor): """ Scales the Previewer view. - :param scaleFactor: Float ( Float ) - :return: Method success. ( Boolean ) + :param scaleFactor: Float + :type scaleFactor: float + :return: Method success. + :rtype: bool """ graphicsView = self.findChild(QGraphicsView) @@ -1045,7 +1108,8 @@ def fitWindow(self): """ Fits the View window. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ if not self.__displayGraphicsItem: @@ -1065,7 +1129,8 @@ def fitImage(self): """ Fits the image to the View. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ if not self.__displayGraphicsItem: @@ -1083,8 +1148,10 @@ def loopThroughImages(self, backward=False): """ Loops through View images. - :param backward: Looping backward. ( Boolean ) - :return: Method success. ( Boolean ) + :param backward: Looping backward. + :type backward: bool + :return: Method success. + :rtype: bool """ index = self.__paths.index(self.__displayGraphicsItem.image.data.path) diff --git a/sibl_gui/components/addons/preview/preview.py b/sibl_gui/components/addons/preview/preview.py index c9761b53..f83f05c9 100644 --- a/sibl_gui/components/addons/preview/preview.py +++ b/sibl_gui/components/addons/preview/preview.py @@ -79,10 +79,14 @@ def __init__(self, parent=None, name=None, *args, **kwargs): """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param name: Component name. ( String ) - :param \*args: Arguments. ( \* ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param parent: Object parent. + :type parent: QObject + :param name: Component name. + :type name: unicode + :param \*args: Arguments. + :type \*args: \* + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -130,7 +134,8 @@ def uiResourcesDirectory(self): """ Property for **self.__uiResourcesDirectory** attribute. - :return: self.__uiResourcesDirectory. ( String ) + :return: self.__uiResourcesDirectory. + :rtype: unicode """ return self.__uiResourcesDirectory @@ -141,7 +146,8 @@ def uiResourcesDirectory(self, value): """ Setter for **self.__uiResourcesDirectory** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -162,7 +168,8 @@ def engine(self): """ Property for **self.__engine** attribute. - :return: self.__engine. ( QObject ) + :return: self.__engine. + :rtype: QObject """ return self.__engine @@ -173,7 +180,8 @@ def engine(self, value): """ Setter for **self.__engine** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -194,7 +202,8 @@ def settings(self): """ Property for **self.__settings** attribute. - :return: self.__settings. ( QSettings ) + :return: self.__settings. + :rtype: QSettings """ return self.__settings @@ -205,7 +214,8 @@ def settings(self, value): """ Setter for **self.__settings** attribute. - :param value: Attribute value. ( QSettings ) + :param value: Attribute value. + :type value: QSettings """ raise foundations.exceptions.ProgrammingError( @@ -226,7 +236,8 @@ def settingsSection(self): """ Property for **self.__settingsSection** attribute. - :return: self.__settingsSection. ( String ) + :return: self.__settingsSection. + :rtype: unicode """ return self.__settingsSection @@ -237,7 +248,8 @@ def settingsSection(self, value): """ Setter for **self.__settingsSection** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -258,7 +270,8 @@ def preferencesManager(self): """ Property for **self.__preferencesManager** attribute. - :return: self.__preferencesManager. ( QWidget ) + :return: self.__preferencesManager. + :rtype: QWidget """ return self.__preferencesManager @@ -269,7 +282,8 @@ def preferencesManager(self, value): """ Setter for **self.__preferencesManager** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -290,7 +304,8 @@ def iblSetsOutliner(self): """ Property for **self.__iblSetsOutliner** attribute. - :return: self.__iblSetsOutliner. ( QWidget ) + :return: self.__iblSetsOutliner. + :rtype: QWidget """ return self.__iblSetsOutliner @@ -301,7 +316,8 @@ def iblSetsOutliner(self, value): """ Setter for **self.__iblSetsOutliner** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -322,7 +338,8 @@ def inspector(self): """ Property for **self.__inspector** attribute. - :return: self.__inspector. ( QWidget ) + :return: self.__inspector. + :rtype: QWidget """ return self.__inspector @@ -333,7 +350,8 @@ def inspector(self, value): """ Setter for **self.__inspector** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -354,7 +372,8 @@ def imagesPreviewers(self): """ Property for **self.__imagesPreviewers** attribute. - :return: self.__imagesPreviewers. ( List ) + :return: self.__imagesPreviewers. + :rtype: list """ return self.__imagesPreviewers @@ -365,7 +384,8 @@ def imagesPreviewers(self, value): """ Setter for **self.__imagesPreviewers** attribute. - :param value: Attribute value. ( List ) + :param value: Attribute value. + :type value: list """ raise foundations.exceptions.ProgrammingError( @@ -386,7 +406,8 @@ def maximumImagesPreviewersInstances(self): """ Property for **self.__maximumImagesPreviewersInstances** attribute. - :return: self.__maximumImagesPreviewersInstances. ( Integer ) + :return: self.__maximumImagesPreviewersInstances. + :rtype: int """ return self.__maximumImagesPreviewersInstances @@ -397,7 +418,8 @@ def maximumImagesPreviewersInstances(self, value): """ Setter for **self.__maximumImagesPreviewersInstances** attribute. - :param value: Attribute value. ( Integer ) + :param value: Attribute value. + :type value: int """ raise foundations.exceptions.ProgrammingError( @@ -418,7 +440,8 @@ def inspectorButtons(self): """ Property for **self.__inspectorButtons** attribute. - :return: self.__inspectorButtons. ( Dictionary ) + :return: self.__inspectorButtons. + :rtype: dict """ return self.__inspectorButtons @@ -429,7 +452,8 @@ def inspectorButtons(self, value): """ Setter for **self.__inspectorButtons** attribute. - :param value: Attribute value. ( Dictionary ) + :param value: Attribute value. + :type value: dict """ raise foundations.exceptions.ProgrammingError( @@ -452,8 +476,10 @@ def activate(self, engine): """ Activates the Component. - :param engine: Engine to attach the Component to. ( QObject ) - :return: Method success. ( Boolean ) + :param engine: Engine to attach the Component to. + :type engine: QObject + :return: Method success. + :rtype: bool """ LOGGER.debug("> Activating '{0}' Component.".format(self.__class__.__name__)) @@ -476,7 +502,8 @@ def deactivate(self): """ Deactivates the Component. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Deactivating '{0}' Component.".format(self.__class__.__name__)) @@ -500,7 +527,8 @@ def initializeUi(self): """ Initializes the Component ui. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Initializing '{0}' Component ui.".format(self.__class__.__name__)) @@ -521,7 +549,8 @@ def uninitializeUi(self): """ Uninitializes the Component ui. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Uninitializing '{0}' Component ui.".format(self.__class__.__name__)) @@ -540,7 +569,8 @@ def addWidget(self): """ Adds the Component Widget to the engine. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Adding '{0}' Component Widget.".format(self.__class__.__name__)) @@ -553,7 +583,8 @@ def removeWidget(self): """ Removes the Component Widget from the engine. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Removing '{0}' Component Widget.".format(self.__class__.__name__)) @@ -668,8 +699,10 @@ def __iblSetsOutliner_views_viewIblSetsBackgroundImagesAction__triggered(self, c """ Defines the slot triggered by **'Actions|Umbra|Components|core.iblSetsOutliner|View Background Image ...'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ return self.viewIblSetsImagesUi("Background") @@ -678,8 +711,10 @@ def __iblSetsOutliner_views_viewIblSetsLightingImagesAction__triggered(self, che """ Defines the slot triggered by **'Actions|Umbra|Components|core.iblSetsOutliner|View Lighting Image ...'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ return self.viewIblSetsImagesUi("Lighting") @@ -688,8 +723,10 @@ def __iblSetsOutliner_views_viewIblSetsReflectionImagesAction__triggered(self, c """ Defines the slot triggered by **'Actions|Umbra|Components|core.iblSetsOutliner|View Reflection Image ...'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ return self.viewIblSetsImagesUi("Reflection") @@ -698,8 +735,10 @@ def __iblSetsOutliner_views_viewIblSetsPlatesAction__triggered(self, checked): """ Defines the slot triggered by **'Actions|Umbra|Components|core.iblSetsOutliner|View Plate(s) ...'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ return self.viewIblSetsImagesUi("Plate") @@ -708,8 +747,10 @@ def __Inspector_Overall_frame_viewActiveIblSetBackgroundImageAction__triggered(s """ Defines the slot triggered by **'Actions|Umbra|Components|core.inspector|View Background Image ...'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ return self.viewActiveIblSetImagesUi("Background") @@ -718,8 +759,10 @@ def __Inspector_Overall_frame_viewActiveIblSetLightingImageAction__triggered(sel """ Defines the slot triggered by **'Actions|Umbra|Components|core.inspector|View Lighting Image ...'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ return self.viewActiveIblSetImagesUi("Lighting") @@ -728,8 +771,10 @@ def __Inspector_Overall_frame_viewActiveIblSetReflectionImageAction__triggered(s """ Defines the slot triggered by **'"Actions|Umbra|Components|core.inspector|View Reflection Image ...'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ return self.viewActiveIblSetImagesUi("Reflection") @@ -738,8 +783,10 @@ def __Inspector_Overall_frame_viewActiveIblSetPlatesAction__triggered(self, chec """ Defines the slot triggered by **'Actions|Umbra|Components|core.inspector|View Plate(s) ...'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ return self.viewActiveIblSetImagesUi("Plate") @@ -758,7 +805,8 @@ def __Custom_Previewer_Path_toolButton__clicked(self, checked): """ Defines the slot triggered by **Custom_Previewer_Path_toolButton** Widget when clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ customPreviewerExecutable = umbra.ui.common.storeLastBrowsedPath( @@ -791,7 +839,8 @@ def __hasMaximumImagesPreviewersInstances(self): """ Returns if the maximum Previewers instances allowed is reached. - :return: Maximum instances reached. ( Boolean ) + :return: Maximum instances reached. + :rtype: bool """ if len(self.__imagesPreviewers) >= self.__maximumImagesPreviewersInstances: @@ -807,9 +856,12 @@ def viewIblSetsImagesUi(self, imageType, *args): """ Launches selected Ibl Sets Images Previewer. - :param imageType: Image type. ( String ) - :param \*args: Arguments. ( \* ) - :return: Method success. ( Boolean ) + :param imageType: Image type. + :type imageType: unicode + :param \*args: Arguments. + :type \*args: \* + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -842,9 +894,12 @@ def viewActiveIblSetImagesUi(self, imageType, *args): """ Launches :mod:`sibl_gui.components.core.inspector.inspector` Component Ibl Set Images Previewer. - :param imageType: Image type. ( String ) - :param \*args: Arguments. ( \* ) - :return: Method success. ( Boolean ) + :param imageType: Image type. + :type imageType: unicode + :param \*args: Arguments. + :type \*args: \* + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -880,8 +935,10 @@ def viewImages(self, paths, customPreviewer=None): """ Launches an Ibl Set Images Previewer. - :param paths: Image paths. ( List ) - :param customPreviewer: Custom previewer. ( String ) + :param paths: Image paths. + :type paths: list + :param customPreviewer: Custom previewer. + :type customPreviewer: unicode """ if customPreviewer: @@ -907,8 +964,10 @@ def addImagesPreviewer(self, imagesPreviewer): """ Adds an Images Previewer. - :param imagesPreviewer: Images Previewer. ( ImagesPreviewer ) - :return: Method success. ( Boolean ) + :param imagesPreviewer: Images Previewer. + :type imagesPreviewer: ImagesPreviewer + :return: Method success. + :rtype: bool """ LOGGER.debug("> Adding '{0}' Images Previewer.".format(imagesPreviewer)) @@ -920,7 +979,8 @@ def removeImagesPreviewer(self, imagesPreviewer): """ Removes an Images Previewer. - :param imagesPreviewer: Images Previewer. ( ImagesPreviewer ) + :param imagesPreviewer: Images Previewer. + :type imagesPreviewer: ImagesPreviewer """ LOGGER.debug("> Removing '{0}' Images Previewer.".format(imagesPreviewer)) @@ -934,8 +994,10 @@ def getImagesPreviewer(self, paths): """ Launches an Images Previewer. - :param paths: Images paths. ( List ) - :return: Method success. ( Boolean ) + :param paths: Images paths. + :type paths: list + :return: Method success. + :rtype: bool """ LOGGER.debug("> Launching Images Previewer for '{0}' images.".format(", ".join(paths))) @@ -948,9 +1010,12 @@ def getProcessCommand(self, paths, customPreviewer): """ Gets process command. - :param paths: Paths to preview. ( String ) - :param customPreviewer: Custom browser. ( String ) - :return: Process command. ( String ) + :param paths: Paths to preview. + :type paths: unicode + :param customPreviewer: Custom browser. + :type customPreviewer: unicode + :return: Process command. + :rtype: unicode """ processCommand = None @@ -967,9 +1032,12 @@ def getIblSetImagesPaths(self, iblSet, imageType): """ Gets Ibl Set images paths. - :param iblSet: Ibl Set. ( IblSet ) - :param imageType: Image type. ( String ) - :return: Images paths. ( List ) + :param iblSet: Ibl Set. + :type iblSet: IblSet + :param imageType: Image type. + :type imageType: unicode + :return: Images paths. + :rtype: list """ imagePaths = [] diff --git a/sibl_gui/components/addons/rawEditingUtilities/rawEditingUtilities.py b/sibl_gui/components/addons/rawEditingUtilities/rawEditingUtilities.py index 1f05fc2f..0e4e00aa 100644 --- a/sibl_gui/components/addons/rawEditingUtilities/rawEditingUtilities.py +++ b/sibl_gui/components/addons/rawEditingUtilities/rawEditingUtilities.py @@ -75,10 +75,14 @@ def __init__(self, parent=None, name=None, *args, **kwargs): """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param name: Component name. ( String ) - :param \*args: Arguments. ( \* ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param parent: Object parent. + :type parent: QObject + :param name: Component name. + :type name: unicode + :param \*args: Arguments. + :type \*args: \* + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -107,7 +111,8 @@ def engine(self): """ Property for **self.__engine** attribute. - :return: self.__engine. ( QObject ) + :return: self.__engine. + :rtype: QObject """ return self.__engine @@ -118,7 +123,8 @@ def engine(self, value): """ Setter for **self.__engine** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -139,7 +145,8 @@ def settings(self): """ Property for **self.__settings** attribute. - :return: self.__settings. ( QSettings ) + :return: self.__settings. + :rtype: QSettings """ return self.__settings @@ -150,7 +157,8 @@ def settings(self, value): """ Setter for **self.__settings** attribute. - :param value: Attribute value. ( QSettings ) + :param value: Attribute value. + :type value: QSettings """ raise foundations.exceptions.ProgrammingError( @@ -171,7 +179,8 @@ def settingsSection(self): """ Property for **self.__settingsSection** attribute. - :return: self.__settingsSection. ( String ) + :return: self.__settingsSection. + :rtype: unicode """ return self.__settingsSection @@ -182,7 +191,8 @@ def settingsSection(self, value): """ Setter for **self.__settingsSection** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -203,7 +213,8 @@ def scriptEditor(self): """ Property for **self.__scriptEditor** attribute. - :return: self.__scriptEditor. ( QWidget ) + :return: self.__scriptEditor. + :rtype: QWidget """ return self.__scriptEditor @@ -214,7 +225,8 @@ def scriptEditor(self, value): """ Setter for **self.__scriptEditor** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -235,7 +247,8 @@ def preferencesManager(self): """ Property for **self.__preferencesManager** attribute. - :return: self.__preferencesManager. ( QWidget ) + :return: self.__preferencesManager. + :rtype: QWidget """ return self.__preferencesManager @@ -246,7 +259,8 @@ def preferencesManager(self, value): """ Setter for **self.__preferencesManager** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -267,7 +281,8 @@ def componentsManagerUi(self): """ Property for **self.__componentsManagerUi** attribute. - :return: self.__componentsManagerUi. ( QWidget ) + :return: self.__componentsManagerUi. + :rtype: QWidget """ return self.__componentsManagerUi @@ -278,7 +293,8 @@ def componentsManagerUi(self, value): """ Setter for **self.__componentsManagerUi** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -299,7 +315,8 @@ def iblSetsOutliner(self): """ Property for **self.__iblSetsOutliner** attribute. - :return: self.__iblSetsOutliner. ( QWidget ) + :return: self.__iblSetsOutliner. + :rtype: QWidget """ return self.__iblSetsOutliner @@ -310,7 +327,8 @@ def iblSetsOutliner(self, value): """ Setter for **self.__iblSetsOutliner** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -331,7 +349,8 @@ def inspector(self): """ Property for **self.__inspector** attribute. - :return: self.__inspector. ( QWidget ) + :return: self.__inspector. + :rtype: QWidget """ return self.__inspector @@ -342,7 +361,8 @@ def inspector(self, value): """ Setter for **self.__inspector** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -363,7 +383,8 @@ def templatesOutliner(self): """ Property for **self.__templatesOutliner** attribute. - :return: self.__templatesOutliner. ( QWidget ) + :return: self.__templatesOutliner. + :rtype: QWidget """ return self.__templatesOutliner @@ -374,7 +395,8 @@ def templatesOutliner(self, value): """ Setter for **self.__templatesOutliner** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -397,8 +419,10 @@ def activate(self, engine): """ Activates the Component. - :param engine: Engine to attach the Component to. ( QObject ) - :return: Method success. ( Boolean ) + :param engine: Engine to attach the Component to. + :type engine: QObject + :return: Method success. + :rtype: bool """ LOGGER.debug("> Activating '{0}' Component.".format(self.__class__.__name__)) @@ -421,7 +445,8 @@ def deactivate(self): """ Deactivates the Component. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Deactivating '{0}' Component.".format(self.__class__.__name__)) @@ -444,7 +469,8 @@ def initializeUi(self): """ Initializes the Component ui. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Initializing '{0}' Component ui.".format(self.__class__.__name__)) @@ -467,7 +493,8 @@ def uninitializeUi(self): """ Uninitializes the Component ui. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Uninitializing '{0}' Component ui.".format(self.__class__.__name__)) @@ -489,7 +516,8 @@ def addWidget(self): """ Adds the Component Widget to the engine. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Adding '{0}' Component Widget.".format(self.__class__.__name__)) @@ -502,7 +530,8 @@ def removeWidget(self): """ Removes the Component Widget from the engine. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Removing '{0}' Component Widget.".format(self.__class__.__name__)) @@ -574,8 +603,10 @@ def __iblSetsOutliner_views_editIblSetsFilesAction__triggered(self, checked): Defines the slot triggered by **'Actions|Umbra|Components|core.iblSetsOutliner|Edit Ibl Set(s) File(s) ...'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ return self.editIblSetsFilesUi() @@ -584,8 +615,10 @@ def __inspector_editActiveIblSetFileAction__triggered(self, checked): """ Defines the slot triggered by **'Actions|Umbra|Components|core.inspector|Edit Ibl Set File ...'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ return self.editActiveIblSetFileUi() @@ -595,8 +628,10 @@ def __templatesOutliner_view_editTemplatesFilesAction__triggered(self, checked): Defines the slot triggered by **'Actions|Umbra|Components|core.templatesOutliner|Edit Template(s) File(s) ...'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ return self.editTemplatesFilesUi() @@ -606,8 +641,10 @@ def __componentsManagerUi_view_editComponentsAction__triggered(self, checked): Defines the slot triggered by **'Actions|Umbra|Components|factory.componentsManagerUi|Edit Component(s) ...'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ return self.editComponentsUi() @@ -626,7 +663,8 @@ def __Custom_Text_Editor_Path_toolButton__clicked(self, checked): """ Defines the slot triggered by **Custom_Text_Editor_Path_toolButton** Widget when clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ customTextEditorExecutable = umbra.ui.common.storeLastBrowsedPath( @@ -663,7 +701,8 @@ def __engine__contentDropped(self, event): """ Defines the slot triggered by content when dropped into the engine. - :param event: Event. ( QEvent ) + :param event: Event. + :type event: QEvent """ if not event.mimeData().hasUrls(): @@ -689,7 +728,8 @@ def __scriptEditor_Script_Editor_tabWidget__contentDropped(self, event): """ Defines the slot triggered by content when dropped into the **scriptEditor.Script_Editor_tabWidget** Widget. - :param event: Event. ( QEvent ) + :param event: Event. + :type event: QEvent """ if event.source() in self.__iblSetsOutliner.views: @@ -702,7 +742,8 @@ def editIblSetsFilesUi(self): """ Edits selected Ibl Sets files. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -730,7 +771,8 @@ def editActiveIblSetFileUi(self): """ Edits :mod:`sibl_gui.components.core.inspector.inspector` Component Ibl Set file. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -751,7 +793,8 @@ def editTemplatesFilesUi(self): """ Edits selected Templates files. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -778,7 +821,8 @@ def editComponentsUi(self): """ Edits selected Components packages. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -804,9 +848,12 @@ def getProcessCommand(self, path, customTextEditor): """ Gets process command. - :param path: Path to edit. ( String ) - :param customTextEditor: Custom text editor. ( String ) - :return: Process command. ( String ) + :param path: Path to edit. + :type path: unicode + :param customTextEditor: Custom text editor. + :type customTextEditor: unicode + :return: Process command. + :rtype: unicode """ processCommand = None @@ -824,9 +871,12 @@ def editPath(self, path, customTextEditor=None): """ Provides editing capability. - :param path: Path to edit. ( String ) - :param customTextEditor: Custom text editor. ( String ) - :return: Method success. ( Boolean ) + :param path: Path to edit. + :type path: unicode + :param customTextEditor: Custom text editor. + :type customTextEditor: unicode + :return: Method success. + :rtype: bool """ if customTextEditor: diff --git a/sibl_gui/components/addons/rewiringTool/rewiringTool.py b/sibl_gui/components/addons/rewiringTool/rewiringTool.py index b2a5d28b..59a4b3bc 100644 --- a/sibl_gui/components/addons/rewiringTool/rewiringTool.py +++ b/sibl_gui/components/addons/rewiringTool/rewiringTool.py @@ -68,10 +68,14 @@ def __init__(self, parent=None, name=None, *args, **kwargs): """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param name: Component name. ( String ) - :param \*args: Arguments. ( \* ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param parent: Object parent. + :type parent: QObject + :param name: Component name. + :type name: unicode + :param \*args: Arguments. + :type \*args: \* + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -106,7 +110,8 @@ def dockArea(self): """ Property for **self.__dockArea** attribute. - :return: self.__dockArea. ( Integer ) + :return: self.__dockArea. + :rtype: int """ return self.__dockArea @@ -117,7 +122,8 @@ def dockArea(self, value): """ Setter for **self.__dockArea** attribute. - :param value: Attribute value. ( Integer ) + :param value: Attribute value. + :type value: int """ raise foundations.exceptions.ProgrammingError( @@ -138,7 +144,8 @@ def engine(self): """ Property for **self.__engine** attribute. - :return: self.__engine. ( QObject ) + :return: self.__engine. + :rtype: QObject """ return self.__engine @@ -149,7 +156,8 @@ def engine(self, value): """ Setter for **self.__engine** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -170,7 +178,8 @@ def iblSetsOutliner(self): """ Property for **self.__iblSetsOutliner** attribute. - :return: self.__iblSetsOutliner. ( QWidget ) + :return: self.__iblSetsOutliner. + :rtype: QWidget """ return self.__iblSetsOutliner @@ -181,7 +190,8 @@ def iblSetsOutliner(self, value): """ Setter for **self.__iblSetsOutliner** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -202,7 +212,8 @@ def reWireFramesWidgets(self): """ Property for **self.__reWireFramesWidgets** attribute. - :return: self.__reWireFramesWidgets. ( Tuple ) + :return: self.__reWireFramesWidgets. + :rtype: tuple """ return self.__reWireFramesWidgets @@ -213,7 +224,8 @@ def reWireFramesWidgets(self, value): """ Setter for **self.__reWireFramesWidgets** attribute. - :param value: Attribute value. ( Tuple ) + :param value: Attribute value. + :type value: tuple """ raise foundations.exceptions.ProgrammingError( @@ -234,7 +246,8 @@ def reWireComboBoxesWidgets(self): """ Property for **self.__reWireComboBoxesWidgets** attribute. - :return: self.__reWireComboBoxesWidgets. ( Tuple ) + :return: self.__reWireComboBoxesWidgets. + :rtype: tuple """ return self.__reWireComboBoxesWidgets @@ -245,7 +258,8 @@ def reWireComboBoxesWidgets(self, value): """ Setter for **self.__reWireComboBoxesWidgets** attribute. - :param value: Attribute value. ( Tuple ) + :param value: Attribute value. + :type value: tuple """ raise foundations.exceptions.ProgrammingError( @@ -266,7 +280,8 @@ def reWireLineEditWidgets(self): """ Property for **self.__reWireLineEditWidgets** attribute. - :return: self.__reWireLineEditWidgets. ( Tuple ) + :return: self.__reWireLineEditWidgets. + :rtype: tuple """ return self.__reWireLineEditWidgets @@ -277,7 +292,8 @@ def reWireLineEditWidgets(self, value): """ Setter for **self.__reWireLineEditWidgets** attribute. - :param value: Attribute value. ( Tuple ) + :param value: Attribute value. + :type value: tuple """ raise foundations.exceptions.ProgrammingError( @@ -298,7 +314,8 @@ def rewiringParameters(self): """ Property for **self.__rewiringParameters** attribute. - :return: self.__rewiringParameters. ( Tuple ) + :return: self.__rewiringParameters. + :rtype: tuple """ return self.__rewiringParameters @@ -309,7 +326,8 @@ def rewiringParameters(self, value): """ Setter for **self.__rewiringParameters** attribute. - :param value: Attribute value. ( Tuple ) + :param value: Attribute value. + :type value: tuple """ raise foundations.exceptions.ProgrammingError( @@ -332,8 +350,10 @@ def activate(self, engine): """ Activates the Component. - :param engine: Engine to attach the Component to. ( QObject ) - :return: Method success. ( Boolean ) + :param engine: Engine to attach the Component to. + :type engine: QObject + :return: Method success. + :rtype: bool """ LOGGER.debug("> Activating '{0}' Component.".format(self.__class__.__name__)) @@ -350,7 +370,8 @@ def deactivate(self): """ Deactivates the Component. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Deactivating '{0}' Component.".format(self.__class__.__name__)) @@ -367,7 +388,8 @@ def initializeUi(self): """ Initializes the Component ui. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Initializing '{0}' Component ui.".format(self.__class__.__name__)) @@ -403,7 +425,8 @@ def uninitializeUi(self): """ Uninitializes the Component ui. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Uninitializing '{0}' Component ui.".format(self.__class__.__name__)) @@ -427,7 +450,8 @@ def addWidget(self): """ Adds the Component Widget to the engine. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Adding '{0}' Component Widget.".format(self.__class__.__name__)) @@ -440,7 +464,8 @@ def removeWidget(self): """ Removes the Component Widget from the engine. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Removing '{0}' Component Widget.".format(self.__class__.__name__)) @@ -454,7 +479,8 @@ def __Background_Path_toolButton__clicked(self, checked): """ Defines the slot triggered by **Background_ToolButton** Widget when clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ self.__setReWireCustomPath("Background") @@ -463,7 +489,8 @@ def __Lighting_Path_toolButton__clicked(self, checked): """ Defines the slot triggered by **Lighting_ToolButton** Widget when clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ self.__setReWireCustomPath("Lighting") @@ -472,7 +499,8 @@ def __Reflection_Path_toolButton__clicked(self, checked): """ Defines the slot triggered by **Reflection_ToolButton** Widget when clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ self.__setReWireCustomPath("Reflection") @@ -481,7 +509,8 @@ def __setReWireWidgetFramesVisibility(self, index): """ Shows / hides rewire Widget frames. - :param index: ComboBox index. ( Tuple ) + :param index: ComboBox index. + :type index: tuple """ for index in range(len(self.__reWireComboBoxesWidgets)): @@ -497,7 +526,8 @@ def __setReWireCustomPath(self, component): Sets the :mod:`sibl_gui.components.addons.rewiringTool.rewiringTool` Component custom image QLineEdit Widgets. - :param component: Target Component. ( String ) + :param component: Target Component. + :type component: unicode """ customFile = umbra.ui.common.storeLastBrowsedPath(QFileDialog.getOpenFileName(self, @@ -516,7 +546,8 @@ def getOverrideKeys(self): """ Gets override keys. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.info("{0} | Updating Loader Script override keys!".format(self.__class__.__name__)) diff --git a/sibl_gui/components/addons/sIBLeditUtilities/sIBLeditUtilities.py b/sibl_gui/components/addons/sIBLeditUtilities/sIBLeditUtilities.py index 8b9de039..2fa308d3 100644 --- a/sibl_gui/components/addons/sIBLeditUtilities/sIBLeditUtilities.py +++ b/sibl_gui/components/addons/sIBLeditUtilities/sIBLeditUtilities.py @@ -68,10 +68,14 @@ def __init__(self, parent=None, name=None, *args, **kwargs): """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param name: Component name. ( String ) - :param \*args: Arguments. ( \* ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param parent: Object parent. + :type parent: QObject + :param name: Component name. + :type name: unicode + :param \*args: Arguments. + :type \*args: \* + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -97,7 +101,8 @@ def engine(self): """ Property for **self.__engine** attribute. - :return: self.__engine. ( QObject ) + :return: self.__engine. + :rtype: QObject """ return self.__engine @@ -108,7 +113,8 @@ def engine(self, value): """ Setter for **self.__engine** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -129,7 +135,8 @@ def settings(self): """ Property for **self.__settings** attribute. - :return: self.__settings. ( QSettings ) + :return: self.__settings. + :rtype: QSettings """ return self.__settings @@ -140,7 +147,8 @@ def settings(self, value): """ Setter for **self.__settings** attribute. - :param value: Attribute value. ( QSettings ) + :param value: Attribute value. + :type value: QSettings """ raise foundations.exceptions.ProgrammingError( @@ -161,7 +169,8 @@ def settingsSection(self): """ Property for **self.__settingsSection** attribute. - :return: self.__settingsSection. ( String ) + :return: self.__settingsSection. + :rtype: unicode """ return self.__settingsSection @@ -172,7 +181,8 @@ def settingsSection(self, value): """ Setter for **self.__settingsSection** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -193,7 +203,8 @@ def preferencesManager(self): """ Property for **self.__preferencesManager** attribute. - :return: self.__preferencesManager. ( QWidget ) + :return: self.__preferencesManager. + :rtype: QWidget """ return self.__preferencesManager @@ -204,7 +215,8 @@ def preferencesManager(self, value): """ Setter for **self.__preferencesManager** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -225,7 +237,8 @@ def iblSetsOutliner(self): """ Property for **self.__iblSetsOutliner** attribute. - :return: self.__iblSetsOutliner. ( QWidget ) + :return: self.__iblSetsOutliner. + :rtype: QWidget """ return self.__iblSetsOutliner @@ -236,7 +249,8 @@ def iblSetsOutliner(self, value): """ Setter for **self.__iblSetsOutliner** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -257,7 +271,8 @@ def inspector(self): """ Property for **self.__inspector** attribute. - :return: self.__inspector. ( QWidget ) + :return: self.__inspector. + :rtype: QWidget """ return self.__inspector @@ -268,7 +283,8 @@ def inspector(self, value): """ Setter for **self.__inspector** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -291,8 +307,10 @@ def activate(self, engine): """ Activates the Component. - :param engine: Engine to attach the Component to. ( QObject ) - :return: Method success. ( Boolean ) + :param engine: Engine to attach the Component to. + :type engine: QObject + :return: Method success. + :rtype: bool """ LOGGER.debug("> Activating '{0}' Component.".format(self.__class__.__name__)) @@ -312,7 +330,8 @@ def deactivate(self): """ Deactivates the Component. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Deactivating '{0}' Component.".format(self.__class__.__name__)) @@ -332,7 +351,8 @@ def initializeUi(self): """ Initializes the Component ui. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Initializing '{0}' Component ui.".format(self.__class__.__name__)) @@ -352,7 +372,8 @@ def uninitializeUi(self): """ Uninitializes the Component ui. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Uninitializing '{0}' Component ui.".format(self.__class__.__name__)) @@ -370,7 +391,8 @@ def addWidget(self): """ Adds the Component Widget to the engine. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Adding '{0}' Component Widget.".format(self.__class__.__name__)) @@ -383,7 +405,8 @@ def removeWidget(self): """ Removes the Component Widget from the engine. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Removing '{0}' Component Widget.".format(self.__class__.__name__)) @@ -434,8 +457,10 @@ def __iblSetsOutliner_views_editIblSetInSIBLEditAction__triggered(self, checked) """ Defines the slot triggered by **'Actions|Umbra|Components|core.iblSetsOutliner|Edit In sIBLedit ...'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ return self.editIblSetInSIBLEditUi() @@ -444,8 +469,10 @@ def __inspector_editActiveIblSetInSIBLEditAction__triggered(self, checked): """ Defines the slot triggered by **'Actions|Umbra|Components|core.inspector|Edit In sIBLedit ...'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ return self.editActiveIblSetInSIBLEditUi() @@ -463,7 +490,8 @@ def __sIBLedit_Path_toolButton__clicked(self, checked): """ Defines the slot triggered by **sIBLedit_Path_toolButton** Widget when clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ sIBLeditExecutable = umbra.ui.common.storeLastBrowsedPath(QFileDialog.getOpenFileName(self, @@ -496,7 +524,8 @@ def editIblSetInSIBLEditUi(self): """ Edits selected Ibl Set in sIBLedit. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -524,7 +553,8 @@ def editActiveIblSetInSIBLEditUi(self): """ Edits :mod:`sibl_gui.components.core.inspector.inspector` Component inspected Ibl Set in sIBLedit. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -549,9 +579,12 @@ def getProcessCommand(self, path, sIBLedit): """ Gets process command. - :param path: Path. ( String ) - :param sIBLedit: sIBLedit. ( String ) - :return: Process command. ( String ) + :param path: Path. + :type path: unicode + :param sIBLedit: sIBLedit. + :type sIBLedit: unicode + :return: Process command. + :rtype: unicode """ return "\"{0}\" \"{1}\"".format(sIBLedit, path) @@ -561,9 +594,12 @@ def editIblSetInSIBLedit(self, path, sIBLedit): """ Edits given Ibl Set in sIBLedit. - :param path: Path. ( String ) - :param sIBLedit: sIBLedit. ( String ) - :return: Method success. ( Boolean ) + :param path: Path. + :type path: unicode + :param sIBLedit: sIBLedit. + :type sIBLedit: unicode + :return: Method success. + :rtype: bool """ editCommand = self.getProcessCommand(path, sIBLedit) diff --git a/sibl_gui/components/addons/searchDatabase/searchDatabase.py b/sibl_gui/components/addons/searchDatabase/searchDatabase.py index 0bc9a5db..9473f959 100644 --- a/sibl_gui/components/addons/searchDatabase/searchDatabase.py +++ b/sibl_gui/components/addons/searchDatabase/searchDatabase.py @@ -74,10 +74,14 @@ def __init__(self, parent=None, name=None, *args, **kwargs): """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param name: Component name. ( String ) - :param \*args: Arguments. ( \* ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param parent: Object parent. + :type parent: QObject + :param name: Component name. + :type name: unicode + :param \*args: Arguments. + :type \*args: \* + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -107,7 +111,8 @@ def dockArea(self): """ Property for **self.__dockArea** attribute. - :return: self.__dockArea. ( Integer ) + :return: self.__dockArea. + :rtype: int """ return self.__dockArea @@ -118,7 +123,8 @@ def dockArea(self, value): """ Setter for **self.__dockArea** attribute. - :param value: Attribute value. ( Integer ) + :param value: Attribute value. + :type value: int """ raise foundations.exceptions.ProgrammingError( @@ -139,7 +145,8 @@ def viewSpacing(self): """ Property for **self.__viewSpacing** attribute. - :return: self.__viewSpacing. ( Integer ) + :return: self.__viewSpacing. + :rtype: int """ return self.__viewSpacing @@ -150,7 +157,8 @@ def viewSpacing(self, value): """ Setter for **self.__viewSpacing** attribute. - :param value: Attribute value. ( Integer ) + :param value: Attribute value. + :type value: int """ raise foundations.exceptions.ProgrammingError( @@ -171,7 +179,8 @@ def engine(self): """ Property for **self.__engine** attribute. - :return: self.__engine. ( QObject ) + :return: self.__engine. + :rtype: QObject """ return self.__engine @@ -182,7 +191,8 @@ def engine(self, value): """ Setter for **self.__engine** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -204,7 +214,8 @@ def iblSetsOutliner(self): """ Property for **self.__iblSetsOutliner** attribute. - :return: self.__iblSetsOutliner. ( QWidget ) + :return: self.__iblSetsOutliner. + :rtype: QWidget """ return self.__iblSetsOutliner @@ -215,7 +226,8 @@ def iblSetsOutliner(self, value): """ Setter for **self.__iblSetsOutliner** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -236,7 +248,8 @@ def collectionsOutliner(self): """ Property for **self.__collectionsOutliner** attribute. - :return: self.__collectionsOutliner. ( QWidget ) + :return: self.__collectionsOutliner. + :rtype: QWidget """ return self.__collectionsOutliner @@ -247,7 +260,8 @@ def collectionsOutliner(self, value): """ Setter for **self.__collectionsOutliner** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -268,7 +282,8 @@ def view(self): """ Property for **self.__view** attribute. - :return: self.__view. ( QWidget ) + :return: self.__view. + :rtype: QWidget """ return self.__view @@ -279,7 +294,8 @@ def view(self, value): """ Setter for **self.__view** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -300,7 +316,8 @@ def cloudExcludedTags(self): """ Property for **self.__cloudExcludedTags** attribute. - :return: self.__cloudExcludedTags. ( List ) + :return: self.__cloudExcludedTags. + :rtype: list """ return self.__cloudExcludedTags @@ -311,7 +328,8 @@ def cloudExcludedTags(self, value): """ Setter for **self.__cloudExcludedTags** attribute. - :param value: Attribute value. ( List ) + :param value: Attribute value. + :type value: list """ raise foundations.exceptions.ProgrammingError( @@ -334,8 +352,10 @@ def activate(self, engine): """ Activates the Component. - :param engine: Engine to attach the Component to. ( QObject ) - :return: Method success. ( Boolean ) + :param engine: Engine to attach the Component to. + :type engine: QObject + :return: Method success. + :rtype: bool """ LOGGER.debug("> Activating '{0}' Component.".format(self.__class__.__name__)) @@ -352,7 +372,8 @@ def deactivate(self): """ Deactivates the Component. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Deactivating '{0}' Component.".format(self.__class__.__name__)) @@ -369,7 +390,8 @@ def initializeUi(self): """ Initializes the Component ui. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Initializing '{0}' Component ui.".format(self.__class__.__name__)) @@ -415,7 +437,8 @@ def uninitializeUi(self): """ Uninitializes the Component ui. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Uninitializing '{0}' Component ui.".format(self.__class__.__name__)) @@ -439,7 +462,8 @@ def addWidget(self): """ Adds the Component Widget to the engine. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Adding '{0}' Component Widget.".format(self.__class__.__name__)) @@ -452,7 +476,8 @@ def removeWidget(self): """ Removes the Component Widget from the engine. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Removing '{0}' Component Widget.".format(self.__class__.__name__)) @@ -466,7 +491,8 @@ def __Search_Database_lineEdit__textChanged(self, text): """ Defines the slot triggered by **Search_Database_lineEdit** Widget when text changed. - :param text: Current text value. ( QString ) + :param text: Current text value. + :type text: QString """ self.setTagsCloudMatchingIblsSetsUi() @@ -475,7 +501,8 @@ def __Case_Sensitive_Matching_pushButton__clicked(self, checked): """ Defines the slot triggered by **Case_Sensitive_Matching_pushButton** Widget when clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ self.setTagsCloudMatchingIblsSetsUi() @@ -484,7 +511,8 @@ def __Time_Low_timeEdit__timeChanged(self, time): """ Defines the slot triggered by **Time_Low_timeEdit** Widget when time changed. - :param time: Current time. ( QTime ) + :param time: Current time. + :type time: QTime """ self.Time_Low_timeEdit.time() >= self.Time_High_timeEdit.time() and \ @@ -495,7 +523,8 @@ def __Time_High_timeEdit__timeChanged(self, time): """ Defines the slot triggered by **Time_Low_timeEdit** Widget when time changed. - :param time: Current time. ( QTime ) + :param time: Current time. + :type time: QTime """ self.Time_High_timeEdit.time() <= self.Time_Low_timeEdit.time() and \ @@ -506,7 +535,8 @@ def __view__doubleClicked(self, listWidgetItem): """ Defines the slot triggered by the View when double clicked. - :param listWidgetItem: List Widget item. ( QlistWidgetItem ) + :param listWidgetItem: List Widget item. + :type listWidgetItem: QlistWidgetItem """ self.Search_Database_lineEdit.setText("{0} {1}".format(self.Search_Database_lineEdit.text(), listWidgetItem.text())) @@ -515,8 +545,10 @@ def __collectionsOutliner_view_selectionModel__selectionChanged(self, selectedIt """ Defines the slot triggered by **collectionsOutliner.view** Model when selection changed - :param selectedItems: Selected items. ( QItemSelection ) - :param deselectedItems: Deselected items. ( QItemSelection ) + :param selectedItems: Selected items. + :type selectedItems: QItemSelection + :param deselectedItems: Deselected items. + :type deselectedItems: QItemSelection """ self.setTagsCloudMatchingIblsSetsUi() @@ -526,7 +558,8 @@ def setTagsCloudMatchingIblsSetsUi(self): Sets the user defined pattern matching Ibl Sets and updates :mod:`sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner` Component Model content. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -539,7 +572,8 @@ def setTimeMatchingIblSetsUi(self): Sets the user defined time matching Ibl Sets and updates :mod:`sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner` Component Model content. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -551,9 +585,12 @@ def setTagsCloudMatchingIblsSets(self, pattern, flags=re.IGNORECASE): Sets the pattern matching Ibl Sets and updates :mod:`sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner` Component Model content. - :param pattern: Filtering pattern. ( String ) - :param flags: Regex filtering flags. ( Integer ) - :return: Method success. ( Boolean ) + :param pattern: Filtering pattern. + :type pattern: unicode + :param flags: Regex filtering flags. + :type flags: int + :return: Method success. + :rtype: bool """ LOGGER.debug("> Filtering Ibl Sets by Tags.") @@ -606,9 +643,12 @@ def setTimeMatchingIblSets(self, timeLow, timeHigh): Sets the time matching Ibl Sets and updates :mod:`sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner` Component Model content. - :param timeLow: Time low. ( QTime ) - :param timeHigh: Time high. ( QTime ) - :return: Method success. ( Boolean ) + :param timeLow: Time low. + :type timeLow: QTime + :param timeHigh: Time high. + :type timeHigh: QTime + :return: Method success. + :rtype: bool """ LOGGER.debug("> Filtering Ibl Sets by time range from '{0}' to '{1}'.".format(timeLow, timeHigh)) diff --git a/sibl_gui/components/core/collectionsOutliner/collectionsOutliner.py b/sibl_gui/components/core/collectionsOutliner/collectionsOutliner.py index 0c7a3c12..56d3042d 100644 --- a/sibl_gui/components/core/collectionsOutliner/collectionsOutliner.py +++ b/sibl_gui/components/core/collectionsOutliner/collectionsOutliner.py @@ -94,10 +94,14 @@ def __init__(self, parent=None, name=None, *args, **kwargs): """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param name: Component name. ( String ) - :param \*args: Arguments. ( \* ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param parent: Object parent. + :type parent: QObject + :param name: Component name. + :type name: unicode + :param \*args: Arguments. + :type \*args: \* + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -136,7 +140,8 @@ def uiResourcesDirectory(self): """ Property for **self.__uiResourcesDirectory** attribute. - :return: self.__uiResourcesDirectory. ( String ) + :return: self.__uiResourcesDirectory. + :rtype: unicode """ return self.__uiResourcesDirectory @@ -147,7 +152,8 @@ def uiResourcesDirectory(self, value): """ Setter for **self.__uiResourcesDirectory** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -168,7 +174,8 @@ def uiDefaultCollectionImage(self): """ Property for **self.__uiDefaultCollectionImage** attribute. - :return: self.__uiDefaultCollectionImage. ( String ) + :return: self.__uiDefaultCollectionImage. + :rtype: unicode """ return self.__uiDefaultCollectionImage @@ -179,7 +186,8 @@ def uiDefaultCollectionImage(self, value): """ Setter for **self.__uiDefaultCollectionImage** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -200,7 +208,8 @@ def uiUserCollectionImage(self): """ Property for **self.__uiUserCollectionImage** attribute. - :return: self.__uiUserCollectionImage. ( String ) + :return: self.__uiUserCollectionImage. + :rtype: unicode """ return self.__uiUserCollectionImage @@ -211,7 +220,8 @@ def uiUserCollectionImage(self, value): """ Setter for **self.__uiUserCollectionImage** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -232,7 +242,8 @@ def dockArea(self): """ Property for **self.__dockArea** attribute. - :return: self.__dockArea. ( Integer ) + :return: self.__dockArea. + :rtype: int """ return self.__dockArea @@ -243,7 +254,8 @@ def dockArea(self, value): """ Setter for **self.__dockArea** attribute. - :param value: Attribute value. ( Integer ) + :param value: Attribute value. + :type value: int """ raise foundations.exceptions.ProgrammingError( @@ -264,7 +276,8 @@ def engine(self): """ Property for **self.__engine** attribute. - :return: self.__engine. ( QObject ) + :return: self.__engine. + :rtype: QObject """ return self.__engine @@ -275,7 +288,8 @@ def engine(self, value): """ Setter for **self.__engine** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -296,7 +310,8 @@ def settings(self): """ Property for **self.__settings** attribute. - :return: self.__settings. ( QSettings ) + :return: self.__settings. + :rtype: QSettings """ return self.__settings @@ -307,7 +322,8 @@ def settings(self, value): """ Setter for **self.__settings** attribute. - :param value: Attribute value. ( QSettings ) + :param value: Attribute value. + :type value: QSettings """ raise foundations.exceptions.ProgrammingError( @@ -328,7 +344,8 @@ def settingsSection(self): """ Property for **self.__settingsSection** attribute. - :return: self.__settingsSection. ( String ) + :return: self.__settingsSection. + :rtype: unicode """ return self.__settingsSection @@ -339,7 +356,8 @@ def settingsSection(self, value): """ Setter for **self.__settingsSection** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -360,7 +378,8 @@ def settingsSeparator(self): """ Property for **self.__settingsSeparator** attribute. - :return: self.__settingsSeparator. ( String ) + :return: self.__settingsSeparator. + :rtype: unicode """ return self.__settingsSeparator @@ -371,7 +390,8 @@ def settingsSeparator(self, value): """ Setter for **self.__settingsSeparator** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -392,7 +412,8 @@ def iblSetsOutliner(self): """ Property for **self.__iblSetsOutliner** attribute. - :return: self.__iblSetsOutliner. ( QWidget ) + :return: self.__iblSetsOutliner. + :rtype: QWidget """ return self.__iblSetsOutliner @@ -403,7 +424,8 @@ def iblSetsOutliner(self, value): """ Setter for **self.__iblSetsOutliner** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -424,7 +446,8 @@ def model(self): """ Property for **self.__model** attribute. - :return: self.__model. ( CollectionsModel ) + :return: self.__model. + :rtype: CollectionsModel """ return self.__model @@ -435,7 +458,8 @@ def model(self, value): """ Setter for **self.__model** attribute. - :param value: Attribute value. ( CollectionsModel ) + :param value: Attribute value. + :type value: CollectionsModel """ raise foundations.exceptions.ProgrammingError( @@ -456,7 +480,8 @@ def view(self): """ Property for **self.__view** attribute. - :return: self.__view. ( QWidget ) + :return: self.__view. + :rtype: QWidget """ return self.__view @@ -467,7 +492,8 @@ def view(self, value): """ Setter for **self.__view** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -488,7 +514,8 @@ def overallCollection(self): """ Property for **self.__overallCollection** attribute. - :return: self.__overallCollection. ( String ) + :return: self.__overallCollection. + :rtype: unicode """ return self.__overallCollection @@ -499,7 +526,8 @@ def overallCollection(self, value): """ Setter for **self.__overallCollection** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -520,7 +548,8 @@ def defaultCollection(self): """ Property for **self.__defaultCollection** attribute. - :return: self.__defaultCollection. ( String ) + :return: self.__defaultCollection. + :rtype: unicode """ return self.__defaultCollection @@ -531,7 +560,8 @@ def defaultCollection(self, value): """ Setter for **self.__defaultCollection** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -552,7 +582,8 @@ def iblSetsCountLabel(self): """ Property for **self.__iblSetsCountLabel** attribute. - :return: self.__iblSetsCountLabel. ( String ) + :return: self.__iblSetsCountLabel. + :rtype: unicode """ return self.__iblSetsCountLabel @@ -563,7 +594,8 @@ def iblSetsCountLabel(self, value): """ Setter for **self.__iblSetsCountLabel** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -584,7 +616,8 @@ def headers(self): """ Property for **self.__headers** attribute. - :return: self.__headers. ( OrderedDict ) + :return: self.__headers. + :rtype: OrderedDict """ return self.__headers @@ -595,7 +628,8 @@ def headers(self, value): """ Setter for **self.__headers** attribute. - :param value: Attribute value. ( OrderedDict ) + :param value: Attribute value. + :type value: OrderedDict """ raise foundations.exceptions.ProgrammingError( @@ -618,8 +652,10 @@ def activate(self, engine): """ Activates the Component. - :param engine: Engine to attach the Component to. ( QObject ) - :return: Method success. ( Boolean ) + :param engine: Engine to attach the Component to. + :type engine: QObject + :return: Method success. + :rtype: bool """ LOGGER.debug("> Activating '{0}' Component.".format(self.__class__.__name__)) @@ -647,7 +683,8 @@ def initializeUi(self): """ Initializes the Component ui. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Initializing '{0}' Component ui.".format(self.__class__.__name__)) @@ -691,7 +728,8 @@ def addWidget(self): """ Adds the Component Widget to the engine. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Adding '{0}' Component Widget.".format(self.__class__.__name__)) @@ -713,7 +751,8 @@ def onStartup(self): """ Defines the slot triggered on Framework startup. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Calling '{0}' Component Framework 'onStartup' method.".format(self.__class__.__name__)) @@ -745,7 +784,8 @@ def onClose(self): """ Defines the slot triggered on Framework close. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Calling '{0}' Component Framework 'onClose' method.".format(self.__class__.__name__)) @@ -790,8 +830,10 @@ def __model__dataChanged(self, startIndex, endIndex): """ Defines the slot triggered by the Model when data has changed. - :param startIndex: Edited item starting QModelIndex. ( QModelIndex ) - :param endIndex: Edited item ending QModelIndex. ( QModelIndex ) + :param startIndex: Edited item starting QModelIndex. + :type startIndex: QModelIndex + :param endIndex: Edited item ending QModelIndex. + :type endIndex: QModelIndex """ collectionNode = self.__model.getNode(startIndex) @@ -840,8 +882,10 @@ def __view_addContentAction__triggered(self, checked): """ Defines the slot triggered by **'Actions|Umbra|Components|core.collectionsOutliner|Add Content ...'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ return self.addContentUi() @@ -850,8 +894,10 @@ def __view_addCollectionAction__triggered(self, checked): """ Defines the slot triggered by **'Actions|Umbra|Components|core.collectionsOutliner|Add Collection ...'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ return self.addCollectionUi() @@ -861,8 +907,10 @@ def __view_removeCollectionsAction__triggered(self, checked): Defines the slot triggered by **'Actions|Umbra|Components|core.collectionsOutliner|Remove Collection(s) ...'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ return self.removeCollectionsUi() @@ -871,8 +919,10 @@ def __view_selectionModel__selectionChanged(self, selectedItems, deselectedItems """ Defines the slot triggered by the View **selectionModel** when selection changed. - :param selectedItems: Selected items. ( QItemSelection ) - :param deselectedItems: Deselected items. ( QItemSelection ) + :param selectedItems: Selected items. + :type selectedItems: QItemSelection + :param deselectedItems: Deselected items. + :type deselectedItems: QItemSelection """ self.__iblSetsOutliner.refreshNodes.emit() @@ -883,7 +933,8 @@ def addContentUi(self): """ Adds user defined content to the Database. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -913,7 +964,8 @@ def addCollectionUi(self): """ Adds an user defined Collection to the Database. - :return: Collection name. ( String ) + :return: Collection name. + :rtype: unicode :note: This method may require user interaction. """ @@ -955,7 +1007,8 @@ def removeCollectionsUi(self): """ Removes user selected Collections from the Database. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -998,9 +1051,12 @@ def addCollection(self, name, comment="Double click to set a comment!"): """ Adds a Collection to the Database. - :param name: Collection name. ( String ) - :param collection: Collection name. ( String ) - :return: Method success. ( Boolean ) + :param name: Collection name. + :type name: unicode + :param collection: Collection name. + :type collection: unicode + :return: Method success. + :rtype: bool """ if name != self.__overallCollection: @@ -1025,8 +1081,10 @@ def removeCollection(self, collection): """ Removes given Collection from the Database. - :param collection: Collection to remove. ( Collection ) - :return: Method success. ( Boolean ) + :param collection: Collection to remove. + :type collection: Collection + :return: Method success. + :rtype: bool """ iblSets = sibl_gui.components.core.database.operations.getCollectionsIblSets((collection.id,)) @@ -1047,7 +1105,8 @@ def getCollections(self): """ Returns Database Ibl Sets Collections. - :return: Database Ibl Sets Collections. ( List ) + :return: Database Ibl Sets Collections. + :rtype: list """ return sibl_gui.components.core.database.operations.getCollectionsByType("IblSets") @@ -1056,11 +1115,15 @@ def filterCollections(self, pattern, attribute, flags=re.IGNORECASE): """ Filters the Database Ibl Sets Collections on given attribute using given pattern. - :param pattern: Filter pattern. ( String ) - :param attribute: Attribute to filter on. ( String ) - :param flags: Regex filtering flags. ( Integer ) + :param pattern: Filter pattern. + :type pattern: unicode + :param attribute: Attribute to filter on. + :type attribute: unicode + :param flags: Regex filtering flags. + :type flags: int - :return: Filtered Database Ibl Sets Collections. ( List ) + :return: Filtered Database Ibl Sets Collections. + :rtype: list """ try: @@ -1075,8 +1138,10 @@ def collectionExists(self, name): """ Returns if given Collection name exists in the Database. - :param name: Collection name. ( String ) - :return: Collection exists. ( Boolean ) + :param name: Collection name. + :type name: unicode + :return: Collection exists. + :rtype: bool """ return sibl_gui.components.core.database.operations.collectionExists(name) @@ -1085,7 +1150,8 @@ def listCollections(self): """ Lists Database Ibl Sets Collections names. - :return: Database Ibl Sets Collections names. ( List ) + :return: Database Ibl Sets Collections names. + :rtype: list """ return [collection.name for collection in self.getCollections()] @@ -1132,8 +1198,10 @@ def getCollectionByName(self, name): """ Returns Database Ibl Sets Collection with given name. - :param name: Collection name. ( String ) - :return: Database Ibl Sets Collection. ( Collection ) + :param name: Collection name. + :type name: unicode + :return: Database Ibl Sets Collection. + :rtype: Collection """ collections = self.filterCollections(r"^{0}$".format(name), "name") @@ -1143,8 +1211,10 @@ def getCollectionsIblSets(self, collections): """ Gets given Collections Ibl Sets. - :param collections: Collections to get Ibl Sets from. ( List ) - :return: Ibl Sets list. ( List ) + :param collections: Collections to get Ibl Sets from. + :type collections: list + :return: Ibl Sets list. + :rtype: list """ return [iblSet for iblSet in \ @@ -1154,8 +1224,10 @@ def getCollectionId(self, collection): """ Returns given Collection id. - :param collection: Collection to get the id from. ( String ) - :return: Provided Collection id. ( Integer ) + :param collection: Collection to get the id from. + :type collection: unicode + :return: Provided Collection id. + :rtype: int """ children = self.__model.findChildren(r"^{0}$".format(collection)) @@ -1166,7 +1238,8 @@ def getSelectedNodes(self): """ Returns the View selected nodes. - :return: View selected nodes. ( Dictionary ) + :return: View selected nodes. + :rtype: dict """ return self.__view.getSelectedNodes() @@ -1175,7 +1248,8 @@ def getSelectedCollectionsNodes(self): """ Returns the View selected Collections nodes. - :return: View selected Collections nodes. ( List ) + :return: View selected Collections nodes. + :rtype: list """ return [node for node in self.getSelectedNodes() if node.family == "Collection"] @@ -1184,7 +1258,8 @@ def getSelectedCollections(self): """ Gets the View selected Collections. - :return: View selected Collections. ( List ) + :return: View selected Collections. + :rtype: list """ return [node.databaseItem for node in self.getSelectedCollectionsNodes()] diff --git a/sibl_gui/components/core/collectionsOutliner/models.py b/sibl_gui/components/core/collectionsOutliner/models.py index 59664cf9..9aa25229 100644 --- a/sibl_gui/components/core/collectionsOutliner/models.py +++ b/sibl_gui/components/core/collectionsOutliner/models.py @@ -54,10 +54,14 @@ def __init__(self, parent=None, rootNode=None, horizontalHeaders=None, verticalH """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param rootNode: Root node. ( AbstractCompositeNode ) - :param horizontalHeaders: Headers. ( OrderedDict ) - :param verticalHeaders: Headers. ( OrderedDict ) + :param parent: Object parent. + :type parent: QObject + :param rootNode: Root node. + :type rootNode: AbunicodeactCompositeNode + :param horizontalHeaders: Headers. + :type horizontalHeaders: OrderedDict + :param verticalHeaders: Headers. + :type verticalHeaders: OrderedDict """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -75,8 +79,10 @@ def initializeModel(self, rootNode): """ Initializes the Model using given root node. - :param rootNode: Graph root node. ( DefaultNode ) - :return: Method success ( Boolean ) + :param rootNode: Graph root node. + :type rootNode: DefaultNode + :return: Method success + :rtype: bool """ LOGGER.debug("> Initializing model with '{0}' root node.".format(rootNode)) diff --git a/sibl_gui/components/core/collectionsOutliner/nodes.py b/sibl_gui/components/core/collectionsOutliner/nodes.py index 8745f32d..2497837b 100644 --- a/sibl_gui/components/core/collectionsOutliner/nodes.py +++ b/sibl_gui/components/core/collectionsOutliner/nodes.py @@ -69,15 +69,24 @@ def __init__(self, """ Initializes the class. - :param name: Node name. ( String ) - :param parent: Node parent. ( GraphModelNode ) - :param children: Children. ( List ) - :param roles: Roles. ( Dictionary ) - :param nodeFlags: Node flags. ( Integer ) - :param attributesFlags: Attributes flags. ( Integer ) - :param iconSize: Icon size. ( String ) - :param iconPlaceholder: Icon placeholder. ( QIcon ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param name: Node name. + :type name: unicode + :param parent: Node parent. + :type parent: GraphModelNode + :param children: Children. + :type children: list + :param roles: Roles. + :type roles: dict + :param nodeFlags: Node flags. + :type nodeFlags: int + :param attributesFlags: Attributes flags. + :type attributesFlags: int + :param iconSize: Icon size. + :type iconSize: unicode + :param iconPlaceholder: Icon placeholder. + :type iconPlaceholder: QIcon + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -101,7 +110,8 @@ def __initializeNode(self, attributesFlags=int(Qt.ItemIsSelectable | Qt.ItemIsEn """ Initializes the node. - :param attributesFlags: Attributes flags. ( Integer ) + :param attributesFlags: Attributes flags. + :type attributesFlags: int """ self["count"] = sibl_gui.ui.nodes.GraphModelAttribute(name="count", @@ -114,7 +124,8 @@ def updateNode(self): """ Updates the node. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ return self.updateNodeAttributes() @@ -123,7 +134,8 @@ def updateNodeAttributes(self): """ Updates the Node attributes. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ self.count.value = self.count.roles[Qt.DisplayRole] = sum(node.count.value for node in self.children) diff --git a/sibl_gui/components/core/collectionsOutliner/views.py b/sibl_gui/components/core/collectionsOutliner/views.py index b7a174d4..d12b8de7 100644 --- a/sibl_gui/components/core/collectionsOutliner/views.py +++ b/sibl_gui/components/core/collectionsOutliner/views.py @@ -62,10 +62,14 @@ def __init__(self, parent, model=None, readOnly=False, message=None): """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param model: Model. ( QObject ) - :param readOnly: View is read only. ( Boolean ) - :param message: View default message when Model is empty. ( String ) + :param parent: Object parent. + :type parent: QObject + :param model: Model. + :type model: QObject + :param readOnly: View is read only. + :type readOnly: bool + :param message: View default message when Model is empty. + :type message: unicode """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -87,7 +91,8 @@ def container(self): """ Property for **self.__container** attribute. - :return: self.__container. ( QObject ) + :return: self.__container. + :rtype: QObject """ return self.__container @@ -98,7 +103,8 @@ def container(self, value): """ Setter for **self.__container** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -119,7 +125,8 @@ def treeViewIndentation(self): """ Property for **self.__treeViewIndentation** attribute. - :return: self.__treeViewIndentation. ( Integer ) + :return: self.__treeViewIndentation. + :rtype: int """ return self.__treeViewIndentation @@ -130,7 +137,8 @@ def treeViewIndentation(self, value): """ Setter for **self.__treeViewIndentation** attribute. - :param value: Attribute value. ( Integer ) + :param value: Attribute value. + :type value: int """ raise foundations.exceptions.ProgrammingError( @@ -153,7 +161,8 @@ def dragEnterEvent(self, event): """ Reimplements the :meth:`sibl_gui.ui.views.Abstract_QTreeView.dragEnterEvent` method. - :param event: QEvent. ( QEvent ) + :param event: QEvent. + :type event: QEvent """ if event.mimeData().hasFormat("application/x-umbragraphmodeldatalist"): @@ -166,7 +175,8 @@ def dragMoveEvent(self, event): """ Reimplements the :meth:`sibl_gui.ui.views.Abstract_QTreeView.dragMoveEvent` method. - :param event: QEvent. ( QEvent ) + :param event: QEvent. + :type event: QEvent """ pass @@ -178,7 +188,8 @@ def dropEvent(self, event): """ Reimplements the :meth:`sibl_gui.ui.views.Abstract_QTreeView.dropEvent` method. - :param event: QEvent. ( QEvent ) + :param event: QEvent. + :type event: QEvent """ if not self.readOnly: @@ -249,7 +260,8 @@ def storeModelSelection(self): """ Stores the Model selection. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Storing Model selection!") @@ -266,7 +278,8 @@ def restoreModelSelection(self): """ Restores the Model selection. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Restoring Model selection!") diff --git a/sibl_gui/components/core/database/database.py b/sibl_gui/components/core/database/database.py index a5233a2a..6cf454c6 100644 --- a/sibl_gui/components/core/database/database.py +++ b/sibl_gui/components/core/database/database.py @@ -65,7 +65,8 @@ def __init__(self, name=None): """ Initializes the class. - :param name: Component name. ( String ) + :param name: Component name. + :type name: unicode """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -96,7 +97,8 @@ def engine(self): """ Property for **self.__engine** attribute. - :return: self.__engine. ( QObject ) + :return: self.__engine. + :rtype: QObject """ return self.__engine @@ -107,7 +109,8 @@ def engine(self, value): """ Setter for **self.__engine** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -128,7 +131,8 @@ def databaseName(self): """ Property for **self.__databaseName** attribute. - :return: self.__databaseName. ( String ) + :return: self.__databaseName. + :rtype: unicode """ return self.__databaseName @@ -139,7 +143,8 @@ def databaseName(self, value): """ Setter for **self.__databaseName** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -160,7 +165,8 @@ def databaseEngine(self): """ Property for **self.__databaseEngine** attribute. - :return: self.__databaseEngine. ( Object ) + :return: self.__databaseEngine. + :rtype: object """ return self.__databaseEngine @@ -171,7 +177,8 @@ def databaseEngine(self, value): """ Setter for **self.__databaseEngine** attribute. - :param value: Attribute value. ( Object ) + :param value: Attribute value. + :type value: object """ raise foundations.exceptions.ProgrammingError( @@ -192,7 +199,8 @@ def databaseCatalog(self): """ Property for **self.__databaseCatalog** attribute. - :return: self.__databaseCatalog. ( Object ) + :return: self.__databaseCatalog. + :rtype: object """ return self.__databaseCatalog @@ -203,7 +211,8 @@ def databaseCatalog(self, value): """ Setter for **self.__databaseCatalog** attribute. - :param value: Attribute value. ( Object ) + :param value: Attribute value. + :type value: object """ raise foundations.exceptions.ProgrammingError( @@ -224,7 +233,8 @@ def databaseSession(self): """ Property for **self.__databaseSession** attribute. - :return: self.__databaseSession. ( Object ) + :return: self.__databaseSession. + :rtype: object """ return self.__databaseSession @@ -235,7 +245,8 @@ def databaseSession(self, value): """ Setter for **self.__databaseSession** attribute. - :param value: Attribute value. ( Object ) + :param value: Attribute value. + :type value: object """ raise foundations.exceptions.ProgrammingError( @@ -256,7 +267,8 @@ def databaseSessionMaker(self): """ Property for **self.__databaseSessionMaker** attribute. - :return: self.__databaseSessionMaker. ( Object ) + :return: self.__databaseSessionMaker. + :rtype: object """ return self.__databaseSessionMaker @@ -267,7 +279,8 @@ def databaseSessionMaker(self, value): """ Setter for **self.__databaseSessionMaker** attribute. - :param value: Attribute value. ( Object ) + :param value: Attribute value. + :type value: object """ raise foundations.exceptions.ProgrammingError( @@ -288,7 +301,8 @@ def databaseConnectionString(self): """ Property for **self.__databaseConnectionString** attribute. - :return: self.__databaseConnectionString. ( String ) + :return: self.__databaseConnectionString. + :rtype: unicode """ return self.__databaseConnectionString @@ -299,7 +313,8 @@ def databaseConnectionString(self, value): """ Setter for **self.__databaseConnectionString** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -320,7 +335,8 @@ def databaseBackupDirectory(self): """ Property for **self.__databaseBackupDirectory** attribute. - :return: self.__databaseBackupDirectory. ( String ) + :return: self.__databaseBackupDirectory. + :rtype: unicode """ return self.__databaseBackupDirectory @@ -331,7 +347,8 @@ def databaseBackupDirectory(self, value): """ Setter for **self.__databaseBackupDirectory** attribute. - :param value: Attribute value. ( Object ) + :param value: Attribute value. + :type value: object """ raise foundations.exceptions.ProgrammingError( @@ -352,7 +369,8 @@ def databaseBackupCount(self): """ Property for **self.__databaseBackupCount** attribute. - :return: self.__databaseBackupCount. ( String ) + :return: self.__databaseBackupCount. + :rtype: unicode """ return self.__databaseBackupCount @@ -363,7 +381,8 @@ def databaseBackupCount(self, value): """ Setter for **self.__databaseBackupCount** attribute. - :param value: Attribute value. ( Object ) + :param value: Attribute value. + :type value: object """ raise foundations.exceptions.ProgrammingError( @@ -386,8 +405,10 @@ def activate(self, engine): """ Activates the Component. - :param engine: Engine to attach the Component to. ( QObject ) - :return: Method success. ( Boolean ) + :param engine: Engine to attach the Component to. + :type engine: QObject + :return: Method success. + :rtype: bool """ LOGGER.debug("> Activating '{0}' Component.".format(self.__class__.__name__)) @@ -410,7 +431,8 @@ def initialize(self): """ Initializes the Component. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Initializing '{0}' Component.".format(self.__class__.__name__)) @@ -474,7 +496,8 @@ def commit(self): """ Commits pending changes in the Database. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ return sibl_gui.components.core.database.operations.commit(self.__databaseSession) diff --git a/sibl_gui/components/core/database/nodes.py b/sibl_gui/components/core/database/nodes.py index 04bc1802..6ecc89a9 100644 --- a/sibl_gui/components/core/database/nodes.py +++ b/sibl_gui/components/core/database/nodes.py @@ -62,9 +62,12 @@ def getTemplateUserName(title, software): """ Returns the Template user name. - :param title: Template title. ( String ) - :param software: Template software. ( String ) - :return: Template user name. ( String ) + :param title: Template title. + :type title: unicode + :param software: Template software. + :type software: unicode + :return: Template user name. + :rtype: unicode """ return foundations.strings.removeStrip(title, software) @@ -91,16 +94,26 @@ def __init__(self, """ Initializes the class. - :param databaseItem: Database object. ( Object ) - :param name: Node name. ( String ) - :param parent: Node parent. ( GraphModelNode ) - :param children: Children. ( List ) - :param roles: Roles. ( Dictionary ) - :param nodeFlags: Node flags. ( Integer ) - :param attributesFlags: Attributes flags. ( Integer ) - :param iconSize: Icon size. ( String ) - :param iconPlaceholder: Icon placeholder. ( QIcon ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param databaseItem: Database object. + :type databaseItem: object + :param name: Node name. + :type name: unicode + :param parent: Node parent. + :type parent: GraphModelNode + :param children: Children. + :type children: list + :param roles: Roles. + :type roles: dict + :param nodeFlags: Node flags. + :type nodeFlags: int + :param attributesFlags: Attributes flags. + :type attributesFlags: int + :param iconSize: Icon size. + :type iconSize: unicode + :param iconPlaceholder: Icon placeholder. + :type iconPlaceholder: QIcon + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -129,7 +142,8 @@ def databaseItem(self): """ Property for **self.__databaseItem** attribute. - :return: self.__databaseItem. ( Object ) + :return: self.__databaseItem. + :rtype: object """ return self.__databaseItem @@ -140,7 +154,8 @@ def databaseItem(self, value): """ Setter for **self.__databaseItem** attribute. - :param value: Attribute value. ( Object ) + :param value: Attribute value. + :type value: object """ raise foundations.exceptions.ProgrammingError( @@ -161,7 +176,8 @@ def toolTipText(self): """ Property for **self.__toolTipText** attribute. - :return: self.__toolTipText. ( String ) + :return: self.__toolTipText. + :rtype: unicode """ return self.__toolTipText @@ -172,7 +188,8 @@ def toolTipText(self, value): """ Setter for **self.__toolTipText** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ if value is not None: @@ -197,7 +214,8 @@ def __initializeNode(self, attributesFlags=int(Qt.ItemIsSelectable | Qt.ItemIsEn """ Initializes the node. - :param attributesFlags: Attributes flags. ( Integer ) + :param attributesFlags: Attributes flags. + :type attributesFlags: int """ for column in self.__databaseItem.__table__.columns: @@ -214,7 +232,8 @@ def updateNode(self): """ Updates the Node from the database item. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ raise NotImplementedError("{0} | '{1}' must be implemented by '{2}' subclasses!".format( @@ -224,7 +243,8 @@ def updateNodeAttributes(self): """ Updates the Node attributes from the database item attributes. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ for column in self.__databaseItem.__table__.columns: @@ -241,7 +261,8 @@ def updateDatabaseItem(self): """ Updates the database item from the node. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ raise NotImplementedError("{0} | '{1}' must be implemented by '{2}' subclasses!".format( @@ -251,7 +272,8 @@ def updateDatabaseItemAttributes(self): """ Updates the database item attributes from the Node attributes. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ for column in self.__databaseItem.__table__.columns: @@ -268,7 +290,8 @@ def updateToolTip(self): """ Updates the Node tooltip. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ raise NotImplementedError("{0} | '{1}' must be implemented by '{2}' subclasses!".format( @@ -297,17 +320,28 @@ def __init__(self, """ Initializes the class. - :param databaseItem: Database object. ( Object ) - :param name: Node name. ( String ) - :param parent: Node parent. ( GraphModelNode ) - :param children: Children. ( List ) - :param roles: Roles. ( Dictionary ) - :param nodeFlags: Node flags. ( Integer ) - :param attributesFlags: Attributes flags. ( Integer ) - :param iconPath: Icon path. ( String ) - :param iconSize: Icon size. ( String ) - :param iconPlaceholder: Icon placeholder. ( QIcon ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param databaseItem: Database object. + :type databaseItem: object + :param name: Node name. + :type name: unicode + :param parent: Node parent. + :type parent: GraphModelNode + :param children: Children. + :type children: list + :param roles: Roles. + :type roles: dict + :param nodeFlags: Node flags. + :type nodeFlags: int + :param attributesFlags: Attributes flags. + :type attributesFlags: int + :param iconPath: Icon path. + :type iconPath: unicode + :param iconSize: Icon size. + :type iconSize: unicode + :param iconPlaceholder: Icon placeholder. + :type iconPlaceholder: QIcon + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -344,7 +378,8 @@ def iconPath(self): """ Property for **self.__iconPath** attribute. - :return: self.__iconPath. ( String ) + :return: self.__iconPath. + :rtype: unicode """ return self.__iconPath @@ -355,7 +390,8 @@ def iconPath(self, value): """ Setter for **self.__iconPath** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -388,7 +424,8 @@ def updateNode(self): """ This method updates the node from the database item. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ self.name = self.roles[Qt.DisplayRole] = self.roles[Qt.EditRole] = self.__databaseItem.title @@ -398,7 +435,8 @@ def updateNodeAttributes(self): """ This method updates the node attributes from the database item attributes. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ return AbstractDatabaseNode.updateNodeAttributes(self) @@ -407,7 +445,8 @@ def updateDatabaseItem(self): """ This method updates the database item from the node. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ self.title = self.databaseItem.title = self.name @@ -417,7 +456,8 @@ def updateToolTip(self): """ This method updates the node tooltip. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ self.roles[Qt.ToolTipRole] = self.toolTipText.format(self.databaseItem.title, @@ -450,16 +490,26 @@ def __init__(self, """ Initializes the class. - :param databaseItem: Database object. ( Object ) - :param name: Node name. ( String ) - :param parent: Node parent. ( GraphModelNode ) - :param children: Children. ( List ) - :param roles: Roles. ( Dictionary ) - :param nodeFlags: Node flags. ( Integer ) - :param attributesFlags: Attributes flags. ( Integer ) - :param iconSize: Icon size. ( String ) - :param iconPlaceholder: Icon placeholder. ( QIcon ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param databaseItem: Database object. + :type databaseItem: object + :param name: Node name. + :type name: unicode + :param parent: Node parent. + :type parent: GraphModelNode + :param children: Children. + :type children: list + :param roles: Roles. + :type roles: dict + :param nodeFlags: Node flags. + :type nodeFlags: int + :param attributesFlags: Attributes flags. + :type attributesFlags: int + :param iconSize: Icon size. + :type iconSize: unicode + :param iconPlaceholder: Icon placeholder. + :type iconPlaceholder: QIcon + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -503,7 +553,8 @@ def updateNode(self): """ This method updates the node from the database item. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ self.name = self.roles[Qt.DisplayRole] = self.roles[Qt.EditRole] = getTemplateUserName(self.databaseItem.title, @@ -515,7 +566,8 @@ def updateNodeAttributes(self): """ This method updates the node attributes from the database item attributes. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ return AbstractDatabaseNode.updateNodeAttributes(self) @@ -524,7 +576,8 @@ def updateDatabaseItem(self): """ This method updates the database item from the node. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ self.title = self.databaseItem.title = self.name @@ -534,7 +587,8 @@ def updateToolTip(self): """ This method updates the node tooltip. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ self.roles[Qt.ToolTipRole] = self.toolTipText.format(getTemplateUserName(self.databaseItem.title, @@ -566,16 +620,26 @@ def __init__(self, """ Initializes the class. - :param databaseItem: Database object. ( Object ) - :param name: Node name. ( String ) - :param parent: Node parent. ( GraphModelNode ) - :param children: Children. ( List ) - :param roles: Roles. ( Dictionary ) - :param nodeFlags: Node flags. ( Integer ) - :param attributesFlags: Attributes flags. ( Integer ) - :param iconSize: Icon size. ( String ) - :param iconPlaceholder: Icon placeholder. ( QIcon ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param databaseItem: Database object. + :type databaseItem: object + :param name: Node name. + :type name: unicode + :param parent: Node parent. + :type parent: GraphModelNode + :param children: Children. + :type children: list + :param roles: Roles. + :type roles: dict + :param nodeFlags: Node flags. + :type nodeFlags: int + :param attributesFlags: Attributes flags. + :type attributesFlags: int + :param iconSize: Icon size. + :type iconSize: unicode + :param iconPlaceholder: Icon placeholder. + :type iconPlaceholder: QIcon + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -620,7 +684,8 @@ def updateNode(self): """ This method updates the node from the database item. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ self.name = self.roles[Qt.DisplayRole] = self.roles[Qt.EditRole] = self.databaseItem.name @@ -630,7 +695,8 @@ def updateNodeAttributes(self): """ This method updates the node attributes from the database item attributes. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ self.count.value = self.count.roles[Qt.DisplayRole] = \ @@ -642,7 +708,8 @@ def updateDatabaseItem(self): """ This method updates the database item from the node. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ self.databaseItem.name = self.name @@ -652,7 +719,8 @@ def updateToolTip(self): """ This method updates the node tooltip. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ self.roles[Qt.ToolTipRole] = self.toolTipText.format(self.databaseItem.name, diff --git a/sibl_gui/components/core/database/operations.py b/sibl_gui/components/core/database/operations.py index b74a2cea..ee9b64f3 100644 --- a/sibl_gui/components/core/database/operations.py +++ b/sibl_gui/components/core/database/operations.py @@ -109,7 +109,8 @@ def createSession(): """ Creates a default session. - :return: Database session. ( Session ) + :return: Database session. + :rtype: Session """ return DEFAULT_SESSION_MAKER() @@ -118,8 +119,10 @@ def getSession(session=None): """ Returns either given session or the default one. - :param session: Database session. ( Session ) - :return: Database session. ( Session ) + :param session: Database session. + :type session: Session + :return: Database session. + :rtype: Session """ if session is not None: @@ -134,9 +137,12 @@ def query(*args, **kwargs): """ Queries given session or the default one. - :param \*args: Arguments. ( \* ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) - :return: Query result. ( Object ) + :param \*args: Arguments. + :type \*args: \* + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* + :return: Query result. + :rtype: object """ return getSession(kwargs.get("session")).query(*args, **kwargs) @@ -146,8 +152,10 @@ def commit(session=None): """ Commits changes to the Database. - :param session: Database session. ( Session ) - :return: Database commit success. ( Boolean ) + :param session: Database session. + :type session: Session + :return: Database commit success. + :rtype: bool """ session = getSession(session) @@ -164,9 +172,12 @@ def addItem(item, session=None): """ Adds an item to the Database. - :param item: Item to add. ( Database object ) - :param session: Database session. ( Session ) - :return: Database commit success. ( Boolean ) + :param item: Item to add. + :type item: Object + :param session: Database session. + :type session: Session + :return: Database commit success. + :rtype: bool """ LOGGER.debug("> Adding: '{0}' item to the Database.".format(item)) @@ -179,12 +190,18 @@ def addStandardItem(type, name, path, collection, session=None): """ Adds a new standard item to the Database. - :param type: Item type. ( Object ) - :param name: Item name. ( String ) - :param path: Item path. ( String ) - :param collection: Collection id. ( String ) - :param session: Database session. ( Session ) - :return: Database commit success. ( Boolean ) + :param type: Item type. + :type type: object + :param name: Item name. + :type name: unicode + :param path: Item path. + :type path: unicode + :param collection: Collection id. + :type collection: unicode + :param session: Database session. + :type session: Session + :return: Database commit success. + :rtype: bool """ LOGGER.debug("> Adding: '{0}' '{1}' to the Database.".format(name, type.__name__)) @@ -204,9 +221,12 @@ def removeItem(item, session=None): """ Removes an item from the Database. - :param item: Item to remove. ( Database object ) - :param session: Database session. ( Session ) - :return: Database commit success. ( Boolean ) + :param item: Item to remove. + :type item: Object + :param session: Database session. + :type session: Session + :return: Database commit success. + :rtype: bool """ LOGGER.debug("> Removing: '{0}' item from the Database.".format(item)) @@ -219,10 +239,14 @@ def removeStandardItem(type, identity, session=None): """ Removes a standard item from the Database. - :param type: Item type. ( Object ) - :param identity: Item id. ( String ) - :param session: Database session. ( Session ) - :return: Database commit success. ( Boolean ) + :param type: Item type. + :type type: object + :param identity: Item id. + :type identity: unicode + :param session: Database session. + :type session: Session + :return: Database commit success. + :rtype: bool """ LOGGER.debug("> Removing item type '{0}' with id '{1}' from the Database.".format(type.__name__, identity)) @@ -234,9 +258,12 @@ def updateItemContent(item, session=None): """ Update an item content. - :param item: Item to set content. ( IblSet ) - :param session: Database session. ( Session ) - :return: Database commit success. ( Boolean ) + :param item: Item to set content. + :type item: IblSet + :param session: Database session. + :type session: Session + :return: Database commit success. + :rtype: bool """ LOGGER.debug("> Updating '{0}' '{1}' content.".format(item.name, item.__class__.__name__)) @@ -254,10 +281,14 @@ def updateItemLocation(item, path, session=None): """ Updates an item location. - :param item: Item to update. ( Object ) - :param path: Item path. ( Path ) - :param session: Database session. ( Session ) - :return: Database commit success. ( Boolean ) + :param item: Item to update. + :type item: object + :param path: Item path. + :type path: Path + :param session: Database session. + :type session: Session + :return: Database commit success. + :rtype: bool """ LOGGER.debug("> Updating '{0}' '{1}' location.".format(item, item.__class__.__name__)) @@ -277,11 +308,16 @@ def filterItems(items, pattern, field, flags=0): """ Filters items from the Database. - :param items: Database items. ( List ) - :param pattern: Filtering pattern. ( String ) - :param field: Database field to search into. ( String ) - :param flags: Flags passed to the regex engine. ( Integer ) - :return: Filtered items. ( List ) + :param items: Database items. + :type items: list + :param pattern: Filtering pattern. + :type pattern: unicode + :param field: Database field to search into. + :type field: unicode + :param flags: Flags passed to the regex engine. + :type flags: int + :return: Filtered items. + :rtype: list """ return [item for item in items if re.search(pattern, foundations.strings.toString(item.__dict__[field]), flags)] @@ -290,11 +326,16 @@ def itemExists(items, pattern, field, flags=0): """ Returns if given item exists in the Database. - :param items: Database items. ( List ) - :param pattern: Filtering pattern. ( String ) - :param field: Database field to search into. ( String ) - :param flags: Flags passed to the regex engine. ( Integer ) - :return: Filtered items. ( List ) + :param items: Database items. + :type items: list + :param pattern: Filtering pattern. + :type pattern: unicode + :param field: Database field to search into. + :type field: unicode + :param flags: Flags passed to the regex engine. + :type flags: int + :return: Filtered items. + :rtype: list """ return filterItems(items, pattern, field, flags) and True or False @@ -303,8 +344,10 @@ def getIblSets(session=None): """ Returns the Ibl Sets from the Database. - :param session: Database session. ( Session ) - :return: Database Ibl Sets. ( List ) + :param session: Database session. + :type session: Session + :return: Database Ibl Sets. + :rtype: list """ return getSession(session).query(IblSet) @@ -313,11 +356,16 @@ def filterIblSets(pattern, field, flags=0, session=None): """ Filters the sets from the Database. - :param pattern: Filtering pattern. ( String ) - :param field: Database field to search into. ( String ) - :param flags: Flags passed to the regex engine. ( Integer ) - :param session: Database session. ( Session ) - :return: Filtered Ibl Sets. ( List ) + :param pattern: Filtering pattern. + :type pattern: unicode + :param field: Database field to search into. + :type field: unicode + :param flags: Flags passed to the regex engine. + :type flags: int + :param session: Database session. + :type session: Session + :return: Filtered Ibl Sets. + :rtype: list """ return filterItems(getIblSets(getSession(session)), pattern, field, flags) @@ -326,9 +374,12 @@ def iblSetExists(path, session=None): """ Returns if given Ibl Set exists in the Database. - :param name: Ibl Set path. ( String ) - :param session: Database session. ( Session ) - :return: Ibl Set exists. ( Boolean ) + :param name: Ibl Set path. + :type name: unicode + :param session: Database session. + :type session: Session + :return: Ibl Set exists. + :rtype: bool """ return filterIblSets("^{0}$".format(re.escape(path)), "path", session=getSession(session)) and True or False @@ -337,11 +388,16 @@ def addIblSet(name, path, collection, session=None): """ Adds a new Ibl Set to the Database. - :param name: Ibl Set name. ( String ) - :param path: Ibl Set path. ( String ) - :param collection: Collection id. ( String ) - :param session: Database session. ( Session ) - :return: Database commit success. ( Boolean ) + :param name: Ibl Set name. + :type name: unicode + :param path: Ibl Set path. + :type path: unicode + :param collection: Collection id. + :type collection: unicode + :param session: Database session. + :type session: Session + :return: Database commit success. + :rtype: bool """ return addStandardItem(IblSet, name, path, collection, getSession(session)) @@ -350,9 +406,12 @@ def removeIblSet(identity, session=None): """ Removes an Ibl Set from the Database. - :param identity: Ibl Set id. ( String ) - :param session: Database session. ( Session ) - :return: Database commit success. ( Boolean ) + :param identity: Ibl Set id. + :type identity: unicode + :param session: Database session. + :type session: Session + :return: Database commit success. + :rtype: bool """ return removeStandardItem(IblSet, identity, getSession(session)) @@ -361,9 +420,12 @@ def updateIblSetContent(iblSet, session=None): """ Update an Ibl Set content. - :param iblSet: Ibl Set to set content. ( IblSet ) - :param session: Database session. ( Session ) - :return: Database commit success. ( Boolean ) + :param iblSet: Ibl Set to set content. + :type iblSet: IblSet + :param session: Database session. + :type session: Session + :return: Database commit success. + :rtype: bool """ return updateItemContent(iblSet, getSession(session)) @@ -372,10 +434,14 @@ def updateIblSetLocation(iblSet, path, session=None): """ Updates an Ibl Set location. - :param iblSet: Ibl Set to update. ( IblSet ) - :param path: Ibl Set path. ( Path ) - :param session: Database session. ( Session ) - :return: Database commit success. ( Boolean ) + :param iblSet: Ibl Set to update. + :type iblSet: IblSet + :param path: Ibl Set path. + :type path: Path + :param session: Database session. + :type session: Session + :return: Database commit success. + :rtype: bool """ return updateItemLocation(iblSet, path, getSession(session)) @@ -384,8 +450,10 @@ def checkIblSetsTableIntegrity(session=None): """ Checks sets table integrity. - :param session: Database session. ( Session ) - :return: Ibl Sets table erroneous items. ( Dictionary ) + :param session: Database session. + :type session: Session + :return: Ibl Sets table erroneous items. + :rtype: dict """ LOGGER.debug("> Checking 'Sets' Database table integrity.") @@ -424,8 +492,10 @@ def getCollections(session=None): """ Returns the Collections from the Database. - :param session: Database session. ( Session ) - :return: Database Collections. ( List ) + :param session: Database session. + :type session: Session + :return: Database Collections. + :rtype: list """ return getSession(session).query(Collection) @@ -434,11 +504,16 @@ def filterCollections(pattern, field, flags=0, session=None): """ Filters the Collections from the Database. - :param pattern: Filtering pattern. ( String ) - :param field: Database field to search into. ( String ) - :param flags: Flags passed to the regex engine. ( Integer ) - :param session: Database session. ( Session ) - :return: Filtered Collections. ( List ) + :param pattern: Filtering pattern. + :type pattern: unicode + :param field: Database field to search into. + :type field: unicode + :param flags: Flags passed to the regex engine. + :type flags: int + :param session: Database session. + :type session: Session + :return: Filtered Collections. + :rtype: list """ return filterItems(getCollections(getSession(session)), pattern, field, flags) @@ -447,9 +522,12 @@ def getCollectionsByType(type, session=None): """ Returns Collections of given type. - :param type: Type name. ( String ) - :param session: Database session. ( Session ) - :return: Ibl Sets Collections. ( List ) + :param type: Type name. + :type type: unicode + :param session: Database session. + :type session: Session + :return: Ibl Sets Collections. + :rtype: list """ return [collection for collection in filterCollections(type, "type", session=getSession(session))] @@ -458,12 +536,18 @@ def filterCollectionsByType(type, pattern, field, flags=0, session=None): """ Filters the Ibl Sets Collections from the Database. - :param type: Type name. ( String ) - :param pattern: Filtering pattern. ( String ) - :param field: Database field to search into. ( String ) - :param flags: Flags passed to the regex engine. ( Integer ) - :param session: Database session. ( Session ) - :return: Filtered Collections. ( List ) + :param type: Type name. + :type type: unicode + :param pattern: Filtering pattern. + :type pattern: unicode + :param field: Database field to search into. + :type field: unicode + :param flags: Flags passed to the regex engine. + :type flags: int + :param session: Database session. + :type session: Session + :return: Filtered Collections. + :rtype: list """ return list(set(getCollectionsByType(type, session)).intersection( @@ -473,11 +557,16 @@ def filterIblSetsCollections(pattern, field, flags=0, session=None): """ Filters the Ibl Sets Collections from the Database. - :param pattern: Filtering pattern. ( String ) - :param field: Database field to search into. ( String ) - :param flags: Flags passed to the regex engine. ( Integer ) - :param session: Database session. ( Session ) - :return: Filtered Collections. ( List ) + :param pattern: Filtering pattern. + :type pattern: unicode + :param field: Database field to search into. + :type field: unicode + :param flags: Flags passed to the regex engine. + :type flags: int + :param session: Database session. + :type session: Session + :return: Filtered Collections. + :rtype: list """ return filterCollectionsByType("IblSets", pattern, field, flags, getSession(session)) @@ -486,11 +575,16 @@ def filterTemplatesCollections(pattern, field, flags=0, session=None): """ Filters the Templates Collections from the Database. - :param pattern: Filtering pattern. ( String ) - :param field: Database field to search into. ( String ) - :param flags: Flags passed to the regex engine. ( Integer ) - :param session: Database session. ( Session ) - :return: Filtered Collections. ( List ) + :param pattern: Filtering pattern. + :type pattern: unicode + :param field: Database field to search into. + :type field: unicode + :param flags: Flags passed to the regex engine. + :type flags: int + :param session: Database session. + :type session: Session + :return: Filtered Collections. + :rtype: list """ return filterCollectionsByType("Templates", pattern, field, flags, getSession(session)) @@ -499,9 +593,12 @@ def collectionExists(name, session=None): """ Returns if the Collection exists in the Database. - :param name: Collection name. ( String ) - :param session: Database session. ( Session ) - :return: Collection exists. ( Boolean ) + :param name: Collection name. + :type name: unicode + :param session: Database session. + :type session: Session + :return: Collection exists. + :rtype: bool """ return filterCollections("^{0}$".format(name), "name", session=getSession(session)) and True or False @@ -510,11 +607,16 @@ def addCollection(collection, type, comment, session=None): """ Adds a Collection to the Database. - :param collection: Collection name. ( String ) - :param type: Collection type. ( String ) - :param comment: Collection comment. ( String ) - :param session: Database session. ( Session ) - :return: Database commit success. ( Boolean ) + :param collection: Collection name. + :type collection: unicode + :param type: Collection type. + :type type: unicode + :param comment: Collection comment. + :type comment: unicode + :param session: Database session. + :type session: Session + :return: Database commit success. + :rtype: bool """ LOGGER.debug("> Adding: '{0}' Collection of type '{1}' to the Database.".format(collection, type)) @@ -532,9 +634,12 @@ def removeCollection(identity, session=None): """ Removes a Collection from the Database. - :param identity: Collection id. ( String ) - :param session: Database session. ( Session ) - :return: Database commit success. ( Boolean ) + :param identity: Collection id. + :type identity: unicode + :param session: Database session. + :type session: Session + :return: Database commit success. + :rtype: bool """ return removeStandardItem(Collection, identity, getSession(session)) @@ -543,9 +648,12 @@ def getCollectionsIblSets(identities, session=None): """ Returns Ibl Sets from Collections ids - :param identities: Collections ids. ( List ) - :param session: Database session. ( Session ) - :return: Ibl Sets list. ( List ) + :param identities: Collections ids. + :type identities: list + :param session: Database session. + :type session: Session + :return: Ibl Sets list. + :rtype: list """ iblSets = [] @@ -560,9 +668,12 @@ def getCollectionIblSetsCount(collection, session=None): """ Returns given Collection Ibl Sets count. - :param collection: Collection. ( Collection ) - :param session: Database session. ( Session ) - :return: Collection Ibl Sets count. ( Integer ) + :param collection: Collection. + :type collection: Collection + :param session: Database session. + :type session: Session + :return: Collection Ibl Sets count. + :rtype: int """ return getSession(session).query(IblSet).filter_by(collection=collection.id).count() @@ -571,9 +682,12 @@ def getCollectionTemplatesCount(collection, session=None): """ Returns given Collection Tempates count. - :param collection: Collection. ( Collection ) - :param session: Database session. ( Session ) - :return: Collection Templates count. ( Integer ) + :param collection: Collection. + :type collection: Collection + :param session: Database session. + :type session: Session + :return: Collection Templates count. + :rtype: int """ return getSession(session).query(Template).filter_by(collection=collection.id).count() @@ -582,8 +696,10 @@ def getTemplates(session=None): """ Returns the Templates from the Database. - :param session: Database session. ( Session ) - :return: Database Templates. ( List ) + :param session: Database session. + :type session: Session + :return: Database Templates. + :rtype: list """ return getSession(session).query(Template) @@ -592,11 +708,16 @@ def filterTemplates(pattern, field, flags=0, session=None): """ Filters the Templates from the Database. - :param pattern: Filtering pattern. ( String ) - :param field: Database field to search into. ( String ) - :param flags: Flags passed to the regex engine. ( Integer ) - :param session: Database session. ( Session ) - :return: Filtered Templates. ( List ) + :param pattern: Filtering pattern. + :type pattern: unicode + :param field: Database field to search into. + :type field: unicode + :param flags: Flags passed to the regex engine. + :type flags: int + :param session: Database session. + :type session: Session + :return: Filtered Templates. + :rtype: list """ return filterItems(getTemplates(getSession(session)), pattern, field, flags) @@ -605,9 +726,12 @@ def templateExists(path, session=None): """ Returns if given Template exists in the Database. - :param name: Template path. ( String ) - :param session: Database session. ( Session ) - :return: Template exists. ( Boolean ) + :param name: Template path. + :type name: unicode + :param session: Database session. + :type session: Session + :return: Template exists. + :rtype: bool """ return filterTemplates("^{0}$".format(re.escape(path)), "path", session=getSession(session)) and True or False @@ -616,11 +740,16 @@ def addTemplate(name, path, collection, session=None): """ Adds a new Template to the Database. - :param name: Template name. ( String ) - :param path: Template path. ( String ) - :param collection: Collection id. ( String ) - :param session: Database session. ( Session ) - :return: Database commit success. ( Boolean ) + :param name: Template name. + :type name: unicode + :param path: Template path. + :type path: unicode + :param collection: Collection id. + :type collection: unicode + :param session: Database session. + :type session: Session + :return: Database commit success. + :rtype: bool """ return addStandardItem(Template, name, path, collection, getSession(session)) @@ -629,9 +758,12 @@ def removeTemplate(identity, session=None): """ Removes a Template from the Database. - :param identity: Template id. ( String ) - :param session: Database session. ( Session ) - :return: Database commit success. ( Boolean ) + :param identity: Template id. + :type identity: unicode + :param session: Database session. + :type session: Session + :return: Database commit success. + :rtype: bool """ return removeStandardItem(Template, identity, getSession(session)) @@ -640,9 +772,12 @@ def updateTemplateContent(template, session=None): """ Update a Template content. - :param template: Template to Template content. ( Template ) - :param session: Database session. ( Session ) - :return: Database commit success. ( Boolean ) + :param template: Template to Template content. + :type template: Template + :param session: Database session. + :type session: Session + :return: Database commit success. + :rtype: bool """ return updateItemContent(template, getSession(session)) @@ -651,10 +786,14 @@ def updateTemplateLocation(template, path, session=None): """ Updates a Template location. - :param template: Template to update. ( Template ) - :param path: Template path. ( Path ) - :param session: Database session. ( Session ) - :return: Database commit success. ( Boolean ) + :param template: Template to update. + :type template: Template + :param path: Template path. + :type path: Path + :param session: Database session. + :type session: Session + :return: Database commit success. + :rtype: bool """ return updateItemLocation(template, path, getSession(session)) @@ -663,8 +802,10 @@ def checkTemplatesTableIntegrity(session=None): """ Checks Templates table integrity. - :param session: Database session. ( Session ) - :return: Templates table erroneous items. ( Dictionary ) + :param session: Database session. + :type session: Session + :return: Templates table erroneous items. + :rtype: dict """ LOGGER.debug("> Checking 'Templates' Database table integrity.") diff --git a/sibl_gui/components/core/database/types.py b/sibl_gui/components/core/database/types.py index a3a8cae6..4e9c4bb4 100644 --- a/sibl_gui/components/core/database/types.py +++ b/sibl_gui/components/core/database/types.py @@ -104,24 +104,42 @@ def __init__(self, """ Initializes the class. - :param name: Ibl Set name. ( String ) - :param path: Ibl Set file path. ( String ) - :param osStats: Ibl Set file statistics. ( String ) - :param collection: Ibl Set collection. ( String ) - :param title: Ibl Set title. ( String ) - :param author: Ibl Set author. ( String ) - :param link: Ibl Set online link. ( String ) - :param icon: Ibl Set icon path. ( String ) - :param previewImage: Ibl Set preview image path. ( String ) - :param backgroundImage: Ibl Set background image path. ( String ) - :param lightingImage: Ibl Set lighting image path. ( String ) - :param reflectionImage: Ibl Set reflection image path. ( String ) - :param location: Ibl Set location. ( String ) - :param latitude: Ibl Set latitude. ( String ), - :param longitude: Ibl Set longitude. ( String ) - :param date: Ibl Set shot date. ( String ) - :param time: Ibl Set shot time. ( String ) - :param comment: Ibl Set comment. ( String ) + :param name: Ibl Set name. + :type name: unicode + :param path: Ibl Set file path. + :type path: unicode + :param osStats: Ibl Set file statistics. + :type osStats: unicode + :param collection: Ibl Set collection. + :type collection: unicode + :param title: Ibl Set title. + :type title: unicode + :param author: Ibl Set author. + :type author: unicode + :param link: Ibl Set online link. + :type link: unicode + :param icon: Ibl Set icon path. + :type icon: unicode + :param previewImage: Ibl Set preview image path. + :type previewImage: unicode + :param backgroundImage: Ibl Set background image path. + :type backgroundImage: unicode + :param lightingImage: Ibl Set lighting image path. + :type lightingImage: unicode + :param reflectionImage: Ibl Set reflection image path. + :type reflectionImage: unicode + :param location: Ibl Set location. + :type location: unicode + :param latitude: Ibl Set latitude. + :type latitude: unicode + :param longitude: Ibl Set longitude. + :type longitude: unicode + :param date: Ibl Set shot date. + :type date: unicode + :param time: Ibl Set shot time. + :type time: unicode + :param comment: Ibl Set comment. + :type comment: unicode """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -151,7 +169,8 @@ def setContent(self): """ Initializes the class attributes. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ sectionsFileParser = SectionsFileParser(self.path) @@ -234,22 +253,38 @@ def __init__(self, """ Initializes the class. - :param name: Template name. ( String ) - :param path: Template file path. ( String ) - :param osStats: Template file statistics. ( String ) - :param collection: Template collection. ( String ) - :param helpFile: Template help file path. ( String ) - :param title: Template title. ( String ) - :param author: Template author. ( String ) - :param email: Template author email. ( String ) - :param url: Template online link. ( String ) - :param release: Template release version. ( String ) - :param date: Template release date. ( String ) - :param software: Template target software. ( String ) - :param version: Template target software version. ( String ) - :param renderer: Template target renderer. ( String ) - :param outputScript: Template loader script name. ( String ) - :param comment: Template comment. ( String ) + :param name: Template name. + :type name: unicode + :param path: Template file path. + :type path: unicode + :param osStats: Template file statistics. + :type osStats: unicode + :param collection: Template collection. + :type collection: unicode + :param helpFile: Template help file path. + :type helpFile: unicode + :param title: Template title. + :type title: unicode + :param author: Template author. + :type author: unicode + :param email: Template author email. + :type email: unicode + :param url: Template online link. + :type url: unicode + :param release: Template release version. + :type release: unicode + :param date: Template release date. + :type date: unicode + :param software: Template target software. + :type software: unicode + :param version: Template target software version. + :type version: unicode + :param renderer: Template target renderer. + :type renderer: unicode + :param outputScript: Template loader script name. + :type outputScript: unicode + :param comment: Template comment. + :type comment: unicode """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -277,7 +312,8 @@ def setContent(self): """ Initializes the class attributes. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ sectionsFileParser = SectionsFileParser(self.path) @@ -335,9 +371,12 @@ def __init__(self, name=None, type=None, comment=None): """ Initializes the class. - :param name: Collection name. ( String ) - :param type: Collection type. ( String ) - :param comment: Collection comment. ( String ) + :param name: Collection name. + :type name: unicode + :param type: Collection type. + :type type: unicode + :param comment: Collection comment. + :type comment: unicode """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) diff --git a/sibl_gui/components/core/iblSetsOutliner/iblSetsOutliner.py b/sibl_gui/components/core/iblSetsOutliner/iblSetsOutliner.py index 9f243377..11ecc132 100644 --- a/sibl_gui/components/core/iblSetsOutliner/iblSetsOutliner.py +++ b/sibl_gui/components/core/iblSetsOutliner/iblSetsOutliner.py @@ -105,17 +105,22 @@ class IblSetsOutliner(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): """ This signal is emited by the :class:`IblSetsOutliner` class when the current active View is changed. ( pyqtSignal ) - :return: Current active view index. ( Integer ) + :return: Current active view index. + :rtype: int """ def __init__(self, parent=None, name=None, *args, **kwargs): """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param name: Component name. ( String ) - :param \*args: Arguments. ( \* ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param parent: Object parent. + :type parent: QObject + :param name: Component name. + :type name: unicode + :param \*args: Arguments. + :type \*args: \* + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -185,7 +190,8 @@ def uiResourcesDirectory(self): """ Property for **self.__uiResourcesDirectory** attribute. - :return: self.__uiResourcesDirectory. ( String ) + :return: self.__uiResourcesDirectory. + :rtype: unicode """ return self.__uiResourcesDirectory @@ -196,7 +202,8 @@ def uiResourcesDirectory(self, value): """ Setter for **self.__uiResourcesDirectory** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -217,7 +224,8 @@ def uiThumbnailsViewImage(self): """ Property for **self.__uiThumbnailsViewImage** attribute. - :return: self.__uiThumbnailsViewImage. ( String ) + :return: self.__uiThumbnailsViewImage. + :rtype: unicode """ return self.__uiThumbnailsViewImage @@ -228,7 +236,8 @@ def uiThumbnailsViewImage(self, value): """ Setter for **self.__uiThumbnailsViewImage** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -249,7 +258,8 @@ def uiColumnsViewImage(self): """ Property for **self.__uiColumnsViewImage** attribute. - :return: self.__uiColumnsViewImage. ( String ) + :return: self.__uiColumnsViewImage. + :rtype: unicode """ return self.__uiColumnsViewImage @@ -260,7 +270,8 @@ def uiColumnsViewImage(self, value): """ Setter for **self.__uiColumnsViewImage** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -281,7 +292,8 @@ def uiDetailsViewImage(self): """ Property for **self.__uiDetailsViewImage** attribute. - :return: self.__uiDetailsViewImage. ( String ) + :return: self.__uiDetailsViewImage. + :rtype: unicode """ return self.__uiDetailsViewImage @@ -292,7 +304,8 @@ def uiDetailsViewImage(self, value): """ Setter for **self.__uiDetailsViewImage** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -313,7 +326,8 @@ def uiLargestSizeImage(self): """ Property for **self.__uiLargestSizeImage** attribute. - :return: self.__uiLargestSizeImage. ( String ) + :return: self.__uiLargestSizeImage. + :rtype: unicode """ return self.__uiLargestSizeImage @@ -324,7 +338,8 @@ def uiLargestSizeImage(self, value): """ Setter for **self.__uiLargestSizeImage** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -345,7 +360,8 @@ def uiSmallestSizeImage(self): """ Property for **self.__uiSmallestSizeImage** attribute. - :return: self.__uiSmallestSizeImage. ( String ) + :return: self.__uiSmallestSizeImage. + :rtype: unicode """ return self.__uiSmallestSizeImage @@ -356,7 +372,8 @@ def uiSmallestSizeImage(self, value): """ Setter for **self.__uiSmallestSizeImage** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -377,7 +394,8 @@ def uiPanoramicLoadingImage(self): """ Property for **self.__uiPanoramicLoadingImage** attribute. - :return: self.__uiPanoramicLoadingImage. ( String ) + :return: self.__uiPanoramicLoadingImage. + :rtype: unicode """ return self.__uiPanoramicLoadingImage @@ -388,7 +406,8 @@ def uiPanoramicLoadingImage(self, value): """ Setter for **self.__uiPanoramicLoadingImage** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -409,7 +428,8 @@ def uiSquareLoadingImage(self): """ Property for **self.__uiSquareLoadingImage** attribute. - :return: self.__uiSquareLoadingImage. ( String ) + :return: self.__uiSquareLoadingImage. + :rtype: unicode """ return self.__uiSquareLoadingImage @@ -420,7 +440,8 @@ def uiSquareLoadingImage(self, value): """ Setter for **self.__uiSquareLoadingImage** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -440,7 +461,8 @@ def uiSwitchThumbnailsTypeImage(self): """ Property for **self.__uiSwitchThumbnailsTypeImage** attribute. - :return: self.__uiSwitchThumbnailsTypeImage. ( String ) + :return: self.__uiSwitchThumbnailsTypeImage. + :rtype: unicode """ return self.__uiSwitchThumbnailsTypeImage @@ -451,7 +473,8 @@ def uiSwitchThumbnailsTypeImage(self, value): """ Setter for **self.__uiSwitchThumbnailsTypeImage** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -472,7 +495,8 @@ def dockArea(self): """ Property for **self.__dockArea** attribute. - :return: self.__dockArea. ( Integer ) + :return: self.__dockArea. + :rtype: int """ return self.__dockArea @@ -483,7 +507,8 @@ def dockArea(self, value): """ Setter for **self.__dockArea** attribute. - :param value: Attribute value. ( Integer ) + :param value: Attribute value. + :type value: int """ raise foundations.exceptions.ProgrammingError( @@ -504,7 +529,8 @@ def engine(self): """ Property for **self.__engine** attribute. - :return: self.__engine. ( QObject ) + :return: self.__engine. + :rtype: QObject """ return self.__engine @@ -515,7 +541,8 @@ def engine(self, value): """ Setter for **self.__engine** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -536,7 +563,8 @@ def settings(self): """ Property for **self.__settings** attribute. - :return: self.__settings. ( QSettings ) + :return: self.__settings. + :rtype: QSettings """ return self.__settings @@ -547,7 +575,8 @@ def settings(self, value): """ Setter for **self.__settings** attribute. - :param value: Attribute value. ( QSettings ) + :param value: Attribute value. + :type value: QSettings """ raise foundations.exceptions.ProgrammingError( @@ -568,7 +597,8 @@ def settingsSection(self): """ Property for **self.__settingsSection** attribute. - :return: self.__settingsSection. ( String ) + :return: self.__settingsSection. + :rtype: unicode """ return self.__settingsSection @@ -579,7 +609,8 @@ def settingsSection(self, value): """ Setter for **self.__settingsSection** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -600,7 +631,8 @@ def settingsSeparator(self): """ Property for **self.__settingsSeparator** attribute. - :return: self.__settingsSeparator. ( String ) + :return: self.__settingsSeparator. + :rtype: unicode """ return self.__settingsSeparator @@ -611,7 +643,8 @@ def settingsSeparator(self, value): """ Setter for **self.__settingsSeparator** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -632,7 +665,8 @@ def extension(self): """ Property for **self.__extension** attribute. - :return: self.__extension. ( String ) + :return: self.__extension. + :rtype: unicode """ return self.__extension @@ -643,7 +677,8 @@ def extension(self, value): """ Setter for **self.__extension** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -664,7 +699,8 @@ def inspectLayout(self): """ Property for **self.__inspectLayout** attribute. - :return: self.__inspectLayout. ( String ) + :return: self.__inspectLayout. + :rtype: unicode """ return self.__inspectLayout @@ -675,7 +711,8 @@ def inspectLayout(self, value): """ Setter for **self.__inspectLayout** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -696,7 +733,8 @@ def scriptEditor(self): """ Property for **self.__scriptEditor** attribute. - :return: self.__scriptEditor. ( QWidget ) + :return: self.__scriptEditor. + :rtype: QWidget """ return self.__scriptEditor @@ -707,7 +745,8 @@ def scriptEditor(self, value): """ Setter for **self.__scriptEditor** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -728,7 +767,8 @@ def collectionsOutliner(self): """ Property for **self.__collectionsOutliner** attribute. - :return: self.__collectionsOutliner. ( QWidget ) + :return: self.__collectionsOutliner. + :rtype: QWidget """ return self.__collectionsOutliner @@ -739,7 +779,8 @@ def collectionsOutliner(self, value): """ Setter for **self.__collectionsOutliner** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -760,7 +801,8 @@ def model(self): """ Property for **self.__model** attribute. - :return: self.__model. ( IblSetsModel ) + :return: self.__model. + :rtype: IblSetsModel """ return self.__model @@ -771,7 +813,8 @@ def model(self, value): """ Setter for **self.__model** attribute. - :param value: Attribute value. ( IblSetsModel ) + :param value: Attribute value. + :type value: IblSetsModel """ raise foundations.exceptions.ProgrammingError( @@ -792,7 +835,8 @@ def views(self): """ Property for **self.__views** attribute. - :return: self.__views. ( Tuple ) + :return: self.__views. + :rtype: tuple """ return self.__views @@ -803,7 +847,8 @@ def views(self, value): """ Setter for **self.__views** attribute. - :param value: Attribute value. ( Tuple ) + :param value: Attribute value. + :type value: tuple """ raise foundations.exceptions.ProgrammingError( @@ -824,7 +869,8 @@ def viewsPushButtons(self): """ Property for **self.__viewsPushButtons** attribute. - :return: self.__viewsPushButtons. ( Dictionary ) + :return: self.__viewsPushButtons. + :rtype: dict """ return self.__viewsPushButtons @@ -835,7 +881,8 @@ def viewsPushButtons(self, value): """ Setter for **self.__viewsPushButtons** attribute. - :param value: Attribute value. ( Dictionary ) + :param value: Attribute value. + :type value: dict """ raise foundations.exceptions.ProgrammingError( @@ -856,7 +903,8 @@ def thumbnailsView(self): """ Property for **self.__thumbnailsView** attribute. - :return: self.__thumbnailsView. ( QListView ) + :return: self.__thumbnailsView. + :rtype: QListView """ return self.__thumbnailsView @@ -867,7 +915,8 @@ def thumbnailsView(self, value): """ Setter for **self.__thumbnailsView** attribute. - :param value: Attribute value. ( QListView ) + :param value: Attribute value. + :type value: QListView """ raise foundations.exceptions.ProgrammingError( @@ -888,7 +937,8 @@ def detailsView(self): """ Property for **self.__detailsView** attribute. - :return: self.__detailsView. ( QTreeView ) + :return: self.__detailsView. + :rtype: QTreeView """ return self.__detailsView @@ -899,7 +949,8 @@ def detailsView(self, value): """ Setter for **self.__detailsView** attribute. - :param value: Attribute value. ( QTreeView ) + :param value: Attribute value. + :type value: QTreeView """ raise foundations.exceptions.ProgrammingError( @@ -920,7 +971,8 @@ def detailsViewHeaders(self): """ Property for **self.__detailsViewHeaders** attribute. - :return: self.__detailsViewHeaders. ( OrderedDict ) + :return: self.__detailsViewHeaders. + :rtype: OrderedDict """ return self.__detailsViewHeaders @@ -931,7 +983,8 @@ def detailsViewHeaders(self, value): """ Setter for **self.__detailsViewHeaders** attribute. - :param value: Attribute value. ( OrderedDict ) + :param value: Attribute value. + :type value: OrderedDict """ raise foundations.exceptions.ProgrammingError( @@ -952,7 +1005,8 @@ def panoramicThumbnails(self): """ Property for **self.__panoramicThumbnails** attribute. - :return: self.__panoramicThumbnails. ( Boolean ) + :return: self.__panoramicThumbnails. + :rtype: bool """ return self.__panoramicThumbnails @@ -963,7 +1017,8 @@ def panoramicThumbnails(self, value): """ Setter for **self.__panoramicThumbnails** attribute. - :param value: Attribute value. ( Boolean ) + :param value: Attribute value. + :type value: bool """ if value is not None: @@ -985,7 +1040,8 @@ def panoramicThumbnailsSize(self): """ Property for **self.__panoramicThumbnailsSize** attribute. - :return: self.__panoramicThumbnailsSize. ( String ) + :return: self.__panoramicThumbnailsSize. + :rtype: unicode """ return self.__panoramicThumbnailsSize @@ -996,7 +1052,8 @@ def panoramicThumbnailsSize(self, value): """ Setter for **self.__panoramicThumbnailsSize** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ if value is not None: @@ -1018,7 +1075,8 @@ def squareThumbnailsSize(self): """ Property for **self.__squareThumbnailsSize** attribute. - :return: self.__squareThumbnailsSize. ( String ) + :return: self.__squareThumbnailsSize. + :rtype: unicode """ return self.__squareThumbnailsSize @@ -1029,7 +1087,8 @@ def squareThumbnailsSize(self, value): """ Setter for **self.__squareThumbnailsSize** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ if value is not None: @@ -1051,7 +1110,8 @@ def thumbnailsMinimumSize(self): """ Property for **self.__thumbnailsMinimumSize** attribute. - :return: self.__thumbnailsMinimumSize. ( Dictionary ) + :return: self.__thumbnailsMinimumSize. + :rtype: dict """ return self.__thumbnailsMinimumSize @@ -1062,7 +1122,8 @@ def thumbnailsMinimumSize(self, value): """ Setter for **self.__thumbnailsMinimumSize** attribute. - :param value: Attribute value. ( Dictionary ) + :param value: Attribute value. + :type value: dict """ if value is not None: @@ -1084,7 +1145,8 @@ def searchContexts(self): """ Property for **self.__searchContexts** attribute. - :return: self.__searchContexts. ( OrderedDict ) + :return: self.__searchContexts. + :rtype: OrderedDict """ return self.__searchContexts @@ -1095,7 +1157,8 @@ def searchContexts(self, value): """ Setter for **self.__searchContexts** attribute. - :param value: Attribute value. ( OrderedDict ) + :param value: Attribute value. + :type value: OrderedDict """ raise foundations.exceptions.ProgrammingError( @@ -1116,7 +1179,8 @@ def activeSearchContext(self): """ Property for **self.__activeSearchContext** attribute. - :return: self.__activeSearchContext. ( OrderedDict ) + :return: self.__activeSearchContext. + :rtype: OrderedDict """ return self.__activeSearchContext @@ -1127,7 +1191,8 @@ def activeSearchContext(self, value): """ Setter for **self.__activeSearchContext** attribute. - :param value: Attribute value. ( OrderedDict ) + :param value: Attribute value. + :type value: OrderedDict """ raise foundations.exceptions.ProgrammingError( @@ -1148,7 +1213,8 @@ def searchContextMenu(self): """ Property for **self.__searchContextMenu** attribute. - :return: self.__searchContextMenu. ( QMenu ) + :return: self.__searchContextMenu. + :rtype: QMenu """ return self.__searchContextMenu @@ -1182,8 +1248,10 @@ def activate(self, engine): """ Activates the Component. - :param engine: Engine to attach the Component to. ( QObject ) - :return: Method success. ( Boolean ) + :param engine: Engine to attach the Component to. + :type engine: QObject + :return: Method success. + :rtype: bool """ LOGGER.debug("> Activating '{0}' Component.".format(self.__class__.__name__)) @@ -1212,7 +1280,8 @@ def initializeUi(self): """ Initializes the Component ui. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Initializing '{0}' Component ui.".format(self.__class__.__name__)) @@ -1314,7 +1383,8 @@ def addWidget(self): """ Adds the Component Widget to the engine. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Adding '{0}' Component Widget.".format(self.__class__.__name__)) @@ -1337,7 +1407,8 @@ def onStartup(self): """ Defines the slot triggered on Framework startup. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Calling '{0}' Component Framework 'onStartup' method.".format(self.__class__.__name__)) @@ -1402,7 +1473,8 @@ def onClose(self): """ Defines the slot triggered on Framework close. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Calling '{0}' Component Framework 'onClose' method.".format(self.__class__.__name__)) @@ -1422,7 +1494,8 @@ def __views_setUi(self, thumbnailsSize=None): """ Sets the Views ui. - :param thumbnailsSize: Thumbnails size. ( Integer ) + :param thumbnailsSize: Thumbnails size. + :type thumbnailsSize: int """ if not thumbnailsSize: @@ -1446,7 +1519,8 @@ def __views_refreshUi(self, thumbnailsSize=None): """ Refreshes the Views ui. - :param thumbnailsSize: Thumbnails size. ( Integer ) + :param thumbnailsSize: Thumbnails size. + :type thumbnailsSize: int """ self.__views_setUi(thumbnailsSize) @@ -1495,8 +1569,10 @@ def __views_addContentAction__triggered(self, checked): """ Defines the slot triggered by **'Actions|Umbra|Components|core.iblSetsOutliner|Add Content ...'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ return self.addContentUi() @@ -1505,8 +1581,10 @@ def __views_addIblSetAction__triggered(self, checked): """ Defines the slot triggered by **'Actions|Umbra|Components|core.iblSetsOutliner|Add Ibl Set ...'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ return self.addIblSetUi() @@ -1515,8 +1593,10 @@ def __views_removeIblSetsAction__triggered(self, checked): """ Defines the slot triggered by **'Actions|Umbra|Components|core.iblSetsOutliner|Remove Ibl Set(s) ...'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ return self.removeIblSetsUi() @@ -1526,8 +1606,10 @@ def __views_updateIblSetsLocationsAction__triggered(self, checked): Defines the slot triggered by **'Actions|Umbra|Components|core.iblSetsOutliner|Update Ibl Set(s) Location(s) ...'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ return self.updateSelectedIblSetsLocationUi() @@ -1536,8 +1618,10 @@ def __views_pushButtons__clicked(self, index, checked): """ Defines the slot triggered by **\*_View_pushButton** Widget when clicked. - :param index: Button index. ( Integer ) - :param checked: Checked state. ( Boolean ) + :param index: Button index. + :type index: int + :param checked: Checked state. + :type checked: bool """ self.setActiveViewIndex(index) @@ -1546,7 +1630,8 @@ def __views__doubleClicked(self, index): """ Defines the slot triggered by a **\*_View** Widget when double clicked. - :param index: Clicked item index. ( QModelIndex ) + :param index: Clicked item index. + :type index: QModelIndex """ self.__engine.layoutsManager.restoreLayout(self.__inspectLayout) @@ -1555,7 +1640,8 @@ def __views__activeViewChanged(self, index): """ Defines the slot triggered by the active View changed. - :param index: Current active View. ( integer ) + :param index: Current active View. + :type index: int """ self.Ibl_Sets_Outliner_Thumbnails_Slider_frame.setVisible(not index) @@ -1567,7 +1653,8 @@ def __Switch_Thumbnails_Type_pushButton__clicked(self, checked): """ Defines the slot triggered by **Switch_Thumbnails_Type_pushButton** Widget when clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ self.setPanoramicThumbnails(not self.__panoramicThumbnails) @@ -1576,7 +1663,8 @@ def __Search_Database_lineEdit__textChanged(self, text): """ Defines the slot triggered by **Search_Database_lineEdit** Widget when text changed. - :param text: Current text value. ( QString ) + :param text: Current text value. + :type text: QString """ self.setIblSets(self.__searchIblSets(foundations.strings.toString(self.Search_Database_lineEdit.text()), @@ -1587,7 +1675,8 @@ def __Thumbnails_Size_horizontalSlider__changed(self, value): """ Scales the View icons. - :param value: Thumbnails size. ( Integer ) + :param value: Thumbnails size. + :type value: int """ self.__thumbnailsView._Thumbnails_QListView__setDefaultUiState(value, 2 if self.__panoramicThumbnails else 1) @@ -1603,7 +1692,8 @@ def __engine__contentDropped(self, event): """ Defines the slot triggered by content when dropped into the engine. - :param event: Event. ( QEvent ) + :param event: Event. + :type event: QEvent """ if not event.mimeData().hasUrls(): @@ -1648,7 +1738,8 @@ def __engine_fileSystemEventsManager__fileChanged(self, file): """ Defines the slot triggered by **fileSystemEventsManager** when a file is changed. - :param file: File changed. ( String ) + :param file: File changed. + :type file: unicode """ iblSet = foundations.common.getFirstItem(filter(lambda x: x.path == file, self.getIblSets())) @@ -1665,7 +1756,8 @@ def __getCandidateCollectionId(self): """ Returns a Collection id. - :return: Collection id. ( Integer ) + :return: Collection id. + :rtype: int """ collections = self.__collectionsOutliner.getSelectedCollections() @@ -1678,11 +1770,15 @@ def __searchIblSets(self, pattern, attribute, flags=re.IGNORECASE): """ Filters the current Collection Ibl Sets. - :param pattern: Ibl Sets filter pattern. ( String ) - :param attribute: Attribute to filter Ibl Sets on. ( String ) - :param flags: Regex filtering flags. ( Integer ) + :param pattern: Ibl Sets filter pattern. + :type pattern: unicode + :param attribute: Attribute to filter Ibl Sets on. + :type attribute: unicode + :param flags: Regex filtering flags. + :type flags: int - :return: Filtered Ibl Sets. ( List ) + :return: Filtered Ibl Sets. + :rtype: list """ try: @@ -1705,7 +1801,8 @@ def getActiveView(self): """ Returns the current active View. - :return: Current active View. ( QWidget ) + :return: Current active View. + :rtype: QWidget """ return self.Ibl_Sets_Outliner_stackedWidget.currentWidget() @@ -1714,7 +1811,8 @@ def getActiveViewIndex(self): """ Returns the current active View index. - :return: Current active View index. ( Integer ) + :return: Current active View index. + :rtype: int """ return self.Ibl_Sets_Outliner_stackedWidget.currentIndex() @@ -1723,8 +1821,10 @@ def setActiveView(self, view): """ Sets the active View to given View. - :param view: View. ( QWidget ) - :return: Method success. ( Boolean ) + :param view: View. + :type view: QWidget + :return: Method success. + :rtype: bool """ index = self.Ibl_Sets_Outliner_stackedWidget.indexOf(view) @@ -1736,8 +1836,10 @@ def setActiveViewIndex(self, index): """ Sets the active View to given index. - :param index: Index. ( Integer ) - :return: Method success. ( Boolean ) + :param index: Index. + :type index: int + :return: Method success. + :rtype: bool """ self.Ibl_Sets_Outliner_stackedWidget.setCurrentIndex(index) @@ -1748,9 +1850,12 @@ def setActiveSearchContext(self, context, *args): """ Sets the active search context. - :param context: Search context. ( String ) - :param \*args: Arguments. ( \* ) - :return: Method succes. ( Boolean ) + :param context: Search context. + :type context: unicode + :param \*args: Arguments. + :type \*args: \* + :return: Method succes. + :rtype: bool """ text = "{0} ...".format(context) @@ -1766,8 +1871,10 @@ def setPanoramicThumbnails(self, state): """ Sets the panoramic thumbnails. - :param state: Panoramic thumbnails. ( Boolean ) - :return: Method succes. ( Boolean ) + :param state: Panoramic thumbnails. + :type state: bool + :return: Method succes. + :rtype: bool """ oldIn, oldOut = UiConstants.thumbnailsSizes.get(self.__thumbnailsMinimumSize), UiConstants.thumbnailsSizes.get( @@ -1791,7 +1898,8 @@ def addContentUi(self): """ Adds user defined content to the Database. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -1815,7 +1923,8 @@ def addIblSetUi(self): """ Adds an user defined Ibl Set to the Database. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -1844,7 +1953,8 @@ def removeIblSetsUi(self): """ Removes user selected Ibl Sets from the Database. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -1877,8 +1987,10 @@ def updateIblSetLocationUi(self, iblSet): """ Updates given Ibl Set location. - :param iblSet: Ibl Set to update. ( IblSet ) - :return: Method success. ( Boolean ) + :param iblSet: Ibl Set to update. + :type iblSet: IblSet + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -1905,7 +2017,8 @@ def updateSelectedIblSetsLocationUi(self): """ Updates user selected Ibl Sets locations. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -1935,10 +2048,14 @@ def addIblSet(self, name, path, collectionId=None): """ Adds an Ibl Set to the Database. - :param name: Ibl Set name. ( String ) - :param path: Ibl Set path. ( String ) - :param collectionId: Target Collection id. ( Integer ) - :return: Method success. ( Boolean ) + :param name: Ibl Set name. + :type name: unicode + :param path: Ibl Set path. + :type path: unicode + :param collectionId: Target Collection id. + :type collectionId: int + :return: Method success. + :rtype: bool """ if not self.iblSetExists(path): @@ -1960,9 +2077,12 @@ def addDirectory(self, directory, collectionId=None): """ Adds directory Ibl Sets to the Database. - :param directory: Directory to add. ( String ) - :param collectionId: Target Collection id. ( Integer ) - :return: Method success. ( Boolean ) + :param directory: Directory to add. + :type directory: unicode + :param collectionId: Target Collection id. + :type collectionId: int + :return: Method success. + :rtype: bool """ LOGGER.debug("> Initializing directory '{0}' filesWalker.".format(directory)) @@ -1994,8 +2114,10 @@ def removeIblSet(self, iblSet): """ Removes given Ibl Set from the Database. - :param iblSet: Ibl Set to remove. ( IblSet ) - :return: Method success. ( Boolean ) + :param iblSet: Ibl Set to remove. + :type iblSet: IblSet + :return: Method success. + :rtype: bool """ LOGGER.info("{0} | Removing '{1}' Ibl Set from the Database!".format(self.__class__.__name__, iblSet.title)) @@ -2012,9 +2134,12 @@ def updateIblSetLocation(self, iblSet, file): """ Updates given Ibl Set location. - :param iblSet: Ibl Set to update. ( IblSet ) - :param iblSet: New Ibl Set file. ( String ) - :return: Method success. ( Boolean ) + :param iblSet: Ibl Set to update. + :type iblSet: IblSet + :param iblSet: New Ibl Set file. + :type iblSet: unicode + :return: Method success. + :rtype: bool """ LOGGER.info("{0} | Updating '{1}' Ibl Set with new location: '{2}'!".format(self.__class__.__name__, @@ -2031,7 +2156,8 @@ def getIblSets(self): """ Returns Database Ibl Sets. - :return: Database Ibl Sets. ( List ) + :return: Database Ibl Sets. + :rtype: list """ return [iblSet for iblSet in sibl_gui.components.core.database.operations.getIblSets()] @@ -2040,11 +2166,15 @@ def filterIblSets(self, pattern, attribute, flags=re.IGNORECASE): """ Filters the Database Ibl Sets on given attribute using given pattern. - :param pattern: Filter pattern. ( String ) - :param attribute: Attribute to filter on. ( String ) - :param flags: Regex filtering flags. ( Integer ) + :param pattern: Filter pattern. + :type pattern: unicode + :param attribute: Attribute to filter on. + :type attribute: unicode + :param flags: Regex filtering flags. + :type flags: int - :return: Filtered Database Ibl Sets. ( List ) + :return: Filtered Database Ibl Sets. + :rtype: list """ try: @@ -2060,8 +2190,10 @@ def iblSetExists(self, path): """ Returns if given Ibl Set path exists in the Database. - :param path: Collection path. ( String ) - :return: Collection exists. ( Boolean ) + :param path: Collection path. + :type path: unicode + :return: Collection exists. + :rtype: bool """ return sibl_gui.components.core.database.operations.iblSetExists(path) @@ -2070,7 +2202,8 @@ def listIblSets(self): """ Lists Database Ibl Sets names. - :return: Database Ibl Sets names. ( List ) + :return: Database Ibl Sets names. + :rtype: list :note: The list is actually returned using 'title' attributes instead of 'name' attributes """ @@ -2081,8 +2214,10 @@ def setIblSets(self, iblSets=None): """ Sets the Ibl Sets Model nodes. - :param iblSets: Ibl Sets to set. ( List ) - :return: Method success. ( Boolean ) + :param iblSets: Ibl Sets to set. + :type iblSets: list + :return: Method success. + :rtype: bool """ nodeFlags = self.__engine.parameters.databaseReadOnly and int(Qt.ItemIsSelectable | Qt.ItemIsEnabled) or \ @@ -2125,8 +2260,10 @@ def getIblSetByName(self, name): """ Returns Database Ibl Set with given name. - :param name: Ibl Set name. ( String ) - :return: Database Ibl Set. ( IblSet ) + :param name: Ibl Set name. + :type name: unicode + :return: Database Ibl Set. + :rtype: IblSet :note: The filtering is actually performed on 'title' attributes instead of 'name' attributes. """ @@ -2138,7 +2275,8 @@ def getSelectedNodes(self): """ Returns the current active View selected nodes. - :return: View selected nodes. ( Dictionary ) + :return: View selected nodes. + :rtype: dict """ return self.getActiveView().getSelectedNodes() @@ -2147,7 +2285,8 @@ def getSelectedIblSetsNodes(self): """ Returns the current active View selected Ibl Sets nodes. - :return: View selected Ibl Sets nodes. ( List ) + :return: View selected Ibl Sets nodes. + :rtype: list """ return [node for node in self.getSelectedNodes() if node.family == "IblSet"] @@ -2156,7 +2295,8 @@ def getSelectedIblSets(self): """ Returns the current active View selected Ibl Sets. - :return: View selected Ibl Sets. ( List ) + :return: View selected Ibl Sets. + :rtype: list """ return [node.databaseItem for node in self.getSelectedIblSetsNodes()] diff --git a/sibl_gui/components/core/iblSetsOutliner/models.py b/sibl_gui/components/core/iblSetsOutliner/models.py index 9a22e54d..6157d989 100644 --- a/sibl_gui/components/core/iblSetsOutliner/models.py +++ b/sibl_gui/components/core/iblSetsOutliner/models.py @@ -59,10 +59,14 @@ def __init__(self, parent=None, rootNode=None, horizontalHeaders=None, verticalH """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param rootNode: Root node. ( AbstractCompositeNode ) - :param horizontalHeaders: Headers. ( OrderedDict ) - :param verticalHeaders: Headers. ( OrderedDict ) + :param parent: Object parent. + :type parent: QObject + :param rootNode: Root node. + :type rootNode: AbunicodeactCompositeNode + :param horizontalHeaders: Headers. + :type horizontalHeaders: OrderedDict + :param verticalHeaders: Headers. + :type verticalHeaders: OrderedDict """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -80,8 +84,10 @@ def initializeModel(self, rootNode): """ Initializes the Model using given root node. - :param rootNode: Graph root node. ( DefaultNode ) - :return: Method success ( Boolean ) + :param rootNode: Graph root node. + :type rootNode: DefaultNode + :return: Method success + :rtype: bool """ LOGGER.debug("> Initializing model with '{0}' root node.".format(rootNode)) @@ -96,9 +102,11 @@ def sort(self, column, order=Qt.AscendingOrder): """ Reimplements the :meth:`umbra.ui.models.GraphModel.sort` method. - :param column: Column. ( Integer ) + :param column: Column. + :type column: int :param order: Order. ( Qt.SortOrder ) - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ if column > self.columnCount(): diff --git a/sibl_gui/components/core/iblSetsOutliner/views.py b/sibl_gui/components/core/iblSetsOutliner/views.py index 6419b824..df7e4663 100644 --- a/sibl_gui/components/core/iblSetsOutliner/views.py +++ b/sibl_gui/components/core/iblSetsOutliner/views.py @@ -61,10 +61,14 @@ def __init__(self, parent, model=None, readOnly=False, message=None): """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param model: Model. ( QObject ) - :param readOnly: View is read only. ( Boolean ) - :param message: View default message when Model is empty. ( String ) + :param parent: Object parent. + :type parent: QObject + :param model: Model. + :type model: QObject + :param readOnly: View is read only. + :type readOnly: bool + :param message: View default message when Model is empty. + :type message: unicode """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -85,7 +89,8 @@ def listViewSpacing(self): """ Property for **self.__listViewSpacing** attribute. - :return: self.__listViewSpacing. ( Integer ) + :return: self.__listViewSpacing. + :rtype: int """ return self.__listViewSpacing @@ -96,7 +101,8 @@ def listViewSpacing(self, value): """ Setter for **self.__listViewSpacing** attribute. - :param value: Attribute value. ( Integer ) + :param value: Attribute value. + :type value: int """ if value is not None: @@ -119,7 +125,8 @@ def listViewMargin(self): """ Property for **self.__listViewMargin** attribute. - :return: self.__listViewMargin. ( Integer ) + :return: self.__listViewMargin. + :rtype: int """ return self.__listViewMargin @@ -130,7 +137,8 @@ def listViewMargin(self, value): """ Setter for **self.__listViewMargin** attribute. - :param value: Attribute value. ( Integer ) + :param value: Attribute value. + :type value: int """ if value is not None: @@ -172,8 +180,10 @@ def __setDefaultUiState(self, iconsSize=None, iconsRatio=2): """ Sets the Widget default ui state. - :param iconsSize: Icons size. ( Integer ) - :param iconRatio: Icons ratio. ( Integer ) + :param iconsSize: Icons size. + :type iconsSize: int + :param iconRatio: Icons ratio. + :type iconRatio: int """ LOGGER.debug("> Setting default View state!") @@ -194,10 +204,14 @@ def __init__(self, parent, model=None, readOnly=False, message=None): """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param model: Model. ( QObject ) - :param readOnly: View is read only. ( Boolean ) - :param message: View default message when Model is empty. ( String ) + :param parent: Object parent. + :type parent: QObject + :param model: Model. + :type model: QObject + :param readOnly: View is read only. + :type readOnly: bool + :param message: View default message when Model is empty. + :type message: unicode """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -217,7 +231,8 @@ def treeViewIndentation(self): """ Property for **self.__treeViewIndentation** attribute. - :return: self.__treeViewIndentation. ( Integer ) + :return: self.__treeViewIndentation. + :rtype: int """ return self.__treeViewIndentation @@ -228,7 +243,8 @@ def treeViewIndentation(self, value): """ Setter for **self.__treeViewIndentation** attribute. - :param value: Attribute value. ( Integer ) + :param value: Attribute value. + :type value: int """ raise foundations.exceptions.ProgrammingError( diff --git a/sibl_gui/components/core/inspector/inspector.py b/sibl_gui/components/core/inspector/inspector.py index 1d2bf070..6d1d9850 100644 --- a/sibl_gui/components/core/inspector/inspector.py +++ b/sibl_gui/components/core/inspector/inspector.py @@ -91,7 +91,8 @@ def __init__(self, **kwargs): """ Initializes the class. - :param kwargs: name, icon, previewImage, image ( Key / Value pairs ) + :param kwargs: name, icon, previewImage, image + :type kwargs: dict """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -107,7 +108,8 @@ def __init__(self, **kwargs): """ Initializes the class. - :param kwargs: name, color, uCoordinate, vCoordinate ( Key / Value pairs ) + :param kwargs: name, color, uCoordinate, vCoordinate + :type kwargs: dict """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -142,10 +144,14 @@ def __init__(self, parent=None, name=None, *args, **kwargs): """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param name: Component name. ( String ) - :param \*args: Arguments. ( \* ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param parent: Object parent. + :type parent: QObject + :param name: Component name. + :type name: unicode + :param \*args: Arguments. + :type \*args: \* + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -247,7 +253,8 @@ def uiResourcesDirectory(self): """ Property for **self.__uiResourcesDirectory** attribute. - :return: self.__uiResourcesDirectory. ( String ) + :return: self.__uiResourcesDirectory. + :rtype: unicode """ return self.__uiResourcesDirectory @@ -258,7 +265,8 @@ def uiResourcesDirectory(self, value): """ Setter for **self.__uiResourcesDirectory** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -279,7 +287,8 @@ def uiPreviousImage(self): """ Property for **self.__uiPreviousImage** attribute. - :return: self.__uiPreviousImage. ( String ) + :return: self.__uiPreviousImage. + :rtype: unicode """ return self.__uiPreviousImage @@ -290,7 +299,8 @@ def uiPreviousImage(self, value): """ Setter for **self.__uiPreviousImage** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -311,7 +321,8 @@ def uiNextImage(self): """ Property for **self.__uiNextImage** attribute. - :return: self.__uiNextImage. ( String ) + :return: self.__uiNextImage. + :rtype: unicode """ return self.__uiNextImage @@ -322,7 +333,8 @@ def uiNextImage(self, value): """ Setter for **self.__uiNextImage** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -343,7 +355,8 @@ def uiLoadingImage(self): """ Property for **self.__uiLoadingImage** attribute. - :return: self.__uiLoadingImage. ( String ) + :return: self.__uiLoadingImage. + :rtype: unicode """ return self.__uiLoadingImage @@ -354,7 +367,8 @@ def uiLoadingImage(self, value): """ Setter for **self.__uiLoadingImage** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -375,7 +389,8 @@ def dockArea(self): """ Property for **self.__dockArea** attribute. - :return: self.__dockArea. ( Integer ) + :return: self.__dockArea. + :rtype: int """ return self.__dockArea @@ -386,7 +401,8 @@ def dockArea(self, value): """ Setter for **self.__dockArea** attribute. - :param value: Attribute value. ( Integer ) + :param value: Attribute value. + :type value: int """ raise foundations.exceptions.ProgrammingError( @@ -407,7 +423,8 @@ def listViewIconSize(self): """ Property for **self.__listViewIconSize** attribute. - :return: self.__listViewIconSize. ( Integer ) + :return: self.__listViewIconSize. + :rtype: int """ return self.__listViewIconSize @@ -418,7 +435,8 @@ def listViewIconSize(self, value): """ Setter for **self.__listViewIconSize** attribute. - :param value: Attribute value. ( Integer ) + :param value: Attribute value. + :type value: int """ if value is not None: @@ -441,7 +459,8 @@ def engine(self): """ Property for **self.__engine** attribute. - :return: self.__engine. ( QObject ) + :return: self.__engine. + :rtype: QObject """ return self.__engine @@ -452,7 +471,8 @@ def engine(self, value): """ Setter for **self.__engine** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -473,7 +493,8 @@ def iblSetsOutliner(self): """ Property for **self.__iblSetsOutliner** attribute. - :return: self.__iblSetsOutliner. ( QWidget ) + :return: self.__iblSetsOutliner. + :rtype: QWidget """ return self.__iblSetsOutliner @@ -484,7 +505,8 @@ def iblSetsOutliner(self, value): """ Setter for **self.__iblSetsOutliner** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -505,7 +527,8 @@ def sectionsFileParsersCache(self): """ Property for **self.__sectionsFileParsersCache** attribute. - :return: self.__sectionsFileParsersCache. ( Cache ) + :return: self.__sectionsFileParsersCache. + :rtype: Cache """ return self.__sectionsFileParsersCache @@ -516,7 +539,8 @@ def sectionsFileParsersCache(self, value): """ Setter for **self.__sectionsFileParsersCache** attribute. - :param value: Attribute value. ( Cache ) + :param value: Attribute value. + :type value: Cache """ raise foundations.exceptions.ProgrammingError( @@ -537,7 +561,8 @@ def model(self): """ Property for **self.__model** attribute. - :return: self.__model. ( PlatesModel ) + :return: self.__model. + :rtype: PlatesModel """ return self.__model @@ -548,7 +573,8 @@ def model(self, value): """ Setter for **self.__model** attribute. - :param value: Attribute value. ( PlatesModel ) + :param value: Attribute value. + :type value: PlatesModel """ raise foundations.exceptions.ProgrammingError( @@ -569,7 +595,8 @@ def view(self): """ Property for **self.__view** attribute. - :return: self.__view. ( QWidget ) + :return: self.__view. + :rtype: QWidget """ return self.__view @@ -580,7 +607,8 @@ def view(self, value): """ Setter for **self.__view** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -601,7 +629,8 @@ def thumbnailsSize(self): """ Property for **self.__thumbnailsSize** attribute. - :return: self.__thumbnailsSize. ( String ) + :return: self.__thumbnailsSize. + :rtype: unicode """ return self.__thumbnailsSize @@ -612,7 +641,8 @@ def thumbnailsSize(self, value): """ Setter for **self.__thumbnailsSize** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ if value is not None: @@ -634,7 +664,8 @@ def activeIblSet(self): """ Property for **self.__activeIblSet** attribute. - :return: self.__activeIblSet. ( IblSet ) + :return: self.__activeIblSet. + :rtype: IblSet """ return self.__activeIblSet @@ -645,7 +676,8 @@ def activeIblSet(self, value): """ Setter for **self.__activeIblSet** attribute. - :param value: Attribute value. ( IblSet ) + :param value: Attribute value. + :type value: IblSet """ raise foundations.exceptions.ProgrammingError( @@ -666,7 +698,8 @@ def inspectorPlates(self): """ Property for **self.__inspectorPlates** attribute. - :return: self.__inspectorPlates. ( Dictionary ) + :return: self.__inspectorPlates. + :rtype: dict """ return self.__inspectorPlates @@ -677,7 +710,8 @@ def inspectorPlates(self, value): """ Setter for **self.__inspectorPlates** attribute. - :param value: Attribute value. ( Dictionary ) + :param value: Attribute value. + :type value: dict """ raise foundations.exceptions.ProgrammingError( @@ -698,7 +732,8 @@ def noPreviewImageText(self): """ Property for **self.__noPreviewImageText** attribute. - :return: self.__noPreviewImageText. ( String ) + :return: self.__noPreviewImageText. + :rtype: unicode """ return self.__noPreviewImageText @@ -709,7 +744,8 @@ def noPreviewImageText(self, value): """ Setter for **self.__noPreviewImageText** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -730,7 +766,8 @@ def noActiveIblSetText(self): """ Property for **self.__noActiveIblSetText** attribute. - :return: self.__noActiveIblSetText. ( String ) + :return: self.__noActiveIblSetText. + :rtype: unicode """ return self.__noActiveIblSetText @@ -741,7 +778,8 @@ def noActiveIblSetText(self, value): """ Setter for **self.__noActiveIblSetText** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -762,7 +800,8 @@ def activeIblSetToolTipText(self): """ Property for **self.__activeIblSetToolTipText** attribute. - :return: self.__activeIblSetToolTipText. ( String ) + :return: self.__activeIblSetToolTipText. + :rtype: unicode """ return self.__activeIblSetToolTipText @@ -773,7 +812,8 @@ def activeIblSetToolTipText(self, value): """ Setter for **self.__activeIblSetToolTipText** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -794,7 +834,8 @@ def lightLabelRadius(self): """ Property for **self.__lightLabelRadius** attribute. - :return: self.__lightLabelRadius. ( Integer ) + :return: self.__lightLabelRadius. + :rtype: int """ return self.__lightLabelRadius @@ -805,7 +846,8 @@ def lightLabelRadius(self, value): """ Setter for **self.__lightLabelRadius** attribute. - :param value: Attribute value. ( Integer ) + :param value: Attribute value. + :type value: int """ raise foundations.exceptions.ProgrammingError( @@ -826,7 +868,8 @@ def lightLabelTextOffset(self): """ Property for **self.__lightLabelTextOffset** attribute. - :return: self.__lightLabelTextOffset. ( Integer ) + :return: self.__lightLabelTextOffset. + :rtype: int """ return self.__lightLabelTextOffset @@ -837,7 +880,8 @@ def lightLabelTextOffset(self, value): """ Setter for **self.__lightLabelTextOffset** attribute. - :param value: Attribute value. ( Integer ) + :param value: Attribute value. + :type value: int """ raise foundations.exceptions.ProgrammingError( @@ -858,7 +902,8 @@ def lightLabelTextMargin(self): """ Property for **self.__lightLabelTextMargin** attribute. - :return: self.__lightLabelTextMargin. ( Integer ) + :return: self.__lightLabelTextMargin. + :rtype: int """ return self.__lightLabelTextMargin @@ -869,7 +914,8 @@ def lightLabelTextMargin(self, value): """ Setter for **self.__lightLabelTextMargin** attribute. - :param value: Attribute value. ( Integer ) + :param value: Attribute value. + :type value: int """ raise foundations.exceptions.ProgrammingError( @@ -890,7 +936,8 @@ def lightLabelTextHeight(self): """ Property for **self.__lightLabelTextHeight** attribute. - :return: self.__lightLabelTextHeight. ( Integer ) + :return: self.__lightLabelTextHeight. + :rtype: int """ return self.__lightLabelTextHeight @@ -901,7 +948,8 @@ def lightLabelTextHeight(self, value): """ Setter for **self.__lightLabelTextHeight** attribute. - :param value: Attribute value. ( Integer ) + :param value: Attribute value. + :type value: int """ raise foundations.exceptions.ProgrammingError( @@ -922,7 +970,8 @@ def lightLabelTextFont(self): """ Property for **self.__lightLabelTextFont** attribute. - :return: self.__lightLabelTextFont. ( String ) + :return: self.__lightLabelTextFont. + :rtype: unicode """ return self.__lightLabelTextFont @@ -933,7 +982,8 @@ def lightLabelTextFont(self, value): """ Setter for **self.__lightLabelTextFont** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -954,7 +1004,8 @@ def unnamedLightName(self): """ Property for **self.__unnamedLightName** attribute. - :return: self.__unnamedLightName. ( String ) + :return: self.__unnamedLightName. + :rtype: unicode """ return self.__unnamedLightName @@ -965,7 +1016,8 @@ def unnamedLightName(self, value): """ Setter for **self.__unnamedLightName** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ if value is not None: @@ -990,8 +1042,10 @@ def activate(self, engine): """ This method activates the Component. - :param engine: Engine to attach the Component to. ( QObject ) - :return: Method success. ( Boolean ) + :param engine: Engine to attach the Component to. + :type engine: QObject + :return: Method success. + :rtype: bool """ LOGGER.debug("> Activating '{0}' Component.".format(self.__class__.__name__)) @@ -1020,7 +1074,8 @@ def initializeUi(self): """ This method initializes the Component ui. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Initializing '{0}' Component ui.".format(self.__class__.__name__)) @@ -1086,7 +1141,8 @@ def addWidget(self): """ This method adds the Component Widget to the engine. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Adding '{0}' Component Widget.".format(self.__class__.__name__)) @@ -1184,8 +1240,10 @@ def __view_selectionModel__selectionChanged(self, selectedItems, deselectedItems """ This method is triggered when **Plates_listView** Model selection has changed. - :param selectedItems: Selected items. ( QItemSelection ) - :param deselectedItems: Deselected items. ( QItemSelection ) + :param selectedItems: Selected items. + :type selectedItems: QItemSelection + :param deselectedItems: Deselected items. + :type deselectedItems: QItemSelection """ index = foundations.common.getFirstItem(selectedItems.indexes()) @@ -1202,7 +1260,8 @@ def __engine_fileSystemEventsManager__fileChanged(self, file): """ This method is triggered by the **fileSystemEventsManager** when a file is changed. - :param file: File changed. ( String ) + :param file: File changed. + :type file: unicode """ file = foundations.strings.toString(file) @@ -1221,7 +1280,8 @@ def __engine_imagesCaches_QPixmap__contentAdded(self, paths): """ This method is triggered by the **QPixmap** images cache when contend is added. - :param paths: Added content. ( List ) + :param paths: Added content. + :type paths: list """ if not self.__activeIblSet: @@ -1244,8 +1304,10 @@ def __iblSetsOutliner_view_selectionModel__selectionChanged(self, selectedItems, This method is triggered when :mod:`sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner` Component Model selection has changed. - :param selectedItems: Selected items. ( QItemSelection ) - :param deselectedItems: Deselected items. ( QItemSelection ) + :param selectedItems: Selected items. + :type selectedItems: QItemSelection + :param deselectedItems: Deselected items. + :type deselectedItems: QItemSelection """ self.__setActiveIblSet() @@ -1262,7 +1324,8 @@ def __Previous_Ibl_Set_pushButton__clicked(self, checked): """ This method is triggered when **Previous_Ibl_Set_pushButton** Widget is clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ self.loopThroughIblSets(True) @@ -1271,7 +1334,8 @@ def __Next_Ibl_Set_pushButton__clicked(self, checked): """ This method is triggered when **Next_Ibl_Set_pushButton** Widget is clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ self.loopThroughIblSets() @@ -1280,7 +1344,8 @@ def __Previous_Plate_pushButton__clicked(self, checked): """ This method is triggered when **Previous_Plate_pushButton** Widget is clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ self.loopThroughPlates(True) @@ -1289,7 +1354,8 @@ def __Next_Plate_pushButton__clicked(self, checked): """ This method is triggered when **Next_Plate_pushButton** Widget is clicked. - :param checked: Checked state. ( Boolean ) + :param checked: Checked state. + :type checked: bool """ self.loopThroughPlates() @@ -1298,7 +1364,8 @@ def __Image_label__linkActivated(self, url): """ This method is triggered when a link is clicked in the **Image_label** Widget. - :param url: Url to explore. ( QString ) + :param url: Url to explore. + :type url: QString """ QDesktopServices.openUrl(QUrl(url)) @@ -1388,8 +1455,10 @@ def __drawLightLabel(self, painter, light): """ This method draws a light label on given QPainter. - :param painter: QPainter. ( QPainter ) - :param light: Light. ( Light ) + :param painter: QPainter. + :type painter: QPainter + :param light: Light. + :type light: Light """ width = painter.window().width() @@ -1433,7 +1502,8 @@ def setPlates(self): """ This method sets the Plates Model nodes. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Setting up '{0}' Model!".format("Plates_listView")) @@ -1466,8 +1536,10 @@ def loopThroughIblSets(self, backward=False): """ This method loops through :mod:`sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner` Component Ibl Sets. - :param backward: Looping backward. ( Boolean ) - :return: Method success. ( Boolean ) + :param backward: Looping backward. + :type backward: bool + :return: Method success. + :rtype: bool """ if self.__activeIblSet: @@ -1498,8 +1570,10 @@ def loopThroughPlates(self, backward=False): """ This method loops through :mod:`sibl_gui.components.core.inspector.inspector` Component Ibl Set Plates. - :param backward: Looping backward. ( Boolean ) - :return: Method success. ( Boolean ) + :param backward: Looping backward. + :type backward: bool + :return: Method success. + :rtype: bool """ index = foundations.common.getFirstItem(self.Plates_listView.selectedIndexes()) diff --git a/sibl_gui/components/core/inspector/models.py b/sibl_gui/components/core/inspector/models.py index e66fd74f..d90eb79a 100644 --- a/sibl_gui/components/core/inspector/models.py +++ b/sibl_gui/components/core/inspector/models.py @@ -53,10 +53,14 @@ def __init__(self, parent=None, rootNode=None, horizontalHeaders=None, verticalH """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param rootNode: Root node. ( AbstractCompositeNode ) - :param horizontalHeaders: Headers. ( OrderedDict ) - :param verticalHeaders: Headers. ( OrderedDict ) + :param parent: Object parent. + :type parent: QObject + :param rootNode: Root node. + :type rootNode: AbunicodeactCompositeNode + :param horizontalHeaders: Headers. + :type horizontalHeaders: OrderedDict + :param verticalHeaders: Headers. + :type verticalHeaders: OrderedDict """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -74,8 +78,10 @@ def initializeModel(self, rootNode): """ Initializes the Model using given root node. - :param rootNode: Graph root node. ( DefaultNode ) - :return: Method success ( Boolean ) + :param rootNode: Graph root node. + :type rootNode: DefaultNode + :return: Method success + :rtype: bool """ LOGGER.debug("> Initializing model with '{0}' root node.".format(rootNode)) diff --git a/sibl_gui/components/core/inspector/nodes.py b/sibl_gui/components/core/inspector/nodes.py index e245095e..2cd54ad1 100644 --- a/sibl_gui/components/core/inspector/nodes.py +++ b/sibl_gui/components/core/inspector/nodes.py @@ -72,16 +72,26 @@ def __init__(self, """ Initializes the class. - :param plate: Plate object. ( Plate ) - :param name: Node name. ( String ) - :param parent: Node parent. ( GraphModelNode ) - :param children: Children. ( List ) - :param roles: Roles. ( Dictionary ) - :param nodeFlags: Node flags. ( Integer ) - :param attributesFlags: Attributes flags. ( Integer ) - :param iconSize: Icon size. ( String ) - :param iconPlaceholder: Icon placeholder. ( QIcon ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param plate: Plate object. + :type plate: Plate + :param name: Node name. + :type name: unicode + :param parent: Node parent. + :type parent: GraphModelNode + :param children: Children. + :type children: list + :param roles: Roles. + :type roles: dict + :param nodeFlags: Node flags. + :type nodeFlags: int + :param attributesFlags: Attributes flags. + :type attributesFlags: int + :param iconSize: Icon size. + :type iconSize: unicode + :param iconPlaceholder: Icon placeholder. + :type iconPlaceholder: QIcon + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -113,7 +123,8 @@ def plate(self): """ Property for **self.__plate** attribute. - :return: self.__plate. ( Plate ) + :return: self.__plate. + :rtype: Plate """ return self.__plate @@ -124,7 +135,8 @@ def plate(self, value): """ Setter for **self.__plate** attribute. - :param value: Attribute value. ( Plate ) + :param value: Attribute value. + :type value: Plate """ raise foundations.exceptions.ProgrammingError( @@ -145,7 +157,8 @@ def toolTipText(self): """ Property for **self.__toolTipText** attribute. - :return: self.__toolTipText. ( String ) + :return: self.__toolTipText. + :rtype: unicode """ return self.__toolTipText @@ -156,7 +169,8 @@ def toolTipText(self, value): """ Setter for **self.__toolTipText** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -179,7 +193,8 @@ def __initializeNode(self, attributesFlags=int(Qt.ItemIsSelectable | Qt.ItemIsEn """ This method initializes the node. - :param attributesFlags: Attributes flags. ( Integer ) + :param attributesFlags: Attributes flags. + :type attributesFlags: int """ self.roles.update({Qt.ToolTipRole : self.__toolTipText.format(self.name)}) diff --git a/sibl_gui/components/core/inspector/views.py b/sibl_gui/components/core/inspector/views.py index 6d88bc98..149237b0 100644 --- a/sibl_gui/components/core/inspector/views.py +++ b/sibl_gui/components/core/inspector/views.py @@ -61,10 +61,14 @@ def __init__(self, parent, model=None, readOnly=False, message=None): """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param model: Model. ( QObject ) - :param readOnly: View is read only. ( Boolean ) - :param message: View default message when Model is empty. ( String ) + :param parent: Object parent. + :type parent: QObject + :param model: Model. + :type model: QObject + :param readOnly: View is read only. + :type readOnly: bool + :param message: View default message when Model is empty. + :type message: unicode """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -84,7 +88,8 @@ def listViewIconSize(self): """ Property for **self.__listViewIconSize** attribute. - :return: self.__listViewIconSize. ( Integer ) + :return: self.__listViewIconSize. + :rtype: int """ return self.__listViewIconSize @@ -95,7 +100,8 @@ def listViewIconSize(self, value): """ Setter for **self.__listViewIconSize** attribute. - :param value: Attribute value. ( Integer ) + :param value: Attribute value. + :type value: int """ raise foundations.exceptions.ProgrammingError( diff --git a/sibl_gui/components/core/templatesOutliner/models.py b/sibl_gui/components/core/templatesOutliner/models.py index 4d375677..f98fb9d4 100644 --- a/sibl_gui/components/core/templatesOutliner/models.py +++ b/sibl_gui/components/core/templatesOutliner/models.py @@ -53,10 +53,14 @@ def __init__(self, parent=None, rootNode=None, horizontalHeaders=None, verticalH """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param rootNode: Root node. ( AbstractCompositeNode ) - :param horizontalHeaders: Headers. ( OrderedDict ) - :param verticalHeaders: Headers. ( OrderedDict ) + :param parent: Object parent. + :type parent: QObject + :param rootNode: Root node. + :type rootNode: AbunicodeactCompositeNode + :param horizontalHeaders: Headers. + :type horizontalHeaders: OrderedDict + :param verticalHeaders: Headers. + :type verticalHeaders: OrderedDict """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -74,8 +78,10 @@ def initializeModel(self, rootNode): """ Initializes the Model using given root node. - :param rootNode: Graph root node. ( DefaultNode ) - :return: Method success ( Boolean ) + :param rootNode: Graph root node. + :type rootNode: DefaultNode + :return: Method success + :rtype: bool """ LOGGER.debug("> Initializing model with '{0}' root node.".format(rootNode)) diff --git a/sibl_gui/components/core/templatesOutliner/nodes.py b/sibl_gui/components/core/templatesOutliner/nodes.py index f913aeb0..cedefda1 100644 --- a/sibl_gui/components/core/templatesOutliner/nodes.py +++ b/sibl_gui/components/core/templatesOutliner/nodes.py @@ -70,15 +70,24 @@ def __init__(self, """ Initializes the class. - :param name: Node name. ( String ) - :param parent: Node parent. ( GraphModelNode ) - :param children: Children. ( List ) - :param roles: Roles. ( Dictionary ) - :param nodeFlags: Node flags. ( Integer ) - :param attributesFlags: Attributes flags. ( Integer ) - :param iconSize: Icon size. ( String ) - :param iconPlaceholder: Icon placeholder. ( QIcon ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param name: Node name. + :type name: unicode + :param parent: Node parent. + :type parent: GraphModelNode + :param children: Children. + :type children: list + :param roles: Roles. + :type roles: dict + :param nodeFlags: Node flags. + :type nodeFlags: int + :param attributesFlags: Attributes flags. + :type attributesFlags: int + :param iconSize: Icon size. + :type iconSize: unicode + :param iconPlaceholder: Icon placeholder. + :type iconPlaceholder: QIcon + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -102,7 +111,8 @@ def __initializeNode(self, attributesFlags=int(Qt.ItemIsSelectable | Qt.ItemIsEn """ Initializes the node. - :param attributesFlags: Attributes flags. ( Integer ) + :param attributesFlags: Attributes flags. + :type attributesFlags: int """ self["release"] = sibl_gui.ui.nodes.GraphModelAttribute(name="release", diff --git a/sibl_gui/components/core/templatesOutliner/templatesOutliner.py b/sibl_gui/components/core/templatesOutliner/templatesOutliner.py index 8d33db76..d00fca1f 100644 --- a/sibl_gui/components/core/templatesOutliner/templatesOutliner.py +++ b/sibl_gui/components/core/templatesOutliner/templatesOutliner.py @@ -102,10 +102,14 @@ def __init__(self, parent=None, name=None, *args, **kwargs): """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param name: Component name. ( String ) - :param \*args: Arguments. ( \* ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param parent: Object parent. + :type parent: QObject + :param name: Component name. + :type name: unicode + :param \*args: Arguments. + :type \*args: \* + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -177,7 +181,8 @@ def uiResourcesDirectory(self): """ Property for **self.__uiResourcesDirectory** attribute. - :return: self.__uiResourcesDirectory. ( String ) + :return: self.__uiResourcesDirectory. + :rtype: unicode """ return self.__uiResourcesDirectory @@ -188,7 +193,8 @@ def uiResourcesDirectory(self, value): """ Setter for **self.__uiResourcesDirectory** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -209,7 +215,8 @@ def uiSoftwareAffixe(self): """ Property for **self.__uiSoftwareAffixe** attribute. - :return: self.__uiSoftwareAffixe. ( String ) + :return: self.__uiSoftwareAffixe. + :rtype: unicode """ return self.__uiSoftwareAffixe @@ -220,7 +227,8 @@ def uiSoftwareAffixe(self, value): """ Setter for **self.__uiSoftwareAffixe** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -241,7 +249,8 @@ def uiUnknownSoftwareImage(self): """ Property for **self.__uiUnknownSoftwareImage** attribute. - :return: self.__uiUnknownSoftwareImage. ( String ) + :return: self.__uiUnknownSoftwareImage. + :rtype: unicode """ return self.__uiUnknownSoftwareImage @@ -252,7 +261,8 @@ def uiUnknownSoftwareImage(self, value): """ Setter for **self.__uiUnknownSoftwareImage** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -273,7 +283,8 @@ def dockArea(self): """ Property for **self.__dockArea** attribute. - :return: self.__dockArea. ( Integer ) + :return: self.__dockArea. + :rtype: int """ return self.__dockArea @@ -284,7 +295,8 @@ def dockArea(self, value): """ Setter for **self.__dockArea** attribute. - :param value: Attribute value. ( Integer ) + :param value: Attribute value. + :type value: int """ raise foundations.exceptions.ProgrammingError( @@ -305,7 +317,8 @@ def engine(self): """ Property for **self.__engine** attribute. - :return: self.__engine. ( QObject ) + :return: self.__engine. + :rtype: QObject """ return self.__engine @@ -316,7 +329,8 @@ def engine(self, value): """ Setter for **self.__engine** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -337,7 +351,8 @@ def settings(self): """ Property for **self.__settings** attribute. - :return: self.__settings. ( QSettings ) + :return: self.__settings. + :rtype: QSettings """ return self.__settings @@ -348,7 +363,8 @@ def settings(self, value): """ Setter for **self.__settings** attribute. - :param value: Attribute value. ( QSettings ) + :param value: Attribute value. + :type value: QSettings """ raise foundations.exceptions.ProgrammingError( @@ -369,7 +385,8 @@ def settingsSection(self): """ Property for **self.__settingsSection** attribute. - :return: self.__settingsSection. ( String ) + :return: self.__settingsSection. + :rtype: unicode """ return self.__settingsSection @@ -380,7 +397,8 @@ def settingsSection(self, value): """ Setter for **self.__settingsSection** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -401,7 +419,8 @@ def settingsSeparator(self): """ Property for **self.__settingsSeparator** attribute. - :return: self.__settingsSeparator. ( String ) + :return: self.__settingsSeparator. + :rtype: unicode """ return self.__settingsSeparator @@ -412,7 +431,8 @@ def settingsSeparator(self, value): """ Setter for **self.__settingsSeparator** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -433,7 +453,8 @@ def scriptEditor(self): """ Property for **self.__scriptEditor** attribute. - :return: self.__scriptEditor. ( QWidget ) + :return: self.__scriptEditor. + :rtype: QWidget """ return self.__scriptEditor @@ -444,7 +465,8 @@ def scriptEditor(self, value): """ Setter for **self.__scriptEditor** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -465,7 +487,8 @@ def database(self): """ Property for **self.__database** attribute. - :return: self.__database. ( Object ) + :return: self.__database. + :rtype: object """ return self.__database @@ -476,7 +499,8 @@ def database(self, value): """ Setter for **self.__database** attribute. - :param value: Attribute value. ( Object ) + :param value: Attribute value. + :type value: object """ raise foundations.exceptions.ProgrammingError( @@ -497,7 +521,8 @@ def model(self): """ Property for **self.__model** attribute. - :return: self.__model. ( TemplatesModel ) + :return: self.__model. + :rtype: TemplatesModel """ return self.__model @@ -508,7 +533,8 @@ def model(self, value): """ Setter for **self.__model** attribute. - :param value: Attribute value. ( TemplatesModel ) + :param value: Attribute value. + :type value: TemplatesModel """ raise foundations.exceptions.ProgrammingError( @@ -529,7 +555,8 @@ def view(self): """ Property for **self.__view** attribute. - :return: self.__view. ( QWidget ) + :return: self.__view. + :rtype: QWidget """ return self.__view @@ -540,7 +567,8 @@ def view(self, value): """ Setter for **self.__view** attribute. - :param value: Attribute value. ( QWidget ) + :param value: Attribute value. + :type value: QWidget """ raise foundations.exceptions.ProgrammingError( @@ -561,7 +589,8 @@ def headers(self): """ Property for **self.__headers** attribute. - :return: self.__headers. ( OrderedDict ) + :return: self.__headers. + :rtype: OrderedDict """ return self.__headers @@ -572,7 +601,8 @@ def headers(self, value): """ Setter for **self.__headers** attribute. - :param value: Attribute value. ( OrderedDict ) + :param value: Attribute value. + :type value: OrderedDict """ raise foundations.exceptions.ProgrammingError( @@ -593,7 +623,8 @@ def extension(self): """ Property for **self.__extension** attribute. - :return: self.__extension. ( String ) + :return: self.__extension. + :rtype: unicode """ return self.__extension @@ -604,7 +635,8 @@ def extension(self, value): """ Setter for **self.__extension** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -625,7 +657,8 @@ def defaultCollections(self): """ Property for **self.__defaultCollections** attribute. - :return: self.__defaultCollections. ( Dictionary ) + :return: self.__defaultCollections. + :rtype: dict """ return self.__defaultCollections @@ -636,7 +669,8 @@ def defaultCollections(self, value): """ Setter for **self.__defaultCollections** attribute. - :param value: Attribute value. ( Dictionary ) + :param value: Attribute value. + :type value: dict """ raise foundations.exceptions.ProgrammingError( @@ -657,7 +691,8 @@ def factoryCollection(self): """ Property for **self.__factoryCollection** attribute. - :return: self.__factoryCollection. ( String ) + :return: self.__factoryCollection. + :rtype: unicode """ return self.__factoryCollection @@ -668,7 +703,8 @@ def factoryCollection(self, value): """ Setter for **self.__factoryCollection** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -689,7 +725,8 @@ def userCollection(self): """ Property for **self.__userCollection** attribute. - :return: self.__userCollection. ( String ) + :return: self.__userCollection. + :rtype: unicode """ return self.__userCollection @@ -700,7 +737,8 @@ def userCollection(self, value): """ Setter for **self.__userCollection** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -721,7 +759,8 @@ def templatesInformationsDefaultText(self): """ Property for **self.__templatesInformationsDefaultText** attribute. - :return: self.__templatesInformationsDefaultText. ( String ) + :return: self.__templatesInformationsDefaultText. + :rtype: unicode """ return self.__templatesInformationsDefaultText @@ -732,7 +771,8 @@ def templatesInformationsDefaultText(self, value): """ Setter for **self.__templatesInformationsDefaultText** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -753,7 +793,8 @@ def treeViewInnerMargins(self): """ Property for **self.__treeViewInnerMargins** attribute. - :return: self.__treeViewInnerMargins. ( Integer ) + :return: self.__treeViewInnerMargins. + :rtype: int """ return self.__treeViewInnerMargins @@ -764,7 +805,8 @@ def treeViewInnerMargins(self, value): """ Setter for **self.__treeViewInnerMargins** attribute. - :param value: Attribute value. ( Integer ) + :param value: Attribute value. + :type value: int """ raise foundations.exceptions.ProgrammingError( @@ -785,7 +827,8 @@ def templatesInformationsText(self): """ Property for **self.__templatesInformationsText** attribute. - :return: self.__templatesInformationsText. ( String ) + :return: self.__templatesInformationsText. + :rtype: unicode """ return self.__templatesInformationsText @@ -796,7 +839,8 @@ def templatesInformationsText(self, value): """ Setter for **self.__templatesInformationsText** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -819,8 +863,10 @@ def activate(self, engine): """ This method activates the Component. - :param engine: Engine to attach the Component to. ( QObject ) - :return: Method success. ( Boolean ) + :param engine: Engine to attach the Component to. + :type engine: QObject + :return: Method success. + :rtype: bool """ LOGGER.debug("> Activating '{0}' Component.".format(self.__class__.__name__)) @@ -856,7 +902,8 @@ def initializeUi(self): """ This method initializes the Component ui. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Initializing '{0}' Component ui.".format(self.__class__.__name__)) @@ -912,7 +959,8 @@ def addWidget(self): """ This method adds the Component Widget to the engine. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Adding '{0}' Component Widget.".format(self.__class__.__name__)) @@ -934,7 +982,8 @@ def onStartup(self): """ This method is triggered on Framework startup. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Calling '{0}' Component Framework 'onStartup' method.".format(self.__class__.__name__)) @@ -1012,7 +1061,8 @@ def onClose(self): """ This method is triggered on Framework close. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Calling '{0}' Component Framework 'onClose' method.".format(self.__class__.__name__)) @@ -1082,8 +1132,10 @@ def __view_addTemplateAction__triggered(self, checked): """ This method is triggered by **'Actions|Umbra|Components|core.templatesOutliner|Add Template ...'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ return self.addTemplateUi() @@ -1092,8 +1144,10 @@ def __view_removeTemplatesAction__triggered(self, checked): """ This method is triggered by **'Actions|Umbra|Components|core.templatesOutliner|Remove Template(s) ...'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ return self.removeTemplatesUi() @@ -1102,8 +1156,10 @@ def __view_importDefaultTemplatesAction__triggered(self, checked): """ This method is triggered by **'Actions|Umbra|Components|core.templatesOutliner|Import Default Templates'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ return self.importDefaultTemplatesUi() @@ -1112,8 +1168,10 @@ def __view_displayHelpFilesAction__triggered(self, checked): """ This method is triggered by **'Actions|Umbra|Components|core.templatesOutliner|Display Help File(s) ...'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ return self.displayHelpFilesUi() @@ -1122,8 +1180,10 @@ def __view_filterTemplatesVersionsAction__triggered(self, checked): """ This method is triggered by **'Actions|Umbra|Components|core.templatesOutliner|Filter Templates Versions'** action. - :param checked: Action checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Action checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ return self.filterTemplatesVersionsUi() @@ -1132,8 +1192,10 @@ def __view_selectionModel__selectionChanged(self, selectedItems, deselectedItems """ This method sets the **Template_Informations_textEdit** Widget. - :param selectedItems: Selected items. ( QItemSelection ) - :param deselectedItems: Deselected items. ( QItemSelection ) + :param selectedItems: Selected items. + :type selectedItems: QItemSelection + :param deselectedItems: Deselected items. + :type deselectedItems: QItemSelection """ LOGGER.debug("> Initializing '{0}' Widget.".format("Template_Informations_textEdit")) @@ -1166,7 +1228,8 @@ def __engine__contentDropped(self, event): """ This method is triggered when content is dropped into the engine. - :param event: Event. ( QEvent ) + :param event: Event. + :type event: QEvent """ if not event.mimeData().hasUrls(): @@ -1211,7 +1274,8 @@ def __engine_fileSystemEventsManager__fileChanged(self, file): """ This method is triggered by the **fileSystemEventsManager** when a file is changed. - :param file: File changed. ( String ) + :param file: File changed. + :type file: unicode """ template = foundations.common.getFirstItem(filter(lambda x: x.path == file, self.getTemplates())) @@ -1228,7 +1292,8 @@ def __Template_Informations_textBrowser__anchorClicked(self, url): """ This method is triggered when a link is clicked in the **Template_Informations_textBrowser** Widget. - :param url: Url to explore. ( QUrl ) + :param url: Url to explore. + :type url: QUrl """ QDesktopServices.openUrl(url) @@ -1237,8 +1302,10 @@ def __getCandidateCollectionId(self, path=None): """ This method returns a Collection id. - :param path: Template path. ( String ) - :return: Collection id. ( Integer ) + :param path: Template path. + :type path: unicode + :return: Collection id. + :rtype: int """ collection = self.getCollectionByName(self.__userCollection) @@ -1257,7 +1324,8 @@ def addTemplateUi(self): """ This method adds an user defined Template to the Database. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -1286,7 +1354,8 @@ def removeTemplatesUi(self): """ This method removes user selected Templates from the Database. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -1334,8 +1403,10 @@ def updateTemplateLocationUi(self, template): """ This method updates given Template location. - :param template: Template to update. ( Template ) - :return: Method success. ( Boolean ) + :param template: Template to update. + :type template: Template + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -1362,7 +1433,8 @@ def importDefaultTemplatesUi(self): """ This method imports default Templates into the Database. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -1379,7 +1451,8 @@ def displayHelpFilesUi(self): """ This method displays user selected Templates help files. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ selectedTemplates = self.getSelectedTemplates() @@ -1404,7 +1477,8 @@ def filterTemplatesVersionsUi(self): """ This method filters Templates by versions. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool :note: This method may require user interaction. """ @@ -1436,10 +1510,14 @@ def addTemplate(self, name, path, collectionId=None): """ This method adds a Template to the Database. - :param name: Template set name. ( String ) - :param path: Template set path. ( String ) - :param collectionId: Target Collection id. ( Integer ) - :return: Method success. ( Boolean ) + :param name: Template set name. + :type name: unicode + :param path: Template set path. + :type path: unicode + :param collectionId: Target Collection id. + :type collectionId: int + :return: Method success. + :rtype: bool """ if not sibl_gui.components.core.database.operations.filterTemplates("^{0}$".format(re.escape(path)), "path"): @@ -1461,9 +1539,12 @@ def addDirectory(self, directory, collectionId=None): """ This method adds given directory Templates to the Database. - :param directory: Templates directory. ( String ) - :param collectionId: Collection id. ( Integer ) - :return: Method success. ( Boolean ) + :param directory: Templates directory. + :type directory: unicode + :param collectionId: Collection id. + :type collectionId: int + :return: Method success. + :rtype: bool """ LOGGER.debug("> Initializing directory '{0}' filesWalker.".format(directory)) @@ -1495,8 +1576,10 @@ def addDefaultTemplates(self, forceImport=False): """ This method adds default Templates Collections / Templates to the Database. - :param forceImport: Force Templates import. ( Boolean ) - :return: Method success. ( Boolean ) + :param forceImport: Force Templates import. + :type forceImport: bool + :return: Method success. + :rtype: bool """ if not forceImport and self.getTemplates(): @@ -1528,8 +1611,10 @@ def removeTemplate(self, template): """ This method removes given Template from the Database. - :param templates: Template to remove. ( List ) - :return: Method success. ( Boolean ) + :param templates: Template to remove. + :type templates: list + :return: Method success. + :rtype: bool """ LOGGER.info("{0} | Removing '{1}' Template from the Database!".format(self.__class__.__name__, template.name)) @@ -1545,8 +1630,10 @@ def templateExists(self, path): """ This method returns if given Template path exists in the Database. - :param name: Template path. ( String ) - :return: Template exists. ( Boolean ) + :param name: Template path. + :type name: unicode + :return: Template exists. + :rtype: bool """ return sibl_gui.components.core.database.operations.templateExists(path) @@ -1556,8 +1643,10 @@ def displayHelpFile(self, template): """ This method displays given Templates help file. - :param template: Template to display help file. ( Template ) - :return: Method success. ( Boolean ) + :param template: Template to display help file. + :type template: Template + :return: Method success. + :rtype: bool """ helpFile = template.helpFile or umbra.ui.common.getResourcePath(UiConstants.invalidLinkHtmlFile) @@ -1576,7 +1665,8 @@ def getCollections(self): """ This method returns Database Templates Collections. - :return: Database Templates Collections. ( List ) + :return: Database Templates Collections. + :rtype: list """ return sibl_gui.components.core.database.operations.getCollectionsByType("Templates") @@ -1585,11 +1675,15 @@ def filterCollections(self, pattern, attribute, flags=re.IGNORECASE): """ This method filters the Database Templates Collections on given attribute using given pattern. - :param pattern: Filter pattern. ( String ) - :param attribute: Attribute to filter on. ( String ) - :param flags: Regex filtering flags. ( Integer ) + :param pattern: Filter pattern. + :type pattern: unicode + :param attribute: Attribute to filter on. + :type attribute: unicode + :param flags: Regex filtering flags. + :type flags: int - :return: Filtered Database Templates Collections. ( List ) + :return: Filtered Database Templates Collections. + :rtype: list """ try: @@ -1604,7 +1698,8 @@ def getTemplates(self): """ This method returns Database Templates. - :return: Database Templates. ( List ) + :return: Database Templates. + :rtype: list """ return [template for template in sibl_gui.components.core.database.operations.getTemplates()] @@ -1613,11 +1708,15 @@ def filterTemplates(self, pattern, attribute, flags=re.IGNORECASE): """ This method filters the Database Templates on given attribute using given pattern. - :param pattern: Filter pattern. ( String ) - :param attribute: Attribute to filter on. ( String ) - :param flags: Regex filtering flags. ( Integer ) + :param pattern: Filter pattern. + :type pattern: unicode + :param attribute: Attribute to filter on. + :type attribute: unicode + :param flags: Regex filtering flags. + :type flags: int - :return: Filtered Database Templates. ( List ) + :return: Filtered Database Templates. + :rtype: list """ try: @@ -1633,7 +1732,8 @@ def listTemplates(self): """ This method lists Database Templates names. - :return: Database Templates names. ( List ) + :return: Database Templates names. + :rtype: list """ return [template.title for template in self.getTemplates()] @@ -1703,8 +1803,10 @@ def getTemplateByName(self, name): """ This method returns Database Template with given name. - :param name: Template name. ( String ) - :return: Database Template. ( Template ) + :param name: Template name. + :type name: unicode + :return: Database Template. + :rtype: Template :note: The filtering is actually performed on 'title' attributes instead of 'name' attributes. """ @@ -1716,8 +1818,10 @@ def getCollectionByName(self, name): """ This method gets Templates Collection from given Collection name. - :param collection: Collection name. ( String ) - :return: Collection. ( Collection ) + :param collection: Collection name. + :type collection: unicode + :return: Collection. + :rtype: Collection """ collections = self.filterCollections(r"^{0}$".format(name), "name") @@ -1727,8 +1831,10 @@ def getCollectionId(self, collection): """ This method returns given Collection id. - :param collection: Collection to get the id from. ( String ) - :return: Provided Collection id. ( Integer ) + :param collection: Collection to get the id from. + :type collection: unicode + :return: Provided Collection id. + :rtype: int """ children = self.__model.findChildren(r"^{0}$".format(collection)) @@ -1739,7 +1845,8 @@ def getSelectedNodes(self): """ This method returns the View selected nodes. - :return: View selected nodes. ( Dictionary ) + :return: View selected nodes. + :rtype: dict """ return self.__view.getSelectedNodes() @@ -1748,7 +1855,8 @@ def getSelectedTemplatesNodes(self): """ This method returns the View selected Templates nodes. - :return: View selected Templates nodes. ( List ) + :return: View selected Templates nodes. + :rtype: list """ return [node for node in self.getSelectedNodes() if node.family == "Template"] @@ -1757,7 +1865,8 @@ def getSelectedTemplates(self): """ This method gets the View selected Templates. - :return: View selected Templates. ( List ) + :return: View selected Templates. + :rtype: list """ return [node.databaseItem for node in self.getSelectedTemplatesNodes()] diff --git a/sibl_gui/components/core/templatesOutliner/views.py b/sibl_gui/components/core/templatesOutliner/views.py index 5ab604ff..d2f20bd4 100644 --- a/sibl_gui/components/core/templatesOutliner/views.py +++ b/sibl_gui/components/core/templatesOutliner/views.py @@ -61,10 +61,14 @@ def __init__(self, parent, model=None, readOnly=False, message=None): """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param model: Model. ( QObject ) - :param readOnly: View is read only. ( Boolean ) - :param message: View default message when Model is empty. ( String ) + :param parent: Object parent. + :type parent: QObject + :param model: Model. + :type model: QObject + :param readOnly: View is read only. + :type readOnly: bool + :param message: View default message when Model is empty. + :type message: unicode """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -86,7 +90,8 @@ def container(self): """ Property for **self.__container** attribute. - :return: self.__container. ( QObject ) + :return: self.__container. + :rtype: QObject """ return self.__container @@ -97,7 +102,8 @@ def container(self, value): """ Setter for **self.__container** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -118,7 +124,8 @@ def treeViewIndentation(self): """ Property for **self.__treeViewIndentation** attribute. - :return: self.__treeViewIndentation. ( Integer ) + :return: self.__treeViewIndentation. + :rtype: int """ return self.__treeViewIndentation @@ -129,7 +136,8 @@ def treeViewIndentation(self, value): """ Setter for **self.__treeViewIndentation** attribute. - :param value: Attribute value. ( Integer ) + :param value: Attribute value. + :type value: int """ raise foundations.exceptions.ProgrammingError( @@ -185,7 +193,8 @@ def storeModelSelection(self): """ Stores the Model selection. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Storing Model selection!") @@ -204,7 +213,8 @@ def restoreModelSelection(self): """ Restores the Model selection. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Restoring Model selection!") diff --git a/sibl_gui/launcher.py b/sibl_gui/launcher.py index 96bff840..b5f9df5e 100644 --- a/sibl_gui/launcher.py +++ b/sibl_gui/launcher.py @@ -130,11 +130,16 @@ def __init__(self, """ Initializes the class. - :param componentsPaths: Components componentsPaths. ( Tuple / List ) - :param requisiteComponents: Requisite components names. ( Tuple / List ) - :param visibleComponents: Visible components names. ( Tuple / List ) - :param \*args: Arguments. ( \* ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param componentsPaths: Components componentsPaths. + :type componentsPaths: tuple or list + :param requisiteComponents: Requisite components names. + :type requisiteComponents: tuple or list + :param visibleComponents: Visible components names. + :type visibleComponents: tuple or list + :param \*args: Arguments. + :type \*args: \* + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -159,7 +164,8 @@ def thumbnailsCacheDirectory(self): """ Property for **self.__thumbnailsCacheDirectory** attribute. - :return: self.__thumbnailsCacheDirectory. ( String ) + :return: self.__thumbnailsCacheDirectory. + :rtype: unicode """ return self.__thumbnailsCacheDirectory @@ -170,7 +176,8 @@ def thumbnailsCacheDirectory(self, value): """ Setter for **self.__thumbnailsCacheDirectory** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -191,7 +198,8 @@ def imagesCaches(self): """ Property for **self.__imagesCaches** attribute. - :return: self.__imagesCaches. ( Structure ) + :return: self.__imagesCaches. + :rtype: Structure """ return self.__imagesCaches @@ -202,7 +210,8 @@ def imagesCaches(self, value): """ Setter for **self.__imagesCaches** attribute. - :param value: Attribute value. ( Structure ) + :param value: Attribute value. + :type value: Structure """ raise foundations.exceptions.ProgrammingError( @@ -289,8 +298,10 @@ def extendCommandLineParametersParser(parser): """ Returns the command line parameters parser. - :param parser: Command line parameters parser. ( Parser ) - :return: Definition success. ( Boolean ) + :param parser: Command line parameters parser. + :type parser: Parser + :return: Definition success. + :rtype: bool """ parser.add_option("-d", @@ -321,7 +332,8 @@ def main(): """ Starts the Application. - :return: Definition success. ( Boolean ) + :return: Definition success. + :rtype: bool """ commandLineParametersParser = umbra.engine.getCommandLineParametersParser() diff --git a/sibl_gui/libraries/freeImage/freeImage.py b/sibl_gui/libraries/freeImage/freeImage.py index a5b63af7..ca7c4b64 100644 --- a/sibl_gui/libraries/freeImage/freeImage.py +++ b/sibl_gui/libraries/freeImage/freeImage.py @@ -420,8 +420,10 @@ def pointer(data): Converts None to a real NULL pointer to work around bugs in how ctypes handles None on 64-bit platforms. - :param data: Data . ( Object ) - :return: Pointer. ( POINTER ) + :param data: Data . + :type data: object + :return: Pointer. + :rtype: POINTER """ pointer = ctypes.POINTER(data) @@ -443,8 +445,10 @@ def unchecked(type): nor does it support custom datatypes on callbacks, so we must ensure that all callbacks return primitive datatypes. Non-primitive return values wrapped with unchecked won't be typechecked, and will be converted to c_void_p. - :param type: Type . ( Object ) - :return: Type. ( Object ) + :param type: Type . + :type type: object + :return: Type. + :rtype: object """ if (hasattr(type, "_type_") and isinstance(type._type_, str) and type._type_ != "P"): @@ -2002,7 +2006,8 @@ def getFreeImageLibraryPath(): """ Returns the FreeImage library path. - :return: FreeImage library path. ( String ) + :return: FreeImage library path. + :rtype: unicode """ global FREEIMAGE_LIBRARY_PATH @@ -2023,7 +2028,8 @@ def __init__(self, **kwargs): """ Initializes the class. - :param kwargs: path, width, height, bpp, osStats. ( Key / Value pairs ) + :param kwargs: path, width, height, bpp, osStats. + :type kwargs: dict """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -2039,7 +2045,8 @@ def __init__(self, imagePath=None): """ Initializes the class. - :param imagePath: Image path. ( String ) + :param imagePath: Image path. + :type imagePath: unicode """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -2066,7 +2073,8 @@ def library(self): """ Property for **self.__library** attribute. - :return: self.__library. ( Library ) + :return: self.__library. + :rtype: Library """ return self.__library @@ -2077,7 +2085,8 @@ def library(self, value): """ Setter for **self.__library** attribute. - :param value: Attribute value. ( Library ) + :param value: Attribute value. + :type value: Library """ raise foundations.exceptions.ProgrammingError( @@ -2098,7 +2107,8 @@ def errorsCallback(self): """ Property for **self.__errorsCallback** attribute. - :return: self.__errorsCallback. ( Object ) + :return: self.__errorsCallback. + :rtype: object """ return self.__errorsCallback @@ -2109,7 +2119,8 @@ def errorsCallback(self, value): """ Setter for **self.__errorsCallback** attribute. - :param value: Attribute value. ( Object ) + :param value: Attribute value. + :type value: object """ raise foundations.exceptions.ProgrammingError( @@ -2130,7 +2141,8 @@ def imagePath(self): """ Property for **self.__imagePath** attribute. - :return: self.__imagePath. ( String ) + :return: self.__imagePath. + :rtype: unicode """ return self.__imagePath @@ -2141,7 +2153,8 @@ def imagePath(self, value): """ Setter for **self.__imagePath** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ if value is not None: @@ -2163,7 +2176,8 @@ def bitmap(self): """ Property for **self.__bitmap** attribute. - :return: self.__bitmap. ( Object ) + :return: self.__bitmap. + :rtype: object """ return self.__bitmap @@ -2174,7 +2188,8 @@ def bitmap(self, value): """ Setter for **self.__bitmap** attribute. - :param value: Attribute value. ( Object ) + :param value: Attribute value. + :type value: object """ self.__bitmap = value @@ -2205,8 +2220,10 @@ def getImageFormat(self, imagePath=None): """ Gets the file format. - :param imagePath: Image path. ( String ) - :return: File format. ( FREE_IMAGE_FORMAT ) + :param imagePath: Image path. + :type imagePath: unicode + :return: File format. + :rtype: FREE_IMAGE_FORMAT """ imagePath = imagePath or self.__imagePath @@ -2223,7 +2240,8 @@ def load(self): """ Loads the file. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ if not self.__imagePath: @@ -2243,7 +2261,8 @@ def save(self): """ Saves the file. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ return self.saveAs(self.getImageFormat(self.__imagePath), self.__imagePath, FI_DEFAULT_NULL) @@ -2253,10 +2272,14 @@ def saveAs(self, imageFormat, imagePath, flags=FI_DEFAULT_NULL): """ Saves the image to the given file. - :param imageFormat: Image format. ( Integer ) - :param imagePath: Image path. ( String ) - :param flags: Save flags. ( Integer ) - :return: Method success. ( Boolean ) + :param imageFormat: Image format. + :type imageFormat: int + :param imagePath: Image path. + :type imagePath: unicode + :param flags: Save flags. + :type flags: int + :return: Method success. + :rtype: bool """ if self.__library.FreeImage_FIFSupportsWriting(imageFormat): @@ -2273,9 +2296,12 @@ def convertToType(self, targetType, linearScale=True): """ Converts the bitmap to given type. - :param targetType: Target type. ( Integer ) - :param linearScale: Linear scale. ( Boolean ) - :return: Method success. ( Boolean ) + :param targetType: Target type. + :type targetType: int + :param linearScale: Linear scale. + :type linearScale: bool + :return: Method success. + :rtype: bool """ LOGGER.debug("> Converting '{0}' image bitmap to type '{1}'!".format(self.__imagePath, targetType)) @@ -2288,8 +2314,10 @@ def convertToLdr(self, gamma=2.2): """ Converts the HDR bitmap to LDR. - :param gamma: Image conversion gamma. ( Float ) - :return: Method success. ( Boolean ) + :param gamma: Image conversion gamma. + :type gamma: float + :return: Method success. + :rtype: bool """ LOGGER.debug("> Converting '{0}' HDR image bitmap to LDR!".format(self.__imagePath)) @@ -2303,7 +2331,8 @@ def convertToQImage(self): """ Converts the bitmap to `QImage `_. - :return: Converted image. ( QImage ) + :return: Converted image. + :rtype: QImage """ bpp = self.__library.FreeImage_GetBPP(self.__bitmap) diff --git a/sibl_gui/resources/patches/001_migrate_3-x-x_to_4-0-0.py b/sibl_gui/resources/patches/001_migrate_3-x-x_to_4-0-0.py index 09300d56..eb022831 100644 --- a/sibl_gui/resources/patches/001_migrate_3-x-x_to_4-0-0.py +++ b/sibl_gui/resources/patches/001_migrate_3-x-x_to_4-0-0.py @@ -61,7 +61,8 @@ def apply(): """ Triggers the patch execution. - :return: Definition success. ( Boolean ) + :return: Definition success. + :rtype: bool """ deprecated = """ diff --git a/sibl_gui/resources/patches/002_migrate_4-x-x_to_4-0-2.py b/sibl_gui/resources/patches/002_migrate_4-x-x_to_4-0-2.py index 2884e203..a3e5e7f7 100644 --- a/sibl_gui/resources/patches/002_migrate_4-x-x_to_4-0-2.py +++ b/sibl_gui/resources/patches/002_migrate_4-x-x_to_4-0-2.py @@ -56,7 +56,8 @@ def apply(): """ Triggers the patch execution. - :return: Definition success. ( Boolean ) + :return: Definition success. + :rtype: bool """ defaultScriptEditorDirectory = os.path.join(RuntimeGlobals.userApplicationDataDirectory, diff --git a/sibl_gui/resources/patches/003_migrate_4-x-x_to_4-0-3.py b/sibl_gui/resources/patches/003_migrate_4-x-x_to_4-0-3.py index 2dd2b936..0c223cb0 100644 --- a/sibl_gui/resources/patches/003_migrate_4-x-x_to_4-0-3.py +++ b/sibl_gui/resources/patches/003_migrate_4-x-x_to_4-0-3.py @@ -57,7 +57,8 @@ def apply(): """ Triggers the patch execution. - :return: Definition success. ( Boolean ) + :return: Definition success. + :rtype: bool """ umbra.ui.widgets.messageBox.messageBox("Information", diff --git a/sibl_gui/resources/patches/004_migrate_4-x-x_to_4-0-7.py b/sibl_gui/resources/patches/004_migrate_4-x-x_to_4-0-7.py index 48407382..bcd5bcff 100644 --- a/sibl_gui/resources/patches/004_migrate_4-x-x_to_4-0-7.py +++ b/sibl_gui/resources/patches/004_migrate_4-x-x_to_4-0-7.py @@ -61,7 +61,8 @@ def apply(): """ Triggers the patch execution. - :return: Definition success. ( Boolean ) + :return: Definition success. + :rtype: bool """ databaseDirectory = os.path.join(RuntimeGlobals.userApplicationDataDirectory, Constants.databaseDirectory) diff --git a/sibl_gui/tests/tests.py b/sibl_gui/tests/tests.py index 53d53694..da559086 100644 --- a/sibl_gui/tests/tests.py +++ b/sibl_gui/tests/tests.py @@ -48,7 +48,8 @@ def _setPackageDirectory(): """ Sets the package directory in the path. - :return: Definition success. ( Boolean ) + :return: Definition success. + :rtype: bool """ packageDirectory = os.path.normpath(os.path.join(os.path.dirname(__file__), "../")) @@ -61,7 +62,8 @@ def testsSuite(): """ Runs the tests suite. - :return: Tests suite. ( TestSuite ) + :return: Tests suite. + :rtype: TestSuite """ testsLoader = unittest.TestLoader() diff --git a/sibl_gui/tests/testsInternational.py b/sibl_gui/tests/testsInternational.py index 809fc5b1..f1f0ea83 100644 --- a/sibl_gui/tests/testsInternational.py +++ b/sibl_gui/tests/testsInternational.py @@ -58,7 +58,8 @@ def testsInternational(): """ Runs the international tests suite. - :return: Definition success. ( Boolean ) + :return: Definition success. + :rtype: bool """ userApplicationDirectory = tempfile.mkdtemp(prefix=USER_APPLICATION_DIRECTORY_PREFIX) diff --git a/sibl_gui/ui/caches.py b/sibl_gui/ui/caches.py index e4f15e5b..1588bccf 100644 --- a/sibl_gui/ui/caches.py +++ b/sibl_gui/ui/caches.py @@ -64,7 +64,8 @@ def __init__(self, **kwargs): """ Initializes the class. - :param kwargs: type, content. ( Key / Value pairs ) + :param kwargs: type, content. + :type kwargs: dict """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -81,7 +82,8 @@ class AbstractResourcesCache(QObject): This signal is emited by the :class:`AsynchronousGraphicsItemsCache` class whenever content has been added. ( pyqtSignal ) - :return: Content added to the cache. ( List ) + :return: Content added to the cache. + :rtype: list """ contentRemoved = pyqtSignal(list) @@ -89,14 +91,16 @@ class AbstractResourcesCache(QObject): This signal is emited by the :class:`AsynchronousGraphicsItemsCache` class whenever content has been removed. ( pyqtSignal ) - :return: Content removed from the cache. ( List ) + :return: Content removed from the cache. + :rtype: list """ def __init__(self, parent=None): """ Initializes the class. - :param parent: Object parent. ( QObject ) + :param parent: Object parent. + :type parent: QObject """ QObject.__init__(self, parent) @@ -111,7 +115,8 @@ def mapping(self): """ Property for **self.__mapping** attribute. - :return: self.__mapping. ( Dictionary ) + :return: self.__mapping. + :rtype: dict """ return self.__mapping @@ -122,7 +127,8 @@ def mapping(self, value): """ Setter for **self.__mapping** attribute. - :param value: Attribute value. ( Dictionary ) + :param value: Attribute value. + :type value: dict """ raise foundations.exceptions.ProgrammingError( @@ -145,8 +151,10 @@ def __getitem__(self, item): """ Reimplements the :meth:`object.__getitem__` method. - :param item: Item name. ( String ) - :return: Item. ( Object ) + :param item: Item name. + :type item: unicode + :return: Item. + :rtype: object """ return self.__mapping.__getitem__(item) @@ -155,8 +163,10 @@ def __setitem__(self, key, value): """ Reimplements the :meth:`object.__setitem__` method. - :param key: Key. ( String ) - :param value: Item. ( Object ) + :param key: Key. + :type key: unicode + :param value: Item. + :type value: object """ self.__mapping.__setitem__(key, value) @@ -165,7 +175,8 @@ def __iter__(self): """ Reimplements the :meth:`object.__iter__` method. - :return: Paths iterator. ( Object ) + :return: Paths iterator. + :rtype: object """ return self.__mapping.iteritems() @@ -174,8 +185,10 @@ def __contains__(self, item): """ Reimplements the :meth:`object.__contains__` method. - :param item: Item name. ( String ) - :return: Item existence. ( Boolean ) + :param item: Item name. + :type item: unicode + :return: Item existence. + :rtype: bool """ return item in self.__mapping.keys() @@ -184,7 +197,8 @@ def __len__(self): """ Reimplements the :meth:`object.__len__` method. - :return: Paths count. ( Integer ) + :return: Paths count. + :rtype: int """ return len(self.__mapping.keys()) @@ -193,8 +207,10 @@ def isCached(self, key): """ Returns if given content is cached. - :param key: Content to retrieve. ( Object ) - :return: Is content cached. ( Boolean ) + :param key: Content to retrieve. + :type key: object + :return: Is content cached. + :rtype: bool """ return key in self @@ -203,7 +219,8 @@ def listContent(self): """ Lists the cache content. - :return: Cache content. ( List ) + :return: Cache content. + :rtype: list """ return self.__mapping.keys() @@ -212,8 +229,10 @@ def addContent(self, **content): """ Adds given content to the cache. - :param \*\*content: Content to add. ( \*\* ) - :return: Method success. ( Boolean ) + :param \*\*content: Content to add. + :type \*\*content: \*\* + :return: Method success. + :rtype: bool """ LOGGER.debug("> Adding '{0}' content to the cache.".format(self.__class__.__name__, content)) @@ -226,8 +245,10 @@ def removeContent(self, *keys): """ Removes given content from the cache. - :param \*keys: Content to remove. ( \* ) - :return: Method success. ( Boolean ) + :param \*keys: Content to remove. + :type \*keys: \* + :return: Method success. + :rtype: bool """ LOGGER.debug("> Removing '{0}' content from the cache.".format(self.__class__.__name__, keys)) @@ -244,8 +265,10 @@ def getContent(self, key): """ Gets given content from the cache. - :param key: Content to retrieve. ( Object ) - :return: Content. ( Object ) + :param key: Content to retrieve. + :type key: object + :return: Content. + :rtype: object """ LOGGER.debug("> Retrieving '{0}' content from the cache.".format(self.__class__.__name__, key)) @@ -256,7 +279,8 @@ def flushContent(self): """ Flushes the cache content. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Flushing cache content.".format(self.__class__.__name__)) @@ -270,7 +294,8 @@ def getMetrics(self): """ Returns the cache metrics. - :return: Cache metrics. ( Dictionary ) + :return: Cache metrics. + :rtype: dict """ cacheMetrics = CacheMetrics() @@ -287,9 +312,12 @@ def __init__(self, parent=None, type=None, placeholder=None): """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param type: Cache type. ( QImage / QPixmap / QIcon ) - :param placeholder: Placeholder image. ( String ) + :param parent: Object parent. + :type parent: QObject + :param type: Cache type. + :type type: QImage or QPixmap or QIcon + :param placeholder: Placeholder image. + :type placeholder: unicode """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -315,7 +343,8 @@ def type(self): """ Property for **self.__type** attribute. - :return: self.__type. ( QObject ) + :return: self.__type. + :rtype: QObject """ return self.__type @@ -326,7 +355,8 @@ def type(self, value): """ Setter for **self.__type** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -347,7 +377,8 @@ def placeholder(self): """ Property for **self.__placeholder** attribute. - :return: self.__placeholder. ( String ) + :return: self.__placeholder. + :rtype: unicode """ return self.__placeholder @@ -358,7 +389,8 @@ def placeholder(self, value): """ Setter for **self.__placeholder** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ raise foundations.exceptions.ProgrammingError( @@ -379,7 +411,8 @@ def placeholderGraphicsItem(self): """ Property for **self.__placeholderGraphicsItem** attribute. - :return: self.__placeholderGraphicsItem. ( QObject ) + :return: self.__placeholderGraphicsItem. + :rtype: QObject """ return self.__placeholderGraphicsItem @@ -390,7 +423,8 @@ def placeholderGraphicsItem(self, value): """ Setter for **self.__placeholderGraphicsItem** attribute. - :param value: Attribute value. ( QObject ) + :param value: Attribute value. + :type value: QObject """ raise foundations.exceptions.ProgrammingError( @@ -411,7 +445,8 @@ def worker(self): """ Property for **self.__worker** attribute. - :return: self.__worker. ( QThread ) + :return: self.__worker. + :rtype: QThread """ return self.__worker @@ -422,7 +457,8 @@ def worker(self, value): """ Setter for **self.__worker** attribute. - :param value: Attribute value. ( QThread ) + :param value: Attribute value. + :type value: QThread """ if value is not None: @@ -448,8 +484,10 @@ def __worker__imageLoaded(self, image, size): """ Defines the slot triggered by :obj:`AsynchronousGraphicsItemsCache.worker` method when an image has been loaded. - :param image: Loaded image. ( QImage ) - :param size: Image size. ( String ) + :param image: Loaded image. + :type image: QImage + :param size: Image size. + :type size: unicode """ graphicsItem = sibl_gui.ui.common.convertImage(image, self.__type) @@ -465,7 +503,8 @@ def __setPlaceholderGraphicsItem(self, path): """ Sets the placeholderGraphicsItem graphics item. - :param path: Placeholder image path. ( String ) + :param path: Placeholder image path. + :type path: unicode """ if not foundations.common.pathExists(path): @@ -481,9 +520,12 @@ def getContent(self, key, size="Default"): """ Reimplements the :meth:`AbstractResourcesCache.getContent` method. - :param key: Content to retrieve. ( Object ) - :param size: Size to retrieve. ( String ) - :return: Content. ( Object ) + :param key: Content to retrieve. + :type key: object + :param size: Size to retrieve. + :type size: unicode + :return: Content. + :rtype: object """ LOGGER.debug("> Retrieving '{0}' content from the cache.".format(self.__class__.__name__, key)) @@ -496,7 +538,8 @@ def flushContent(self): """ Reimplements the :meth:`AbstractResourcesCache.flushContent` method. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Flushing cache content.".format(self.__class__.__name__)) @@ -512,8 +555,10 @@ def loadContent(self, **content): """ Loads given content into the cache. - :param \*\*content: Content to add. ( \*\* ) - :return: Method success. ( Boolean ) + :param \*\*content: Content to add. + :type \*\*content: \*\* + :return: Method success. + :rtype: bool """ LOGGER.debug("> Adding '{0}' content to the cache.".format(self.__class__.__name__, content)) @@ -541,8 +586,10 @@ def loadAsynchronousContent(self, **content): """ Loads given content asynchronously into the cache. - :param \*\*content: Content to add. ( \*\* ) - :return: Method success. ( Boolean ) + :param \*\*content: Content to add. + :type \*\*content: \*\* + :return: Method success. + :rtype: bool """ LOGGER.debug("> Adding '{0}' content to the cache.".format(self.__class__.__name__, content)) @@ -582,7 +629,8 @@ def getMetrics(self): """ Reimplements the :meth:`AbstractResourcesCache.getMetrics` method. - :return: Cache metrics. ( Dictionary ) + :return: Cache metrics. + :rtype: dict """ cacheMetrics = AbstractResourcesCache.getMetrics(self) diff --git a/sibl_gui/ui/common.py b/sibl_gui/ui/common.py index 81c492e3..4ce9417a 100644 --- a/sibl_gui/ui/common.py +++ b/sibl_gui/ui/common.py @@ -81,9 +81,12 @@ def convertImage(image, type): """ Converts given image to given type. - :param image: Image to convert. ( QImage ) - :param type: Type to convert to. ( QImage / QPixmap / QIcon ) - :return: Converted image. ( QImage / QPixmap / QIcon ) + :param image: Image to convert. + :type image: QImage + :param type: Type to convert to. + :type type: QImage or QPixmap or QIcon + :return: Converted image. + :rtype: QImage or QPixmap or QIcon """ graphicsItem = image @@ -98,10 +101,14 @@ def getThumbnailPath(path, size, cacheDirectory=None): """ Returns given image thumbnail cached path at given size. - :param path: Image path. ( String ) - :param size: Thumbnail size. ( String ) - :param cacheDirectory: Thumbnails cache directory. ( String ) - :return: Cached thumbnail path. ( String ) + :param path: Image path. + :type path: unicode + :param size: Thumbnail size. + :type size: unicode + :param cacheDirectory: Thumbnails cache directory. + :type cacheDirectory: unicode + :return: Cached thumbnail path. + :rtype: unicode """ cacheDirectory = cacheDirectory if cacheDirectory is not None else RuntimeGlobals.thumbnailsCacheDirectory @@ -117,13 +124,20 @@ def extractThumbnail(path, """ Extract given image thumbnail at given size. - :param path: Image path. ( String ) - :param size: Thumbnail size. ( String ) - :param image: Image to use instead of given path one. ( QImage ) - :param format: Thumbnail format. ( String ) - :param quality: Thumbnail quality, -1 to 100. ( Integer ) - :param cacheDirectory: Thumbnails cache directory. ( String ) - :return: Thumbnail image. ( QImage ) + :param path: Image path. + :type path: unicode + :param size: Thumbnail size. + :type size: unicode + :param image: Image to use instead of given path one. + :type image: QImage + :param format: Thumbnail format. + :type format: unicode + :param quality: Thumbnail quality, -1 to 100. + :type quality: int + :param cacheDirectory: Thumbnails cache directory. + :type cacheDirectory: unicode + :return: Thumbnail image. + :rtype: QImage """ cacheDirectory = cacheDirectory if cacheDirectory is not None else RuntimeGlobals.thumbnailsCacheDirectory @@ -148,9 +162,12 @@ def loadGraphicsItem(path, type, size="Default"): Loads a graphic item: `QIcon `_, `QImage `_, `QPixmap `_. - :param path: Image path. ( String ) - :param type: QIcon, QImage, QPixmap. ( QObject ) - :param size: Image size. ( String ) + :param path: Image path. + :type path: unicode + :param type: QIcon, QImage, QPixmap. + :type type: QObject + :param size: Image size. + :type size: unicode :return: Image. ( QIcon, QImage, QPixmap ) """ @@ -187,12 +204,17 @@ def getGraphicsItem(path, type, size="Default", asynchronousLoading=True, placeh Returns a display item: `QIcon `_, `QImage `_, `QPixmap `_ instance. - :param path: Image path. ( String ) - :param type: QIcon, QImage, QPixmap. ( QObject ) - :param size: Image size. ( String ) - :param asynchronousLoading: Images are loaded asynchronously. ( Boolean ) + :param path: Image path. + :type path: unicode + :param type: QIcon, QImage, QPixmap. + :type type: QObject + :param size: Image size. + :type size: unicode + :param asynchronousLoading: Images are loaded asynchronously. + :type asynchronousLoading: bool :param placeholder: Placeholder to use while loading asynchronously. ( QIcon, QImage, QPixmap ) - :param imagesCache: Image cache. ( Dictionary / AsynchronousGraphicsItemsCache ) + :param imagesCache: Image cache. + :type imagesCache: Dictionary or AsynchronousGraphicsItemsCache :return: Image. ( QIcon, QImage, QPixmap ) """ @@ -217,12 +239,18 @@ def getIcon(path, size="Default", asynchronousLoading=True, placeholder=None, im """ Returns a `QIcon `_ instance. - :param path: Icon image path. ( String ) - :param size: Image size. ( String ) - :param asynchronousLoading: Images are loaded asynchronously. ( Boolean ) - :param placeholder: Placeholder to use while loading asynchronously. ( QIcon ) - :param imagesCache: Image cache. ( Dictionary / AsynchronousGraphicsItemsCache ) - :return: QIcon. ( QIcon ) + :param path: Icon image path. + :type path: unicode + :param size: Image size. + :type size: unicode + :param asynchronousLoading: Images are loaded asynchronously. + :type asynchronousLoading: bool + :param placeholder: Placeholder to use while loading asynchronously. + :type placeholder: QIcon + :param imagesCache: Image cache. + :type imagesCache: Dictionary or AsynchronousGraphicsItemsCache + :return: QIcon. + :rtype: QIcon """ cache = imagesCache and imagesCache or RuntimeGlobals.imagesCaches.get("QIcon") @@ -232,12 +260,18 @@ def getPixmap(path, size="Default", asynchronousLoading=True, placeholder=None, """ Returns a `QPixmap `_ instance. - :param path: Icon image path. ( String ) - :param size: Image size. ( String ) - :param asynchronousLoading: Images are loaded asynchronously. ( Boolean ) - :param placeholder: Placeholder to use while loading asynchronously. ( QPixmap ) - :param imagesCache: Image cache. ( Dictionary / AsynchronousGraphicsItemsCache ) - :return: QPixmap. ( QPixmap ) + :param path: Icon image path. + :type path: unicode + :param size: Image size. + :type size: unicode + :param asynchronousLoading: Images are loaded asynchronously. + :type asynchronousLoading: bool + :param placeholder: Placeholder to use while loading asynchronously. + :type placeholder: QPixmap + :param imagesCache: Image cache. + :type imagesCache: Dictionary or AsynchronousGraphicsItemsCache + :return: QPixmap. + :rtype: QPixmap """ cache = imagesCache and imagesCache or RuntimeGlobals.imagesCaches.get("QPixmap") @@ -247,12 +281,18 @@ def getImage(path, size="Default", asynchronousLoading=True, placeholder=None, i """ Returns a `QImage `_ instance. - :param path: Icon image path. ( String ) - :param size: Image size. ( String ) - :param asynchronousLoading: Images are loaded asynchronously. ( Boolean ) - :param placeholder: Placeholder to use while loading asynchronously. ( QImage ) - :param imagesCache: Image cache. ( Dictionary / AsynchronousGraphicsItemsCache ) - :return: QImage. ( QImage ) + :param path: Icon image path. + :type path: unicode + :param size: Image size. + :type size: unicode + :param asynchronousLoading: Images are loaded asynchronously. + :type asynchronousLoading: bool + :param placeholder: Placeholder to use while loading asynchronously. + :type placeholder: QImage + :param imagesCache: Image cache. + :type imagesCache: Dictionary or AsynchronousGraphicsItemsCache + :return: QImage. + :rtype: QImage """ cache = imagesCache and imagesCache or RuntimeGlobals.imagesCaches.get("QImage") @@ -262,10 +302,14 @@ def createPixmap(width=128, height=128, text=None): """ Create a default `QPixmap `_ instance. - :param width: Pixmap width. ( Integer ) - :param height: Pixmap height. ( Integer ) - :param text: Pximap text. ( String ) - :return: QPixmap. ( QPixmap ) + :param width: Pixmap width. + :type width: int + :param height: Pixmap height. + :type height: int + :param text: Pximap text. + :type text: unicode + :return: QPixmap. + :rtype: QPixmap """ loadingPixmap = QPixmap(width, height) @@ -284,9 +328,11 @@ def getImageInformationsHeader(path, graphicsItem): Returns a :class:`sibl_gui.libraries.freeImage.freeImage.ImageInformationsHeader` class from given path and graphics item. - :param path: Image path. ( String ) + :param path: Image path. + :type path: unicode :param graphicsItem: Image graphics item. ( QImage, QPixmap, QIcon ) - :return: Image informations header. ( ImageInformationsHeader ) + :return: Image informations header. + :rtype: ImageInformationsHeader """ if not foundations.common.pathExists(path): @@ -305,8 +351,10 @@ def filterImagePath(path): """ Filters the image path. - :param path: Image path. ( String ) - :return: Path. ( String ) + :param path: Image path. + :type path: unicode + :return: Path. + :rtype: unicode """ if foundations.common.pathExists(path): @@ -323,9 +371,12 @@ def getFormatedShotDate(date, time): """ Returns a formated shot date. - :param date: Ibl Set date key value. ( String ) - :param time: Ibl Set time key value. ( String ) - :return: Current shot date. ( String ) + :param date: Ibl Set date key value. + :type date: unicode + :param time: Ibl Set time key value. + :type time: unicode + :return: Current shot date. + :rtype: unicode """ LOGGER.debug("> Formating shot date with '{0}' date and '{1}' time.".format(date, time)) diff --git a/sibl_gui/ui/models.py b/sibl_gui/ui/models.py index 00a1e992..29ab0f3c 100644 --- a/sibl_gui/ui/models.py +++ b/sibl_gui/ui/models.py @@ -60,11 +60,16 @@ def __init__(self, parent=None, rootNode=None, horizontalHeaders=None, verticalH """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param rootNode: Root node. ( AbstractCompositeNode ) - :param horizontalHeaders: Headers. ( OrderedDict ) - :param verticalHeaders: Headers. ( OrderedDict ) - :param defaultNode: Default node. ( GraphModelNode ) + :param parent: Object parent. + :type parent: QObject + :param rootNode: Root node. + :type rootNode: AbunicodeactCompositeNode + :param horizontalHeaders: Headers. + :type horizontalHeaders: OrderedDict + :param verticalHeaders: Headers. + :type verticalHeaders: OrderedDict + :param defaultNode: Default node. + :type defaultNode: GraphModelNode """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -78,9 +83,12 @@ def data(self, index, role=Qt.DisplayRole): """ Reimplements the :meth:`umbra.ui.models.GraphModel.data` method. - :param index: Index. ( QModelIndex ) - :param role: Role. ( Integer ) - :return: Data. ( QVariant ) + :param index: Index. + :type index: QModelIndex + :param role: Role. + :type role: int + :return: Data. + :rtype: QVariant """ if not index.isValid(): diff --git a/sibl_gui/ui/nodes.py b/sibl_gui/ui/nodes.py index f4fe5bb1..4f50271c 100644 --- a/sibl_gui/ui/nodes.py +++ b/sibl_gui/ui/nodes.py @@ -76,7 +76,8 @@ def iconSize(self): """ Property for **self.__iconSize** attribute. - :return: self.__iconSize. ( String ) + :return: self.__iconSize. + :rtype: unicode """ return self.__iconSize @@ -87,7 +88,8 @@ def iconSize(self, value): """ Setter for **self.__iconSize** attribute. - :param value: Attribute value. ( String ) + :param value: Attribute value. + :type value: unicode """ if value is not None: @@ -110,7 +112,8 @@ def iconPlaceholder(self): """ Property for **self.__iconPlaceholder** attribute. - :return: self.__iconPlaceholder. ( QIcon ) + :return: self.__iconPlaceholder. + :rtype: QIcon """ return self.__iconPlaceholder @@ -121,7 +124,8 @@ def iconPlaceholder(self, value): """ Setter for **self.__iconPlaceholder** attribute. - :param value: Attribute value. ( QIcon ) + :param value: Attribute value. + :type value: QIcon """ if value is not None: @@ -155,13 +159,20 @@ def __init__(self, """ Initializes the class. - :param name: Attribute name. ( String ) - :param value: Attribute value. ( Object ) - :param roles: Roles. ( Dictionary ) - :param flags: Flags. ( Integer ) - :param iconSize: Icon size. ( String ) - :param iconPlaceholder: Icon placeholder. ( QIcon ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param name: Attribute name. + :type name: unicode + :param value: Attribute value. + :type value: object + :param roles: Roles. + :type roles: dict + :param flags: Flags. + :type flags: int + :param iconSize: Icon size. + :type iconSize: unicode + :param iconPlaceholder: Icon placeholder. + :type iconPlaceholder: QIcon + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -193,14 +204,21 @@ def __init__(self, """ Initializes the class. - :param name: Node name. ( String ) - :param parent: Node parent. ( AbstractNode / AbstractCompositeNode ) - :param children: Children. ( List ) - :param roles: Roles. ( Dictionary ) + :param name: Node name. + :type name: unicode + :param parent: Node parent. + :type parent: AbunicodeactNode or AbunicodeactCompositeNode + :param children: Children. + :type children: list + :param roles: Roles. + :type roles: dict :param flags: Flags. ( Qt.ItemFlag ) - :param iconSize: Icon size. ( String ) - :param iconPlaceholder: Icon placeholder. ( QIcon ) - :param \*\*kwargs: Keywords arguments. ( \*\* ) + :param iconSize: Icon size. + :type iconSize: unicode + :param iconPlaceholder: Icon placeholder. + :type iconPlaceholder: QIcon + :param \*\*kwargs: Keywords arguments. + :type \*\*kwargs: \*\* """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) diff --git a/sibl_gui/ui/views.py b/sibl_gui/ui/views.py index f374a1b8..833ff232 100644 --- a/sibl_gui/ui/views.py +++ b/sibl_gui/ui/views.py @@ -56,7 +56,8 @@ def __init__(self, model=None): """ Initializes the class. - :param model: Model. ( QObject ) + :param model: Model. + :type model: QObject """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -74,7 +75,8 @@ def modelSelection(self): """ Property for **self.__modelSelection** attribute. - :return: self.__modelSelection. ( Dictionary ) + :return: self.__modelSelection. + :rtype: dict """ return self.__modelSelection @@ -85,7 +87,8 @@ def modelSelection(self, value): """ Setter for **self.__modelSelection** attribute. - :param value: Attribute value. ( Dictionary ) + :param value: Attribute value. + :type value: dict """ if value is not None: @@ -114,7 +117,8 @@ def setModel(self, model): """ Reimplements the **umbra.ui.views.Abstract_QListView.setModel** method. - :param model: Model to set. ( QObject ) + :param model: Model to set. + :type model: QObject """ if not model: @@ -146,7 +150,8 @@ def storeModelSelection(self): """ Stores the Model selection. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Storing Model selection!") @@ -160,7 +165,8 @@ def restoreModelSelection(self): """ Restores the Model selection. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Restoring Model selection!") @@ -187,10 +193,14 @@ def __init__(self, parent=None, model=None, readOnly=False, message=None): """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param model: Model. ( QObject ) - :param readOnly: View is read only. ( Boolean ) - :param message: View default message when Model is empty. ( String ) + :param parent: Object parent. + :type parent: QObject + :param model: Model. + :type model: QObject + :param readOnly: View is read only. + :type readOnly: bool + :param message: View default message when Model is empty. + :type message: unicode """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -207,10 +217,14 @@ def __init__(self, parent=None, model=None, readOnly=False, message=None): """ Initializes the class. - :param parent: Object parent. ( QObject ) - :param model: Model. ( QObject ) - :param readOnly: View is read only. ( Boolean ) - :param message: View default message when Model is empty. ( String ) + :param parent: Object parent. + :type parent: QObject + :param model: Model. + :type model: QObject + :param readOnly: View is read only. + :type readOnly: bool + :param message: View default message when Model is empty. + :type message: unicode """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) diff --git a/sibl_gui/ui/widgets/application_QToolBar.py b/sibl_gui/ui/widgets/application_QToolBar.py index a57e01bd..faba1a44 100644 --- a/sibl_gui/ui/widgets/application_QToolBar.py +++ b/sibl_gui/ui/widgets/application_QToolBar.py @@ -82,7 +82,8 @@ def setToolBarChildrenWidgets(self): """ Sets the toolBar children widgets. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ LOGGER.debug("> Adding 'Application_Logo_label' widget!") @@ -119,7 +120,8 @@ def getLayoutsActiveLabels(self): """ Returns the layouts **Active_QLabel** widgets. - :return: Layouts active labels. ( List ) + :return: Layouts active labels. + :rtype: list """ self.__layoutsActiveLabelsCollection = Active_QLabelsCollection(self) @@ -168,7 +170,8 @@ def getCentralWidgetActiveLabel(self): """ Provides the default **Central_Widget_activeLabel** widget. - :return: Central Widget active label. ( Active_QLabel ) + :return: Central Widget active label. + :rtype: Active_QLabel """ centralWidgetButton = Active_QLabel(self, @@ -185,7 +188,8 @@ def extendMiscellaneousActiveLabel(self): """ Extends the default **Miscellaneous_activeLabel** widget. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ self.miscellaneousMenu.addAction(self.__container.actionsManager.registerAction( @@ -198,8 +202,10 @@ def __makeDonationDisplayMiscAction__triggered(self, checked): """ Defines the slot triggered by **'Actions|Umbra|ToolBar|Miscellaneous|Make A Donation ...'** action. - :param checked: Checked state. ( Boolean ) - :return: Method success. ( Boolean ) + :param checked: Checked state. + :type checked: bool + :return: Method success. + :rtype: bool """ LOGGER.debug("> Opening url: '{0}'.".format(UiConstants.makeDonationFile)) diff --git a/sibl_gui/ui/workers.py b/sibl_gui/ui/workers.py index 6233ec63..6448556b 100644 --- a/sibl_gui/ui/workers.py +++ b/sibl_gui/ui/workers.py @@ -62,14 +62,16 @@ class GraphicsItem_worker(QThread): """ This signal is emited by the :class:`GraphicsItem_worker` class when an image has been loaded. ( pyqtSignal ) - :return: Loaded image. ( QImage ) + :return: Loaded image. + :rtype: QImage """ def __init__(self, parent=None): """ Initializes the class. - :param parent: Object parent. ( QObject ) + :param parent: Object parent. + :type parent: QObject """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) @@ -88,7 +90,8 @@ def requests(self): """ Property for **self.__requests** attribute. - :return: self.__requests. ( Queue ) + :return: self.__requests. + :rtype: Queue """ return self.__requests @@ -99,7 +102,8 @@ def requests(self, value): """ Setter for **self.__requests** attribute. - :param value: Attribute value. ( Queue ) + :param value: Attribute value. + :type value: Queue """ raise foundations.exceptions.ProgrammingError( @@ -123,8 +127,10 @@ def addRequest(self, request): """ Adds given request to the requests queue. - :param request: Request. ( Tuple / List ) - :return: Method success. ( Boolean ) + :param request: Request. + :type request: tuple or list + :return: Method success. + :rtype: bool """ path, size = request @@ -140,7 +146,8 @@ def flushRequests(self): """ Flushes the requests queue. - :return: Method success. ( Boolean ) + :return: Method success. + :rtype: bool """ with self.__requests.mutex: diff --git a/utilities/getHDRLabsDocumentation.py b/utilities/getHDRLabsDocumentation.py index c03c466d..1d6a079a 100644 --- a/utilities/getHDRLabsDocumentation.py +++ b/utilities/getHDRLabsDocumentation.py @@ -55,8 +55,10 @@ def getHDRLabsDocumentation(fileIn, fileOut): """ Extracts sIBL_GUI Documentation body for HDRLabs.com. - :param fileIn: File to convert. ( String ) - :param fileOut: Output file. ( String ) + :param fileIn: File to convert. + :type fileIn: unicode + :param fileOut: Output file. + :type fileOut: unicode """ LOGGER.info("{0} | Extracting 'body' tag content from {1}' file!".format(getHDRLabsDocumentation.__name__, fileIn)) diff --git a/utilities/getSphinxDocumentationApi.py b/utilities/getSphinxDocumentationApi.py index b7d6ac99..8f99ad1a 100755 --- a/utilities/getSphinxDocumentationApi.py +++ b/utilities/getSphinxDocumentationApi.py @@ -26,7 +26,7 @@ import re import shutil import sys -f sys.version_info[:2] <= (2, 6): +if sys.version_info[:2] <= (2, 6): from ordereddict import OrderedDict else: from collections import OrderedDict @@ -112,10 +112,14 @@ def getSphinxDocumentationApi(packages, cloneDirectory, outputDirectory, apiFile """ Gets Sphinx documentation API. - :param packages: Packages. ( String ) - :param cloneDirectory: Source clone directory. ( String ) - :param outputDirectory: Content directory. ( String ) - :param apiFile: API file. ( String ) + :param packages: Packages. + :type packages: unicode + :param cloneDirectory: Source clone directory. + :type cloneDirectory: unicode + :param outputDirectory: Content directory. + :type outputDirectory: unicode + :param apiFile: API file. + :type apiFile: unicode """ LOGGER.info("{0} | Building Sphinx documentation API!".format(getSphinxDocumentationApi.__name__)) diff --git a/utilities/getSphinxDocumentationTocTree.py b/utilities/getSphinxDocumentationTocTree.py index c9333a28..bb224542 100644 --- a/utilities/getSphinxDocumentationTocTree.py +++ b/utilities/getSphinxDocumentationTocTree.py @@ -83,10 +83,14 @@ def getSphinxDocumentationTocTree(title, fileIn, fileOut, contentDirectory): """ Gets Sphinx documentation index file. - :param title: Package title. ( String ) - :param fileIn: File to convert. ( String ) - :param fileOut: Output file. ( String ) - :param contentDirectory: Content directory. ( String ) + :param title: Package title. + :type title: unicode + :param fileIn: File to convert. + :type fileIn: unicode + :param fileOut: Output file. + :type fileOut: unicode + :param contentDirectory: Content directory. + :type contentDirectory: unicode """ LOGGER.info("{0} | Building Sphinx documentation index '{1}' file!".format(getSphinxDocumentationTocTree.__name__, diff --git a/utilities/listImports.py b/utilities/listImports.py index f91eec96..a05e74c7 100644 --- a/utilities/listImports.py +++ b/utilities/listImports.py @@ -61,10 +61,14 @@ def listImports(packages, filtersIn, filtersOut): """ Lists Application imports. - :param packages: Packages. ( List ) - :param filtersIn: Filters in. ( Tuple / List ) - :param filtersOut: Filters out. ( Tuple / List ) - :return: Imports. ( List ) + :param packages: Packages. + :type packages: list + :param filtersIn: Filters in. + :type filtersIn: tuple or list + :param filtersOut: Filters out. + :type filtersOut: tuple or list + :return: Imports. + :rtype: list """ imports = set(IMPORTS) diff --git a/utilities/reStructuredTextToHtml.py b/utilities/reStructuredTextToHtml.py index 37f6a81b..fb12f15f 100644 --- a/utilities/reStructuredTextToHtml.py +++ b/utilities/reStructuredTextToHtml.py @@ -66,8 +66,10 @@ def reStructuredTextToHtml(fileIn, fileOut): """ Outputs a reStructuredText file to html. - :param fileIn: File to convert. ( String ) - :param fileOut: Output file. ( String ) + :param fileIn: File to convert. + :type fileIn: unicode + :param fileOut: Output file. + :type fileOut: unicode """ LOGGER.info("{0} | Converting '{1}' reStructuredText file to html!".format(reStructuredTextToHtml.__name__, fileIn)) diff --git a/utilities/recursiveRemove.py b/utilities/recursiveRemove.py index 8c65b184..0c9544ac 100644 --- a/utilities/recursiveRemove.py +++ b/utilities/recursiveRemove.py @@ -44,8 +44,10 @@ def recursiveRemove(rootDirectory, pattern): """ Recursively deletes the matching items. - :param rootDirectory: Directory to recurse. ( String ) - :param pattern: Pattern to match. ( String ) + :param rootDirectory: Directory to recurse. + :type rootDirectory: unicode + :param pattern: Pattern to match. + :type pattern: unicode """ if not os.path.exists(rootDirectory): @@ -60,7 +62,8 @@ def recursiveRemove(rootDirectory, pattern): def remove(item): """ Deletes given item. - :param item: Item to delete. ( String ) + :param item: Item to delete. + :type item: unicode """ print("{0} | Removing file: '{1}'".format(remove.__name__, item)) diff --git a/utilities/sliceDocumentation.py b/utilities/sliceDocumentation.py index 304a9619..09b28fcc 100644 --- a/utilities/sliceDocumentation.py +++ b/utilities/sliceDocumentation.py @@ -72,8 +72,10 @@ def sliceDocumentation(fileIn, outputDirectory): """ This Definition slices given documentation file. - :param fileIn: File to convert. ( String ) - :param outputDirectory: Output directory. ( String ) + :param fileIn: File to convert. + :type fileIn: unicode + :param outputDirectory: Output directory. + :type outputDirectory: unicode """ LOGGER.info("{0} | Slicing '{1}' file!".format(sliceDocumentation.__name__, fileIn)) From 2d2d3fc5792222ce111d704f9bc8a8cb893a7f05 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Thu, 6 Mar 2014 07:45:01 +0100 Subject: [PATCH 18/54] Update erroneous docstrings parameters. --- sibl_gui/components/core/collectionsOutliner/models.py | 2 +- sibl_gui/components/core/iblSetsOutliner/models.py | 2 +- sibl_gui/components/core/inspector/models.py | 2 +- sibl_gui/components/core/templatesOutliner/models.py | 2 +- sibl_gui/ui/models.py | 2 +- sibl_gui/ui/nodes.py | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/sibl_gui/components/core/collectionsOutliner/models.py b/sibl_gui/components/core/collectionsOutliner/models.py index 9aa25229..21e08a11 100644 --- a/sibl_gui/components/core/collectionsOutliner/models.py +++ b/sibl_gui/components/core/collectionsOutliner/models.py @@ -57,7 +57,7 @@ def __init__(self, parent=None, rootNode=None, horizontalHeaders=None, verticalH :param parent: Object parent. :type parent: QObject :param rootNode: Root node. - :type rootNode: AbunicodeactCompositeNode + :type rootNode: AbstractCompositeNode :param horizontalHeaders: Headers. :type horizontalHeaders: OrderedDict :param verticalHeaders: Headers. diff --git a/sibl_gui/components/core/iblSetsOutliner/models.py b/sibl_gui/components/core/iblSetsOutliner/models.py index 6157d989..7b4ead1c 100644 --- a/sibl_gui/components/core/iblSetsOutliner/models.py +++ b/sibl_gui/components/core/iblSetsOutliner/models.py @@ -62,7 +62,7 @@ def __init__(self, parent=None, rootNode=None, horizontalHeaders=None, verticalH :param parent: Object parent. :type parent: QObject :param rootNode: Root node. - :type rootNode: AbunicodeactCompositeNode + :type rootNode: AbstractCompositeNode :param horizontalHeaders: Headers. :type horizontalHeaders: OrderedDict :param verticalHeaders: Headers. diff --git a/sibl_gui/components/core/inspector/models.py b/sibl_gui/components/core/inspector/models.py index d90eb79a..96540bad 100644 --- a/sibl_gui/components/core/inspector/models.py +++ b/sibl_gui/components/core/inspector/models.py @@ -56,7 +56,7 @@ def __init__(self, parent=None, rootNode=None, horizontalHeaders=None, verticalH :param parent: Object parent. :type parent: QObject :param rootNode: Root node. - :type rootNode: AbunicodeactCompositeNode + :type rootNode: AbstractCompositeNode :param horizontalHeaders: Headers. :type horizontalHeaders: OrderedDict :param verticalHeaders: Headers. diff --git a/sibl_gui/components/core/templatesOutliner/models.py b/sibl_gui/components/core/templatesOutliner/models.py index f98fb9d4..1e51b1f3 100644 --- a/sibl_gui/components/core/templatesOutliner/models.py +++ b/sibl_gui/components/core/templatesOutliner/models.py @@ -56,7 +56,7 @@ def __init__(self, parent=None, rootNode=None, horizontalHeaders=None, verticalH :param parent: Object parent. :type parent: QObject :param rootNode: Root node. - :type rootNode: AbunicodeactCompositeNode + :type rootNode: AbstractCompositeNode :param horizontalHeaders: Headers. :type horizontalHeaders: OrderedDict :param verticalHeaders: Headers. diff --git a/sibl_gui/ui/models.py b/sibl_gui/ui/models.py index 29ab0f3c..34454803 100644 --- a/sibl_gui/ui/models.py +++ b/sibl_gui/ui/models.py @@ -63,7 +63,7 @@ def __init__(self, parent=None, rootNode=None, horizontalHeaders=None, verticalH :param parent: Object parent. :type parent: QObject :param rootNode: Root node. - :type rootNode: AbunicodeactCompositeNode + :type rootNode: AbstractCompositeNode :param horizontalHeaders: Headers. :type horizontalHeaders: OrderedDict :param verticalHeaders: Headers. diff --git a/sibl_gui/ui/nodes.py b/sibl_gui/ui/nodes.py index 4f50271c..5771ceef 100644 --- a/sibl_gui/ui/nodes.py +++ b/sibl_gui/ui/nodes.py @@ -207,7 +207,7 @@ def __init__(self, :param name: Node name. :type name: unicode :param parent: Node parent. - :type parent: AbunicodeactNode or AbunicodeactCompositeNode + :type parent: AbstractNode or AbstractCompositeNode :param children: Children. :type children: list :param roles: Roles. From 4a5e1e6196e43f998a7c912dd8c70c9bda4424c2 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Fri, 7 Mar 2014 09:17:35 +0100 Subject: [PATCH 19/54] Update modules headers docstrings. --- .../resources/pages/api/foundations.cache.rst | 17 - .../pages/api/foundations.common.rst | 41 - .../resources/pages/api/foundations.core.rst | 17 - .../pages/api/foundations.dataStructures.rst | 29 - .../pages/api/foundations.decorators.rst | 17 - .../pages/api/foundations.environment.rst | 24 - .../pages/api/foundations.exceptions.rst | 140 ---- .../api/foundations.globals.constants.rst | 12 - .../resources/pages/api/foundations.io.rst | 26 - .../pages/api/foundations.library.rst | 21 - .../pages/api/foundations.namespace.rst | 25 - .../resources/pages/api/foundations.nodes.rst | 25 - .../pages/api/foundations.parsers.rst | 30 - .../resources/pages/api/foundations.pkzip.rst | 17 - .../pages/api/foundations.rotatingBackup.rst | 17 - .../pages/api/foundations.strings.rst | 49 -- .../pages/api/foundations.tcpServer.rst | 21 - .../resources/pages/api/foundations.trace.rst | 95 --- .../pages/api/foundations.ui.common.rst | 21 - .../pages/api/foundations.verbose.rst | 54 -- .../pages/api/foundations.walkers.rst | 21 - .../resources/pages/api/manager.component.rst | 17 - .../pages/api/manager.componentsManager.rst | 25 - .../pages/api/manager.exceptions.rst | 48 -- .../pages/api/manager.globals.constants.rst | 12 - .../pages/api/manager.qobjectComponent.rst | 17 - .../pages/api/manager.qwidgetComponent.rst | 15 - ...sibl_gui.components.addons.about.about.rst | 21 - ...dons.cachesOperations.cachesOperations.rst | 19 - ....databaseOperations.databaseOperations.rst | 23 - ...bl_gui.components.addons.gpsMap.gpsMap.rst | 19 - ...ibl_gui.components.addons.gpsMap.views.rst | 17 - ...s.addons.iblSetsScanner.iblSetsScanner.rst | 17 - ...mponents.addons.iblSetsScanner.workers.rst | 17 - ...nents.addons.loaderScript.loaderScript.rst | 19 - ...oaderScriptOptions.loaderScriptOptions.rst | 19 - ...nents.addons.loaderScriptOptions.views.rst | 17 - ...dons.locationsBrowser.locationsBrowser.rst | 19 - ...addons.loggingNotifier.loggingNotifier.rst | 17 - ...s.addons.onlineUpdater.downloadManager.rst | 19 - ...nts.addons.onlineUpdater.onlineUpdater.rst | 21 - ...nts.addons.onlineUpdater.remoteUpdater.rst | 23 - ....components.addons.onlineUpdater.views.rst | 17 - ...ponents.addons.preview.imagesPreviewer.rst | 23 - ..._gui.components.addons.preview.preview.rst | 19 - ...awEditingUtilities.rawEditingUtilities.rst | 19 - ...nents.addons.rewiringTool.rewiringTool.rst | 19 - ...ns.sIBLeditUtilities.sIBLeditUtilities.rst | 19 - ...s.addons.searchDatabase.searchDatabase.rst | 19 - ...components.addons.searchDatabase.views.rst | 17 - ...ollectionsOutliner.collectionsOutliner.rst | 19 - ...onents.core.collectionsOutliner.models.rst | 17 - ...ponents.core.collectionsOutliner.nodes.rst | 17 - ...ponents.core.collectionsOutliner.views.rst | 17 - ..._gui.components.core.database.database.rst | 17 - ...ui.components.core.database.exceptions.rst | 56 -- ...ibl_gui.components.core.database.nodes.rst | 34 - ...ui.components.core.database.operations.rst | 99 --- ...ibl_gui.components.core.database.types.rst | 27 - ...s.core.iblSetsOutliner.iblSetsOutliner.rst | 19 - ...components.core.iblSetsOutliner.models.rst | 17 - ....components.core.iblSetsOutliner.views.rst | 21 - ...ui.components.core.inspector.inspector.rst | 27 - ...l_gui.components.core.inspector.models.rst | 17 - ...bl_gui.components.core.inspector.nodes.rst | 17 - ...bl_gui.components.core.inspector.views.rst | 17 - ...mponents.core.templatesOutliner.models.rst | 17 - ...omponents.core.templatesOutliner.nodes.rst | 17 - ...re.templatesOutliner.templatesOutliner.rst | 19 - ...omponents.core.templatesOutliner.views.rst | 17 - .../pages/api/sibl_gui.exceptions.rst | 36 - .../pages/api/sibl_gui.globals.constants.rst | 12 - .../api/sibl_gui.globals.runtimeGlobals.rst | 12 - .../api/sibl_gui.globals.uiConstants.rst | 12 - .../resources/pages/api/sibl_gui.launcher.rst | 24 - ...sibl_gui.libraries.freeImage.freeImage.rst | 740 ------------------ .../pages/api/sibl_gui.ui.caches.rst | 25 - .../pages/api/sibl_gui.ui.common.rst | 37 - .../pages/api/sibl_gui.ui.models.rst | 17 - .../resources/pages/api/sibl_gui.ui.nodes.rst | 25 - .../resources/pages/api/sibl_gui.ui.views.rst | 25 - ...bl_gui.ui.widgets.application_QToolBar.rst | 17 - .../pages/api/sibl_gui.ui.workers.rst | 17 - ...ponents.addons.projectsExplorer.models.rst | 17 - ...dons.projectsExplorer.projectsExplorer.rst | 19 - ...mponents.addons.projectsExplorer.views.rst | 17 - ...ponents.addons.tcpClientUi.tcpClientUi.rst | 19 - ...ponents.addons.tcpServerUi.tcpServerUi.rst | 23 - ...umbra.components.addons.traceUi.models.rst | 17 - .../umbra.components.addons.traceUi.nodes.rst | 17 - ...mbra.components.addons.traceUi.traceUi.rst | 19 - .../umbra.components.addons.traceUi.views.rst | 17 - ...omponentsManagerUi.componentsManagerUi.rst | 19 - ...nts.factory.componentsManagerUi.models.rst | 17 - ...ents.factory.componentsManagerUi.nodes.rst | 21 - ...ents.factory.componentsManagerUi.views.rst | 17 - ....preferencesManager.preferencesManager.rst | 19 - ...components.factory.scriptEditor.editor.rst | 17 - ...ents.factory.scriptEditor.editorStatus.rst | 19 - ...components.factory.scriptEditor.models.rst | 29 - ....components.factory.scriptEditor.nodes.rst | 45 -- ...ents.factory.scriptEditor.scriptEditor.rst | 19 - ....factory.scriptEditor.searchAndReplace.rst | 23 - ...nts.factory.scriptEditor.searchInFiles.rst | 19 - ....components.factory.scriptEditor.views.rst | 21 - ...omponents.factory.scriptEditor.workers.rst | 29 - .../resources/pages/api/umbra.engine.rst | 38 - .../resources/pages/api/umbra.exceptions.rst | 89 --- .../pages/api/umbra.globals.constants.rst | 12 - .../api/umbra.globals.runtimeGlobals.rst | 12 - .../pages/api/umbra.globals.uiConstants.rst | 12 - .../resources/pages/api/umbra.guerilla.rst | 12 - .../resources/pages/api/umbra.launcher.rst | 10 - .../api/umbra.managers.actionsManager.rst | 17 - ...umbra.managers.fileSystemEventsManager.rst | 17 - .../api/umbra.managers.layoutsManager.rst | 21 - .../umbra.managers.notificationsManager.rst | 21 - .../api/umbra.managers.patchesManager.rst | 21 - .../resources/pages/api/umbra.preferences.rst | 17 - .../resources/pages/api/umbra.processing.rst | 19 - .../resources/pages/api/umbra.reporter.rst | 36 - .../resources/pages/api/umbra.ui.common.rst | 44 -- .../pages/api/umbra.ui.completers.rst | 17 - .../pages/api/umbra.ui.delegates.rst | 21 - .../pages/api/umbra.ui.highlighters.rst | 29 - .../pages/api/umbra.ui.inputAccelerators.rst | 29 - .../pages/api/umbra.ui.languages.rst | 46 -- .../resources/pages/api/umbra.ui.models.rst | 17 - .../resources/pages/api/umbra.ui.nodes.rst | 33 - .../resources/pages/api/umbra.ui.themes.rst | 21 - .../resources/pages/api/umbra.ui.views.rst | 53 -- .../pages/api/umbra.ui.visualAccelerators.rst | 19 - .../api/umbra.ui.widgets.active_QLabel.rst | 17 - ...ra.ui.widgets.active_QLabelsCollection.rst | 17 - .../umbra.ui.widgets.application_QToolBar.rst | 17 - .../umbra.ui.widgets.basic_QPlainTextEdit.rst | 26 - ...a.ui.widgets.codeEditor_QPlainTextEdit.rst | 21 - ...umbra.ui.widgets.delayed_QSplashScreen.rst | 17 - .../pages/api/umbra.ui.widgets.messageBox.rst | 15 - .../umbra.ui.widgets.notification_QLabel.rst | 17 - .../api/umbra.ui.widgets.search_QLineEdit.rst | 17 - .../umbra.ui.widgets.variable_QPushButton.rst | 17 - sibl_gui/components/addons/about/about.py | 2 +- .../cachesOperations/cachesOperations.py | 2 +- .../databaseOperations/databaseOperations.py | 2 +- sibl_gui/components/addons/gpsMap/gpsMap.py | 2 +- sibl_gui/components/addons/gpsMap/views.py | 2 +- .../addons/iblSetsScanner/iblSetsScanner.py | 2 +- .../addons/iblSetsScanner/workers.py | 2 +- .../addons/loaderScript/loaderScript.py | 2 +- .../loaderScriptOptions.py | 2 +- .../addons/loaderScriptOptions/views.py | 2 +- .../locationsBrowser/locationsBrowser.py | 2 +- .../addons/loggingNotifier/loggingNotifier.py | 2 +- .../addons/onlineUpdater/downloadManager.py | 2 +- .../addons/onlineUpdater/onlineUpdater.py | 2 +- .../addons/onlineUpdater/remoteUpdater.py | 2 +- .../components/addons/onlineUpdater/views.py | 2 +- .../addons/preview/imagesPreviewer.py | 2 +- sibl_gui/components/addons/preview/preview.py | 2 +- .../rawEditingUtilities.py | 2 +- .../addons/rewiringTool/rewiringTool.py | 2 +- .../sIBLeditUtilities/sIBLeditUtilities.py | 2 +- .../addons/searchDatabase/searchDatabase.py | 2 +- .../components/addons/searchDatabase/views.py | 2 +- .../collectionsOutliner.py | 2 +- .../core/collectionsOutliner/models.py | 2 +- .../core/collectionsOutliner/nodes.py | 2 +- .../core/collectionsOutliner/views.py | 2 +- sibl_gui/components/core/database/database.py | 2 +- .../components/core/database/exceptions.py | 2 +- sibl_gui/components/core/database/nodes.py | 2 +- .../components/core/database/operations.py | 2 +- sibl_gui/components/core/database/types.py | 2 +- .../core/iblSetsOutliner/iblSetsOutliner.py | 2 +- .../components/core/iblSetsOutliner/models.py | 2 +- .../components/core/iblSetsOutliner/views.py | 2 +- .../components/core/inspector/inspector.py | 2 +- sibl_gui/components/core/inspector/models.py | 2 +- sibl_gui/components/core/inspector/nodes.py | 2 +- sibl_gui/components/core/inspector/views.py | 2 +- .../core/templatesOutliner/models.py | 2 +- .../core/templatesOutliner/nodes.py | 2 +- .../templatesOutliner/templatesOutliner.py | 2 +- .../core/templatesOutliner/views.py | 2 +- sibl_gui/exceptions.py | 2 +- sibl_gui/globals/constants.py | 2 +- sibl_gui/globals/runtimeGlobals.py | 2 +- sibl_gui/globals/uiConstants.py | 2 +- sibl_gui/launcher.py | 2 +- sibl_gui/libraries/freeImage/freeImage.py | 2 +- .../patches/001_migrate_3-x-x_to_4-0-0.py | 2 +- .../patches/002_migrate_4-x-x_to_4-0-2.py | 2 +- .../patches/003_migrate_4-x-x_to_4-0-3.py | 2 +- .../patches/004_migrate_4-x-x_to_4-0-7.py | 2 +- sibl_gui/tests/tests.py | 2 +- sibl_gui/tests/testsInternational.py | 2 +- .../tests/testsSibl_gui/testsExceptions.py | 2 +- .../testsGlobals/testsConstants.py | 2 +- .../testsGlobals/testsRuntimeGlobals.py | 2 +- .../testsGlobals/testsUiConstants.py | 2 +- sibl_gui/tests/utilities.py | 2 +- sibl_gui/ui/caches.py | 2 +- sibl_gui/ui/common.py | 2 +- sibl_gui/ui/models.py | 2 +- sibl_gui/ui/nodes.py | 2 +- sibl_gui/ui/views.py | 2 +- sibl_gui/ui/widgets/application_QToolBar.py | 2 +- sibl_gui/ui/workers.py | 2 +- utilities/darwinSetup.py | 2 +- utilities/windowsSetup.py | 2 +- 211 files changed, 69 insertions(+), 4211 deletions(-) delete mode 100644 docs/sphinx/source/resources/pages/api/foundations.cache.rst delete mode 100644 docs/sphinx/source/resources/pages/api/foundations.common.rst delete mode 100644 docs/sphinx/source/resources/pages/api/foundations.core.rst delete mode 100644 docs/sphinx/source/resources/pages/api/foundations.dataStructures.rst delete mode 100644 docs/sphinx/source/resources/pages/api/foundations.decorators.rst delete mode 100644 docs/sphinx/source/resources/pages/api/foundations.environment.rst delete mode 100644 docs/sphinx/source/resources/pages/api/foundations.exceptions.rst delete mode 100644 docs/sphinx/source/resources/pages/api/foundations.globals.constants.rst delete mode 100644 docs/sphinx/source/resources/pages/api/foundations.io.rst delete mode 100644 docs/sphinx/source/resources/pages/api/foundations.library.rst delete mode 100644 docs/sphinx/source/resources/pages/api/foundations.namespace.rst delete mode 100644 docs/sphinx/source/resources/pages/api/foundations.nodes.rst delete mode 100644 docs/sphinx/source/resources/pages/api/foundations.parsers.rst delete mode 100644 docs/sphinx/source/resources/pages/api/foundations.pkzip.rst delete mode 100644 docs/sphinx/source/resources/pages/api/foundations.rotatingBackup.rst delete mode 100644 docs/sphinx/source/resources/pages/api/foundations.strings.rst delete mode 100644 docs/sphinx/source/resources/pages/api/foundations.tcpServer.rst delete mode 100644 docs/sphinx/source/resources/pages/api/foundations.trace.rst delete mode 100644 docs/sphinx/source/resources/pages/api/foundations.ui.common.rst delete mode 100644 docs/sphinx/source/resources/pages/api/foundations.verbose.rst delete mode 100644 docs/sphinx/source/resources/pages/api/foundations.walkers.rst delete mode 100644 docs/sphinx/source/resources/pages/api/manager.component.rst delete mode 100644 docs/sphinx/source/resources/pages/api/manager.componentsManager.rst delete mode 100644 docs/sphinx/source/resources/pages/api/manager.exceptions.rst delete mode 100644 docs/sphinx/source/resources/pages/api/manager.globals.constants.rst delete mode 100644 docs/sphinx/source/resources/pages/api/manager.qobjectComponent.rst delete mode 100644 docs/sphinx/source/resources/pages/api/manager.qwidgetComponent.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.about.about.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.cachesOperations.cachesOperations.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.databaseOperations.databaseOperations.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.gpsMap.gpsMap.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.gpsMap.views.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.iblSetsScanner.iblSetsScanner.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.iblSetsScanner.workers.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loaderScript.loaderScript.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loaderScriptOptions.loaderScriptOptions.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loaderScriptOptions.views.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.locationsBrowser.locationsBrowser.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loggingNotifier.loggingNotifier.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.downloadManager.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.onlineUpdater.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.remoteUpdater.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.views.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.preview.imagesPreviewer.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.preview.preview.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.rawEditingUtilities.rawEditingUtilities.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.rewiringTool.rewiringTool.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.sIBLeditUtilities.sIBLeditUtilities.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.searchDatabase.searchDatabase.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.searchDatabase.views.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.collectionsOutliner.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.models.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.nodes.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.views.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.database.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.exceptions.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.nodes.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.operations.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.types.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.iblSetsOutliner.models.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.iblSetsOutliner.views.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.inspector.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.models.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.nodes.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.views.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.models.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.nodes.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.templatesOutliner.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.views.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.exceptions.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.globals.constants.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.globals.runtimeGlobals.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.globals.uiConstants.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.launcher.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.libraries.freeImage.freeImage.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.ui.caches.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.ui.common.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.ui.models.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.ui.nodes.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.ui.views.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.ui.widgets.application_QToolBar.rst delete mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.ui.workers.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.addons.projectsExplorer.models.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.addons.projectsExplorer.projectsExplorer.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.addons.projectsExplorer.views.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.addons.tcpClientUi.tcpClientUi.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.addons.tcpServerUi.tcpServerUi.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.models.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.nodes.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.traceUi.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.views.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.componentsManagerUi.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.models.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.nodes.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.views.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.factory.preferencesManager.preferencesManager.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.editor.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.editorStatus.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.models.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.nodes.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.scriptEditor.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.searchAndReplace.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.searchInFiles.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.views.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.workers.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.engine.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.exceptions.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.globals.constants.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.globals.runtimeGlobals.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.globals.uiConstants.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.guerilla.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.launcher.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.managers.actionsManager.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.managers.fileSystemEventsManager.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.managers.layoutsManager.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.managers.notificationsManager.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.managers.patchesManager.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.preferences.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.processing.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.reporter.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.common.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.completers.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.delegates.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.highlighters.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.inputAccelerators.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.languages.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.models.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.nodes.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.themes.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.views.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.visualAccelerators.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.widgets.active_QLabel.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.widgets.active_QLabelsCollection.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.widgets.application_QToolBar.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.widgets.basic_QPlainTextEdit.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.widgets.codeEditor_QPlainTextEdit.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.widgets.delayed_QSplashScreen.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.widgets.messageBox.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.widgets.notification_QLabel.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.widgets.search_QLineEdit.rst delete mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.widgets.variable_QPushButton.rst diff --git a/docs/sphinx/source/resources/pages/api/foundations.cache.rst b/docs/sphinx/source/resources/pages/api/foundations.cache.rst deleted file mode 100644 index ccf44fcf..00000000 --- a/docs/sphinx/source/resources/pages/api/foundations.cache.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`foundations.cache` -==================== - -.. automodule:: foundations.cache - -Module Attributes ------------------ - -.. attribute:: foundations.cache.LOGGER - -Classes -------- - -.. autoclass:: Cache - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.common.rst b/docs/sphinx/source/resources/pages/api/foundations.common.rst deleted file mode 100644 index 79dd3fdf..00000000 --- a/docs/sphinx/source/resources/pages/api/foundations.common.rst +++ /dev/null @@ -1,41 +0,0 @@ -_`foundations.common` -===================== - -.. automodule:: foundations.common - -Module Attributes ------------------ - -.. attribute:: foundations.common.LOGGER - -.. attribute:: foundations.common.CONNECTION_IP - -.. attribute:: foundations.common.DEFAULT_HOST_IP - -Functions ---------- - -.. autofunction:: uniqify - -.. autofunction:: orderedUniqify - -.. autofunction:: unpackDefault - -.. autofunction:: pathExists - -.. autofunction:: filterPath - -.. autofunction:: getFirstItem - -.. autofunction:: getLastItem - -.. autofunction:: isBinaryFile - -.. autofunction:: repeat - -.. autofunction:: dependencyResolver - -.. autofunction:: isInternetAvailable - -.. autofunction:: getHostAddress - diff --git a/docs/sphinx/source/resources/pages/api/foundations.core.rst b/docs/sphinx/source/resources/pages/api/foundations.core.rst deleted file mode 100644 index ba1fa8f1..00000000 --- a/docs/sphinx/source/resources/pages/api/foundations.core.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`foundations.core` -=================== - -.. automodule:: foundations.core - -Module Attributes ------------------ - -.. attribute:: foundations.core.LOGGER - -Functions ---------- - -.. autofunction:: exit - -.. autofunction:: wait - diff --git a/docs/sphinx/source/resources/pages/api/foundations.dataStructures.rst b/docs/sphinx/source/resources/pages/api/foundations.dataStructures.rst deleted file mode 100644 index 46744022..00000000 --- a/docs/sphinx/source/resources/pages/api/foundations.dataStructures.rst +++ /dev/null @@ -1,29 +0,0 @@ -_`foundations.dataStructures` -============================= - -.. automodule:: foundations.dataStructures - -Module Attributes ------------------ - -.. attribute:: foundations.dataStructures.LOGGER - -Classes -------- - -.. autoclass:: NestedAttribute - :show-inheritance: - :members: - -.. autoclass:: Structure - :show-inheritance: - :members: - -.. autoclass:: OrderedStructure - :show-inheritance: - :members: - -.. autoclass:: Lookup - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.decorators.rst b/docs/sphinx/source/resources/pages/api/foundations.decorators.rst deleted file mode 100644 index 71aed984..00000000 --- a/docs/sphinx/source/resources/pages/api/foundations.decorators.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`foundations.decorators` -========================= - -.. automodule:: foundations.decorators - -Module Attributes ------------------ - -.. attribute:: foundations.decorators.LOGGER - -Functions ---------- - -.. autofunction:: executionTime - -.. autofunction:: memoize - diff --git a/docs/sphinx/source/resources/pages/api/foundations.environment.rst b/docs/sphinx/source/resources/pages/api/foundations.environment.rst deleted file mode 100644 index 56421e22..00000000 --- a/docs/sphinx/source/resources/pages/api/foundations.environment.rst +++ /dev/null @@ -1,24 +0,0 @@ -_`foundations.environment` -========================== - -.. automodule:: foundations.environment - -Module Attributes ------------------ - -.. attribute:: foundations.environment.LOGGER - -Functions ---------- - -.. autofunction:: getSystemApplicationDataDirectory - -.. autofunction:: getUserApplicationDataDirectory - -Classes -------- - -.. autoclass:: Environment - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.exceptions.rst b/docs/sphinx/source/resources/pages/api/foundations.exceptions.rst deleted file mode 100644 index 618ecbca..00000000 --- a/docs/sphinx/source/resources/pages/api/foundations.exceptions.rst +++ /dev/null @@ -1,140 +0,0 @@ -_`foundations.exceptions` -========================= - -.. automodule:: foundations.exceptions - -Module Attributes ------------------ - -.. attribute:: foundations.exceptions.LOGGER - -.. attribute:: foundations.exceptions.EXCEPTIONS_FRAME_SYMBOL - -Functions ---------- - -.. autofunction:: getInnerMostFrame - -.. autofunction:: extractStack - -.. autofunction:: extractArguments - -.. autofunction:: extractLocals - -.. autofunction:: extractException - -.. autofunction:: formatException - -.. autofunction:: formatReport - -.. autofunction:: baseExceptionHandler - -.. autofunction:: installExceptionHandler - -.. autofunction:: uninstallExceptionHandler - -.. autofunction:: handleExceptions - -Classes -------- - -.. autoclass:: AbstractError - :show-inheritance: - :members: - -.. autoclass:: ExecutionError - :show-inheritance: - :members: - -.. autoclass:: BreakIteration - :show-inheritance: - :members: - -.. autoclass:: AbstractParsingError - :show-inheritance: - :members: - -.. autoclass:: FileStructureParsingError - :show-inheritance: - :members: - -.. autoclass:: AttributeStructureParsingError - :show-inheritance: - :members: - -.. autoclass:: AbstractOsError - :show-inheritance: - :members: - -.. autoclass:: PathExistsError - :show-inheritance: - :members: - -.. autoclass:: DirectoryExistsError - :show-inheritance: - :members: - -.. autoclass:: FileExistsError - :show-inheritance: - :members: - -.. autoclass:: AbstractObjectError - :show-inheritance: - :members: - -.. autoclass:: ObjectTypeError - :show-inheritance: - :members: - -.. autoclass:: ObjectExistsError - :show-inheritance: - :members: - -.. autoclass:: AbstractUserError - :show-inheritance: - :members: - -.. autoclass:: ProgrammingError - :show-inheritance: - :members: - -.. autoclass:: UserError - :show-inheritance: - :members: - -.. autoclass:: AbstractNodeError - :show-inheritance: - :members: - -.. autoclass:: NodeAttributeTypeError - :show-inheritance: - :members: - -.. autoclass:: NodeAttributeExistsError - :show-inheritance: - :members: - -.. autoclass:: AbstractLibraryError - :show-inheritance: - :members: - -.. autoclass:: LibraryInstantiationError - :show-inheritance: - :members: - -.. autoclass:: LibraryInitializationError - :show-inheritance: - :members: - -.. autoclass:: LibraryExecutionError - :show-inheritance: - :members: - -.. autoclass:: AbstractServerError - :show-inheritance: - :members: - -.. autoclass:: ServerOperationError - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.globals.constants.rst b/docs/sphinx/source/resources/pages/api/foundations.globals.constants.rst deleted file mode 100644 index 9a423e8f..00000000 --- a/docs/sphinx/source/resources/pages/api/foundations.globals.constants.rst +++ /dev/null @@ -1,12 +0,0 @@ -_`foundations.globals.constants` -================================ - -.. automodule:: foundations.globals.constants - -Classes -------- - -.. autoclass:: Constants - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.io.rst b/docs/sphinx/source/resources/pages/api/foundations.io.rst deleted file mode 100644 index 8c8126fb..00000000 --- a/docs/sphinx/source/resources/pages/api/foundations.io.rst +++ /dev/null @@ -1,26 +0,0 @@ -_`foundations.io` -================= - -.. automodule:: foundations.io - -Module Attributes ------------------ - -.. attribute:: foundations.io.LOGGER - -Functions ---------- - -.. autofunction:: setDirectory - -.. autofunction:: copy - -.. autofunction:: remove - -Classes -------- - -.. autoclass:: File - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.library.rst b/docs/sphinx/source/resources/pages/api/foundations.library.rst deleted file mode 100644 index d5409246..00000000 --- a/docs/sphinx/source/resources/pages/api/foundations.library.rst +++ /dev/null @@ -1,21 +0,0 @@ -_`foundations.library` -====================== - -.. automodule:: foundations.library - -Module Attributes ------------------ - -.. attribute:: foundations.library.LOGGER - -Classes -------- - -.. autoclass:: LibraryHook - :show-inheritance: - :members: - -.. autoclass:: Library - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.namespace.rst b/docs/sphinx/source/resources/pages/api/foundations.namespace.rst deleted file mode 100644 index 35b2aa12..00000000 --- a/docs/sphinx/source/resources/pages/api/foundations.namespace.rst +++ /dev/null @@ -1,25 +0,0 @@ -_`foundations.namespace` -======================== - -.. automodule:: foundations.namespace - -Module Attributes ------------------ - -.. attribute:: foundations.namespace.LOGGER - -.. attribute:: foundations.namespace.NAMESPACE_SPLITTER - -Functions ---------- - -.. autofunction:: setNamespace - -.. autofunction:: getNamespace - -.. autofunction:: removeNamespace - -.. autofunction:: getRoot - -.. autofunction:: getLeaf - diff --git a/docs/sphinx/source/resources/pages/api/foundations.nodes.rst b/docs/sphinx/source/resources/pages/api/foundations.nodes.rst deleted file mode 100644 index 16fc8224..00000000 --- a/docs/sphinx/source/resources/pages/api/foundations.nodes.rst +++ /dev/null @@ -1,25 +0,0 @@ -_`foundations.nodes` -==================== - -.. automodule:: foundations.nodes - -Module Attributes ------------------ - -.. attribute:: foundations.nodes.LOGGER - -Classes -------- - -.. autoclass:: Attribute - :show-inheritance: - :members: - -.. autoclass:: AbstractNode - :show-inheritance: - :members: - -.. autoclass:: AbstractCompositeNode - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.parsers.rst b/docs/sphinx/source/resources/pages/api/foundations.parsers.rst deleted file mode 100644 index a930e76c..00000000 --- a/docs/sphinx/source/resources/pages/api/foundations.parsers.rst +++ /dev/null @@ -1,30 +0,0 @@ -_`foundations.parsers` -====================== - -.. automodule:: foundations.parsers - -Module Attributes ------------------ - -.. attribute:: foundations.parsers.LOGGER - -Functions ---------- - -.. autofunction:: getAttributeCompound - -Classes -------- - -.. autoclass:: AttributeCompound - :show-inheritance: - :members: - -.. autoclass:: SectionsFileParser - :show-inheritance: - :members: - -.. autoclass:: PlistFileParser - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.pkzip.rst b/docs/sphinx/source/resources/pages/api/foundations.pkzip.rst deleted file mode 100644 index 1555737b..00000000 --- a/docs/sphinx/source/resources/pages/api/foundations.pkzip.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`foundations.pkzip` -==================== - -.. automodule:: foundations.pkzip - -Module Attributes ------------------ - -.. attribute:: foundations.pkzip.LOGGER - -Classes -------- - -.. autoclass:: Pkzip - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.rotatingBackup.rst b/docs/sphinx/source/resources/pages/api/foundations.rotatingBackup.rst deleted file mode 100644 index 297b6429..00000000 --- a/docs/sphinx/source/resources/pages/api/foundations.rotatingBackup.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`foundations.rotatingBackup` -============================= - -.. automodule:: foundations.rotatingBackup - -Module Attributes ------------------ - -.. attribute:: foundations.rotatingBackup.LOGGER - -Classes -------- - -.. autoclass:: RotatingBackup - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.strings.rst b/docs/sphinx/source/resources/pages/api/foundations.strings.rst deleted file mode 100644 index b99f9606..00000000 --- a/docs/sphinx/source/resources/pages/api/foundations.strings.rst +++ /dev/null @@ -1,49 +0,0 @@ -_`foundations.strings` -====================== - -.. automodule:: foundations.strings - -Module Attributes ------------------ - -.. attribute:: foundations.strings.LOGGER - -.. attribute:: foundations.strings.ASCII_CHARACTERS - -Functions ---------- - -.. autofunction:: toString - -.. autofunction:: getNiceName - -.. autofunction:: getVersionRank - -.. autofunction:: getSplitextBasename - -.. autofunction:: getCommonAncestor - -.. autofunction:: getCommonPathsAncestor - -.. autofunction:: getWords - -.. autofunction:: filterWords - -.. autofunction:: replace - -.. autofunction:: removeStrip - -.. autofunction:: toForwardSlashes - -.. autofunction:: toBackwardSlashes - -.. autofunction:: toPosixPath - -.. autofunction:: getNormalizedPath - -.. autofunction:: getRandomSequence - -.. autofunction:: isEmail - -.. autofunction:: isWebsite - diff --git a/docs/sphinx/source/resources/pages/api/foundations.tcpServer.rst b/docs/sphinx/source/resources/pages/api/foundations.tcpServer.rst deleted file mode 100644 index 93dda049..00000000 --- a/docs/sphinx/source/resources/pages/api/foundations.tcpServer.rst +++ /dev/null @@ -1,21 +0,0 @@ -_`foundations.tcpServer` -======================== - -.. automodule:: foundations.tcpServer - -Module Attributes ------------------ - -.. attribute:: foundations.tcpServer.LOGGER - -Classes -------- - -.. autoclass:: EchoRequestsHandler - :show-inheritance: - :members: - -.. autoclass:: TCPServer - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.trace.rst b/docs/sphinx/source/resources/pages/api/foundations.trace.rst deleted file mode 100644 index 817c0739..00000000 --- a/docs/sphinx/source/resources/pages/api/foundations.trace.rst +++ /dev/null @@ -1,95 +0,0 @@ -_`foundations.trace` -==================== - -.. automodule:: foundations.trace - -Module Attributes ------------------ - -.. attribute:: foundations.trace.REGISTERED_MODULES - -.. attribute:: foundations.trace.TRACER_SYMBOL - -.. attribute:: foundations.trace.UNTRACABLE_SYMBOL - -.. attribute:: foundations.trace.TRACER_HOOK - -.. attribute:: foundations.trace.UNTRACABLE_NAMES - -.. attribute:: foundations.trace.NULL_OBJECT_NAME - -.. attribute:: foundations.trace.TRACE_NAMES_CACHE - -.. attribute:: foundations.trace.TRACE_WALKER_CACHE - -Functions ---------- - -.. autofunction:: isReadOnly - -.. autofunction:: setTracerHook - -.. autofunction:: getTracerHook - -.. autofunction:: isTraced - -.. autofunction:: isBaseTraced - -.. autofunction:: isUntracable - -.. autofunction:: setTraced - -.. autofunction:: setUntraced - -.. autofunction:: setUntracable - -.. autofunction:: traceWalker - -.. autofunction:: getObjectName - -.. autofunction:: getTraceName - -.. autofunction:: getMethodName - -.. autofunction:: isStaticMethod - -.. autofunction:: isClassMethod - -.. autofunction:: formatArgument - -.. autofunction:: validateTracer - -.. autofunction:: tracer - -.. autofunction:: untracer - -.. autofunction:: untracable - -.. autofunction:: traceFunction - -.. autofunction:: untraceFunction - -.. autofunction:: traceMethod - -.. autofunction:: untraceMethod - -.. autofunction:: traceProperty - -.. autofunction:: untraceProperty - -.. autofunction:: traceClass - -.. autofunction:: untraceClass - -.. autofunction:: traceModule - -.. autofunction:: untraceModule - -.. autofunction:: registerModule - -.. autofunction:: installTracer - -.. autofunction:: uninstallTracer - -.. autofunction:: evaluateTraceRequest - diff --git a/docs/sphinx/source/resources/pages/api/foundations.ui.common.rst b/docs/sphinx/source/resources/pages/api/foundations.ui.common.rst deleted file mode 100644 index a6439fc8..00000000 --- a/docs/sphinx/source/resources/pages/api/foundations.ui.common.rst +++ /dev/null @@ -1,21 +0,0 @@ -_`foundations.ui.common` -======================== - -.. automodule:: foundations.ui.common - -Module Attributes ------------------ - -.. attribute:: foundations.ui.common.LOGGER - -.. attribute:: foundations.ui.common.RESOURCES_DIRECTORY - -.. attribute:: foundations.ui.common.DEFAULT_UI_FILE - -Functions ---------- - -.. autofunction:: centerWidgetOnScreen - -.. autofunction:: QWidgetFactory - diff --git a/docs/sphinx/source/resources/pages/api/foundations.verbose.rst b/docs/sphinx/source/resources/pages/api/foundations.verbose.rst deleted file mode 100644 index c44318e1..00000000 --- a/docs/sphinx/source/resources/pages/api/foundations.verbose.rst +++ /dev/null @@ -1,54 +0,0 @@ -_`foundations.verbose` -====================== - -.. automodule:: foundations.verbose - -Module Attributes ------------------ - -.. attribute:: foundations.verbose.THREADS_IDENTIFIERS - -.. attribute:: foundations.verbose.INDENT_LEVEL - -.. attribute:: foundations.verbose.LOGGER - -.. attribute:: foundations.verbose.LOGGING_DEFAULT_FORMATTER - -.. attribute:: foundations.verbose.LOGGING_EXTENDED_FORMATTER - -.. attribute:: foundations.verbose.LOGGING_STANDARD_FORMATTER - -.. attribute:: foundations.verbose.TRACER_LOGGING_FUNCTION - -Functions ---------- - -.. autofunction:: indentMessage - -.. autofunction:: tracer - -.. autofunction:: installLogger - -.. autofunction:: uninstallLogger - -.. autofunction:: getLoggingConsoleHandler - -.. autofunction:: getLoggingFileHandler - -.. autofunction:: getLoggingStreamHandler - -.. autofunction:: removeLoggingHandler - -.. autofunction:: setVerbosityLevel - -Classes -------- - -.. autoclass:: Streamer - :show-inheritance: - :members: - -.. autoclass:: StandardOutputStreamer - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/foundations.walkers.rst b/docs/sphinx/source/resources/pages/api/foundations.walkers.rst deleted file mode 100644 index 487c7af4..00000000 --- a/docs/sphinx/source/resources/pages/api/foundations.walkers.rst +++ /dev/null @@ -1,21 +0,0 @@ -_`foundations.walkers` -====================== - -.. automodule:: foundations.walkers - -Module Attributes ------------------ - -.. attribute:: foundations.walkers.LOGGER - -Functions ---------- - -.. autofunction:: filesWalker - -.. autofunction:: depthWalker - -.. autofunction:: dictionariesWalker - -.. autofunction:: nodesWalker - diff --git a/docs/sphinx/source/resources/pages/api/manager.component.rst b/docs/sphinx/source/resources/pages/api/manager.component.rst deleted file mode 100644 index acea4a8f..00000000 --- a/docs/sphinx/source/resources/pages/api/manager.component.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`manager.component` -==================== - -.. automodule:: manager.component - -Module Attributes ------------------ - -.. attribute:: manager.component.LOGGER - -Classes -------- - -.. autoclass:: Component - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/manager.componentsManager.rst b/docs/sphinx/source/resources/pages/api/manager.componentsManager.rst deleted file mode 100644 index 2377e5da..00000000 --- a/docs/sphinx/source/resources/pages/api/manager.componentsManager.rst +++ /dev/null @@ -1,25 +0,0 @@ -_`manager.componentsManager` -============================ - -.. automodule:: manager.componentsManager - -Module Attributes ------------------ - -.. attribute:: manager.componentsManager.LOGGER - -Classes -------- - -.. autoclass:: Components - :show-inheritance: - :members: - -.. autoclass:: Profile - :show-inheritance: - :members: - -.. autoclass:: Manager - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/manager.exceptions.rst b/docs/sphinx/source/resources/pages/api/manager.exceptions.rst deleted file mode 100644 index 6cca0ac5..00000000 --- a/docs/sphinx/source/resources/pages/api/manager.exceptions.rst +++ /dev/null @@ -1,48 +0,0 @@ -_`manager.exceptions` -===================== - -.. automodule:: manager.exceptions - -Classes -------- - -.. autoclass:: AbstractComponentsManagerError - :show-inheritance: - :members: - -.. autoclass:: ComponentProfileError - :show-inheritance: - :members: - -.. autoclass:: ComponentModuleError - :show-inheritance: - :members: - -.. autoclass:: ComponentRegistrationError - :show-inheritance: - :members: - -.. autoclass:: ComponentInterfaceError - :show-inheritance: - :members: - -.. autoclass:: ComponentInstantiationError - :show-inheritance: - :members: - -.. autoclass:: ComponentActivationError - :show-inheritance: - :members: - -.. autoclass:: ComponentDeactivationError - :show-inheritance: - :members: - -.. autoclass:: ComponentReloadError - :show-inheritance: - :members: - -.. autoclass:: ComponentExistsError - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/manager.globals.constants.rst b/docs/sphinx/source/resources/pages/api/manager.globals.constants.rst deleted file mode 100644 index bf96f068..00000000 --- a/docs/sphinx/source/resources/pages/api/manager.globals.constants.rst +++ /dev/null @@ -1,12 +0,0 @@ -_`manager.globals.constants` -============================ - -.. automodule:: manager.globals.constants - -Classes -------- - -.. autoclass:: Constants - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/manager.qobjectComponent.rst b/docs/sphinx/source/resources/pages/api/manager.qobjectComponent.rst deleted file mode 100644 index cefd428f..00000000 --- a/docs/sphinx/source/resources/pages/api/manager.qobjectComponent.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`manager.qobjectComponent` -=========================== - -.. automodule:: manager.qobjectComponent - -Module Attributes ------------------ - -.. attribute:: manager.qobjectComponent.LOGGER - -Classes -------- - -.. autoclass:: QObjectComponent - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/manager.qwidgetComponent.rst b/docs/sphinx/source/resources/pages/api/manager.qwidgetComponent.rst deleted file mode 100644 index 672819c6..00000000 --- a/docs/sphinx/source/resources/pages/api/manager.qwidgetComponent.rst +++ /dev/null @@ -1,15 +0,0 @@ -_`manager.qwidgetComponent` -=========================== - -.. automodule:: manager.qwidgetComponent - -Module Attributes ------------------ - -.. attribute:: manager.qwidgetComponent.LOGGER - -Functions ---------- - -.. autofunction:: QWidgetComponentFactory - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.about.about.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.about.about.rst deleted file mode 100644 index 32ff3f98..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.about.about.rst +++ /dev/null @@ -1,21 +0,0 @@ -_`sibl_gui.components.addons.about.about` -========================================= - -.. automodule:: sibl_gui.components.addons.about.about - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.addons.about.about.LOGGER - -.. attribute:: sibl_gui.components.addons.about.about.COMPONENT_UI_FILE - -.. attribute:: sibl_gui.components.addons.about.about.ABOUT_MESSAGE - -Classes -------- - -.. autoclass:: About - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.cachesOperations.cachesOperations.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.cachesOperations.cachesOperations.rst deleted file mode 100644 index e0415714..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.cachesOperations.cachesOperations.rst +++ /dev/null @@ -1,19 +0,0 @@ -_`sibl_gui.components.addons.cachesOperations.cachesOperations` -=============================================================== - -.. automodule:: sibl_gui.components.addons.cachesOperations.cachesOperations - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.addons.cachesOperations.cachesOperations.LOGGER - -.. attribute:: sibl_gui.components.addons.cachesOperations.cachesOperations.COMPONENT_UI_FILE - -Classes -------- - -.. autoclass:: CachesOperations - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.databaseOperations.databaseOperations.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.databaseOperations.databaseOperations.rst deleted file mode 100644 index b0bd2b75..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.databaseOperations.databaseOperations.rst +++ /dev/null @@ -1,23 +0,0 @@ -_`sibl_gui.components.addons.databaseOperations.databaseOperations` -=================================================================== - -.. automodule:: sibl_gui.components.addons.databaseOperations.databaseOperations - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.addons.databaseOperations.databaseOperations.LOGGER - -.. attribute:: sibl_gui.components.addons.databaseOperations.databaseOperations.COMPONENT_UI_FILE - -Classes -------- - -.. autoclass:: DatabaseType - :show-inheritance: - :members: - -.. autoclass:: DatabaseOperations - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.gpsMap.gpsMap.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.gpsMap.gpsMap.rst deleted file mode 100644 index 9b6a3ca8..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.gpsMap.gpsMap.rst +++ /dev/null @@ -1,19 +0,0 @@ -_`sibl_gui.components.addons.gpsMap.gpsMap` -=========================================== - -.. automodule:: sibl_gui.components.addons.gpsMap.gpsMap - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.addons.gpsMap.gpsMap.LOGGER - -.. attribute:: sibl_gui.components.addons.gpsMap.gpsMap.COMPONENT_FILE - -Classes -------- - -.. autoclass:: GpsMap - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.gpsMap.views.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.gpsMap.views.rst deleted file mode 100644 index 7545e679..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.gpsMap.views.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`sibl_gui.components.addons.gpsMap.views` -========================================== - -.. automodule:: sibl_gui.components.addons.gpsMap.views - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.addons.gpsMap.views.LOGGER - -Classes -------- - -.. autoclass:: Map_QWebView - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.iblSetsScanner.iblSetsScanner.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.iblSetsScanner.iblSetsScanner.rst deleted file mode 100644 index 03701683..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.iblSetsScanner.iblSetsScanner.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`sibl_gui.components.addons.iblSetsScanner.iblSetsScanner` -=========================================================== - -.. automodule:: sibl_gui.components.addons.iblSetsScanner.iblSetsScanner - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.addons.iblSetsScanner.iblSetsScanner.LOGGER - -Classes -------- - -.. autoclass:: IblSetsScanner - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.iblSetsScanner.workers.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.iblSetsScanner.workers.rst deleted file mode 100644 index a627be15..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.iblSetsScanner.workers.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`sibl_gui.components.addons.iblSetsScanner.workers` -==================================================== - -.. automodule:: sibl_gui.components.addons.iblSetsScanner.workers - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.addons.iblSetsScanner.workers.LOGGER - -Classes -------- - -.. autoclass:: IblSetsScanner_worker - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loaderScript.loaderScript.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loaderScript.loaderScript.rst deleted file mode 100644 index 933bc1ba..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loaderScript.loaderScript.rst +++ /dev/null @@ -1,19 +0,0 @@ -_`sibl_gui.components.addons.loaderScript.loaderScript` -======================================================= - -.. automodule:: sibl_gui.components.addons.loaderScript.loaderScript - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.addons.loaderScript.loaderScript.LOGGER - -.. attribute:: sibl_gui.components.addons.loaderScript.loaderScript.COMPONENT_FILE - -Classes -------- - -.. autoclass:: LoaderScript - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loaderScriptOptions.loaderScriptOptions.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loaderScriptOptions.loaderScriptOptions.rst deleted file mode 100644 index 3b6a643f..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loaderScriptOptions.loaderScriptOptions.rst +++ /dev/null @@ -1,19 +0,0 @@ -_`sibl_gui.components.addons.loaderScriptOptions.loaderScriptOptions` -===================================================================== - -.. automodule:: sibl_gui.components.addons.loaderScriptOptions.loaderScriptOptions - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.addons.loaderScriptOptions.loaderScriptOptions.LOGGER - -.. attribute:: sibl_gui.components.addons.loaderScriptOptions.loaderScriptOptions.COMPONENT_UI_FILE - -Classes -------- - -.. autoclass:: LoaderScriptOptions - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loaderScriptOptions.views.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loaderScriptOptions.views.rst deleted file mode 100644 index 09cf5ec1..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loaderScriptOptions.views.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`sibl_gui.components.addons.loaderScriptOptions.views` -======================================================= - -.. automodule:: sibl_gui.components.addons.loaderScriptOptions.views - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.addons.loaderScriptOptions.views.LOGGER - -Classes -------- - -.. autoclass:: TemplatesAttributes_QTableWidget - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.locationsBrowser.locationsBrowser.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.locationsBrowser.locationsBrowser.rst deleted file mode 100644 index 0783e72e..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.locationsBrowser.locationsBrowser.rst +++ /dev/null @@ -1,19 +0,0 @@ -_`sibl_gui.components.addons.locationsBrowser.locationsBrowser` -=============================================================== - -.. automodule:: sibl_gui.components.addons.locationsBrowser.locationsBrowser - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.addons.locationsBrowser.locationsBrowser.LOGGER - -.. attribute:: sibl_gui.components.addons.locationsBrowser.locationsBrowser.COMPONENT_UI_FILE - -Classes -------- - -.. autoclass:: LocationsBrowser - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loggingNotifier.loggingNotifier.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loggingNotifier.loggingNotifier.rst deleted file mode 100644 index 6a5d463c..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loggingNotifier.loggingNotifier.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`sibl_gui.components.addons.loggingNotifier.loggingNotifier` -============================================================= - -.. automodule:: sibl_gui.components.addons.loggingNotifier.loggingNotifier - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.addons.loggingNotifier.loggingNotifier.LOGGER - -Classes -------- - -.. autoclass:: LoggingNotifier - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.downloadManager.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.downloadManager.rst deleted file mode 100644 index f9aa8a9d..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.downloadManager.rst +++ /dev/null @@ -1,19 +0,0 @@ -_`sibl_gui.components.addons.onlineUpdater.downloadManager` -=========================================================== - -.. automodule:: sibl_gui.components.addons.onlineUpdater.downloadManager - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.addons.onlineUpdater.downloadManager.LOGGER - -.. attribute:: sibl_gui.components.addons.onlineUpdater.downloadManager.UI_FILE - -Classes -------- - -.. autoclass:: DownloadManager - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.onlineUpdater.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.onlineUpdater.rst deleted file mode 100644 index a54e416b..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.onlineUpdater.rst +++ /dev/null @@ -1,21 +0,0 @@ -_`sibl_gui.components.addons.onlineUpdater.onlineUpdater` -========================================================= - -.. automodule:: sibl_gui.components.addons.onlineUpdater.onlineUpdater - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.addons.onlineUpdater.onlineUpdater.LOGGER - -.. attribute:: sibl_gui.components.addons.onlineUpdater.onlineUpdater.COMPONENT_UI_FILE - -.. attribute:: sibl_gui.components.addons.onlineUpdater.onlineUpdater.REPOSITORY_URL - -Classes -------- - -.. autoclass:: OnlineUpdater - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.remoteUpdater.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.remoteUpdater.rst deleted file mode 100644 index 8ae641b4..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.remoteUpdater.rst +++ /dev/null @@ -1,23 +0,0 @@ -_`sibl_gui.components.addons.onlineUpdater.remoteUpdater` -========================================================= - -.. automodule:: sibl_gui.components.addons.onlineUpdater.remoteUpdater - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.addons.onlineUpdater.remoteUpdater.LOGGER - -.. attribute:: sibl_gui.components.addons.onlineUpdater.remoteUpdater.UI_FILE - -Classes -------- - -.. autoclass:: ReleaseObject - :show-inheritance: - :members: - -.. autoclass:: RemoteUpdater - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.views.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.views.rst deleted file mode 100644 index 7a327999..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.views.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`sibl_gui.components.addons.onlineUpdater.views` -================================================= - -.. automodule:: sibl_gui.components.addons.onlineUpdater.views - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.addons.onlineUpdater.views.LOGGER - -Classes -------- - -.. autoclass:: TemplatesReleases_QTableWidget - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.preview.imagesPreviewer.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.preview.imagesPreviewer.rst deleted file mode 100644 index f36f7bcc..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.preview.imagesPreviewer.rst +++ /dev/null @@ -1,23 +0,0 @@ -_`sibl_gui.components.addons.preview.imagesPreviewer` -===================================================== - -.. automodule:: sibl_gui.components.addons.preview.imagesPreviewer - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.addons.preview.imagesPreviewer.LOGGER - -.. attribute:: sibl_gui.components.addons.preview.imagesPreviewer.UI_FILE - -Classes -------- - -.. autoclass:: Image_QGraphicsItem - :show-inheritance: - :members: - -.. autoclass:: ImagesPreviewer - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.preview.preview.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.preview.preview.rst deleted file mode 100644 index 89f5b5a3..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.preview.preview.rst +++ /dev/null @@ -1,19 +0,0 @@ -_`sibl_gui.components.addons.preview.preview` -============================================= - -.. automodule:: sibl_gui.components.addons.preview.preview - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.addons.preview.preview.LOGGER - -.. attribute:: sibl_gui.components.addons.preview.preview.COMPONENT_UI_FILE - -Classes -------- - -.. autoclass:: Preview - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.rawEditingUtilities.rawEditingUtilities.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.rawEditingUtilities.rawEditingUtilities.rst deleted file mode 100644 index ec547bb2..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.rawEditingUtilities.rawEditingUtilities.rst +++ /dev/null @@ -1,19 +0,0 @@ -_`sibl_gui.components.addons.rawEditingUtilities.rawEditingUtilities` -===================================================================== - -.. automodule:: sibl_gui.components.addons.rawEditingUtilities.rawEditingUtilities - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.addons.rawEditingUtilities.rawEditingUtilities.LOGGER - -.. attribute:: sibl_gui.components.addons.rawEditingUtilities.rawEditingUtilities.COMPONENT_UI_FILE - -Classes -------- - -.. autoclass:: RawEditingUtilities - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.rewiringTool.rewiringTool.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.rewiringTool.rewiringTool.rst deleted file mode 100644 index d91231c4..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.rewiringTool.rewiringTool.rst +++ /dev/null @@ -1,19 +0,0 @@ -_`sibl_gui.components.addons.rewiringTool.rewiringTool` -======================================================= - -.. automodule:: sibl_gui.components.addons.rewiringTool.rewiringTool - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.addons.rewiringTool.rewiringTool.LOGGER - -.. attribute:: sibl_gui.components.addons.rewiringTool.rewiringTool.COMPONENT_UI_FILE - -Classes -------- - -.. autoclass:: RewiringTool - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.sIBLeditUtilities.sIBLeditUtilities.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.sIBLeditUtilities.sIBLeditUtilities.rst deleted file mode 100644 index 915acc47..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.sIBLeditUtilities.sIBLeditUtilities.rst +++ /dev/null @@ -1,19 +0,0 @@ -_`sibl_gui.components.addons.sIBLeditUtilities.sIBLeditUtilities` -================================================================= - -.. automodule:: sibl_gui.components.addons.sIBLeditUtilities.sIBLeditUtilities - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.addons.sIBLeditUtilities.sIBLeditUtilities.LOGGER - -.. attribute:: sibl_gui.components.addons.sIBLeditUtilities.sIBLeditUtilities.COMPONENT_UI_FILE - -Classes -------- - -.. autoclass:: sIBLeditUtilities - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.searchDatabase.searchDatabase.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.searchDatabase.searchDatabase.rst deleted file mode 100644 index fd710d7a..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.searchDatabase.searchDatabase.rst +++ /dev/null @@ -1,19 +0,0 @@ -_`sibl_gui.components.addons.searchDatabase.searchDatabase` -=========================================================== - -.. automodule:: sibl_gui.components.addons.searchDatabase.searchDatabase - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.addons.searchDatabase.searchDatabase.LOGGER - -.. attribute:: sibl_gui.components.addons.searchDatabase.searchDatabase.COMPONENT_UI_FILE - -Classes -------- - -.. autoclass:: SearchDatabase - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.searchDatabase.views.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.searchDatabase.views.rst deleted file mode 100644 index b1dfd64f..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.searchDatabase.views.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`sibl_gui.components.addons.searchDatabase.views` -================================================== - -.. automodule:: sibl_gui.components.addons.searchDatabase.views - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.addons.searchDatabase.views.LOGGER - -Classes -------- - -.. autoclass:: TagsCloud_QListView - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.collectionsOutliner.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.collectionsOutliner.rst deleted file mode 100644 index 2c06b757..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.collectionsOutliner.rst +++ /dev/null @@ -1,19 +0,0 @@ -_`sibl_gui.components.core.collectionsOutliner.collectionsOutliner` -=================================================================== - -.. automodule:: sibl_gui.components.core.collectionsOutliner.collectionsOutliner - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.core.collectionsOutliner.collectionsOutliner.LOGGER - -.. attribute:: sibl_gui.components.core.collectionsOutliner.collectionsOutliner.COMPONENT_UI_FILE - -Classes -------- - -.. autoclass:: CollectionsOutliner - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.models.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.models.rst deleted file mode 100644 index c0425ad8..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.models.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`sibl_gui.components.core.collectionsOutliner.models` -====================================================== - -.. automodule:: sibl_gui.components.core.collectionsOutliner.models - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.core.collectionsOutliner.models.LOGGER - -Classes -------- - -.. autoclass:: CollectionsModel - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.nodes.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.nodes.rst deleted file mode 100644 index 98b23234..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.nodes.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`sibl_gui.components.core.collectionsOutliner.nodes` -===================================================== - -.. automodule:: sibl_gui.components.core.collectionsOutliner.nodes - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.core.collectionsOutliner.nodes.LOGGER - -Classes -------- - -.. autoclass:: OverallCollectionNode - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.views.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.views.rst deleted file mode 100644 index 9a981803..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.views.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`sibl_gui.components.core.collectionsOutliner.views` -===================================================== - -.. automodule:: sibl_gui.components.core.collectionsOutliner.views - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.core.collectionsOutliner.views.LOGGER - -Classes -------- - -.. autoclass:: IblSetsCollections_QTreeView - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.database.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.database.rst deleted file mode 100644 index 31f9e28f..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.database.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`sibl_gui.components.core.database.database` -============================================= - -.. automodule:: sibl_gui.components.core.database.database - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.core.database.database.LOGGER - -Classes -------- - -.. autoclass:: Database - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.exceptions.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.exceptions.rst deleted file mode 100644 index 98ddf8a1..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.exceptions.rst +++ /dev/null @@ -1,56 +0,0 @@ -_`sibl_gui.components.core.database.exceptions` -=============================================== - -.. automodule:: sibl_gui.components.core.database.exceptions - -Classes -------- - -.. autoclass:: AbstractDatabaseError - :show-inheritance: - :members: - -.. autoclass:: DatabaseOperationError - :show-inheritance: - :members: - -.. autoclass:: AbstractIblSetError - :show-inheritance: - :members: - -.. autoclass:: MissingIblSetFileError - :show-inheritance: - :members: - -.. autoclass:: MissingIblSetIconError - :show-inheritance: - :members: - -.. autoclass:: MissingIblSetPreviewImageError - :show-inheritance: - :members: - -.. autoclass:: MissingIblSetBackgroundImageError - :show-inheritance: - :members: - -.. autoclass:: MissingIblSetLightingImageError - :show-inheritance: - :members: - -.. autoclass:: MissingIblSetReflectionImageError - :show-inheritance: - :members: - -.. autoclass:: AbstractTemplateError - :show-inheritance: - :members: - -.. autoclass:: MissingTemplateFileError - :show-inheritance: - :members: - -.. autoclass:: MissingTemplateHelpFileError - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.nodes.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.nodes.rst deleted file mode 100644 index ffeaef56..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.nodes.rst +++ /dev/null @@ -1,34 +0,0 @@ -_`sibl_gui.components.core.database.nodes` -========================================== - -.. automodule:: sibl_gui.components.core.database.nodes - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.core.database.nodes.LOGGER - -Functions ---------- - -.. autofunction:: getTemplateUserName - -Classes -------- - -.. autoclass:: AbstractDatabaseNode - :show-inheritance: - :members: - -.. autoclass:: IblSetNode - :show-inheritance: - :members: - -.. autoclass:: TemplateNode - :show-inheritance: - :members: - -.. autoclass:: CollectionNode - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.operations.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.operations.rst deleted file mode 100644 index 84ef6535..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.operations.rst +++ /dev/null @@ -1,99 +0,0 @@ -_`sibl_gui.components.core.database.operations` -=============================================== - -.. automodule:: sibl_gui.components.core.database.operations - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.core.database.operations.LOGGER - -.. attribute:: sibl_gui.components.core.database.operations.DATABASE_EXCEPTIONS - -.. attribute:: sibl_gui.components.core.database.operations.DEFAULT_SESSION_MAKER - -.. attribute:: sibl_gui.components.core.database.operations.DEFAULT_SESSION - -Functions ---------- - -.. autofunction:: createSession - -.. autofunction:: getSession - -.. autofunction:: query - -.. autofunction:: commit - -.. autofunction:: addItem - -.. autofunction:: addStandardItem - -.. autofunction:: removeItem - -.. autofunction:: removeStandardItem - -.. autofunction:: updateItemContent - -.. autofunction:: updateItemLocation - -.. autofunction:: filterItems - -.. autofunction:: itemExists - -.. autofunction:: getIblSets - -.. autofunction:: filterIblSets - -.. autofunction:: iblSetExists - -.. autofunction:: addIblSet - -.. autofunction:: removeIblSet - -.. autofunction:: updateIblSetContent - -.. autofunction:: updateIblSetLocation - -.. autofunction:: checkIblSetsTableIntegrity - -.. autofunction:: getCollections - -.. autofunction:: filterCollections - -.. autofunction:: getCollectionsByType - -.. autofunction:: filterCollectionsByType - -.. autofunction:: filterIblSetsCollections - -.. autofunction:: filterTemplatesCollections - -.. autofunction:: collectionExists - -.. autofunction:: addCollection - -.. autofunction:: removeCollection - -.. autofunction:: getCollectionsIblSets - -.. autofunction:: getCollectionIblSetsCount - -.. autofunction:: getCollectionTemplatesCount - -.. autofunction:: getTemplates - -.. autofunction:: filterTemplates - -.. autofunction:: templateExists - -.. autofunction:: addTemplate - -.. autofunction:: removeTemplate - -.. autofunction:: updateTemplateContent - -.. autofunction:: updateTemplateLocation - -.. autofunction:: checkTemplatesTableIntegrity - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.types.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.types.rst deleted file mode 100644 index ca8b86d4..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.types.rst +++ /dev/null @@ -1,27 +0,0 @@ -_`sibl_gui.components.core.database.types` -========================================== - -.. automodule:: sibl_gui.components.core.database.types - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.core.database.types.LOGGER - -.. attribute:: sibl_gui.components.core.database.types.Base - -Classes -------- - -.. autoclass:: IblSet - :show-inheritance: - :members: - -.. autoclass:: Template - :show-inheritance: - :members: - -.. autoclass:: Collection - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner.rst deleted file mode 100644 index bb9fb036..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner.rst +++ /dev/null @@ -1,19 +0,0 @@ -_`sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner` -=========================================================== - -.. automodule:: sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner.LOGGER - -.. attribute:: sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner.COMPONENT_UI_FILE - -Classes -------- - -.. autoclass:: IblSetsOutliner - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.iblSetsOutliner.models.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.iblSetsOutliner.models.rst deleted file mode 100644 index 4ecfa465..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.iblSetsOutliner.models.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`sibl_gui.components.core.iblSetsOutliner.models` -================================================== - -.. automodule:: sibl_gui.components.core.iblSetsOutliner.models - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.core.iblSetsOutliner.models.LOGGER - -Classes -------- - -.. autoclass:: IblSetsModel - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.iblSetsOutliner.views.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.iblSetsOutliner.views.rst deleted file mode 100644 index ca4da7d7..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.iblSetsOutliner.views.rst +++ /dev/null @@ -1,21 +0,0 @@ -_`sibl_gui.components.core.iblSetsOutliner.views` -================================================= - -.. automodule:: sibl_gui.components.core.iblSetsOutliner.views - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.core.iblSetsOutliner.views.LOGGER - -Classes -------- - -.. autoclass:: Thumbnails_QListView - :show-inheritance: - :members: - -.. autoclass:: Details_QTreeView - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.inspector.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.inspector.rst deleted file mode 100644 index 0870c7b9..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.inspector.rst +++ /dev/null @@ -1,27 +0,0 @@ -_`sibl_gui.components.core.inspector.inspector` -=============================================== - -.. automodule:: sibl_gui.components.core.inspector.inspector - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.core.inspector.inspector.LOGGER - -.. attribute:: sibl_gui.components.core.inspector.inspector.COMPONENT_UI_FILE - -Classes -------- - -.. autoclass:: Plate - :show-inheritance: - :members: - -.. autoclass:: Light - :show-inheritance: - :members: - -.. autoclass:: Inspector - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.models.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.models.rst deleted file mode 100644 index 2781c86e..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.models.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`sibl_gui.components.core.inspector.models` -============================================ - -.. automodule:: sibl_gui.components.core.inspector.models - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.core.inspector.models.LOGGER - -Classes -------- - -.. autoclass:: PlatesModel - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.nodes.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.nodes.rst deleted file mode 100644 index 976f0d29..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.nodes.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`sibl_gui.components.core.inspector.nodes` -=========================================== - -.. automodule:: sibl_gui.components.core.inspector.nodes - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.core.inspector.nodes.LOGGER - -Classes -------- - -.. autoclass:: PlatesNode - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.views.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.views.rst deleted file mode 100644 index f0f07238..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.views.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`sibl_gui.components.core.inspector.views` -=========================================== - -.. automodule:: sibl_gui.components.core.inspector.views - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.core.inspector.views.LOGGER - -Classes -------- - -.. autoclass:: Plates_QListView - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.models.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.models.rst deleted file mode 100644 index cd86dced..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.models.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`sibl_gui.components.core.templatesOutliner.models` -==================================================== - -.. automodule:: sibl_gui.components.core.templatesOutliner.models - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.core.templatesOutliner.models.LOGGER - -Classes -------- - -.. autoclass:: TemplatesModel - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.nodes.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.nodes.rst deleted file mode 100644 index 61b3277c..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.nodes.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`sibl_gui.components.core.templatesOutliner.nodes` -=================================================== - -.. automodule:: sibl_gui.components.core.templatesOutliner.nodes - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.core.templatesOutliner.nodes.LOGGER - -Classes -------- - -.. autoclass:: SoftwareNode - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.templatesOutliner.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.templatesOutliner.rst deleted file mode 100644 index 619da029..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.templatesOutliner.rst +++ /dev/null @@ -1,19 +0,0 @@ -_`sibl_gui.components.core.templatesOutliner.templatesOutliner` -=============================================================== - -.. automodule:: sibl_gui.components.core.templatesOutliner.templatesOutliner - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.core.templatesOutliner.templatesOutliner.LOGGER - -.. attribute:: sibl_gui.components.core.templatesOutliner.templatesOutliner.COMPONENT_UI_FILE - -Classes -------- - -.. autoclass:: TemplatesOutliner - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.views.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.views.rst deleted file mode 100644 index c18ad58b..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.views.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`sibl_gui.components.core.templatesOutliner.views` -=================================================== - -.. automodule:: sibl_gui.components.core.templatesOutliner.views - -Module Attributes ------------------ - -.. attribute:: sibl_gui.components.core.templatesOutliner.views.LOGGER - -Classes -------- - -.. autoclass:: Templates_QTreeView - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.exceptions.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.exceptions.rst deleted file mode 100644 index 599f6602..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.exceptions.rst +++ /dev/null @@ -1,36 +0,0 @@ -_`sibl_gui.exceptions` -====================== - -.. automodule:: sibl_gui.exceptions - -Classes -------- - -.. autoclass:: AbstractNetworkError - :show-inheritance: - :members: - -.. autoclass:: NetworkError - :show-inheritance: - :members: - -.. autoclass:: SocketConnectionError - :show-inheritance: - :members: - -.. autoclass:: Win32OLEServerConnectionError - :show-inheritance: - :members: - -.. autoclass:: AbstractCacheError - :show-inheritance: - :members: - -.. autoclass:: CacheExistsError - :show-inheritance: - :members: - -.. autoclass:: CacheOperationError - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.globals.constants.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.globals.constants.rst deleted file mode 100644 index 40bbc4e0..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.globals.constants.rst +++ /dev/null @@ -1,12 +0,0 @@ -_`sibl_gui.globals.constants` -============================= - -.. automodule:: sibl_gui.globals.constants - -Classes -------- - -.. autoclass:: Constants - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.globals.runtimeGlobals.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.globals.runtimeGlobals.rst deleted file mode 100644 index f9cd2f54..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.globals.runtimeGlobals.rst +++ /dev/null @@ -1,12 +0,0 @@ -_`sibl_gui.globals.runtimeGlobals` -================================== - -.. automodule:: sibl_gui.globals.runtimeGlobals - -Classes -------- - -.. autoclass:: RuntimeGlobals - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.globals.uiConstants.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.globals.uiConstants.rst deleted file mode 100644 index 7dbe4ec4..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.globals.uiConstants.rst +++ /dev/null @@ -1,12 +0,0 @@ -_`sibl_gui.globals.uiConstants` -=============================== - -.. automodule:: sibl_gui.globals.uiConstants - -Classes -------- - -.. autoclass:: UiConstants - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.launcher.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.launcher.rst deleted file mode 100644 index 8b0b76ac..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.launcher.rst +++ /dev/null @@ -1,24 +0,0 @@ -_`sibl_gui.launcher` -==================== - -.. automodule:: sibl_gui.launcher - -Module Attributes ------------------ - -.. attribute:: sibl_gui.launcher.LOGGER - -Functions ---------- - -.. autofunction:: extendCommandLineParametersParser - -.. autofunction:: main - -Classes -------- - -.. autoclass:: sIBL_GUI - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.libraries.freeImage.freeImage.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.libraries.freeImage.freeImage.rst deleted file mode 100644 index 849c6263..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.libraries.freeImage.freeImage.rst +++ /dev/null @@ -1,740 +0,0 @@ -_`sibl_gui.libraries.freeImage.freeImage` -========================================= - -.. automodule:: sibl_gui.libraries.freeImage.freeImage - -Module Attributes ------------------ - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.LOGGER - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREEIMAGE_LIBRARY_PATH - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREEIMAGE_MAJOR_VERSION - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREEIMAGE_MINOR_VERSION - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREEIMAGE_RELEASE_SERIAL - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREEIMAGE_LOOKUP - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.INT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.BOOL - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.BYTE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.WORD - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.DWORD - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.LONG - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.DOUBLE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.BYTE_P - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREEIMAGE_COLORORDER_BGR - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREEIMAGE_COLORORDER_RGB - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.RGBQUAD - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.RGBTRIPLE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.BITMAPINFOHEADER - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.BITMAPINFO - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.PBITMAPINFO - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIRGB16 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIRGBA16 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIRGBF - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIRGBAF - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FICOMPLEX - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_RGBA_RGB_MASK - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_RGBA_LOOKUP - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI16_555_RED_MASK - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI16_555_GREEN_MASK - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI16_555_BLUE_MASK - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI16_555_RED_SHIFT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI16_555_GREEN_SHIFT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI16_555_BLUE_SHIFT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI16_565_RED_MASK - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI16_565_GREEN_MASK - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI16_565_BLUE_MASK - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI16_565_RED_SHIFT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI16_565_GREEN_SHIFT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI16_565_BLUE_SHIFT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI16_LOOKUP - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIICC_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIICC_COLOR_IS_CMYK - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIICC_LOOKUP - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREE_IMAGE_FORMAT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_UNKNOWN - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_BMP - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_ICO - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_JPEG - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_JNG - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_KOALA - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_LBM - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_IFF - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_MNG - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_PBM - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_PBMRAW - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_PCD - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_PCX - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_PGM - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_PGMRAW - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_PNG - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_PPM - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_PPMRAW - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_RAS - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_TARGA - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_TIFF - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_WBMP - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_PSD - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_CUT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_XBM - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_XPM - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_DDS - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_GIF - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_HDR - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_FAXG3 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_SGI - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_EXR - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_J2K - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_JP2 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_PFM - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_PICT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_RAW - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_LOOKUP - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREE_IMAGE_TYPE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIT_UNKNOWN - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIT_BITMAP - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIT_UINT16 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIT_INT16 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIT_UINT32 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIT_INT32 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIT_FLOAT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIT_DOUBLE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIT_COMPLEX - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIT_RGB16 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIT_RGBA16 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIT_RGBF - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIT_RGBAF - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIT_LOOKUP - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREE_IMAGE_COLOR_TYPE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIC_MINISWHITE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIC_MINISBLACK - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIC_RGB - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIC_PALETTE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIC_RGBALPHA - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIC_CMYK - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIC_LOOKUP - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREE_IMAGE_QUANTIZE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIQ_WUQUANT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIQ_NNQUANT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIQ_LOOKUP - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREE_IMAGE_DITHER - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FID_FS - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FID_BAYER4x4 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FID_BAYER8x8 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FID_CLUSTER6x6 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FID_CLUSTER8x8 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FID_CLUSTER16x16 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FID_BAYER16x16 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FID_LOOKUP - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREE_IMAGE_JPEG_OPERATION - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIJPEG_OP_NONE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIJPEG_OP_FLIP_H - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIJPEG_OP_FLIP_V - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIJPEG_OP_TRANSPOSE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIJPEG_OP_TRANSVERSE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIJPEG_OP_ROTATE_90 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIJPEG_OP_ROTATE_180 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIJPEG_OP_ROTATE_270 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIJPEG_LOOKUP - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREE_IMAGE_TMO - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FITMO_DRAGO03 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FITMO_REINHARD05 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FITMO_FATTAL02 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FITMO_LOOKUP - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREE_IMAGE_FILTER - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FILTER_BOX - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FILTER_BICUBIC - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FILTER_BILINEAR - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FILTER_BSPLINE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FILTER_CATMULLROM - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FILTER_LANCZOS3 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FILTER_LOOKUP - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREE_IMAGE_COLOR_CHANNEL - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FICC_RGB - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FICC_RED - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FICC_GREEN - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FICC_BLUE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FICC_ALPHA - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FICC_BLACK - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FICC_REAL - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FICC_IMAG - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FICC_MAG - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FICC_PHASE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FICC_LOOKUP - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREE_IMAGE_MDTYPE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_NOTYPE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_BYTE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_ASCII - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_SHORT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_LONG - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_RATIONAL - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_SBYTE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_UNDEFINED - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_SSHORT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_SLONG - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_SRATIONAL - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_FLOAT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_DOUBLE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_IFD - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_PALETTE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_LOOKUP - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREE_IMAGE_MDMODEL - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIMD_NODATA - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIMD_COMMENTS - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIMD_EXIF_MAIN - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIMD_EXIF_EXIF - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIMD_EXIF_GPS - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIMD_EXIF_MAKERNOTE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIMD_EXIF_INTEROP - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIMD_IPTC - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIMD_XMP - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIMD_GEOTIFF - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIMD_ANIMATION - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIMD_CUSTOM - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIMD_EXIF_RAW - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIMD_LOOKUP - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.fi_handle - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_ReadProc - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_WriteProc - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_SeekProc - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_TellProc - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_FormatProc - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_DescriptionProc - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_ExtensionListProc - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_RegExprProc - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_OpenProc - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_CloseProc - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_PageCountProc - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_PageCapabilityProc - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_LoadProc - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_SaveProc - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_ValidateProc - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_MimeProc - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_SupportsExportBPPProc - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_SupportsExportTypeProc - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_SupportsICCProfilesProc - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_SupportsNoPixelsProc - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_InitProc - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_LOAD_NOPIXELS - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.BMP_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.BMP_SAVE_RLE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.CUT_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.DDS_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.EXR_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.EXR_FLOAT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.EXR_NONE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.EXR_ZIP - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.EXR_PIZ - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.EXR_PXR24 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.EXR_B44 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.EXR_LC - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FAXG3_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.GIF_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.GIF_LOAD256 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.GIF_PLAYBACK - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.HDR_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.ICO_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.ICO_MAKEALPHA - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.IFF_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.J2K_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.JP2_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_FAST - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_ACCURATE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_CMYK - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_EXIFROTATE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_QUALITYSUPERB - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_QUALITYGOOD - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_QUALITYNORMAL - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_QUALITYAVERAGE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_QUALITYBAD - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_PROGRESSIVE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_SUBSAMPLING_411 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_SUBSAMPLING_420 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_SUBSAMPLING_422 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_SUBSAMPLING_444 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_OPTIMIZE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_BASELINE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.KOALA_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.LBM_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.MNG_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.PCD_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.PCD_BASE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.PCD_BASEDIV4 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.PCD_BASEDIV16 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.PCX_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.PFM_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.PICT_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.PNG_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.PNG_IGNOREGAMMA - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.PNG_Z_BEST_SPEED - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.PNG_Z_DEFAULT_COMPRESSION - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.PNG_Z_BEST_COMPRESSION - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.PNG_Z_NO_COMPRESSION - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.PNG_INTERLACED - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.PNM_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.PNM_SAVE_RAW - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.PNM_SAVE_ASCII - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.PSD_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.PSD_CMYK - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.PSD_LAB - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.RAS_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.RAW_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.RAW_PREVIEW - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.RAW_DISPLAY - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.RAW_HALFSIZE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.SGI_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.TARGA_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.TARGA_LOAD_RGB888 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.TIFF_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.TIFF_CMYK - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.TIFF_PACKBITS - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.TIFF_DEFLATE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.TIFF_ADOBE_DEFLATE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.TIFF_NONE - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.TIFF_CCITTFAX3 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.TIFF_CCITTFAX4 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.TIFF_LZW - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.TIFF_JPEG - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.TIFF_LOGLUV - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.WBMP_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.XBM_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.XPM_DEFAULT - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_COLOR_IS_RGB_COLOR - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_COLOR_IS_RGBA_COLOR - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_COLOR_FIND_EQUAL_COLOR - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_COLOR_ALPHA_IS_INDEX - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_COLOR_PALETTE_SEARCH_MASK - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_COLOR_LOOKUP - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.BPP_1 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.BPP_4 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.BPP_8 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.BPP_16 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.BPP_24 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.BPP_32 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.BPP_48 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.BPP_64 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.BPP_96 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.BPP_1TO8 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.BPP_16TO32 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.BPP_1TO32 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.BPP_1TO48 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.BPP_LOOKUP - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.CPC_8 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.CPC_16 - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.CPC_LOOKUP - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_DEFAULT_NULL - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_DEFAULT_GAMMA - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_DEFAULT_LOOKUP - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FreeImage_OutputMessageFunctionStdCall - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FreeImage_OutputMessageFunction - -.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREEIMAGE_FUNCTIONS - -Functions ---------- - -.. autofunction:: pointer - -.. autofunction:: unchecked - -.. autofunction:: getFreeImageLibraryPath - -Classes -------- - -.. autoclass:: FIBITMAP - :show-inheritance: - :members: - -.. autoclass:: FIMULTIBITMAP - :show-inheritance: - :members: - -.. autoclass:: tagRGBQUAD - :show-inheritance: - :members: - -.. autoclass:: tagRGBTRIPLE - :show-inheritance: - :members: - -.. autoclass:: tagBITMAPINFOHEADER - :show-inheritance: - :members: - -.. autoclass:: tagBITMAPINFO - :show-inheritance: - :members: - -.. autoclass:: tagFIRGB16 - :show-inheritance: - :members: - -.. autoclass:: tagFIRGBA16 - :show-inheritance: - :members: - -.. autoclass:: tagFIRGBF - :show-inheritance: - :members: - -.. autoclass:: tagFIRGBAF - :show-inheritance: - :members: - -.. autoclass:: tagFICOMPLEX - :show-inheritance: - :members: - -.. autoclass:: FIICCPROFILE - :show-inheritance: - :members: - -.. autoclass:: FIMETADATA - :show-inheritance: - :members: - -.. autoclass:: FITAG - :show-inheritance: - :members: - -.. autoclass:: FreeImageIO - :show-inheritance: - :members: - -.. autoclass:: FIMEMORY - :show-inheritance: - :members: - -.. autoclass:: Plugin - :show-inheritance: - :members: - -.. autoclass:: ImageInformationsHeader - :show-inheritance: - :members: - -.. autoclass:: Image - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.ui.caches.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.ui.caches.rst deleted file mode 100644 index 76b84318..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.ui.caches.rst +++ /dev/null @@ -1,25 +0,0 @@ -_`sibl_gui.ui.caches` -===================== - -.. automodule:: sibl_gui.ui.caches - -Module Attributes ------------------ - -.. attribute:: sibl_gui.ui.caches.LOGGER - -Classes -------- - -.. autoclass:: CacheMetrics - :show-inheritance: - :members: - -.. autoclass:: AbstractResourcesCache - :show-inheritance: - :members: - -.. autoclass:: AsynchronousGraphicsItemsCache - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.ui.common.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.ui.common.rst deleted file mode 100644 index 233c7dad..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.ui.common.rst +++ /dev/null @@ -1,37 +0,0 @@ -_`sibl_gui.ui.common` -===================== - -.. automodule:: sibl_gui.ui.common - -Module Attributes ------------------ - -.. attribute:: sibl_gui.ui.common.LOGGER - -Functions ---------- - -.. autofunction:: convertImage - -.. autofunction:: getThumbnailPath - -.. autofunction:: extractThumbnail - -.. autofunction:: loadGraphicsItem - -.. autofunction:: getGraphicsItem - -.. autofunction:: getIcon - -.. autofunction:: getPixmap - -.. autofunction:: getImage - -.. autofunction:: createPixmap - -.. autofunction:: getImageInformationsHeader - -.. autofunction:: filterImagePath - -.. autofunction:: getFormatedShotDate - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.ui.models.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.ui.models.rst deleted file mode 100644 index 40cde7f9..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.ui.models.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`sibl_gui.ui.models` -===================== - -.. automodule:: sibl_gui.ui.models - -Module Attributes ------------------ - -.. attribute:: sibl_gui.ui.models.LOGGER - -Classes -------- - -.. autoclass:: GraphModel - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.ui.nodes.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.ui.nodes.rst deleted file mode 100644 index 4294a924..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.ui.nodes.rst +++ /dev/null @@ -1,25 +0,0 @@ -_`sibl_gui.ui.nodes` -==================== - -.. automodule:: sibl_gui.ui.nodes - -Module Attributes ------------------ - -.. attribute:: sibl_gui.ui.nodes.LOGGER - -Classes -------- - -.. autoclass:: Mixin_GraphModelObject - :show-inheritance: - :members: - -.. autoclass:: GraphModelAttribute - :show-inheritance: - :members: - -.. autoclass:: GraphModelNode - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.ui.views.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.ui.views.rst deleted file mode 100644 index 9378c5fb..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.ui.views.rst +++ /dev/null @@ -1,25 +0,0 @@ -_`sibl_gui.ui.views` -==================== - -.. automodule:: sibl_gui.ui.views - -Module Attributes ------------------ - -.. attribute:: sibl_gui.ui.views.LOGGER - -Classes -------- - -.. autoclass:: Mixin_AbstractView - :show-inheritance: - :members: - -.. autoclass:: Abstract_QListView - :show-inheritance: - :members: - -.. autoclass:: Abstract_QTreeView - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.ui.widgets.application_QToolBar.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.ui.widgets.application_QToolBar.rst deleted file mode 100644 index 3b9b8932..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.ui.widgets.application_QToolBar.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`sibl_gui.ui.widgets.application_QToolBar` -=========================================== - -.. automodule:: sibl_gui.ui.widgets.application_QToolBar - -Module Attributes ------------------ - -.. attribute:: sibl_gui.ui.widgets.application_QToolBar.LOGGER - -Classes -------- - -.. autoclass:: Application_QToolBar - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.ui.workers.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.ui.workers.rst deleted file mode 100644 index c97f3fec..00000000 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.ui.workers.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`sibl_gui.ui.workers` -====================== - -.. automodule:: sibl_gui.ui.workers - -Module Attributes ------------------ - -.. attribute:: sibl_gui.ui.workers.LOGGER - -Classes -------- - -.. autoclass:: GraphicsItem_worker - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.addons.projectsExplorer.models.rst b/docs/sphinx/source/resources/pages/api/umbra.components.addons.projectsExplorer.models.rst deleted file mode 100644 index 6727d8c5..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.components.addons.projectsExplorer.models.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`umbra.components.addons.projectsExplorer.models` -================================================== - -.. automodule:: umbra.components.addons.projectsExplorer.models - -Module Attributes ------------------ - -.. attribute:: umbra.components.addons.projectsExplorer.models.LOGGER - -Classes -------- - -.. autoclass:: ProjectsProxyModel - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.addons.projectsExplorer.projectsExplorer.rst b/docs/sphinx/source/resources/pages/api/umbra.components.addons.projectsExplorer.projectsExplorer.rst deleted file mode 100644 index 0dda8142..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.components.addons.projectsExplorer.projectsExplorer.rst +++ /dev/null @@ -1,19 +0,0 @@ -_`umbra.components.addons.projectsExplorer.projectsExplorer` -============================================================ - -.. automodule:: umbra.components.addons.projectsExplorer.projectsExplorer - -Module Attributes ------------------ - -.. attribute:: umbra.components.addons.projectsExplorer.projectsExplorer.LOGGER - -.. attribute:: umbra.components.addons.projectsExplorer.projectsExplorer.COMPONENT_UI_FILE - -Classes -------- - -.. autoclass:: ProjectsExplorer - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.addons.projectsExplorer.views.rst b/docs/sphinx/source/resources/pages/api/umbra.components.addons.projectsExplorer.views.rst deleted file mode 100644 index 05c3c5ff..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.components.addons.projectsExplorer.views.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`umbra.components.addons.projectsExplorer.views` -================================================= - -.. automodule:: umbra.components.addons.projectsExplorer.views - -Module Attributes ------------------ - -.. attribute:: umbra.components.addons.projectsExplorer.views.LOGGER - -Classes -------- - -.. autoclass:: Projects_QTreeView - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.addons.tcpClientUi.tcpClientUi.rst b/docs/sphinx/source/resources/pages/api/umbra.components.addons.tcpClientUi.tcpClientUi.rst deleted file mode 100644 index cb91ed63..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.components.addons.tcpClientUi.tcpClientUi.rst +++ /dev/null @@ -1,19 +0,0 @@ -_`umbra.components.addons.tcpClientUi.tcpClientUi` -================================================== - -.. automodule:: umbra.components.addons.tcpClientUi.tcpClientUi - -Module Attributes ------------------ - -.. attribute:: umbra.components.addons.tcpClientUi.tcpClientUi.LOGGER - -.. attribute:: umbra.components.addons.tcpClientUi.tcpClientUi.COMPONENT_UI_FILE - -Classes -------- - -.. autoclass:: TCPClientUi - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.addons.tcpServerUi.tcpServerUi.rst b/docs/sphinx/source/resources/pages/api/umbra.components.addons.tcpServerUi.tcpServerUi.rst deleted file mode 100644 index 3bb3be97..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.components.addons.tcpServerUi.tcpServerUi.rst +++ /dev/null @@ -1,23 +0,0 @@ -_`umbra.components.addons.tcpServerUi.tcpServerUi` -================================================== - -.. automodule:: umbra.components.addons.tcpServerUi.tcpServerUi - -Module Attributes ------------------ - -.. attribute:: umbra.components.addons.tcpServerUi.tcpServerUi.LOGGER - -.. attribute:: umbra.components.addons.tcpServerUi.tcpServerUi.COMPONENT_UI_FILE - -Classes -------- - -.. autoclass:: RequestsStackDataHandler - :show-inheritance: - :members: - -.. autoclass:: TCPServerUi - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.models.rst b/docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.models.rst deleted file mode 100644 index de2db37a..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.models.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`umbra.components.addons.traceUi.models` -========================================= - -.. automodule:: umbra.components.addons.traceUi.models - -Module Attributes ------------------ - -.. attribute:: umbra.components.addons.traceUi.models.LOGGER - -Classes -------- - -.. autoclass:: ModulesModel - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.nodes.rst b/docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.nodes.rst deleted file mode 100644 index 725e5269..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.nodes.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`umbra.components.addons.traceUi.nodes` -======================================== - -.. automodule:: umbra.components.addons.traceUi.nodes - -Module Attributes ------------------ - -.. attribute:: umbra.components.addons.traceUi.nodes.LOGGER - -Classes -------- - -.. autoclass:: ModuleNode - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.traceUi.rst b/docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.traceUi.rst deleted file mode 100644 index 27412365..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.traceUi.rst +++ /dev/null @@ -1,19 +0,0 @@ -_`umbra.components.addons.traceUi.traceUi` -========================================== - -.. automodule:: umbra.components.addons.traceUi.traceUi - -Module Attributes ------------------ - -.. attribute:: umbra.components.addons.traceUi.traceUi.LOGGER - -.. attribute:: umbra.components.addons.traceUi.traceUi.COMPONENT_UI_FILE - -Classes -------- - -.. autoclass:: TraceUi - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.views.rst b/docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.views.rst deleted file mode 100644 index 90411a4b..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.views.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`umbra.components.addons.traceUi.views` -======================================== - -.. automodule:: umbra.components.addons.traceUi.views - -Module Attributes ------------------ - -.. attribute:: umbra.components.addons.traceUi.views.LOGGER - -Classes -------- - -.. autoclass:: Modules_QTreeView - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.componentsManagerUi.rst b/docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.componentsManagerUi.rst deleted file mode 100644 index 17554fd9..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.componentsManagerUi.rst +++ /dev/null @@ -1,19 +0,0 @@ -_`umbra.components.factory.componentsManagerUi.componentsManagerUi` -=================================================================== - -.. automodule:: umbra.components.factory.componentsManagerUi.componentsManagerUi - -Module Attributes ------------------ - -.. attribute:: umbra.components.factory.componentsManagerUi.componentsManagerUi.LOGGER - -.. attribute:: umbra.components.factory.componentsManagerUi.componentsManagerUi.COMPONENT_UI_FILE - -Classes -------- - -.. autoclass:: ComponentsManagerUi - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.models.rst b/docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.models.rst deleted file mode 100644 index c7cc6f48..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.models.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`umbra.components.factory.componentsManagerUi.models` -====================================================== - -.. automodule:: umbra.components.factory.componentsManagerUi.models - -Module Attributes ------------------ - -.. attribute:: umbra.components.factory.componentsManagerUi.models.LOGGER - -Classes -------- - -.. autoclass:: ComponentsModel - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.nodes.rst b/docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.nodes.rst deleted file mode 100644 index 7df9b6dd..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.nodes.rst +++ /dev/null @@ -1,21 +0,0 @@ -_`umbra.components.factory.componentsManagerUi.nodes` -===================================================== - -.. automodule:: umbra.components.factory.componentsManagerUi.nodes - -Module Attributes ------------------ - -.. attribute:: umbra.components.factory.componentsManagerUi.nodes.LOGGER - -Classes -------- - -.. autoclass:: PathNode - :show-inheritance: - :members: - -.. autoclass:: ComponentNode - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.views.rst b/docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.views.rst deleted file mode 100644 index 240fc084..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.views.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`umbra.components.factory.componentsManagerUi.views` -===================================================== - -.. automodule:: umbra.components.factory.componentsManagerUi.views - -Module Attributes ------------------ - -.. attribute:: umbra.components.factory.componentsManagerUi.views.LOGGER - -Classes -------- - -.. autoclass:: Components_QTreeView - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.factory.preferencesManager.preferencesManager.rst b/docs/sphinx/source/resources/pages/api/umbra.components.factory.preferencesManager.preferencesManager.rst deleted file mode 100644 index 7fd817cd..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.components.factory.preferencesManager.preferencesManager.rst +++ /dev/null @@ -1,19 +0,0 @@ -_`umbra.components.factory.preferencesManager.preferencesManager` -================================================================= - -.. automodule:: umbra.components.factory.preferencesManager.preferencesManager - -Module Attributes ------------------ - -.. attribute:: umbra.components.factory.preferencesManager.preferencesManager.LOGGER - -.. attribute:: umbra.components.factory.preferencesManager.preferencesManager.COMPONENT_UI_FILE - -Classes -------- - -.. autoclass:: PreferencesManager - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.editor.rst b/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.editor.rst deleted file mode 100644 index 74c354de..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.editor.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`umbra.components.factory.scriptEditor.editor` -=============================================== - -.. automodule:: umbra.components.factory.scriptEditor.editor - -Module Attributes ------------------ - -.. attribute:: umbra.components.factory.scriptEditor.editor.LOGGER - -Classes -------- - -.. autoclass:: Editor - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.editorStatus.rst b/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.editorStatus.rst deleted file mode 100644 index 58178709..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.editorStatus.rst +++ /dev/null @@ -1,19 +0,0 @@ -_`umbra.components.factory.scriptEditor.editorStatus` -===================================================== - -.. automodule:: umbra.components.factory.scriptEditor.editorStatus - -Module Attributes ------------------ - -.. attribute:: umbra.components.factory.scriptEditor.editorStatus.LOGGER - -.. attribute:: umbra.components.factory.scriptEditor.editorStatus.UI_FILE - -Classes -------- - -.. autoclass:: EditorStatus - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.models.rst b/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.models.rst deleted file mode 100644 index 89437388..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.models.rst +++ /dev/null @@ -1,29 +0,0 @@ -_`umbra.components.factory.scriptEditor.models` -=============================================== - -.. automodule:: umbra.components.factory.scriptEditor.models - -Module Attributes ------------------ - -.. attribute:: umbra.components.factory.scriptEditor.models.LOGGER - -Classes -------- - -.. autoclass:: ProjectsModel - :show-inheritance: - :members: - -.. autoclass:: LanguagesModel - :show-inheritance: - :members: - -.. autoclass:: PatternsModel - :show-inheritance: - :members: - -.. autoclass:: SearchResultsModel - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.nodes.rst b/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.nodes.rst deleted file mode 100644 index a934d019..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.nodes.rst +++ /dev/null @@ -1,45 +0,0 @@ -_`umbra.components.factory.scriptEditor.nodes` -============================================== - -.. automodule:: umbra.components.factory.scriptEditor.nodes - -Module Attributes ------------------ - -.. attribute:: umbra.components.factory.scriptEditor.nodes.LOGGER - -Classes -------- - -.. autoclass:: EditorNode - :show-inheritance: - :members: - -.. autoclass:: FileNode - :show-inheritance: - :members: - -.. autoclass:: DirectoryNode - :show-inheritance: - :members: - -.. autoclass:: ProjectNode - :show-inheritance: - :members: - -.. autoclass:: PatternNode - :show-inheritance: - :members: - -.. autoclass:: SearchFileNode - :show-inheritance: - :members: - -.. autoclass:: SearchOccurenceNode - :show-inheritance: - :members: - -.. autoclass:: ReplaceResultNode - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.scriptEditor.rst b/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.scriptEditor.rst deleted file mode 100644 index 7a9f953a..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.scriptEditor.rst +++ /dev/null @@ -1,19 +0,0 @@ -_`umbra.components.factory.scriptEditor.scriptEditor` -===================================================== - -.. automodule:: umbra.components.factory.scriptEditor.scriptEditor - -Module Attributes ------------------ - -.. attribute:: umbra.components.factory.scriptEditor.scriptEditor.LOGGER - -.. attribute:: umbra.components.factory.scriptEditor.scriptEditor.COMPONENT_UI_FILE - -Classes -------- - -.. autoclass:: ScriptEditor - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.searchAndReplace.rst b/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.searchAndReplace.rst deleted file mode 100644 index bd199da1..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.searchAndReplace.rst +++ /dev/null @@ -1,23 +0,0 @@ -_`umbra.components.factory.scriptEditor.searchAndReplace` -========================================================= - -.. automodule:: umbra.components.factory.scriptEditor.searchAndReplace - -Module Attributes ------------------ - -.. attribute:: umbra.components.factory.scriptEditor.searchAndReplace.LOGGER - -.. attribute:: umbra.components.factory.scriptEditor.searchAndReplace.UI_FILE - -Classes -------- - -.. autoclass:: ValidationFilter - :show-inheritance: - :members: - -.. autoclass:: SearchAndReplace - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.searchInFiles.rst b/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.searchInFiles.rst deleted file mode 100644 index f9a11c0c..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.searchInFiles.rst +++ /dev/null @@ -1,19 +0,0 @@ -_`umbra.components.factory.scriptEditor.searchInFiles` -====================================================== - -.. automodule:: umbra.components.factory.scriptEditor.searchInFiles - -Module Attributes ------------------ - -.. attribute:: umbra.components.factory.scriptEditor.searchInFiles.LOGGER - -.. attribute:: umbra.components.factory.scriptEditor.searchInFiles.UI_FILE - -Classes -------- - -.. autoclass:: SearchInFiles - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.views.rst b/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.views.rst deleted file mode 100644 index fd4c2fe8..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.views.rst +++ /dev/null @@ -1,21 +0,0 @@ -_`umbra.components.factory.scriptEditor.views` -============================================== - -.. automodule:: umbra.components.factory.scriptEditor.views - -Module Attributes ------------------ - -.. attribute:: umbra.components.factory.scriptEditor.views.LOGGER - -Classes -------- - -.. autoclass:: SearchResults_QTreeView - :show-inheritance: - :members: - -.. autoclass:: ScriptEditor_QTabWidget - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.workers.rst b/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.workers.rst deleted file mode 100644 index 275248dc..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.workers.rst +++ /dev/null @@ -1,29 +0,0 @@ -_`umbra.components.factory.scriptEditor.workers` -================================================ - -.. automodule:: umbra.components.factory.scriptEditor.workers - -Module Attributes ------------------ - -.. attribute:: umbra.components.factory.scriptEditor.workers.LOGGER - -Classes -------- - -.. autoclass:: Occurence - :show-inheritance: - :members: - -.. autoclass:: SearchResult - :show-inheritance: - :members: - -.. autoclass:: CacheData - :show-inheritance: - :members: - -.. autoclass:: Search_worker - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.engine.rst b/docs/sphinx/source/resources/pages/api/umbra.engine.rst deleted file mode 100644 index d27291e3..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.engine.rst +++ /dev/null @@ -1,38 +0,0 @@ -_`umbra.engine` -=============== - -.. automodule:: umbra.engine - -Module Attributes ------------------ - -.. attribute:: umbra.engine.LOGGER - -.. attribute:: umbra.engine.SESSION_HEADER_TEXT - -.. attribute:: umbra.engine.SESSION_FOOTER_TEXT - -Functions ---------- - -.. autofunction:: showProcessing - -.. autofunction:: encapsulateProcessing - -.. autofunction:: setUserApplicationDataDirectory - -.. autofunction:: getCommandLineParametersParser - -.. autofunction:: getLoggingFile - -.. autofunction:: run - -.. autofunction:: exit - -Classes -------- - -.. autoclass:: Umbra - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.exceptions.rst b/docs/sphinx/source/resources/pages/api/umbra.exceptions.rst deleted file mode 100644 index 0bbbaf1b..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.exceptions.rst +++ /dev/null @@ -1,89 +0,0 @@ -_`umbra.exceptions` -=================== - -.. automodule:: umbra.exceptions - -Functions ---------- - -.. autofunction:: notifyExceptionHandler - -Classes -------- - -.. autoclass:: AbstractEngineError - :show-inheritance: - :members: - -.. autoclass:: EngineConfigurationError - :show-inheritance: - :members: - -.. autoclass:: EngineInitializationError - :show-inheritance: - :members: - -.. autoclass:: ResourceExistsError - :show-inheritance: - :members: - -.. autoclass:: AbstractActionsManagerError - :show-inheritance: - :members: - -.. autoclass:: CategoryExistsError - :show-inheritance: - :members: - -.. autoclass:: ActionExistsError - :show-inheritance: - :members: - -.. autoclass:: AbstractPatchesManagerError - :show-inheritance: - :members: - -.. autoclass:: PatchRegistrationError - :show-inheritance: - :members: - -.. autoclass:: PatchInterfaceError - :show-inheritance: - :members: - -.. autoclass:: PatchApplyError - :show-inheritance: - :members: - -.. autoclass:: AbstractLayoutsManagerError - :show-inheritance: - :members: - -.. autoclass:: LayoutRegistrationError - :show-inheritance: - :members: - -.. autoclass:: LayoutExistError - :show-inheritance: - :members: - -.. autoclass:: AbstractFileSystemEventsManagerError - :show-inheritance: - :members: - -.. autoclass:: PathRegistrationError - :show-inheritance: - :members: - -.. autoclass:: PathExistsError - :show-inheritance: - :members: - -.. autoclass:: AbstractLanguageError - :show-inheritance: - :members: - -.. autoclass:: LanguageGrammarError - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.globals.constants.rst b/docs/sphinx/source/resources/pages/api/umbra.globals.constants.rst deleted file mode 100644 index 263bff3c..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.globals.constants.rst +++ /dev/null @@ -1,12 +0,0 @@ -_`umbra.globals.constants` -========================== - -.. automodule:: umbra.globals.constants - -Classes -------- - -.. autoclass:: Constants - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.globals.runtimeGlobals.rst b/docs/sphinx/source/resources/pages/api/umbra.globals.runtimeGlobals.rst deleted file mode 100644 index 8d75195b..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.globals.runtimeGlobals.rst +++ /dev/null @@ -1,12 +0,0 @@ -_`umbra.globals.runtimeGlobals` -=============================== - -.. automodule:: umbra.globals.runtimeGlobals - -Classes -------- - -.. autoclass:: RuntimeGlobals - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.globals.uiConstants.rst b/docs/sphinx/source/resources/pages/api/umbra.globals.uiConstants.rst deleted file mode 100644 index c72b33b0..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.globals.uiConstants.rst +++ /dev/null @@ -1,12 +0,0 @@ -_`umbra.globals.uiConstants` -============================ - -.. automodule:: umbra.globals.uiConstants - -Classes -------- - -.. autoclass:: UiConstants - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.guerilla.rst b/docs/sphinx/source/resources/pages/api/umbra.guerilla.rst deleted file mode 100644 index 5143312c..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.guerilla.rst +++ /dev/null @@ -1,12 +0,0 @@ -_`umbra.guerilla` -================= - -.. automodule:: umbra.guerilla - -Functions ---------- - -.. autofunction:: attributeWarfare - -.. autofunction:: baseWarfare - diff --git a/docs/sphinx/source/resources/pages/api/umbra.launcher.rst b/docs/sphinx/source/resources/pages/api/umbra.launcher.rst deleted file mode 100644 index d0d5f31e..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.launcher.rst +++ /dev/null @@ -1,10 +0,0 @@ -_`umbra.launcher` -================= - -.. automodule:: umbra.launcher - -Functions ---------- - -.. autofunction:: main - diff --git a/docs/sphinx/source/resources/pages/api/umbra.managers.actionsManager.rst b/docs/sphinx/source/resources/pages/api/umbra.managers.actionsManager.rst deleted file mode 100644 index 45b5bba8..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.managers.actionsManager.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`umbra.managers.actionsManager` -================================ - -.. automodule:: umbra.managers.actionsManager - -Module Attributes ------------------ - -.. attribute:: umbra.managers.actionsManager.LOGGER - -Classes -------- - -.. autoclass:: ActionsManager - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.managers.fileSystemEventsManager.rst b/docs/sphinx/source/resources/pages/api/umbra.managers.fileSystemEventsManager.rst deleted file mode 100644 index f21e25d6..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.managers.fileSystemEventsManager.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`umbra.managers.fileSystemEventsManager` -========================================= - -.. automodule:: umbra.managers.fileSystemEventsManager - -Module Attributes ------------------ - -.. attribute:: umbra.managers.fileSystemEventsManager.LOGGER - -Classes -------- - -.. autoclass:: FileSystemEventsManager - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.managers.layoutsManager.rst b/docs/sphinx/source/resources/pages/api/umbra.managers.layoutsManager.rst deleted file mode 100644 index 845e4748..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.managers.layoutsManager.rst +++ /dev/null @@ -1,21 +0,0 @@ -_`umbra.managers.layoutsManager` -================================ - -.. automodule:: umbra.managers.layoutsManager - -Module Attributes ------------------ - -.. attribute:: umbra.managers.layoutsManager.LOGGER - -Classes -------- - -.. autoclass:: Layout - :show-inheritance: - :members: - -.. autoclass:: LayoutsManager - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.managers.notificationsManager.rst b/docs/sphinx/source/resources/pages/api/umbra.managers.notificationsManager.rst deleted file mode 100644 index 383ca586..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.managers.notificationsManager.rst +++ /dev/null @@ -1,21 +0,0 @@ -_`umbra.managers.notificationsManager` -====================================== - -.. automodule:: umbra.managers.notificationsManager - -Module Attributes ------------------ - -.. attribute:: umbra.managers.notificationsManager.LOGGER - -Classes -------- - -.. autoclass:: Notification - :show-inheritance: - :members: - -.. autoclass:: NotificationsManager - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.managers.patchesManager.rst b/docs/sphinx/source/resources/pages/api/umbra.managers.patchesManager.rst deleted file mode 100644 index 54eb03ed..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.managers.patchesManager.rst +++ /dev/null @@ -1,21 +0,0 @@ -_`umbra.managers.patchesManager` -================================ - -.. automodule:: umbra.managers.patchesManager - -Module Attributes ------------------ - -.. attribute:: umbra.managers.patchesManager.LOGGER - -Classes -------- - -.. autoclass:: Patch - :show-inheritance: - :members: - -.. autoclass:: PatchesManager - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.preferences.rst b/docs/sphinx/source/resources/pages/api/umbra.preferences.rst deleted file mode 100644 index 2910876b..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.preferences.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`umbra.preferences` -==================== - -.. automodule:: umbra.preferences - -Module Attributes ------------------ - -.. attribute:: umbra.preferences.LOGGER - -Classes -------- - -.. autoclass:: Preferences - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.processing.rst b/docs/sphinx/source/resources/pages/api/umbra.processing.rst deleted file mode 100644 index cf2f6d97..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.processing.rst +++ /dev/null @@ -1,19 +0,0 @@ -_`umbra.processing` -=================== - -.. automodule:: umbra.processing - -Module Attributes ------------------ - -.. attribute:: umbra.processing.LOGGER - -.. attribute:: umbra.processing.UI_FILE - -Classes -------- - -.. autoclass:: Processing - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.reporter.rst b/docs/sphinx/source/resources/pages/api/umbra.reporter.rst deleted file mode 100644 index 6e285f23..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.reporter.rst +++ /dev/null @@ -1,36 +0,0 @@ -_`umbra.reporter` -================= - -.. automodule:: umbra.reporter - -Module Attributes ------------------ - -.. attribute:: umbra.reporter.LOGGER - -.. attribute:: umbra.reporter.UI_FILE - -Functions ---------- - -.. autofunction:: baseExceptionHandler - -.. autofunction:: systemExitExceptionHandler - -.. autofunction:: criticalExceptionHandler - -.. autofunction:: installExceptionReporter - -.. autofunction:: uninstallExceptionReporter - -.. autofunction:: enableExceptionReporter - -.. autofunction:: disableExceptionReporter - -Classes -------- - -.. autoclass:: Reporter - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.common.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.common.rst deleted file mode 100644 index d9c61c03..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.ui.common.rst +++ /dev/null @@ -1,44 +0,0 @@ -_`umbra.ui.common` -================== - -.. automodule:: umbra.ui.common - -Module Attributes ------------------ - -.. attribute:: umbra.ui.common.LOGGER - -Functions ---------- - -.. autofunction:: getApplicationInstance - -.. autofunction:: parseLocation - -.. autofunction:: getResourcePath - -.. autofunction:: setWindowDefaultIcon - -.. autofunction:: getSectionsFileParser - -.. autofunction:: storeLastBrowsedPath - -.. autofunction:: getQVariantAsString - -.. autofunction:: parentsWalker - -.. autofunction:: signalsBlocker - -.. autofunction:: showWaitCursor - -.. autofunction:: setToolBoxHeight - -.. autofunction:: setChildrenPadding - -Classes -------- - -.. autoclass:: Location - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.completers.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.completers.rst deleted file mode 100644 index ab4aae66..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.ui.completers.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`umbra.ui.completers` -====================== - -.. automodule:: umbra.ui.completers - -Module Attributes ------------------ - -.. attribute:: umbra.ui.completers.LOGGER - -Classes -------- - -.. autoclass:: DefaultCompleter - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.delegates.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.delegates.rst deleted file mode 100644 index 9f7ea8bd..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.ui.delegates.rst +++ /dev/null @@ -1,21 +0,0 @@ -_`umbra.ui.delegates` -===================== - -.. automodule:: umbra.ui.delegates - -Module Attributes ------------------ - -.. attribute:: umbra.ui.delegates.LOGGER - -Classes -------- - -.. autoclass:: Style - :show-inheritance: - :members: - -.. autoclass:: RichText_QStyledItemDelegate - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.highlighters.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.highlighters.rst deleted file mode 100644 index ff6cbf76..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.ui.highlighters.rst +++ /dev/null @@ -1,29 +0,0 @@ -_`umbra.ui.highlighters` -======================== - -.. automodule:: umbra.ui.highlighters - -Module Attributes ------------------ - -.. attribute:: umbra.ui.highlighters.LOGGER - -Classes -------- - -.. autoclass:: Rule - :show-inheritance: - :members: - -.. autoclass:: FormatsTree - :show-inheritance: - :members: - -.. autoclass:: AbstractHighlighter - :show-inheritance: - :members: - -.. autoclass:: DefaultHighlighter - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.inputAccelerators.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.inputAccelerators.rst deleted file mode 100644 index 26ee02fd..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.ui.inputAccelerators.rst +++ /dev/null @@ -1,29 +0,0 @@ -_`umbra.ui.inputAccelerators` -============================= - -.. automodule:: umbra.ui.inputAccelerators - -Module Attributes ------------------ - -.. attribute:: umbra.ui.inputAccelerators.LOGGER - -Functions ---------- - -.. autofunction:: getEditorCapability - -.. autofunction:: isSymbolsPairComplete - -.. autofunction:: performCompletion - -.. autofunction:: indentationPreEventInputAccelerators - -.. autofunction:: indentationPostEventInputAccelerators - -.. autofunction:: completionPreEventInputAccelerators - -.. autofunction:: completionPostEventInputAccelerators - -.. autofunction:: symbolsExpandingPreEventInputAccelerators - diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.languages.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.languages.rst deleted file mode 100644 index d1b6c18b..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.ui.languages.rst +++ /dev/null @@ -1,46 +0,0 @@ -_`umbra.ui.languages` -===================== - -.. automodule:: umbra.ui.languages - -Module Attributes ------------------ - -.. attribute:: umbra.ui.languages.LOGGER - -.. attribute:: umbra.ui.languages.PYTHON_GRAMMAR_FILE - -.. attribute:: umbra.ui.languages.LOGGING_GRAMMAR_FILE - -.. attribute:: umbra.ui.languages.TEXT_GRAMMAR_FILE - -.. attribute:: umbra.ui.languages.LANGUAGES_ACCELERATORS - -.. attribute:: umbra.ui.languages.DEFAULT_INDENT_MARKER - -.. attribute:: umbra.ui.languages.PYTHON_LANGUAGE - -.. attribute:: umbra.ui.languages.LOGGING_LANGUAGE - -.. attribute:: umbra.ui.languages.TEXT_LANGUAGE - -Functions ---------- - -.. autofunction:: getObjectFromLanguageAccelerators - -.. autofunction:: getLanguageDescription - -.. autofunction:: getPythonLanguage - -.. autofunction:: getLoggingLanguage - -.. autofunction:: getTextLanguage - -Classes -------- - -.. autoclass:: Language - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.models.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.models.rst deleted file mode 100644 index 0bd5fd55..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.ui.models.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`umbra.ui.models` -================== - -.. automodule:: umbra.ui.models - -Module Attributes ------------------ - -.. attribute:: umbra.ui.models.LOGGER - -Classes -------- - -.. autoclass:: GraphModel - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.nodes.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.nodes.rst deleted file mode 100644 index 137c8a88..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.ui.nodes.rst +++ /dev/null @@ -1,33 +0,0 @@ -_`umbra.ui.nodes` -================= - -.. automodule:: umbra.ui.nodes - -Module Attributes ------------------ - -.. attribute:: umbra.ui.nodes.LOGGER - -Classes -------- - -.. autoclass:: Mixin_GraphModelObject - :show-inheritance: - :members: - -.. autoclass:: GraphModelAttribute - :show-inheritance: - :members: - -.. autoclass:: GraphModelNode - :show-inheritance: - :members: - -.. autoclass:: DefaultNode - :show-inheritance: - :members: - -.. autoclass:: FormatNode - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.themes.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.themes.rst deleted file mode 100644 index d5285b37..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.ui.themes.rst +++ /dev/null @@ -1,21 +0,0 @@ -_`umbra.ui.themes` -================== - -.. automodule:: umbra.ui.themes - -Module Attributes ------------------ - -.. attribute:: umbra.ui.themes.LOGGER - -.. attribute:: umbra.ui.themes.DEFAULT_FORMAT - -.. attribute:: umbra.ui.themes.DEFAULT_THEME - -.. attribute:: umbra.ui.themes.LOGGING_THEME - -Functions ---------- - -.. autofunction:: getFormat - diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.views.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.views.rst deleted file mode 100644 index 04a68c45..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.ui.views.rst +++ /dev/null @@ -1,53 +0,0 @@ -_`umbra.ui.views` -================= - -.. automodule:: umbra.ui.views - -Module Attributes ------------------ - -.. attribute:: umbra.ui.views.LOGGER - -Classes -------- - -.. autoclass:: ReadOnlyFilter - :show-inheritance: - :members: - -.. autoclass:: Mixin_AbstractBase - :show-inheritance: - :members: - -.. autoclass:: Mixin_AbstractView - :show-inheritance: - :members: - -.. autoclass:: Mixin_AbstractWidget - :show-inheritance: - :members: - -.. autoclass:: Abstract_QListView - :show-inheritance: - :members: - -.. autoclass:: Abstract_QTableView - :show-inheritance: - :members: - -.. autoclass:: Abstract_QTreeView - :show-inheritance: - :members: - -.. autoclass:: Abstract_QListWidget - :show-inheritance: - :members: - -.. autoclass:: Abstract_QTableWidget - :show-inheritance: - :members: - -.. autoclass:: Abstract_QTreeWidget - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.visualAccelerators.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.visualAccelerators.rst deleted file mode 100644 index a8bc898f..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.ui.visualAccelerators.rst +++ /dev/null @@ -1,19 +0,0 @@ -_`umbra.ui.visualAccelerators` -============================== - -.. automodule:: umbra.ui.visualAccelerators - -Module Attributes ------------------ - -.. attribute:: umbra.ui.visualAccelerators.LOGGER - -Functions ---------- - -.. autofunction:: highlightCurrentLine - -.. autofunction:: highlightOccurences - -.. autofunction:: highlightMatchingSymbolsPairs - diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.active_QLabel.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.active_QLabel.rst deleted file mode 100644 index a01b5b8b..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.active_QLabel.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`umbra.ui.widgets.active_QLabel` -================================= - -.. automodule:: umbra.ui.widgets.active_QLabel - -Module Attributes ------------------ - -.. attribute:: umbra.ui.widgets.active_QLabel.LOGGER - -Classes -------- - -.. autoclass:: Active_QLabel - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.active_QLabelsCollection.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.active_QLabelsCollection.rst deleted file mode 100644 index 9a4d2131..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.active_QLabelsCollection.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`umbra.ui.widgets.active_QLabelsCollection` -============================================ - -.. automodule:: umbra.ui.widgets.active_QLabelsCollection - -Module Attributes ------------------ - -.. attribute:: umbra.ui.widgets.active_QLabelsCollection.LOGGER - -Classes -------- - -.. autoclass:: Active_QLabelsCollection - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.application_QToolBar.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.application_QToolBar.rst deleted file mode 100644 index 64aff334..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.application_QToolBar.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`umbra.ui.widgets.application_QToolBar` -======================================== - -.. automodule:: umbra.ui.widgets.application_QToolBar - -Module Attributes ------------------ - -.. attribute:: umbra.ui.widgets.application_QToolBar.LOGGER - -Classes -------- - -.. autoclass:: Application_QToolBar - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.basic_QPlainTextEdit.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.basic_QPlainTextEdit.rst deleted file mode 100644 index 338737d3..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.basic_QPlainTextEdit.rst +++ /dev/null @@ -1,26 +0,0 @@ -_`umbra.ui.widgets.basic_QPlainTextEdit` -======================================== - -.. automodule:: umbra.ui.widgets.basic_QPlainTextEdit - -Module Attributes ------------------ - -.. attribute:: umbra.ui.widgets.basic_QPlainTextEdit.LOGGER - -Functions ---------- - -.. autofunction:: editBlock - -.. autofunction:: anchorTextCursor - -.. autofunction:: centerTextCursor - -Classes -------- - -.. autoclass:: Basic_QPlainTextEdit - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.codeEditor_QPlainTextEdit.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.codeEditor_QPlainTextEdit.rst deleted file mode 100644 index 10784227..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.codeEditor_QPlainTextEdit.rst +++ /dev/null @@ -1,21 +0,0 @@ -_`umbra.ui.widgets.codeEditor_QPlainTextEdit` -============================================= - -.. automodule:: umbra.ui.widgets.codeEditor_QPlainTextEdit - -Module Attributes ------------------ - -.. attribute:: umbra.ui.widgets.codeEditor_QPlainTextEdit.LOGGER - -Classes -------- - -.. autoclass:: LinesNumbers_QWidget - :show-inheritance: - :members: - -.. autoclass:: CodeEditor_QPlainTextEdit - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.delayed_QSplashScreen.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.delayed_QSplashScreen.rst deleted file mode 100644 index 017f26f0..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.delayed_QSplashScreen.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`umbra.ui.widgets.delayed_QSplashScreen` -========================================= - -.. automodule:: umbra.ui.widgets.delayed_QSplashScreen - -Module Attributes ------------------ - -.. attribute:: umbra.ui.widgets.delayed_QSplashScreen.LOGGER - -Classes -------- - -.. autoclass:: Delayed_QSplashScreen - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.messageBox.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.messageBox.rst deleted file mode 100644 index 97291a4e..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.messageBox.rst +++ /dev/null @@ -1,15 +0,0 @@ -_`umbra.ui.widgets.messageBox` -============================== - -.. automodule:: umbra.ui.widgets.messageBox - -Module Attributes ------------------ - -.. attribute:: umbra.ui.widgets.messageBox.LOGGER - -Functions ---------- - -.. autofunction:: messageBox - diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.notification_QLabel.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.notification_QLabel.rst deleted file mode 100644 index e55d2a70..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.notification_QLabel.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`umbra.ui.widgets.notification_QLabel` -======================================= - -.. automodule:: umbra.ui.widgets.notification_QLabel - -Module Attributes ------------------ - -.. attribute:: umbra.ui.widgets.notification_QLabel.LOGGER - -Classes -------- - -.. autoclass:: Notification_QLabel - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.search_QLineEdit.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.search_QLineEdit.rst deleted file mode 100644 index 2842e9d2..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.search_QLineEdit.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`umbra.ui.widgets.search_QLineEdit` -==================================== - -.. automodule:: umbra.ui.widgets.search_QLineEdit - -Module Attributes ------------------ - -.. attribute:: umbra.ui.widgets.search_QLineEdit.LOGGER - -Classes -------- - -.. autoclass:: Search_QLineEdit - :show-inheritance: - :members: - diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.variable_QPushButton.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.variable_QPushButton.rst deleted file mode 100644 index 9ff4fea6..00000000 --- a/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.variable_QPushButton.rst +++ /dev/null @@ -1,17 +0,0 @@ -_`umbra.ui.widgets.variable_QPushButton` -======================================== - -.. automodule:: umbra.ui.widgets.variable_QPushButton - -Module Attributes ------------------ - -.. attribute:: umbra.ui.widgets.variable_QPushButton.LOGGER - -Classes -------- - -.. autoclass:: Variable_QPushButton - :show-inheritance: - :members: - diff --git a/sibl_gui/components/addons/about/about.py b/sibl_gui/components/addons/about/about.py index c8e9c32e..052911b4 100644 --- a/sibl_gui/components/addons/about/about.py +++ b/sibl_gui/components/addons/about/about.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`About` Component Interface class. + Defines the :class:`About` Component Interface class. **Others:** diff --git a/sibl_gui/components/addons/cachesOperations/cachesOperations.py b/sibl_gui/components/addons/cachesOperations/cachesOperations.py index 82e6a008..7f19d017 100644 --- a/sibl_gui/components/addons/cachesOperations/cachesOperations.py +++ b/sibl_gui/components/addons/cachesOperations/cachesOperations.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`CachesOperations` Component Interface class. + Defines the :class:`CachesOperations` Component Interface class. **Others:** diff --git a/sibl_gui/components/addons/databaseOperations/databaseOperations.py b/sibl_gui/components/addons/databaseOperations/databaseOperations.py index a767a581..f1aa67e3 100644 --- a/sibl_gui/components/addons/databaseOperations/databaseOperations.py +++ b/sibl_gui/components/addons/databaseOperations/databaseOperations.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`DatabaseOperations` Component Interface class and others helper objects. + Defines the :class:`DatabaseOperations` Component Interface class and others helper objects. **Others:** diff --git a/sibl_gui/components/addons/gpsMap/gpsMap.py b/sibl_gui/components/addons/gpsMap/gpsMap.py index 3aee571d..62cdbc9c 100644 --- a/sibl_gui/components/addons/gpsMap/gpsMap.py +++ b/sibl_gui/components/addons/gpsMap/gpsMap.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`GpsMap` Component Interface class and the :class:`Map` class. + Defines the :class:`GpsMap` Component Interface class and the :class:`Map` class. **Others:** diff --git a/sibl_gui/components/addons/gpsMap/views.py b/sibl_gui/components/addons/gpsMap/views.py index 5ed989b5..b7442b98 100644 --- a/sibl_gui/components/addons/gpsMap/views.py +++ b/sibl_gui/components/addons/gpsMap/views.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines + Defines the :class:`sibl_gui.components.core.collectionsOutliner.collectionsOutliner.CollectionsOutliner` Component Interface class Views. diff --git a/sibl_gui/components/addons/iblSetsScanner/iblSetsScanner.py b/sibl_gui/components/addons/iblSetsScanner/iblSetsScanner.py index d531effc..d12a588a 100644 --- a/sibl_gui/components/addons/iblSetsScanner/iblSetsScanner.py +++ b/sibl_gui/components/addons/iblSetsScanner/iblSetsScanner.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`IblSetsScanner` Component Interface class. + Defines the :class:`IblSetsScanner` Component Interface class. **Others:** diff --git a/sibl_gui/components/addons/iblSetsScanner/workers.py b/sibl_gui/components/addons/iblSetsScanner/workers.py index 091a6cc0..3986a8fa 100644 --- a/sibl_gui/components/addons/iblSetsScanner/workers.py +++ b/sibl_gui/components/addons/iblSetsScanner/workers.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`sibl_gui.components.addons.iblSetsScanner.iblSetsScanner.IblSetsScanner` + Defines the :class:`sibl_gui.components.addons.iblSetsScanner.iblSetsScanner.IblSetsScanner` Component Interface class Workers. **Others:** diff --git a/sibl_gui/components/addons/loaderScript/loaderScript.py b/sibl_gui/components/addons/loaderScript/loaderScript.py index 9f6c2773..78e3086b 100644 --- a/sibl_gui/components/addons/loaderScript/loaderScript.py +++ b/sibl_gui/components/addons/loaderScript/loaderScript.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`LoaderScript` Component Interface class. + Defines the :class:`LoaderScript` Component Interface class. **Others:** diff --git a/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py b/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py index 9525b01d..8f757b03 100644 --- a/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py +++ b/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`LoaderScriptOptions` Component Interface class. + Defines the :class:`LoaderScriptOptions` Component Interface class. **Others:** diff --git a/sibl_gui/components/addons/loaderScriptOptions/views.py b/sibl_gui/components/addons/loaderScriptOptions/views.py index 3cd545d9..3ff9fbf4 100644 --- a/sibl_gui/components/addons/loaderScriptOptions/views.py +++ b/sibl_gui/components/addons/loaderScriptOptions/views.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`sibl_gui.components.addons.loaderScriptOptions.loaderScriptOptions.LoaderScriptOptions` + Defines the :class:`sibl_gui.components.addons.loaderScriptOptions.loaderScriptOptions.LoaderScriptOptions` Component Interface class Views. **Others:** diff --git a/sibl_gui/components/addons/locationsBrowser/locationsBrowser.py b/sibl_gui/components/addons/locationsBrowser/locationsBrowser.py index ecdade83..2130d990 100644 --- a/sibl_gui/components/addons/locationsBrowser/locationsBrowser.py +++ b/sibl_gui/components/addons/locationsBrowser/locationsBrowser.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`LocationsBrowser` Component Interface class. + Defines the :class:`LocationsBrowser` Component Interface class. **Others:** diff --git a/sibl_gui/components/addons/loggingNotifier/loggingNotifier.py b/sibl_gui/components/addons/loggingNotifier/loggingNotifier.py index fbe63ed6..f0212ef1 100644 --- a/sibl_gui/components/addons/loggingNotifier/loggingNotifier.py +++ b/sibl_gui/components/addons/loggingNotifier/loggingNotifier.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`LoggingNotifier` Component Interface class. + Defines the :class:`LoggingNotifier` Component Interface class. **Others:** diff --git a/sibl_gui/components/addons/onlineUpdater/downloadManager.py b/sibl_gui/components/addons/onlineUpdater/downloadManager.py index 8fff30f3..d207eb75 100644 --- a/sibl_gui/components/addons/onlineUpdater/downloadManager.py +++ b/sibl_gui/components/addons/onlineUpdater/downloadManager.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`DownloadManager` class. + Defines the :class:`DownloadManager` class. **Others:** diff --git a/sibl_gui/components/addons/onlineUpdater/onlineUpdater.py b/sibl_gui/components/addons/onlineUpdater/onlineUpdater.py index f2bffd41..b3a2861f 100644 --- a/sibl_gui/components/addons/onlineUpdater/onlineUpdater.py +++ b/sibl_gui/components/addons/onlineUpdater/onlineUpdater.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`OnlineUpdater` Component Interface class and others online update related objects. + Defines the :class:`OnlineUpdater` Component Interface class and others online update related objects. **Others:** diff --git a/sibl_gui/components/addons/onlineUpdater/remoteUpdater.py b/sibl_gui/components/addons/onlineUpdater/remoteUpdater.py index 20133b05..ec9cfd2a 100644 --- a/sibl_gui/components/addons/onlineUpdater/remoteUpdater.py +++ b/sibl_gui/components/addons/onlineUpdater/remoteUpdater.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`RemoteUpdater` class and others online update related objects. + Defines the :class:`RemoteUpdater` class and others online update related objects. **Others:** diff --git a/sibl_gui/components/addons/onlineUpdater/views.py b/sibl_gui/components/addons/onlineUpdater/views.py index 1d3691ab..b96dfa57 100644 --- a/sibl_gui/components/addons/onlineUpdater/views.py +++ b/sibl_gui/components/addons/onlineUpdater/views.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`sibl_gui.components.addons.onlineUpdater.onlineUpdater.OnlineUpdater` + Defines the :class:`sibl_gui.components.addons.onlineUpdater.onlineUpdater.OnlineUpdater` Component Interface class Views. **Others:** diff --git a/sibl_gui/components/addons/preview/imagesPreviewer.py b/sibl_gui/components/addons/preview/imagesPreviewer.py index 862f870c..a9ad56e5 100644 --- a/sibl_gui/components/addons/preview/imagesPreviewer.py +++ b/sibl_gui/components/addons/preview/imagesPreviewer.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`Preview` Component Interface class, the :class:`ImagesPreviewer` class + Defines the :class:`Preview` Component Interface class, the :class:`ImagesPreviewer` class and others images preview related objects. **Others:** diff --git a/sibl_gui/components/addons/preview/preview.py b/sibl_gui/components/addons/preview/preview.py index f83f05c9..935c41a8 100644 --- a/sibl_gui/components/addons/preview/preview.py +++ b/sibl_gui/components/addons/preview/preview.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`Preview` Component Interface class, the :class:`ImagesPreviewer` class and + Defines the :class:`Preview` Component Interface class, the :class:`ImagesPreviewer` class and others images preview related objects. **Others:** diff --git a/sibl_gui/components/addons/rawEditingUtilities/rawEditingUtilities.py b/sibl_gui/components/addons/rawEditingUtilities/rawEditingUtilities.py index 0e4e00aa..0f10ecc2 100644 --- a/sibl_gui/components/addons/rawEditingUtilities/rawEditingUtilities.py +++ b/sibl_gui/components/addons/rawEditingUtilities/rawEditingUtilities.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`RawEditingUtilities` Component Interface class. + Defines the :class:`RawEditingUtilities` Component Interface class. **Others:** diff --git a/sibl_gui/components/addons/rewiringTool/rewiringTool.py b/sibl_gui/components/addons/rewiringTool/rewiringTool.py index 59a4b3bc..45d5bea2 100644 --- a/sibl_gui/components/addons/rewiringTool/rewiringTool.py +++ b/sibl_gui/components/addons/rewiringTool/rewiringTool.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`RewiringTool` Component Interface class. + Defines the :class:`RewiringTool` Component Interface class. **Others:** diff --git a/sibl_gui/components/addons/sIBLeditUtilities/sIBLeditUtilities.py b/sibl_gui/components/addons/sIBLeditUtilities/sIBLeditUtilities.py index 2fa308d3..0641818e 100644 --- a/sibl_gui/components/addons/sIBLeditUtilities/sIBLeditUtilities.py +++ b/sibl_gui/components/addons/sIBLeditUtilities/sIBLeditUtilities.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`sIBLeditUtilities` Component Interface class. + Defines the :class:`sIBLeditUtilities` Component Interface class. **Others:** diff --git a/sibl_gui/components/addons/searchDatabase/searchDatabase.py b/sibl_gui/components/addons/searchDatabase/searchDatabase.py index 9473f959..95854a75 100644 --- a/sibl_gui/components/addons/searchDatabase/searchDatabase.py +++ b/sibl_gui/components/addons/searchDatabase/searchDatabase.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`SearchDatabase` Component Interface class. + Defines the :class:`SearchDatabase` Component Interface class. **Others:** diff --git a/sibl_gui/components/addons/searchDatabase/views.py b/sibl_gui/components/addons/searchDatabase/views.py index 10a48499..d2ece303 100644 --- a/sibl_gui/components/addons/searchDatabase/views.py +++ b/sibl_gui/components/addons/searchDatabase/views.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`sibl_gui.components.addons.searchDatabase.searchDatabase.SearchDatabase` + Defines the :class:`sibl_gui.components.addons.searchDatabase.searchDatabase.SearchDatabase` Component Interface class Views. **Others:** diff --git a/sibl_gui/components/core/collectionsOutliner/collectionsOutliner.py b/sibl_gui/components/core/collectionsOutliner/collectionsOutliner.py index 56d3042d..6a24cf03 100644 --- a/sibl_gui/components/core/collectionsOutliner/collectionsOutliner.py +++ b/sibl_gui/components/core/collectionsOutliner/collectionsOutliner.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`CollectionsOutliner` Component Interface class. + Defines the :class:`CollectionsOutliner` Component Interface class. **Others:** diff --git a/sibl_gui/components/core/collectionsOutliner/models.py b/sibl_gui/components/core/collectionsOutliner/models.py index 21e08a11..8c4d97cd 100644 --- a/sibl_gui/components/core/collectionsOutliner/models.py +++ b/sibl_gui/components/core/collectionsOutliner/models.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`sibl_gui.components.core.collectionsOutliner.collectionsOutliner.CollectionsOutliner` + Defines the :class:`sibl_gui.components.core.collectionsOutliner.collectionsOutliner.CollectionsOutliner` Component Interface class Models. **Others:** diff --git a/sibl_gui/components/core/collectionsOutliner/nodes.py b/sibl_gui/components/core/collectionsOutliner/nodes.py index 2497837b..6dbbf149 100644 --- a/sibl_gui/components/core/collectionsOutliner/nodes.py +++ b/sibl_gui/components/core/collectionsOutliner/nodes.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`sibl_gui.components.core.collectionsOutliner.collectionsOutliner.CollectionsOutliner` + Defines the :class:`sibl_gui.components.core.collectionsOutliner.collectionsOutliner.CollectionsOutliner` Component Interface class nodes. **Others:** diff --git a/sibl_gui/components/core/collectionsOutliner/views.py b/sibl_gui/components/core/collectionsOutliner/views.py index d12b8de7..52468f75 100644 --- a/sibl_gui/components/core/collectionsOutliner/views.py +++ b/sibl_gui/components/core/collectionsOutliner/views.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`sibl_gui.components.core.collectionsOutliner.collectionsOutliner.CollectionsOutliner` + Defines the :class:`sibl_gui.components.core.collectionsOutliner.collectionsOutliner.CollectionsOutliner` Component Interface class Views. **Others:** diff --git a/sibl_gui/components/core/database/database.py b/sibl_gui/components/core/database/database.py index 6cf454c6..dab7327e 100644 --- a/sibl_gui/components/core/database/database.py +++ b/sibl_gui/components/core/database/database.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`Database` Component Interface class. + Defines the :class:`Database` Component Interface class. **Others:** diff --git a/sibl_gui/components/core/database/exceptions.py b/sibl_gui/components/core/database/exceptions.py index b4895147..d3eb6d9e 100644 --- a/sibl_gui/components/core/database/exceptions.py +++ b/sibl_gui/components/core/database/exceptions.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines **database** component exceptions. + Defines **database** component exceptions. **Others:** diff --git a/sibl_gui/components/core/database/nodes.py b/sibl_gui/components/core/database/nodes.py index 6ecc89a9..0e33bbf2 100644 --- a/sibl_gui/components/core/database/nodes.py +++ b/sibl_gui/components/core/database/nodes.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines Application nodes classes related to Database objects. + Defines Application nodes classes related to Database objects. **Others:** diff --git a/sibl_gui/components/core/database/operations.py b/sibl_gui/components/core/database/operations.py index ee9b64f3..2488d16a 100644 --- a/sibl_gui/components/core/database/operations.py +++ b/sibl_gui/components/core/database/operations.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines Application Database operations objects. + Defines Application Database operations objects. **Others:** diff --git a/sibl_gui/components/core/database/types.py b/sibl_gui/components/core/database/types.py index 4e9c4bb4..b6a29f2a 100644 --- a/sibl_gui/components/core/database/types.py +++ b/sibl_gui/components/core/database/types.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines Application Database types: :class:`IblSet`, :class:`Template` + Defines Application Database types: :class:`IblSet`, :class:`Template` and :class:`Collection` classes. **Others:** diff --git a/sibl_gui/components/core/iblSetsOutliner/iblSetsOutliner.py b/sibl_gui/components/core/iblSetsOutliner/iblSetsOutliner.py index 11ecc132..1e6118e2 100644 --- a/sibl_gui/components/core/iblSetsOutliner/iblSetsOutliner.py +++ b/sibl_gui/components/core/iblSetsOutliner/iblSetsOutliner.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`IblSetsOutliner` Component Interface class. + Defines the :class:`IblSetsOutliner` Component Interface class. **Others:** diff --git a/sibl_gui/components/core/iblSetsOutliner/models.py b/sibl_gui/components/core/iblSetsOutliner/models.py index 7b4ead1c..02c0cdcc 100644 --- a/sibl_gui/components/core/iblSetsOutliner/models.py +++ b/sibl_gui/components/core/iblSetsOutliner/models.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner.IblSetsOutliner` + Defines the :class:`sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner.IblSetsOutliner` Component Interface class Models. **Others:** diff --git a/sibl_gui/components/core/iblSetsOutliner/views.py b/sibl_gui/components/core/iblSetsOutliner/views.py index df7e4663..6349b9ed 100644 --- a/sibl_gui/components/core/iblSetsOutliner/views.py +++ b/sibl_gui/components/core/iblSetsOutliner/views.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner.IblSetsOutliner` + Defines the :class:`sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner.IblSetsOutliner` Component Interface class Views. **Others:** diff --git a/sibl_gui/components/core/inspector/inspector.py b/sibl_gui/components/core/inspector/inspector.py index 6d1d9850..4e61bcd7 100644 --- a/sibl_gui/components/core/inspector/inspector.py +++ b/sibl_gui/components/core/inspector/inspector.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`Inspector` Component Interface class and others helpers objects. + Defines the :class:`Inspector` Component Interface class and others helpers objects. **Others:** diff --git a/sibl_gui/components/core/inspector/models.py b/sibl_gui/components/core/inspector/models.py index 96540bad..0f3ec734 100644 --- a/sibl_gui/components/core/inspector/models.py +++ b/sibl_gui/components/core/inspector/models.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`sibl_gui.components.core.inspector.inspector.Inspector` + Defines the :class:`sibl_gui.components.core.inspector.inspector.Inspector` Component Interface class Models. **Others:** diff --git a/sibl_gui/components/core/inspector/nodes.py b/sibl_gui/components/core/inspector/nodes.py index 2cd54ad1..bf0aded4 100644 --- a/sibl_gui/components/core/inspector/nodes.py +++ b/sibl_gui/components/core/inspector/nodes.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`sibl_gui.components.core.inspector.inspector.Inspector` + Defines the :class:`sibl_gui.components.core.inspector.inspector.Inspector` Component Interface class nodes. **Others:** diff --git a/sibl_gui/components/core/inspector/views.py b/sibl_gui/components/core/inspector/views.py index 149237b0..4d12a7bf 100644 --- a/sibl_gui/components/core/inspector/views.py +++ b/sibl_gui/components/core/inspector/views.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`sibl_gui.components.core.inspector.inspector.Inspector` + Defines the :class:`sibl_gui.components.core.inspector.inspector.Inspector` Component Interface class Views. **Others:** diff --git a/sibl_gui/components/core/templatesOutliner/models.py b/sibl_gui/components/core/templatesOutliner/models.py index 1e51b1f3..bdf3d933 100644 --- a/sibl_gui/components/core/templatesOutliner/models.py +++ b/sibl_gui/components/core/templatesOutliner/models.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`sibl_gui.components.core.templatesOutliner.templatesOutliner.TemplatesOutliner` + Defines the :class:`sibl_gui.components.core.templatesOutliner.templatesOutliner.TemplatesOutliner` Component Interface class Models. **Others:** diff --git a/sibl_gui/components/core/templatesOutliner/nodes.py b/sibl_gui/components/core/templatesOutliner/nodes.py index cedefda1..db59493b 100644 --- a/sibl_gui/components/core/templatesOutliner/nodes.py +++ b/sibl_gui/components/core/templatesOutliner/nodes.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`sibl_gui.components.core.templatesOutliner.templatesOutliner.TemplatesOutliner` + Defines the :class:`sibl_gui.components.core.templatesOutliner.templatesOutliner.TemplatesOutliner` Component Interface class nodes. **Others:** diff --git a/sibl_gui/components/core/templatesOutliner/templatesOutliner.py b/sibl_gui/components/core/templatesOutliner/templatesOutliner.py index d00fca1f..3bf1e666 100644 --- a/sibl_gui/components/core/templatesOutliner/templatesOutliner.py +++ b/sibl_gui/components/core/templatesOutliner/templatesOutliner.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`TemplatesOutliner` Component Interface class. + Defines the :class:`TemplatesOutliner` Component Interface class. **Others:** diff --git a/sibl_gui/components/core/templatesOutliner/views.py b/sibl_gui/components/core/templatesOutliner/views.py index d2f20bd4..642ef922 100644 --- a/sibl_gui/components/core/templatesOutliner/views.py +++ b/sibl_gui/components/core/templatesOutliner/views.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`sibl_gui.components.core.templatesOutliner.templatesOutliner.TemplatesOutliner` + Defines the :class:`sibl_gui.components.core.templatesOutliner.templatesOutliner.TemplatesOutliner` Component Interface class Views. **Others:** diff --git a/sibl_gui/exceptions.py b/sibl_gui/exceptions.py index cd8d7bed..e4b39d62 100644 --- a/sibl_gui/exceptions.py +++ b/sibl_gui/exceptions.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines **sIBL_GUI** package exceptions. + Defines **sIBL_GUI** package exceptions. **Others:** diff --git a/sibl_gui/globals/constants.py b/sibl_gui/globals/constants.py index 144f1548..c061ed78 100644 --- a/sibl_gui/globals/constants.py +++ b/sibl_gui/globals/constants.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines **sIBL_GUI** package default constants through the :class:`Constants` class. + Defines **sIBL_GUI** package default constants through the :class:`Constants` class. **Others:** diff --git a/sibl_gui/globals/runtimeGlobals.py b/sibl_gui/globals/runtimeGlobals.py index 6a73266e..20861686 100644 --- a/sibl_gui/globals/runtimeGlobals.py +++ b/sibl_gui/globals/runtimeGlobals.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines **sIBL_GUI** package runtime globals through the :class:`RuntimeGlobals` class. + Defines **sIBL_GUI** package runtime globals through the :class:`RuntimeGlobals` class. **Others:** diff --git a/sibl_gui/globals/uiConstants.py b/sibl_gui/globals/uiConstants.py index 513c7a05..d3c3ffcb 100644 --- a/sibl_gui/globals/uiConstants.py +++ b/sibl_gui/globals/uiConstants.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines **sIBL_GUI** package ui constants through the :class:`UiConstants` class. + Defines **sIBL_GUI** package ui constants through the :class:`UiConstants` class. **Others:** diff --git a/sibl_gui/launcher.py b/sibl_gui/launcher.py index b5f9df5e..0cd205ca 100644 --- a/sibl_gui/launcher.py +++ b/sibl_gui/launcher.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - | This module defines various classes, methods and definitions to run, maintain and exit the Application. + | Defines various classes, methods and definitions to run, maintain and exit the Application. | The main Application object is the :class:`sIBL_GUI` class. **Others:** diff --git a/sibl_gui/libraries/freeImage/freeImage.py b/sibl_gui/libraries/freeImage/freeImage.py index ca7c4b64..a56db61a 100644 --- a/sibl_gui/libraries/freeImage/freeImage.py +++ b/sibl_gui/libraries/freeImage/freeImage.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module provides FreeImage library ( http://freeimage.sourceforge.net/ ) bindings. + Provides FreeImage library ( http://freeimage.sourceforge.net/ ) bindings. **Others:** Portions of the code from FreeImagePy by diff --git a/sibl_gui/resources/patches/001_migrate_3-x-x_to_4-0-0.py b/sibl_gui/resources/patches/001_migrate_3-x-x_to_4-0-0.py index eb022831..6bf45a83 100644 --- a/sibl_gui/resources/patches/001_migrate_3-x-x_to_4-0-0.py +++ b/sibl_gui/resources/patches/001_migrate_3-x-x_to_4-0-0.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module migrates sIBL_GUI from 3.x.x to 4.0.0. + Migrates sIBL_GUI from 3.x.x to 4.0.0. **Others:** diff --git a/sibl_gui/resources/patches/002_migrate_4-x-x_to_4-0-2.py b/sibl_gui/resources/patches/002_migrate_4-x-x_to_4-0-2.py index a3e5e7f7..57f278dd 100644 --- a/sibl_gui/resources/patches/002_migrate_4-x-x_to_4-0-2.py +++ b/sibl_gui/resources/patches/002_migrate_4-x-x_to_4-0-2.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module migrates sIBL_GUI from 4.x.x to 4.0.2. + Migrates sIBL_GUI from 4.x.x to 4.0.2. **Others:** diff --git a/sibl_gui/resources/patches/003_migrate_4-x-x_to_4-0-3.py b/sibl_gui/resources/patches/003_migrate_4-x-x_to_4-0-3.py index 0c223cb0..ceeb2d12 100644 --- a/sibl_gui/resources/patches/003_migrate_4-x-x_to_4-0-3.py +++ b/sibl_gui/resources/patches/003_migrate_4-x-x_to_4-0-3.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module migrates sIBL_GUI from 4.x.x to 4.0.3. + Migrates sIBL_GUI from 4.x.x to 4.0.3. **Others:** diff --git a/sibl_gui/resources/patches/004_migrate_4-x-x_to_4-0-7.py b/sibl_gui/resources/patches/004_migrate_4-x-x_to_4-0-7.py index bcd5bcff..2cd1e196 100644 --- a/sibl_gui/resources/patches/004_migrate_4-x-x_to_4-0-7.py +++ b/sibl_gui/resources/patches/004_migrate_4-x-x_to_4-0-7.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module migrates sIBL_GUI from 4.x.x to 4.0.7. + Migrates sIBL_GUI from 4.x.x to 4.0.7. **Others:** diff --git a/sibl_gui/tests/tests.py b/sibl_gui/tests/tests.py index da559086..2716efcd 100644 --- a/sibl_gui/tests/tests.py +++ b/sibl_gui/tests/tests.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module runs the tests suite. + Runs the tests suite. **Others:** diff --git a/sibl_gui/tests/testsInternational.py b/sibl_gui/tests/testsInternational.py index f1f0ea83..03753fba 100644 --- a/sibl_gui/tests/testsInternational.py +++ b/sibl_gui/tests/testsInternational.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module runs the international tests suite. + Runs the international tests suite. **Others:** diff --git a/sibl_gui/tests/testsSibl_gui/testsExceptions.py b/sibl_gui/tests/testsSibl_gui/testsExceptions.py index 75de44a1..4f3ca47c 100644 --- a/sibl_gui/tests/testsSibl_gui/testsExceptions.py +++ b/sibl_gui/tests/testsSibl_gui/testsExceptions.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines units tests for :mod:`sibl_gui.exceptions` module. + Defines units tests for :mod:`sibl_gui.exceptions` module. **Others:** diff --git a/sibl_gui/tests/testsSibl_gui/testsGlobals/testsConstants.py b/sibl_gui/tests/testsSibl_gui/testsGlobals/testsConstants.py index ee022bd3..37961ddb 100644 --- a/sibl_gui/tests/testsSibl_gui/testsGlobals/testsConstants.py +++ b/sibl_gui/tests/testsSibl_gui/testsGlobals/testsConstants.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines units tests for :mod:`sibl_gui.globals.constants` module. + Defines units tests for :mod:`sibl_gui.globals.constants` module. **Others:** diff --git a/sibl_gui/tests/testsSibl_gui/testsGlobals/testsRuntimeGlobals.py b/sibl_gui/tests/testsSibl_gui/testsGlobals/testsRuntimeGlobals.py index 774d5ab7..47f0b57b 100644 --- a/sibl_gui/tests/testsSibl_gui/testsGlobals/testsRuntimeGlobals.py +++ b/sibl_gui/tests/testsSibl_gui/testsGlobals/testsRuntimeGlobals.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines units tests for :mod:`sibl_gui.globals.runtimeGlobals` module. + Defines units tests for :mod:`sibl_gui.globals.runtimeGlobals` module. **Others:** diff --git a/sibl_gui/tests/testsSibl_gui/testsGlobals/testsUiConstants.py b/sibl_gui/tests/testsSibl_gui/testsGlobals/testsUiConstants.py index 20b9e523..65518ade 100644 --- a/sibl_gui/tests/testsSibl_gui/testsGlobals/testsUiConstants.py +++ b/sibl_gui/tests/testsSibl_gui/testsGlobals/testsUiConstants.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines units tests for :mod:`sibl_gui.globals.uiConstants` module. + Defines units tests for :mod:`sibl_gui.globals.uiConstants` module. **Others:** diff --git a/sibl_gui/tests/utilities.py b/sibl_gui/tests/utilities.py index 454ab1cb..fedfdd42 100644 --- a/sibl_gui/tests/utilities.py +++ b/sibl_gui/tests/utilities.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines tests suite logging configuration. + Defines tests suite logging configuration. **Others:** diff --git a/sibl_gui/ui/caches.py b/sibl_gui/ui/caches.py index 1588bccf..20a6d85a 100644 --- a/sibl_gui/ui/caches.py +++ b/sibl_gui/ui/caches.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the Application caches classes. + Defines the Application caches classes. **Others:** diff --git a/sibl_gui/ui/common.py b/sibl_gui/ui/common.py index 4ce9417a..28a0e632 100644 --- a/sibl_gui/ui/common.py +++ b/sibl_gui/ui/common.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines common ui manipulation related objects. + Defines common ui manipulation related objects. **Others:** diff --git a/sibl_gui/ui/models.py b/sibl_gui/ui/models.py index 34454803..2282cee1 100644 --- a/sibl_gui/ui/models.py +++ b/sibl_gui/ui/models.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the Application models classes. + Defines the Application models classes. **Others:** diff --git a/sibl_gui/ui/nodes.py b/sibl_gui/ui/nodes.py index 5771ceef..233cfda1 100644 --- a/sibl_gui/ui/nodes.py +++ b/sibl_gui/ui/nodes.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the Application nodes classes. + Defines the Application nodes classes. **Others:** diff --git a/sibl_gui/ui/views.py b/sibl_gui/ui/views.py index 833ff232..a19383e1 100644 --- a/sibl_gui/ui/views.py +++ b/sibl_gui/ui/views.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the Application views classes. + Defines the Application views classes. **Others:** diff --git a/sibl_gui/ui/widgets/application_QToolBar.py b/sibl_gui/ui/widgets/application_QToolBar.py index faba1a44..78c186f6 100644 --- a/sibl_gui/ui/widgets/application_QToolBar.py +++ b/sibl_gui/ui/widgets/application_QToolBar.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the :class:`Application_QToolBar` class. + Defines the :class:`Application_QToolBar` class. **Others:** diff --git a/sibl_gui/ui/workers.py b/sibl_gui/ui/workers.py index 6448556b..38ecdb67 100644 --- a/sibl_gui/ui/workers.py +++ b/sibl_gui/ui/workers.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - This module defines the Application workers classes. + Defines the Application workers classes. **Others:** diff --git a/utilities/darwinSetup.py b/utilities/darwinSetup.py index 6d087960..c2e27f7c 100755 --- a/utilities/darwinSetup.py +++ b/utilities/darwinSetup.py @@ -8,7 +8,7 @@ Mac Os X. **Description:** - This module defines the py2app configuration file. + Defines the py2app configuration file. **Others:** diff --git a/utilities/windowsSetup.py b/utilities/windowsSetup.py index 2df28e72..a184e88c 100644 --- a/utilities/windowsSetup.py +++ b/utilities/windowsSetup.py @@ -8,7 +8,7 @@ Windows. **Description:** - This module defines the pyinstaller configuration file. + Defines the pyinstaller configuration file. **Others:** From fc7ca2731921cb8f7c46cd9cc3f5780c443d09e0 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Sat, 8 Mar 2014 18:57:42 +0100 Subject: [PATCH 20/54] Update various docstrings. --- sibl_gui/ui/caches.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sibl_gui/ui/caches.py b/sibl_gui/ui/caches.py index 20a6d85a..270322a7 100644 --- a/sibl_gui/ui/caches.py +++ b/sibl_gui/ui/caches.py @@ -165,7 +165,7 @@ def __setitem__(self, key, value): :param key: Key. :type key: unicode - :param value: Item. + :param value: Value. :type value: object """ From fdaf7c8234c29435dfb2dbc9b97252a0a5081ab9 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Thu, 13 Mar 2014 06:58:41 +0100 Subject: [PATCH 21/54] Update various docstrings. --- sibl_gui/components/addons/about/about.py | 22 ++--- sibl_gui/components/addons/gpsMap/gpsMap.py | 2 +- .../addons/loaderScript/loaderScript.py | 4 +- .../locationsBrowser/locationsBrowser.py | 10 +- .../addons/onlineUpdater/onlineUpdater.py | 2 +- sibl_gui/components/addons/preview/preview.py | 4 +- .../rawEditingUtilities.py | 8 +- .../sIBLeditUtilities/sIBLeditUtilities.py | 4 +- .../addons/searchDatabase/searchDatabase.py | 4 +- .../collectionsOutliner.py | 6 +- sibl_gui/components/core/database/nodes.py | 34 +++---- .../core/iblSetsOutliner/iblSetsOutliner.py | 12 +-- .../components/core/inspector/inspector.py | 62 ++++++------ sibl_gui/components/core/inspector/nodes.py | 2 +- .../templatesOutliner/templatesOutliner.py | 98 +++++++++---------- utilities/darwinBuild.sh | 2 +- utilities/getDocumentation.sh | 2 +- utilities/getSphinxDocumentationApi.py | 2 +- utilities/windowsBuild.sh | 2 +- 19 files changed, 141 insertions(+), 141 deletions(-) diff --git a/sibl_gui/components/addons/about/about.py b/sibl_gui/components/addons/about/about.py index 052911b4..ebf97aaf 100644 --- a/sibl_gui/components/addons/about/about.py +++ b/sibl_gui/components/addons/about/about.py @@ -119,7 +119,7 @@ #********************************************************************************************************************** class About(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): """ - | This class is the :mod:`sibl_gui.components.addons.about.about` Component Interface class. + | Defines the :mod:`sibl_gui.components.addons.about.about` Component Interface class. | It adds the **About sIBL_GUI ...** miscellaneous menu action and provides associated **sIBL_GUI - About** window. | The message displayed by the **sIBL_GUI - About** window is defined by the :attr:`sibl_gui.components.addons.about.about.ABOUT_MESSAGE` attribute. @@ -127,7 +127,7 @@ class About(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): def __init__(self, parent=None, name=None, *args, **kwargs): """ - This method initializes the class. + Initializes the class. :param parent: Object parent. :type parent: QObject @@ -331,7 +331,7 @@ def miscellaneousMenu(self): #****************************************************************************************************************** def activate(self, engine): """ - This method activates the Component. + Activates the Component. :param engine: Engine to attach the Component to. :type engine: QObject @@ -352,7 +352,7 @@ def activate(self, engine): def deactivate(self): """ - This method deactivates the Component. + Deactivates the Component. :return: Method success. :rtype: bool @@ -371,7 +371,7 @@ def deactivate(self): def initializeUi(self): """ - This method initializes the Component ui. + Initializes the Component ui. :return: Method success. :rtype: bool @@ -384,7 +384,7 @@ def initializeUi(self): def uninitializeUi(self): """ - This method uninitializes the Component ui. + Uninitializes the Component ui. :return: Method success. :rtype: bool @@ -397,7 +397,7 @@ def uninitializeUi(self): def addWidget(self): """ - This method adds the Component Widget to the engine. + Adds the Component Widget to the engine. :return: Method success. :rtype: bool @@ -409,7 +409,7 @@ def addWidget(self): def removeWidget(self): """ - This method removes the Component Widget from the engine. + Removes the Component Widget from the engine. :return: Method success. :rtype: bool @@ -421,7 +421,7 @@ def removeWidget(self): def __addActions(self): """ - This method sets Component actions. + Sets Component actions. """ LOGGER.debug("> Adding '{0}' Component actions.".format(self.__class__.__name__)) @@ -432,7 +432,7 @@ def __addActions(self): def __removeActions(self): """ - This method removes actions. + Removes actions. """ LOGGER.debug("> Removing '{0}' Component actions.".format(self.__class__.__name__)) @@ -443,7 +443,7 @@ def __removeActions(self): def __miscellaneousMenu_aboutAction__triggered(self, checked): """ - This method is triggered by **'Actions|Umbra|ToolBar|Miscellaneous|About {0} ...'** action. + Defines the slot triggered by **'Actions|Umbra|ToolBar|Miscellaneous|About {0} ...'** action. :param checked: Action checked state. :type checked: bool diff --git a/sibl_gui/components/addons/gpsMap/gpsMap.py b/sibl_gui/components/addons/gpsMap/gpsMap.py index 62cdbc9c..7b2c6b52 100644 --- a/sibl_gui/components/addons/gpsMap/gpsMap.py +++ b/sibl_gui/components/addons/gpsMap/gpsMap.py @@ -645,7 +645,7 @@ def setMarkersUi(self): :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ selectedIblSets = self.__iblSetsOutliner.getSelectedIblSets() diff --git a/sibl_gui/components/addons/loaderScript/loaderScript.py b/sibl_gui/components/addons/loaderScript/loaderScript.py index 78e3086b..6537c074 100644 --- a/sibl_gui/components/addons/loaderScript/loaderScript.py +++ b/sibl_gui/components/addons/loaderScript/loaderScript.py @@ -768,7 +768,7 @@ def outputLoaderScriptUi(self): :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ LOGGER.debug("> Initializing Loader Script output.") @@ -820,7 +820,7 @@ def sendLoaderScriptToSoftwareUi(self): :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ if not self.outputLoaderScriptUi(): diff --git a/sibl_gui/components/addons/locationsBrowser/locationsBrowser.py b/sibl_gui/components/addons/locationsBrowser/locationsBrowser.py index 2130d990..e62c386e 100644 --- a/sibl_gui/components/addons/locationsBrowser/locationsBrowser.py +++ b/sibl_gui/components/addons/locationsBrowser/locationsBrowser.py @@ -772,7 +772,7 @@ def openIblSetsLocationsUi(self): :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ selectedIblSets = self.__iblSetsOutliner.getSelectedIblSets() @@ -802,7 +802,7 @@ def openActiveIblSetLocationsUi(self): :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ activeIblSet = self.__inspector.activeIblSet @@ -825,7 +825,7 @@ def openComponentsLocationsUi(self): :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ selectedComponents = self.__componentsManagerUi.getSelectedComponents() @@ -854,7 +854,7 @@ def openTemplatesLocationsUi(self): :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ selectedTemplates = self.__templatesOutliner.getSelectedTemplates() @@ -885,7 +885,7 @@ def openOutputDirectoryUi(self): :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ directory = self.__engine.parameters.loaderScriptsOutputDirectory and \ diff --git a/sibl_gui/components/addons/onlineUpdater/onlineUpdater.py b/sibl_gui/components/addons/onlineUpdater/onlineUpdater.py index b3a2861f..432a87ab 100644 --- a/sibl_gui/components/addons/onlineUpdater/onlineUpdater.py +++ b/sibl_gui/components/addons/onlineUpdater/onlineUpdater.py @@ -865,7 +865,7 @@ def checkForNewReleasesUi(self): :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ if not self.__networkAccessManager.networkAccessible(): diff --git a/sibl_gui/components/addons/preview/preview.py b/sibl_gui/components/addons/preview/preview.py index 935c41a8..5af3fb4a 100644 --- a/sibl_gui/components/addons/preview/preview.py +++ b/sibl_gui/components/addons/preview/preview.py @@ -863,7 +863,7 @@ def viewIblSetsImagesUi(self, imageType, *args): :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ selectedIblSets = self.__iblSetsOutliner.getSelectedIblSets() @@ -901,7 +901,7 @@ def viewActiveIblSetImagesUi(self, imageType, *args): :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ activeIblSet = self.__inspector.activeIblSet diff --git a/sibl_gui/components/addons/rawEditingUtilities/rawEditingUtilities.py b/sibl_gui/components/addons/rawEditingUtilities/rawEditingUtilities.py index 0f10ecc2..3b405a92 100644 --- a/sibl_gui/components/addons/rawEditingUtilities/rawEditingUtilities.py +++ b/sibl_gui/components/addons/rawEditingUtilities/rawEditingUtilities.py @@ -745,7 +745,7 @@ def editIblSetsFilesUi(self): :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ selectedIblSets = self.__iblSetsOutliner.getSelectedIblSets() @@ -774,7 +774,7 @@ def editActiveIblSetFileUi(self): :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ activeIblSet = self.__inspector.activeIblSet @@ -796,7 +796,7 @@ def editTemplatesFilesUi(self): :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ selectedTemplates = self.__templatesOutliner.getSelectedTemplates() @@ -824,7 +824,7 @@ def editComponentsUi(self): :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ selectedComponents = self.__componentsManagerUi.getSelectedComponents() diff --git a/sibl_gui/components/addons/sIBLeditUtilities/sIBLeditUtilities.py b/sibl_gui/components/addons/sIBLeditUtilities/sIBLeditUtilities.py index 0641818e..7e0df09d 100644 --- a/sibl_gui/components/addons/sIBLeditUtilities/sIBLeditUtilities.py +++ b/sibl_gui/components/addons/sIBLeditUtilities/sIBLeditUtilities.py @@ -527,7 +527,7 @@ def editIblSetInSIBLEditUi(self): :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ sIBLedit = foundations.strings.toString(self.sIBLedit_Path_lineEdit.text()) @@ -556,7 +556,7 @@ def editActiveIblSetInSIBLEditUi(self): :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ sIBLedit = foundations.strings.toString(self.sIBLedit_Path_lineEdit.text()) diff --git a/sibl_gui/components/addons/searchDatabase/searchDatabase.py b/sibl_gui/components/addons/searchDatabase/searchDatabase.py index 95854a75..9cd980ff 100644 --- a/sibl_gui/components/addons/searchDatabase/searchDatabase.py +++ b/sibl_gui/components/addons/searchDatabase/searchDatabase.py @@ -561,7 +561,7 @@ def setTagsCloudMatchingIblsSetsUi(self): :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ return self.setTagsCloudMatchingIblsSets(foundations.strings.toString(self.Search_Database_lineEdit.text()), @@ -575,7 +575,7 @@ def setTimeMatchingIblSetsUi(self): :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ return self.setTimeMatchingIblSets(self.Time_Low_timeEdit.time(), self.Time_High_timeEdit.time()) diff --git a/sibl_gui/components/core/collectionsOutliner/collectionsOutliner.py b/sibl_gui/components/core/collectionsOutliner/collectionsOutliner.py index 6a24cf03..b1664feb 100644 --- a/sibl_gui/components/core/collectionsOutliner/collectionsOutliner.py +++ b/sibl_gui/components/core/collectionsOutliner/collectionsOutliner.py @@ -936,7 +936,7 @@ def addContentUi(self): :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ collection = self.addCollectionUi() @@ -967,7 +967,7 @@ def addCollectionUi(self): :return: Collection name. :rtype: unicode - :note: This method may require user interaction. + :note: May require user interaction. """ collectionInformations, state = QInputDialog.getText(self, "Add Collection", "Enter your Collection name:") @@ -1010,7 +1010,7 @@ def removeCollectionsUi(self): :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ selectedNodes = self.getSelectedNodes().keys() diff --git a/sibl_gui/components/core/database/nodes.py b/sibl_gui/components/core/database/nodes.py index 0e33bbf2..f4066aec 100644 --- a/sibl_gui/components/core/database/nodes.py +++ b/sibl_gui/components/core/database/nodes.py @@ -412,7 +412,7 @@ def iconPath(self): #****************************************************************************************************************** def __initializeNode(self): """ - This method initializes the node. + Initializes the node. """ self.roles.update({Qt.DisplayRole : self.databaseItem.title, @@ -422,7 +422,7 @@ def __initializeNode(self): def updateNode(self): """ - This method updates the node from the database item. + Updates the node from the database item. :return: Method success. :rtype: bool @@ -433,7 +433,7 @@ def updateNode(self): def updateNodeAttributes(self): """ - This method updates the node attributes from the database item attributes. + Updates the node attributes from the database item attributes. :return: Method success. :rtype: bool @@ -443,7 +443,7 @@ def updateNodeAttributes(self): def updateDatabaseItem(self): """ - This method updates the database item from the node. + Updates the database item from the node. :return: Method success. :rtype: bool @@ -454,7 +454,7 @@ def updateDatabaseItem(self): def updateToolTip(self): """ - This method updates the node tooltip. + Updates the node tooltip. :return: Method success. :rtype: bool @@ -470,7 +470,7 @@ def updateToolTip(self): class TemplateNode(AbstractDatabaseNode): """ - This class defines Templates nodes. + Defines Templates nodes. """ __family = "Template" @@ -541,7 +541,7 @@ def __init__(self, #****************************************************************************************************************** def __initializeNode(self): """ - This method initializes the node. + Initializes the node. """ templateUserName = getTemplateUserName(self.databaseItem.title, self.databaseItem.software) @@ -551,7 +551,7 @@ def __initializeNode(self): def updateNode(self): """ - This method updates the node from the database item. + Updates the node from the database item. :return: Method success. :rtype: bool @@ -564,7 +564,7 @@ def updateNode(self): def updateNodeAttributes(self): """ - This method updates the node attributes from the database item attributes. + Updates the node attributes from the database item attributes. :return: Method success. :rtype: bool @@ -574,7 +574,7 @@ def updateNodeAttributes(self): def updateDatabaseItem(self): """ - This method updates the database item from the node. + Updates the database item from the node. :return: Method success. :rtype: bool @@ -585,7 +585,7 @@ def updateDatabaseItem(self): def updateToolTip(self): """ - This method updates the node tooltip. + Updates the node tooltip. :return: Method success. :rtype: bool @@ -600,7 +600,7 @@ def updateToolTip(self): class CollectionNode(AbstractDatabaseNode): """ - This class defines Collections nodes. + Defines Collections nodes. """ __family = "Collection" @@ -669,7 +669,7 @@ def __init__(self, #****************************************************************************************************************** def __initializeNode(self): """ - This method initializes the node. + Initializes the node. """ self["count"] = sibl_gui.ui.nodes.GraphModelAttribute( @@ -682,7 +682,7 @@ def __initializeNode(self): def updateNode(self): """ - This method updates the node from the database item. + Updates the node from the database item. :return: Method success. :rtype: bool @@ -693,7 +693,7 @@ def updateNode(self): def updateNodeAttributes(self): """ - This method updates the node attributes from the database item attributes. + Updates the node attributes from the database item attributes. :return: Method success. :rtype: bool @@ -706,7 +706,7 @@ def updateNodeAttributes(self): def updateDatabaseItem(self): """ - This method updates the database item from the node. + Updates the database item from the node. :return: Method success. :rtype: bool @@ -717,7 +717,7 @@ def updateDatabaseItem(self): def updateToolTip(self): """ - This method updates the node tooltip. + Updates the node tooltip. :return: Method success. :rtype: bool diff --git a/sibl_gui/components/core/iblSetsOutliner/iblSetsOutliner.py b/sibl_gui/components/core/iblSetsOutliner/iblSetsOutliner.py index 1e6118e2..1ff2d15a 100644 --- a/sibl_gui/components/core/iblSetsOutliner/iblSetsOutliner.py +++ b/sibl_gui/components/core/iblSetsOutliner/iblSetsOutliner.py @@ -1736,7 +1736,7 @@ def __engine__contentDropped(self, event): def __engine_fileSystemEventsManager__fileChanged(self, file): """ - Defines the slot triggered by **fileSystemEventsManager** when a file is changed. + Defines the slot triggered by the **fileSystemEventsManager** when a file is changed. :param file: File changed. :type file: unicode @@ -1901,7 +1901,7 @@ def addContentUi(self): :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ directory = umbra.ui.common.storeLastBrowsedPath((QFileDialog.getExistingDirectory(self, @@ -1926,7 +1926,7 @@ def addIblSetUi(self): :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ path = umbra.ui.common.storeLastBrowsedPath((QFileDialog.getOpenFileName(self, @@ -1956,7 +1956,7 @@ def removeIblSetsUi(self): :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ selectedIblSets = self.getSelectedIblSets() @@ -1992,7 +1992,7 @@ def updateIblSetLocationUi(self, iblSet): :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ file = umbra.ui.common.storeLastBrowsedPath((QFileDialog.getOpenFileName(self, @@ -2020,7 +2020,7 @@ def updateSelectedIblSetsLocationUi(self): :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ selectedIblSets = self.getSelectedIblSets() diff --git a/sibl_gui/components/core/inspector/inspector.py b/sibl_gui/components/core/inspector/inspector.py index 4e61bcd7..5687b10d 100644 --- a/sibl_gui/components/core/inspector/inspector.py +++ b/sibl_gui/components/core/inspector/inspector.py @@ -1040,7 +1040,7 @@ def unnamedLightName(self): #****************************************************************************************************************** def activate(self, engine): """ - This method activates the Component. + Activates the Component. :param engine: Engine to attach the Component to. :type engine: QObject @@ -1064,7 +1064,7 @@ def activate(self, engine): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def deactivate(self): """ - This method deactivates the Component. + Deactivates the Component. """ raise foundations.exceptions.ProgrammingError( @@ -1072,7 +1072,7 @@ def deactivate(self): def initializeUi(self): """ - This method initializes the Component ui. + Initializes the Component ui. :return: Method success. :rtype: bool @@ -1131,7 +1131,7 @@ def initializeUi(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uninitializeUi(self): """ - This method uninitializes the Component ui. + Uninitializes the Component ui. """ raise foundations.exceptions.ProgrammingError( @@ -1139,7 +1139,7 @@ def uninitializeUi(self): def addWidget(self): """ - This method adds the Component Widget to the engine. + Adds the Component Widget to the engine. :return: Method success. :rtype: bool @@ -1154,7 +1154,7 @@ def addWidget(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def removeWidget(self): """ - This method removes the Component Widget from the engine. + Removes the Component Widget from the engine. """ raise foundations.exceptions.ProgrammingError( @@ -1162,7 +1162,7 @@ def removeWidget(self): def __Inspector_DockWidget_setUi(self): """ - This method sets the :mod:`sibl_gui.components.core.inspector.inspector` Component Widget ui. + Sets the :mod:`sibl_gui.components.core.inspector.inspector` Component Widget ui. """ if self.__activeIblSet: @@ -1205,14 +1205,14 @@ def __Inspector_DockWidget_setUi(self): def __Inspector_DockWidget_refreshUi(self): """ - This method sets the :mod:`sibl_gui.components.core.inspector.inspector` Component Widget ui. + Sets the :mod:`sibl_gui.components.core.inspector.inspector` Component Widget ui. """ self.__Inspector_DockWidget_setUi() def __Inspector_DockWidget_clearUi(self): """ - This method clears the :mod:`sibl_gui.components.core.inspector.inspector` Component Widget ui. + Clears the :mod:`sibl_gui.components.core.inspector.inspector` Component Widget ui. """ self.Title_label.setText(QString()) @@ -1224,21 +1224,21 @@ def __Inspector_DockWidget_clearUi(self): def __Inspector_Overall_frame_addActions(self): """ - This method sets the **Inspector_Overall_frame** actions. + Sets the **Inspector_Overall_frame** actions. """ pass def __model__refreshNodes(self): """ - This method refreshes the **Plates_listView** Model nodes. + Refreshes the **Plates_listView** Model nodes. """ self.setPlates() def __view_selectionModel__selectionChanged(self, selectedItems, deselectedItems): """ - This method is triggered when **Plates_listView** Model selection has changed. + Defines the slot triggered by **Plates_listView** when Model selection has changed. :param selectedItems: Selected items. :type selectedItems: QItemSelection @@ -1258,7 +1258,7 @@ def __view_selectionModel__selectionChanged(self, selectedItems, deselectedItems def __engine_fileSystemEventsManager__fileChanged(self, file): """ - This method is triggered by the **fileSystemEventsManager** when a file is changed. + Defines the slot triggered by the **fileSystemEventsManager** when a file is changed. :param file: File changed. :type file: unicode @@ -1278,7 +1278,7 @@ def __engine_fileSystemEventsManager__fileChanged(self, file): def __engine_imagesCaches_QPixmap__contentAdded(self, paths): """ - This method is triggered by the **QPixmap** images cache when contend is added. + Defines the slot triggered by the **QPixmap** images cache when content is added. :param paths: Added content. :type paths: list @@ -1293,16 +1293,16 @@ def __engine_imagesCaches_QPixmap__contentAdded(self, paths): def __iblSetsOutliner__modelReset(self): """ - This method is triggered when :mod:`sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner` - Component Model has changed. + Defines the slot triggered by :mod:`sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner` + Component Model when changed. """ self.__setActiveIblSet() def __iblSetsOutliner_view_selectionModel__selectionChanged(self, selectedItems, deselectedItems): """ - This method is triggered when :mod:`sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner` - Component Model selection has changed. + Defines the slot triggered by :mod:`sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner` + Component Model selection when changed. :param selectedItems: Selected items. :type selectedItems: QItemSelection @@ -1322,7 +1322,7 @@ def __iblSetsOutliner_view_selectionModel__selectionChanged(self, selectedItems, def __Previous_Ibl_Set_pushButton__clicked(self, checked): """ - This method is triggered when **Previous_Ibl_Set_pushButton** Widget is clicked. + Defines the slot triggered by **Previous_Ibl_Set_pushButton** Widget when clicked. :param checked: Checked state. :type checked: bool @@ -1332,7 +1332,7 @@ def __Previous_Ibl_Set_pushButton__clicked(self, checked): def __Next_Ibl_Set_pushButton__clicked(self, checked): """ - This method is triggered when **Next_Ibl_Set_pushButton** Widget is clicked. + Defines the slot triggered by **Next_Ibl_Set_pushButton** Widget when clicked. :param checked: Checked state. :type checked: bool @@ -1342,7 +1342,7 @@ def __Next_Ibl_Set_pushButton__clicked(self, checked): def __Previous_Plate_pushButton__clicked(self, checked): """ - This method is triggered when **Previous_Plate_pushButton** Widget is clicked. + Defines the slot triggered by **Previous_Plate_pushButton** Widget when clicked. :param checked: Checked state. :type checked: bool @@ -1352,7 +1352,7 @@ def __Previous_Plate_pushButton__clicked(self, checked): def __Next_Plate_pushButton__clicked(self, checked): """ - This method is triggered when **Next_Plate_pushButton** Widget is clicked. + Defines the slot triggered by **Next_Plate_pushButton** Widget when clicked. :param checked: Checked state. :type checked: bool @@ -1362,7 +1362,7 @@ def __Next_Plate_pushButton__clicked(self, checked): def __Image_label__linkActivated(self, url): """ - This method is triggered when a link is clicked in the **Image_label** Widget. + Defines the slot triggered by **Image_label** Widget when a link is clicked. :param url: Url to explore. :type url: QString @@ -1372,7 +1372,7 @@ def __Image_label__linkActivated(self, url): def __setActiveIblSet(self): """ - This method sets the :mod:`sibl_gui.components.core.inspector.inspector` Component Ibl Set. + Sets the :mod:`sibl_gui.components.core.inspector.inspector` Component Ibl Set. """ selectedIblSets = self.__iblSetsOutliner.getSelectedIblSets() @@ -1384,7 +1384,7 @@ def __setActiveIblSet(self): def __setActiveIblSetParser(self): """ - This method sets the :mod:`sibl_gui.components.core.inspector.inspector` Component Ibl Set parser. + Sets the :mod:`sibl_gui.components.core.inspector.inspector` Component Ibl Set parser. """ if foundations.common.pathExists(self.__activeIblSet.path): @@ -1398,7 +1398,7 @@ def __setActiveIblSetParser(self): @foundations.exceptions.handleExceptions(foundations.exceptions.FileExistsError) def __setActiveIblSetPlates(self): """ - This method sets the Plates from the :mod:`sibl_gui.components.core.inspector.inspector` Component Ibl Set. + Sets the Plates from the :mod:`sibl_gui.components.core.inspector.inspector` Component Ibl Set. """ path = self.__activeIblSet.path @@ -1423,7 +1423,7 @@ def __setActiveIblSetPlates(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ExecutionError) def __drawActiveIblSetOverlay(self): """ - This method draws an overlay on :obj:`Inspector.Image_Label` Widget. + Draws an overlay on :obj:`Inspector.Image_Label` Widget. """ painter = QPainter(self.Image_label.pixmap()) @@ -1453,7 +1453,7 @@ def __drawActiveIblSetOverlay(self): def __drawLightLabel(self, painter, light): """ - This method draws a light label on given QPainter. + Draws a light label on given QPainter. :param painter: QPainter. :type painter: QPainter @@ -1500,7 +1500,7 @@ def __drawLightLabel(self, painter, light): def setPlates(self): """ - This method sets the Plates Model nodes. + Sets the Plates Model nodes. :return: Method success. :rtype: bool @@ -1534,7 +1534,7 @@ def setPlates(self): def loopThroughIblSets(self, backward=False): """ - This method loops through :mod:`sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner` Component Ibl Sets. + Loops through :mod:`sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner` Component Ibl Sets. :param backward: Looping backward. :type backward: bool @@ -1568,7 +1568,7 @@ def loopThroughIblSets(self, backward=False): def loopThroughPlates(self, backward=False): """ - This method loops through :mod:`sibl_gui.components.core.inspector.inspector` Component Ibl Set Plates. + Loops through :mod:`sibl_gui.components.core.inspector.inspector` Component Ibl Set Plates. :param backward: Looping backward. :type backward: bool diff --git a/sibl_gui/components/core/inspector/nodes.py b/sibl_gui/components/core/inspector/nodes.py index bf0aded4..9603c5dd 100644 --- a/sibl_gui/components/core/inspector/nodes.py +++ b/sibl_gui/components/core/inspector/nodes.py @@ -191,7 +191,7 @@ def toolTipText(self): #****************************************************************************************************************** def __initializeNode(self, attributesFlags=int(Qt.ItemIsSelectable | Qt.ItemIsEnabled)): """ - This method initializes the node. + Initializes the node. :param attributesFlags: Attributes flags. :type attributesFlags: int diff --git a/sibl_gui/components/core/templatesOutliner/templatesOutliner.py b/sibl_gui/components/core/templatesOutliner/templatesOutliner.py index 3bf1e666..37501743 100644 --- a/sibl_gui/components/core/templatesOutliner/templatesOutliner.py +++ b/sibl_gui/components/core/templatesOutliner/templatesOutliner.py @@ -861,7 +861,7 @@ def templatesInformationsText(self): #****************************************************************************************************************** def activate(self, engine): """ - This method activates the Component. + Activates the Component. :param engine: Engine to attach the Component to. :type engine: QObject @@ -892,7 +892,7 @@ def activate(self, engine): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def deactivate(self): """ - This method deactivates the Component. + Deactivates the Component. """ raise foundations.exceptions.ProgrammingError( @@ -900,7 +900,7 @@ def deactivate(self): def initializeUi(self): """ - This method initializes the Component ui. + Initializes the Component ui. :return: Method success. :rtype: bool @@ -949,7 +949,7 @@ def initializeUi(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def uninitializeUi(self): """ - This method uninitializes the Component ui. + Uninitializes the Component ui. """ raise foundations.exceptions.ProgrammingError( @@ -957,7 +957,7 @@ def uninitializeUi(self): def addWidget(self): """ - This method adds the Component Widget to the engine. + Adds the Component Widget to the engine. :return: Method success. :rtype: bool @@ -972,7 +972,7 @@ def addWidget(self): @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def removeWidget(self): """ - This method removes the Component Widget from the engine. + Removes the Component Widget from the engine. """ raise foundations.exceptions.ProgrammingError( @@ -980,7 +980,7 @@ def removeWidget(self): def onStartup(self): """ - This method is triggered on Framework startup. + Defines the slot triggered by Framework startup. :return: Method success. :rtype: bool @@ -1059,7 +1059,7 @@ def onStartup(self): def onClose(self): """ - This method is triggered on Framework close. + Defines the slot triggered by Framework close. :return: Method success. :rtype: bool @@ -1084,14 +1084,14 @@ def onClose(self): def __model__refreshNodes(self): """ - This method is triggered when the Model nodes need refresh. + Defines the slot triggered by the Model when nodes need refresh. """ self.setTemplates() def __view_addActions(self): """ - This method sets the View actions. + Sets the View actions. """ if not self.__engine.parameters.databaseReadOnly: @@ -1130,7 +1130,7 @@ def __view_addActions(self): def __view_addTemplateAction__triggered(self, checked): """ - This method is triggered by **'Actions|Umbra|Components|core.templatesOutliner|Add Template ...'** action. + Defines the slot triggered by \*\*'Actions|Umbra|Components|core.templatesOutliner|Add Template ...'** action. :param checked: Action checked state. :type checked: bool @@ -1142,7 +1142,7 @@ def __view_addTemplateAction__triggered(self, checked): def __view_removeTemplatesAction__triggered(self, checked): """ - This method is triggered by **'Actions|Umbra|Components|core.templatesOutliner|Remove Template(s) ...'** action. + Defines the slot triggered by \*\*'Actions|Umbra|Components|core.templatesOutliner|Remove Template(s) ...'** action. :param checked: Action checked state. :type checked: bool @@ -1154,7 +1154,7 @@ def __view_removeTemplatesAction__triggered(self, checked): def __view_importDefaultTemplatesAction__triggered(self, checked): """ - This method is triggered by **'Actions|Umbra|Components|core.templatesOutliner|Import Default Templates'** action. + Defines the slot triggered by \*\*'Actions|Umbra|Components|core.templatesOutliner|Import Default Templates'** action. :param checked: Action checked state. :type checked: bool @@ -1166,7 +1166,7 @@ def __view_importDefaultTemplatesAction__triggered(self, checked): def __view_displayHelpFilesAction__triggered(self, checked): """ - This method is triggered by **'Actions|Umbra|Components|core.templatesOutliner|Display Help File(s) ...'** action. + Defines the slot triggered by \*\*'Actions|Umbra|Components|core.templatesOutliner|Display Help File(s) ...'** action. :param checked: Action checked state. :type checked: bool @@ -1178,7 +1178,7 @@ def __view_displayHelpFilesAction__triggered(self, checked): def __view_filterTemplatesVersionsAction__triggered(self, checked): """ - This method is triggered by **'Actions|Umbra|Components|core.templatesOutliner|Filter Templates Versions'** action. + Defines the slot triggered by \*\*'Actions|Umbra|Components|core.templatesOutliner|Filter Templates Versions'** action. :param checked: Action checked state. :type checked: bool @@ -1190,7 +1190,7 @@ def __view_filterTemplatesVersionsAction__triggered(self, checked): def __view_selectionModel__selectionChanged(self, selectedItems, deselectedItems): """ - This method sets the **Template_Informations_textEdit** Widget. + Sets the **Template_Informations_textEdit** Widget. :param selectedItems: Selected items. :type selectedItems: QItemSelection @@ -1226,7 +1226,7 @@ def __view_selectionModel__selectionChanged(self, selectedItems, deselectedItems @umbra.engine.showProcessing("Retrieving Templates ...") def __engine__contentDropped(self, event): """ - This method is triggered when content is dropped into the engine. + Defines the slot triggered when content is dropped into the engine. :param event: Event. :type event: QEvent @@ -1272,7 +1272,7 @@ def __engine__contentDropped(self, event): def __engine_fileSystemEventsManager__fileChanged(self, file): """ - This method is triggered by the **fileSystemEventsManager** when a file is changed. + Defines the slot triggered by the **fileSystemEventsManager** when a file is changed. :param file: File changed. :type file: unicode @@ -1290,7 +1290,7 @@ def __engine_fileSystemEventsManager__fileChanged(self, file): def __Template_Informations_textBrowser__anchorClicked(self, url): """ - This method is triggered when a link is clicked in the **Template_Informations_textBrowser** Widget. + Defines the slot triggered by **Template_Informations_textBrowser** Widget when a link is clicked. :param url: Url to explore. :type url: QUrl @@ -1300,7 +1300,7 @@ def __Template_Informations_textBrowser__anchorClicked(self, url): def __getCandidateCollectionId(self, path=None): """ - This method returns a Collection id. + Returns a Collection id. :param path: Template path. :type path: unicode @@ -1322,12 +1322,12 @@ def __getCandidateCollectionId(self, path=None): @umbra.engine.showProcessing("Adding Template ...") def addTemplateUi(self): """ - This method adds an user defined Template to the Database. + Adds an user defined Template to the Database. :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ path = umbra.ui.common.storeLastBrowsedPath((QFileDialog.getOpenFileName(self, @@ -1352,12 +1352,12 @@ def addTemplateUi(self): @umbra.engine.encapsulateProcessing def removeTemplatesUi(self): """ - This method removes user selected Templates from the Database. + Removes user selected Templates from the Database. :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ selectedNodes = self.getSelectedNodes() @@ -1401,14 +1401,14 @@ def removeTemplatesUi(self): sibl_gui.components.core.database.exceptions.DatabaseOperationError) def updateTemplateLocationUi(self, template): """ - This method updates given Template location. + Updates given Template location. :param template: Template to update. :type template: Template :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ file = umbra.ui.common.storeLastBrowsedPath((QFileDialog.getOpenFileName(self, @@ -1431,12 +1431,12 @@ def updateTemplateLocationUi(self, template): @umbra.engine.showProcessing("Importing Default Templates ...") def importDefaultTemplatesUi(self): """ - This method imports default Templates into the Database. + Imports default Templates into the Database. :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ if self.addDefaultTemplates(forceImport=True): @@ -1449,7 +1449,7 @@ def importDefaultTemplatesUi(self): @umbra.engine.encapsulateProcessing def displayHelpFilesUi(self): """ - This method displays user selected Templates help files. + Displays user selected Templates help files. :return: Method success. :rtype: bool @@ -1475,12 +1475,12 @@ def displayHelpFilesUi(self): @umbra.engine.encapsulateProcessing def filterTemplatesVersionsUi(self): """ - This method filters Templates by versions. + Filters Templates by versions. :return: Method success. :rtype: bool - :note: This method may require user interaction. + :note: May require user interaction. """ templates = sibl_gui.components.core.database.operations.getTemplates() @@ -1508,7 +1508,7 @@ def filterTemplatesVersionsUi(self): sibl_gui.components.core.database.exceptions.DatabaseOperationError) def addTemplate(self, name, path, collectionId=None): """ - This method adds a Template to the Database. + Adds a Template to the Database. :param name: Template set name. :type name: unicode @@ -1537,7 +1537,7 @@ def addTemplate(self, name, path, collectionId=None): @umbra.engine.encapsulateProcessing def addDirectory(self, directory, collectionId=None): """ - This method adds given directory Templates to the Database. + Adds given directory Templates to the Database. :param directory: Templates directory. :type directory: unicode @@ -1574,7 +1574,7 @@ def addDirectory(self, directory, collectionId=None): @foundations.exceptions.handleExceptions(umbra.exceptions.notifyExceptionHandler, Exception) def addDefaultTemplates(self, forceImport=False): """ - This method adds default Templates Collections / Templates to the Database. + Adds default Templates Collections / Templates to the Database. :param forceImport: Force Templates import. :type forceImport: bool @@ -1609,7 +1609,7 @@ def addDefaultTemplates(self, forceImport=False): @foundations.exceptions.handleExceptions(sibl_gui.components.core.database.exceptions.DatabaseOperationError) def removeTemplate(self, template): """ - This method removes given Template from the Database. + Removes given Template from the Database. :param templates: Template to remove. :type templates: list @@ -1628,7 +1628,7 @@ def removeTemplate(self, template): def templateExists(self, path): """ - This method returns if given Template path exists in the Database. + Returns if given Template path exists in the Database. :param name: Template path. :type name: unicode @@ -1641,7 +1641,7 @@ def templateExists(self, path): @foundations.exceptions.handleExceptions(foundations.exceptions.FileExistsError) def displayHelpFile(self, template): """ - This method displays given Templates help file. + Displays given Templates help file. :param template: Template to display help file. :type template: Template @@ -1663,7 +1663,7 @@ def displayHelpFile(self, template): def getCollections(self): """ - This method returns Database Templates Collections. + Returns Database Templates Collections. :return: Database Templates Collections. :rtype: list @@ -1673,7 +1673,7 @@ def getCollections(self): def filterCollections(self, pattern, attribute, flags=re.IGNORECASE): """ - This method filters the Database Templates Collections on given attribute using given pattern. + Filters the Database Templates Collections on given attribute using given pattern. :param pattern: Filter pattern. :type pattern: unicode @@ -1696,7 +1696,7 @@ def filterCollections(self, pattern, attribute, flags=re.IGNORECASE): def getTemplates(self): """ - This method returns Database Templates. + Returns Database Templates. :return: Database Templates. :rtype: list @@ -1706,7 +1706,7 @@ def getTemplates(self): def filterTemplates(self, pattern, attribute, flags=re.IGNORECASE): """ - This method filters the Database Templates on given attribute using given pattern. + Filters the Database Templates on given attribute using given pattern. :param pattern: Filter pattern. :type pattern: unicode @@ -1730,7 +1730,7 @@ def filterTemplates(self, pattern, attribute, flags=re.IGNORECASE): def listTemplates(self): """ - This method lists Database Templates names. + Lists Database Templates names. :return: Database Templates names. :rtype: list @@ -1740,7 +1740,7 @@ def listTemplates(self): def setTemplates(self): """ - This method sets the Templates Model nodes. + Sets the Templates Model nodes. """ nodeFlags = attributesFlags = int(Qt.ItemIsSelectable | Qt.ItemIsEnabled | Qt.ItemIsDragEnabled) @@ -1801,7 +1801,7 @@ def setTemplates(self): def getTemplateByName(self, name): """ - This method returns Database Template with given name. + Returns Database Template with given name. :param name: Template name. :type name: unicode @@ -1816,7 +1816,7 @@ def getTemplateByName(self, name): def getCollectionByName(self, name): """ - This method gets Templates Collection from given Collection name. + Returns Templates Collection from given Collection name. :param collection: Collection name. :type collection: unicode @@ -1829,7 +1829,7 @@ def getCollectionByName(self, name): def getCollectionId(self, collection): """ - This method returns given Collection id. + Returns given Collection id. :param collection: Collection to get the id from. :type collection: unicode @@ -1843,7 +1843,7 @@ def getCollectionId(self, collection): def getSelectedNodes(self): """ - This method returns the View selected nodes. + Returns the View selected nodes. :return: View selected nodes. :rtype: dict @@ -1853,7 +1853,7 @@ def getSelectedNodes(self): def getSelectedTemplatesNodes(self): """ - This method returns the View selected Templates nodes. + Returns the View selected Templates nodes. :return: View selected Templates nodes. :rtype: list @@ -1863,7 +1863,7 @@ def getSelectedTemplatesNodes(self): def getSelectedTemplates(self): """ - This method gets the View selected Templates. + Returns the View selected Templates. :return: View selected Templates. :rtype: list diff --git a/utilities/darwinBuild.sh b/utilities/darwinBuild.sh index cb50f62b..0b68ff96 100755 --- a/utilities/darwinBuild.sh +++ b/utilities/darwinBuild.sh @@ -1,4 +1,4 @@ -#/usr/bin/bash +#!/usr/bin/env bash echo ------------------------------------------------------------------------------- echo sIBL_GUI - Mac Os X - Overall Build echo ------------------------------------------------------------------------------- diff --git a/utilities/getDocumentation.sh b/utilities/getDocumentation.sh index 29a89890..3a52b61c 100755 --- a/utilities/getDocumentation.sh +++ b/utilities/getDocumentation.sh @@ -1,4 +1,4 @@ -#/usr/bin/bash +#!/usr/bin/env bash echo ------------------------------------------------------------------------------- echo sIBL_GUI - Documentation Build echo ------------------------------------------------------------------------------- diff --git a/utilities/getSphinxDocumentationApi.py b/utilities/getSphinxDocumentationApi.py index 8f99ad1a..a7940b89 100755 --- a/utilities/getSphinxDocumentationApi.py +++ b/utilities/getSphinxDocumentationApi.py @@ -93,7 +93,7 @@ DECORATORS_COMMENT_MESSAGE = "#***\tSphinx: Decorator commented for auto-documentation purpose." CONTENT_SUBSTITUTIONS = {"^_initializeApplication\(\)$" : "{0}".format(STATEMENTS_UPDATE_MESSAGGE), - "This method initializes the class.\n" : + "Initializes the class.\n" : ".. Sphinx: Statements updated for auto-documentation purpose.\n", "PYTHON_LANGUAGE \= getPythonLanguage\(\)" : "{0}\n{1}".format(STATEMENTS_UPDATE_MESSAGGE, "PYTHON_LANGUAGE = None"), diff --git a/utilities/windowsBuild.sh b/utilities/windowsBuild.sh index 6be8ef89..817e502f 100755 --- a/utilities/windowsBuild.sh +++ b/utilities/windowsBuild.sh @@ -1,4 +1,4 @@ -#/usr/bin/bash +#!/usr/bin/env bash echo ------------------------------------------------------------------------------- echo sIBL_GUI - Windows - Overall Build echo ------------------------------------------------------------------------------- From 372d5869efa26d3b7f1373c01afe1a23af719721 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Sat, 15 Mar 2014 21:01:39 +0100 Subject: [PATCH 22/54] Change copyrights dates in "docs.sphinx.source.conf" module. --- docs/sphinx/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index cb3a7789..48b318a1 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -48,7 +48,7 @@ # General information about the project. project = u"sIBL_GUI" -copyright = u"2011 - 2014, Thomas Mansencal" +copyright = u"2008 - 2014, Thomas Mansencal" # The version info for the project you"re documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the From 7b79091f40f9060075002c20ce1fd1dffea80cb3 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Tue, 18 Mar 2014 07:48:43 +0100 Subject: [PATCH 23/54] Update documentation / help files. --- docs/help/sIBL_GUI_Manual.html | 83 +- docs/sphinx/source/conf.py | 7 +- docs/sphinx/source/resources/css/basic.css | 524 ------------- docs/sphinx/source/resources/css/default.css | 282 ------- docs/sphinx/source/resources/css/pygments.css | 62 -- docs/sphinx/source/resources/pages/api.rst | 158 +++- .../resources/pages/api/foundations.cache.rst | 17 + .../pages/api/foundations.common.rst | 41 + .../resources/pages/api/foundations.core.rst | 17 + .../pages/api/foundations.dataStructures.rst | 29 + .../pages/api/foundations.decorators.rst | 19 + .../pages/api/foundations.environment.rst | 24 + .../pages/api/foundations.exceptions.rst | 144 ++++ .../api/foundations.globals.constants.rst | 12 + .../resources/pages/api/foundations.io.rst | 26 + .../pages/api/foundations.library.rst | 21 + .../pages/api/foundations.namespace.rst | 25 + .../resources/pages/api/foundations.nodes.rst | 25 + .../pages/api/foundations.parsers.rst | 30 + .../resources/pages/api/foundations.pkzip.rst | 17 + .../pages/api/foundations.rotatingBackup.rst | 17 + .../resources/pages/api/foundations.shell.rst | 21 + .../pages/api/foundations.strings.rst | 49 ++ .../pages/api/foundations.tcpServer.rst | 21 + .../resources/pages/api/foundations.trace.rst | 95 +++ .../pages/api/foundations.ui.common.rst | 21 + .../pages/api/foundations.verbose.rst | 54 ++ .../pages/api/foundations.walkers.rst | 21 + .../resources/pages/api/manager.component.rst | 17 + .../pages/api/manager.componentsManager.rst | 25 + .../pages/api/manager.exceptions.rst | 48 ++ .../pages/api/manager.globals.constants.rst | 12 + .../pages/api/manager.qobjectComponent.rst | 17 + .../pages/api/manager.qwidgetComponent.rst | 15 + .../resources/pages/api/oncilla.buildApi.rst | 29 + .../pages/api/oncilla.buildTocTree.rst | 25 + .../pages/api/oncilla.defaultSanitizer.rst | 19 + .../pages/api/oncilla.globals.constants.rst | 12 + .../api/oncilla.reStructuredTextToHtml.rst | 27 + .../api/oncilla.sliceReStructuredText.rst | 27 + ...sibl_gui.components.addons.about.about.rst | 21 + ...dons.cachesOperations.cachesOperations.rst | 19 + ....databaseOperations.databaseOperations.rst | 23 + ...bl_gui.components.addons.gpsMap.gpsMap.rst | 19 + ...ibl_gui.components.addons.gpsMap.views.rst | 17 + ...s.addons.iblSetsScanner.iblSetsScanner.rst | 17 + ...mponents.addons.iblSetsScanner.workers.rst | 17 + ...nents.addons.loaderScript.loaderScript.rst | 19 + ...oaderScriptOptions.loaderScriptOptions.rst | 19 + ...nents.addons.loaderScriptOptions.views.rst | 17 + ...dons.locationsBrowser.locationsBrowser.rst | 19 + ...addons.loggingNotifier.loggingNotifier.rst | 17 + ...s.addons.onlineUpdater.downloadManager.rst | 19 + ...nts.addons.onlineUpdater.onlineUpdater.rst | 21 + ...nts.addons.onlineUpdater.remoteUpdater.rst | 23 + ....components.addons.onlineUpdater.views.rst | 17 + ...ponents.addons.preview.imagesPreviewer.rst | 23 + ..._gui.components.addons.preview.preview.rst | 19 + ...awEditingUtilities.rawEditingUtilities.rst | 19 + ...nents.addons.rewiringTool.rewiringTool.rst | 19 + ...ns.sIBLeditUtilities.sIBLeditUtilities.rst | 19 + ...s.addons.searchDatabase.searchDatabase.rst | 19 + ...components.addons.searchDatabase.views.rst | 17 + ...ollectionsOutliner.collectionsOutliner.rst | 19 + ...onents.core.collectionsOutliner.models.rst | 17 + ...ponents.core.collectionsOutliner.nodes.rst | 17 + ...ponents.core.collectionsOutliner.views.rst | 17 + ..._gui.components.core.database.database.rst | 17 + ...ui.components.core.database.exceptions.rst | 56 ++ ...ibl_gui.components.core.database.nodes.rst | 34 + ...ui.components.core.database.operations.rst | 99 +++ ...ibl_gui.components.core.database.types.rst | 27 + ...s.core.iblSetsOutliner.iblSetsOutliner.rst | 19 + ...components.core.iblSetsOutliner.models.rst | 17 + ....components.core.iblSetsOutliner.views.rst | 21 + ...ui.components.core.inspector.inspector.rst | 27 + ...l_gui.components.core.inspector.models.rst | 17 + ...bl_gui.components.core.inspector.nodes.rst | 17 + ...bl_gui.components.core.inspector.views.rst | 17 + ...mponents.core.templatesOutliner.models.rst | 17 + ...omponents.core.templatesOutliner.nodes.rst | 17 + ...re.templatesOutliner.templatesOutliner.rst | 19 + ...omponents.core.templatesOutliner.views.rst | 17 + .../pages/api/sibl_gui.exceptions.rst | 36 + .../pages/api/sibl_gui.globals.constants.rst | 12 + .../api/sibl_gui.globals.runtimeGlobals.rst | 12 + .../api/sibl_gui.globals.uiConstants.rst | 12 + .../resources/pages/api/sibl_gui.launcher.rst | 24 + ...sibl_gui.libraries.freeImage.freeImage.rst | 740 ++++++++++++++++++ .../pages/api/sibl_gui.ui.caches.rst | 25 + .../pages/api/sibl_gui.ui.common.rst | 37 + .../pages/api/sibl_gui.ui.models.rst | 17 + .../resources/pages/api/sibl_gui.ui.nodes.rst | 25 + .../resources/pages/api/sibl_gui.ui.views.rst | 25 + ...bl_gui.ui.widgets.application_QToolBar.rst | 17 + .../pages/api/sibl_gui.ui.workers.rst | 17 + ...ponents.addons.projectsExplorer.models.rst | 17 + ...dons.projectsExplorer.projectsExplorer.rst | 19 + ...mponents.addons.projectsExplorer.views.rst | 17 + ...ponents.addons.tcpClientUi.tcpClientUi.rst | 19 + ...ponents.addons.tcpServerUi.tcpServerUi.rst | 23 + ...umbra.components.addons.traceUi.models.rst | 17 + .../umbra.components.addons.traceUi.nodes.rst | 17 + ...mbra.components.addons.traceUi.traceUi.rst | 19 + .../umbra.components.addons.traceUi.views.rst | 17 + ...omponentsManagerUi.componentsManagerUi.rst | 19 + ...nts.factory.componentsManagerUi.models.rst | 17 + ...ents.factory.componentsManagerUi.nodes.rst | 21 + ...ents.factory.componentsManagerUi.views.rst | 17 + ....preferencesManager.preferencesManager.rst | 19 + ...components.factory.scriptEditor.editor.rst | 17 + ...ents.factory.scriptEditor.editorStatus.rst | 19 + ...components.factory.scriptEditor.models.rst | 29 + ....components.factory.scriptEditor.nodes.rst | 45 ++ ...ents.factory.scriptEditor.scriptEditor.rst | 19 + ....factory.scriptEditor.searchAndReplace.rst | 23 + ...nts.factory.scriptEditor.searchInFiles.rst | 19 + ....components.factory.scriptEditor.views.rst | 21 + ...omponents.factory.scriptEditor.workers.rst | 29 + .../resources/pages/api/umbra.engine.rst | 38 + .../resources/pages/api/umbra.exceptions.rst | 89 +++ .../pages/api/umbra.globals.constants.rst | 12 + .../api/umbra.globals.runtimeGlobals.rst | 12 + .../pages/api/umbra.globals.uiConstants.rst | 12 + .../resources/pages/api/umbra.guerilla.rst | 12 + .../resources/pages/api/umbra.launcher.rst | 10 + .../api/umbra.managers.actionsManager.rst | 17 + ...umbra.managers.fileSystemEventsManager.rst | 17 + .../api/umbra.managers.layoutsManager.rst | 21 + .../umbra.managers.notificationsManager.rst | 21 + .../api/umbra.managers.patchesManager.rst | 21 + .../resources/pages/api/umbra.preferences.rst | 17 + .../resources/pages/api/umbra.processing.rst | 19 + .../resources/pages/api/umbra.reporter.rst | 36 + .../resources/pages/api/umbra.ui.common.rst | 44 ++ .../pages/api/umbra.ui.completers.rst | 17 + .../pages/api/umbra.ui.delegates.rst | 21 + .../pages/api/umbra.ui.highlighters.rst | 29 + .../pages/api/umbra.ui.inputAccelerators.rst | 29 + .../pages/api/umbra.ui.languages.rst | 46 ++ .../resources/pages/api/umbra.ui.models.rst | 17 + .../resources/pages/api/umbra.ui.nodes.rst | 33 + .../resources/pages/api/umbra.ui.themes.rst | 21 + .../resources/pages/api/umbra.ui.views.rst | 53 ++ .../pages/api/umbra.ui.visualAccelerators.rst | 19 + .../api/umbra.ui.widgets.active_QLabel.rst | 17 + ...ra.ui.widgets.active_QLabelsCollection.rst | 17 + .../umbra.ui.widgets.application_QToolBar.rst | 17 + .../umbra.ui.widgets.basic_QPlainTextEdit.rst | 26 + ...a.ui.widgets.codeEditor_QPlainTextEdit.rst | 21 + ...umbra.ui.widgets.delayed_QSplashScreen.rst | 17 + .../pages/api/umbra.ui.widgets.messageBox.rst | 15 + .../umbra.ui.widgets.notification_QLabel.rst | 17 + .../api/umbra.ui.widgets.search_QLineEdit.rst | 17 + .../umbra.ui.widgets.variable_QPushButton.rst | 17 + utilities/css/style.css | 78 -- utilities/getSphinxDocumentationApi.py | 261 ------ utilities/getSphinxDocumentationTocTree.py | 133 ---- utilities/libraries/__init__.py | 0 utilities/libraries/python/__init__.py | 0 utilities/libraries/python/pyclbr.py | 360 --------- utilities/reStructuredTextToHtml.py | 92 --- utilities/sanitizer.py | 107 +++ utilities/sliceDocumentation.py | 128 --- utilities/tidy/tidySettings.rc | 10 - 165 files changed, 4608 insertions(+), 1985 deletions(-) delete mode 100644 docs/sphinx/source/resources/css/basic.css delete mode 100644 docs/sphinx/source/resources/css/default.css delete mode 100644 docs/sphinx/source/resources/css/pygments.css create mode 100644 docs/sphinx/source/resources/pages/api/foundations.cache.rst create mode 100644 docs/sphinx/source/resources/pages/api/foundations.common.rst create mode 100644 docs/sphinx/source/resources/pages/api/foundations.core.rst create mode 100644 docs/sphinx/source/resources/pages/api/foundations.dataStructures.rst create mode 100644 docs/sphinx/source/resources/pages/api/foundations.decorators.rst create mode 100644 docs/sphinx/source/resources/pages/api/foundations.environment.rst create mode 100644 docs/sphinx/source/resources/pages/api/foundations.exceptions.rst create mode 100644 docs/sphinx/source/resources/pages/api/foundations.globals.constants.rst create mode 100644 docs/sphinx/source/resources/pages/api/foundations.io.rst create mode 100644 docs/sphinx/source/resources/pages/api/foundations.library.rst create mode 100644 docs/sphinx/source/resources/pages/api/foundations.namespace.rst create mode 100644 docs/sphinx/source/resources/pages/api/foundations.nodes.rst create mode 100644 docs/sphinx/source/resources/pages/api/foundations.parsers.rst create mode 100644 docs/sphinx/source/resources/pages/api/foundations.pkzip.rst create mode 100644 docs/sphinx/source/resources/pages/api/foundations.rotatingBackup.rst create mode 100644 docs/sphinx/source/resources/pages/api/foundations.shell.rst create mode 100644 docs/sphinx/source/resources/pages/api/foundations.strings.rst create mode 100644 docs/sphinx/source/resources/pages/api/foundations.tcpServer.rst create mode 100644 docs/sphinx/source/resources/pages/api/foundations.trace.rst create mode 100644 docs/sphinx/source/resources/pages/api/foundations.ui.common.rst create mode 100644 docs/sphinx/source/resources/pages/api/foundations.verbose.rst create mode 100644 docs/sphinx/source/resources/pages/api/foundations.walkers.rst create mode 100644 docs/sphinx/source/resources/pages/api/manager.component.rst create mode 100644 docs/sphinx/source/resources/pages/api/manager.componentsManager.rst create mode 100644 docs/sphinx/source/resources/pages/api/manager.exceptions.rst create mode 100644 docs/sphinx/source/resources/pages/api/manager.globals.constants.rst create mode 100644 docs/sphinx/source/resources/pages/api/manager.qobjectComponent.rst create mode 100644 docs/sphinx/source/resources/pages/api/manager.qwidgetComponent.rst create mode 100644 docs/sphinx/source/resources/pages/api/oncilla.buildApi.rst create mode 100644 docs/sphinx/source/resources/pages/api/oncilla.buildTocTree.rst create mode 100644 docs/sphinx/source/resources/pages/api/oncilla.defaultSanitizer.rst create mode 100644 docs/sphinx/source/resources/pages/api/oncilla.globals.constants.rst create mode 100644 docs/sphinx/source/resources/pages/api/oncilla.reStructuredTextToHtml.rst create mode 100644 docs/sphinx/source/resources/pages/api/oncilla.sliceReStructuredText.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.about.about.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.cachesOperations.cachesOperations.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.databaseOperations.databaseOperations.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.gpsMap.gpsMap.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.gpsMap.views.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.iblSetsScanner.iblSetsScanner.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.iblSetsScanner.workers.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loaderScript.loaderScript.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loaderScriptOptions.loaderScriptOptions.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loaderScriptOptions.views.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.locationsBrowser.locationsBrowser.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loggingNotifier.loggingNotifier.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.downloadManager.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.onlineUpdater.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.remoteUpdater.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.views.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.preview.imagesPreviewer.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.preview.preview.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.rawEditingUtilities.rawEditingUtilities.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.rewiringTool.rewiringTool.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.sIBLeditUtilities.sIBLeditUtilities.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.searchDatabase.searchDatabase.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.searchDatabase.views.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.collectionsOutliner.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.models.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.nodes.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.views.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.database.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.exceptions.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.nodes.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.operations.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.types.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.iblSetsOutliner.models.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.iblSetsOutliner.views.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.inspector.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.models.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.nodes.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.views.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.models.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.nodes.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.templatesOutliner.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.views.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.exceptions.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.globals.constants.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.globals.runtimeGlobals.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.globals.uiConstants.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.launcher.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.libraries.freeImage.freeImage.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.ui.caches.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.ui.common.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.ui.models.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.ui.nodes.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.ui.views.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.ui.widgets.application_QToolBar.rst create mode 100644 docs/sphinx/source/resources/pages/api/sibl_gui.ui.workers.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.addons.projectsExplorer.models.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.addons.projectsExplorer.projectsExplorer.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.addons.projectsExplorer.views.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.addons.tcpClientUi.tcpClientUi.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.addons.tcpServerUi.tcpServerUi.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.models.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.nodes.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.traceUi.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.views.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.componentsManagerUi.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.models.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.nodes.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.views.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.factory.preferencesManager.preferencesManager.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.editor.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.editorStatus.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.models.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.nodes.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.scriptEditor.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.searchAndReplace.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.searchInFiles.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.views.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.workers.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.engine.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.exceptions.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.globals.constants.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.globals.runtimeGlobals.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.globals.uiConstants.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.guerilla.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.launcher.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.managers.actionsManager.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.managers.fileSystemEventsManager.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.managers.layoutsManager.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.managers.notificationsManager.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.managers.patchesManager.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.preferences.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.processing.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.reporter.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.common.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.completers.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.delegates.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.highlighters.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.inputAccelerators.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.languages.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.models.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.nodes.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.themes.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.views.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.visualAccelerators.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.widgets.active_QLabel.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.widgets.active_QLabelsCollection.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.widgets.application_QToolBar.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.widgets.basic_QPlainTextEdit.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.widgets.codeEditor_QPlainTextEdit.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.widgets.delayed_QSplashScreen.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.widgets.messageBox.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.widgets.notification_QLabel.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.widgets.search_QLineEdit.rst create mode 100644 docs/sphinx/source/resources/pages/api/umbra.ui.widgets.variable_QPushButton.rst delete mode 100644 utilities/css/style.css delete mode 100755 utilities/getSphinxDocumentationApi.py delete mode 100644 utilities/getSphinxDocumentationTocTree.py delete mode 100644 utilities/libraries/__init__.py delete mode 100644 utilities/libraries/python/__init__.py delete mode 100644 utilities/libraries/python/pyclbr.py delete mode 100644 utilities/reStructuredTextToHtml.py create mode 100644 utilities/sanitizer.py delete mode 100644 utilities/sliceDocumentation.py delete mode 100644 utilities/tidy/tidySettings.rc diff --git a/docs/help/sIBL_GUI_Manual.html b/docs/help/sIBL_GUI_Manual.html index 6bdb3361..0a7eb86d 100644 --- a/docs/help/sIBL_GUI_Manual.html +++ b/docs/help/sIBL_GUI_Manual.html @@ -2,88 +2,77 @@ - + diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 48b318a1..fd78d8e6 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -12,6 +12,7 @@ # serve to show the default. import sys, os +import sphinx_rtd_theme from sibl_gui.globals.constants import Constants @@ -97,7 +98,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = "default" +html_theme = "sphinx_rtd_theme" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -105,7 +106,7 @@ # html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = [] +html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". @@ -126,7 +127,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = [".static", "resources/css"] +html_static_path = [".static"] # If not "", a "Last updated on:" timestamp is inserted at every page bottom, # using the given strftime format. diff --git a/docs/sphinx/source/resources/css/basic.css b/docs/sphinx/source/resources/css/basic.css deleted file mode 100644 index c113fe51..00000000 --- a/docs/sphinx/source/resources/css/basic.css +++ /dev/null @@ -1,524 +0,0 @@ -/* - * basic.css - * ~~~~~~~~~ - * - * Sphinx stylesheet -- basic theme. - * - * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - * :Modified By Thomas Mansencal For sIBL_GUI Documentation. - * - */ - -/* -- main layout ----------------------------------------------------------- */ - -div.clearer { - clear: both; -} - -/* -- relbar ---------------------------------------------------------------- */ - -div.related { - width: 100%; - font-size: 90%; -} - -div.related h3 { - display: none; -} - -div.related ul { - margin: 0; - padding: 0 0 0 10px; - list-style: none; -} - -div.related li { - display: inline; -} - -div.related li.right { - float: right; - margin-right: 5px; -} - -/* -- sidebar --------------------------------------------------------------- */ - -div.sphinxsidebarwrapper { - padding: 10px 5px 0 10px; -} - -div.sphinxsidebar { - float: left; - width: 230px; - margin-left: -100%; - font-size: 90%; -} - -div.sphinxsidebar ul { - list-style: none; -} - -div.sphinxsidebar ul ul, div.sphinxsidebar ul.want-points { - margin-left: 20px; - list-style: square; -} - -div.sphinxsidebar ul ul { - margin-top: 0; - margin-bottom: 0; -} - -div.sphinxsidebar form { - margin-top: 10px; -} - -div.sphinxsidebar input { - border: 1px solid rgb(224, 224, 224); - font-family: sans-serif; - font-size: 1em; -} - -img { - border: 0; -} - -/* -- search page ----------------------------------------------------------- */ - -ul.search { - margin: 10px 0 0 20px; - padding: 0; -} - -ul.search li { - padding: 5px 0 5px 20px; - background-image: url(file.png); - background-repeat: no-repeat; - background-position: 0 7px; -} - -ul.search li a { - font-weight: bold; -} - -ul.search li div.context { - color: rgb(96, 96, 96); - margin: 2px 0 0 30px; - text-align: left; -} - -ul.keywordmatches li.goodmatch a { - font-weight: bold; -} - -/* -- index page ------------------------------------------------------------ */ - -table.contentstable { - width: 90%; -} - -table.contentstable p.biglink { - line-height: 150%; -} - -a.biglink { - font-size: 1.3em; -} - -span.linkdescr { - font-style: italic; - padding-top: 5px; - font-size: 90%; -} - -/* -- general index --------------------------------------------------------- */ - -table.indextable { - width: 100%; -} - -table.indextable td { - text-align: left; - vertical-align: top; -} - -table.indextable dl, table.indextable dd { - margin-top: 0; - margin-bottom: 0; -} - -table.indextable tr.pcap { - height: 10px; -} - -table.indextable tr.cap { - margin-top: 10px; - background-color: rgb(64, 64, 64); -} - -img.toggler { - margin-right: 3px; - margin-top: 3px; - cursor: pointer; -} - -div.modindex-jumpbox { - border-top: 2px solid rgb(64, 64, 64); - border-bottom: 2px solid rgb(64, 64, 64); - margin: 1em 0 1em 0; - padding: 0.4em; -} - -div.genindex-jumpbox { - border-top: 2px solid rgb(64, 64, 64); - border-bottom: 2px solid rgb(64, 64, 64); - margin: 1em 0 1em 0; - padding: 0.4em; -} - -/* -- general body styles --------------------------------------------------- */ - -a.headerlink { - visibility: hidden; -} - -h1:hover > a.headerlink, h2:hover > a.headerlink, h3:hover > a.headerlink, h4:hover > a.headerlink, h5:hover > a.headerlink, h6:hover > a.headerlink, dt:hover > a.headerlink { - visibility: visible; -} - -div.body p.caption { - text-align: inherit; -} - -div.body td { - text-align: left; -} - -.field-list ul { - padding-left: 1em; -} - -.first { - margin-top: 0 !important; -} - -p.rubric { - margin-top: 30px; - font-weight: bold; -} - -img.align-left, .figure.align-left, object.align-left { - clear: left; - float: left; - margin-right: 1em; -} - -img.align-right, .figure.align-right, object.align-right { - clear: right; - float: right; - margin-left: 1em; -} - -img.align-center, .figure.align-center, object.align-center { - display: block; - margin-left: auto; - margin-right: auto; -} - -.align-left { - text-align: left; -} - -.align-center { - clear: both; - text-align: center; -} - -.align-right { - text-align: right; -} - -/* -- sidebars -------------------------------------------------------------- */ - -div.sidebar { - margin: 0 0 0.5em 1em; - border: 2px solid rgb(64, 64, 64); - padding: 7px 7px 0 7px; - background-color: rgb(96, 96, 96); - width: 40%; - float: right; -} - -p.sidebar-title { - font-weight: bold; -} - -/* -- topics ---------------------------------------------------------------- */ - -div.topic { - border: 2px solid rgb(64, 64, 64); - padding: 7px 7px 0 7px; - margin: 10px 0 10px 0; -} - -p.topic-title { - font-size: 1.1em; - font-weight: bold; - margin-top: 10px; -} - -/* -- admonitions ----------------------------------------------------------- */ - -div.admonition { - margin-top: 10px; - margin-bottom: 10px; - padding: 7px; -} - -div.admonition dt { - font-weight: bold; -} - -div.admonition dl { - margin-bottom: 0; -} - -p.admonition-title { - margin: 0px 10px 5px 0px; - font-weight: bold; -} - -div.body p.centered { - text-align: center; - margin-top: 25px; -} - -/* -- tables ---------------------------------------------------------------- */ - -table.docutils { - border: 0; - border-collapse: collapse; -} - -table.docutils td, table.docutils th { - padding: 1px 8px 1px 5px; - border-top: 0; - border-left: 0; - border-right: 0; - border-bottom: 2px solid rgb(64, 64, 64); -} - -table.field-list td, table.field-list th { - border: 0 !important; -} - -table.footnote td, table.footnote th { - border: 0 !important; -} - -th { - text-align: left; - padding-right: 5px; -} - -table.citation { - border-left: solid 2px rgb(64, 64, 64); - margin-left: 1px; -} - -table.citation td { - border-bottom: none; -} - -/* -- other body styles ----------------------------------------------------- */ - -ol.arabic { - list-style: decimal; -} - -ol.loweralpha { - list-style: lower-alpha; -} - -ol.upperalpha { - list-style: upper-alpha; -} - -ol.lowerroman { - list-style: lower-roman; -} - -ol.upperroman { - list-style: upper-roman; -} - -dl { - margin-bottom: 30px; -} - -dd p { - margin-top: 0px; -} - -dd ul, dd table { - margin-bottom: 10px; -} - -dd { - margin-top: 3px; - margin-bottom: 10px; - margin-left: 30px; -} - -dt:target, .highlighted { - background-color: rgb(160, 96, 64); -} - -dl.glossary dt { - font-weight: bold; - font-size: 1.1em; -} - -.field-list ul { - margin: 0; - padding-left: 1em; -} - -.field-list p { - margin: 0; -} - -.refcount { - color: rgb(160, 96, 64); -} - -.optional { - font-size: 1.3em; -} - -.versionmodified { - font-style: italic; -} - -.system-message { - background-color: rgb(160, 96, 64); - padding: 5px; - border: 2px solid rgb(160, 64, 48); -} - -.footnote:target { - background-color: rgb(64, 64, 64); -} - -.line-block { - display: block; - margin-top: 1em; - margin-bottom: 1em; -} - -.line-block .line-block { - margin-top: 0; - margin-bottom: 0; - margin-left: 1.5em; -} - -.guilabel, .menuselection { - font-family: sans-serif; -} - -.accelerator { - text-decoration: underline; -} - -.classifier { - font-style: oblique; -} - -/* -- code displays --------------------------------------------------------- */ - -pre { - overflow: auto; - overflow-y: hidden; /* fixes display issues on Chrome browsers */ -} - -td.linenos pre { - padding: 5px 0px; - border: 0; - background-color: transparent; - color: rgb(96, 96, 96); -} - -table.highlighttable { - margin-left: 0.5em; -} - -table.highlighttable td { - padding: 0 0.5em 0 0.5em; -} - -tt.descname { - background-color: transparent; - color: rgb(224, 224, 224); - font-size: 1.75em; -} - -tt.descclassname { - background-color: transparent; - display: none; -} - -tt.xref, a tt { - background-color: transparent; - font-weight: bold; -} - -h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { - background-color: transparent; -} - -.viewcode-link { - float: right; -} - -.viewcode-back { - float: right; - font-family: sans-serif; -} - -div.viewcode-block:target { - margin: -1px -10px; - padding: 0 10px; -} - -/* -- math display ---------------------------------------------------------- */ - -img.math { - vertical-align: middle; -} - -div.body div.math p { - text-align: center; -} - -span.eqno { - float: right; -} - -/* -- printout stylesheet --------------------------------------------------- */ - -@media print { - div.document, - div.documentwrapper, - div.bodywrapper { - margin: 0 !important; - width: 100%; - } - - div.sphinxsidebar, - div.related, - div.footer, - #top-link { - display: none; - } -} diff --git a/docs/sphinx/source/resources/css/default.css b/docs/sphinx/source/resources/css/default.css deleted file mode 100644 index b3578d0c..00000000 --- a/docs/sphinx/source/resources/css/default.css +++ /dev/null @@ -1,282 +0,0 @@ -/* - * default.css_t - * ~~~~~~~~~~~~~ - * - * Sphinx stylesheet -- default theme. - * - * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - * :Modified By Thomas Mansencal For sIBL_GUI Documentation. - * - */ - -@import url("basic.css"); - -/* -- page layout ----------------------------------------------------------- */ - -body { - font-family: sans-serif; - font-size: 100%; - background-color: rgb(32, 32, 32); - color: rgb(192, 192, 192); - margin: 0; - padding: 0; -} - -div.document { - background-color: rgb(64, 64, 64); -} - -div.documentwrapper { - float: left; - width: 100%; -} - -div.bodywrapper { - margin: 0 0 0 256px; -} - -div.body { - background-color: rgb(32, 32, 32); - color: rgb(192, 192, 192); - padding: 0 20px 30px 20px; -} - -div.footer { - color: rgb(192, 192, 192); - width: 100%; - padding: 9px 0 9px 0; - text-align: center; - font-size: 75%; -} - -div.footer a { - color: rgb(192, 192, 192); - text-decoration: underline; -} - -div.related { - background-color: rgb(80, 80, 80); - line-height: 30px; - color: rgb(224, 224, 224); -} - -div.related a { - color: rgb(210, 125, 80); -} - -div.sphinxsidebar { - background-color: rgb(64, 64, 64); -} - -div.sphinxsidebar h3 { - font-family: 'Trebuchet MS', sans-serif; - color: rgb(224, 224, 224); - font-size: 1.4em; - font-weight: normal; - margin: 0; - padding: 0; -} - -div.sphinxsidebar h3 a { - color: rgb(224, 224, 224); -} - -div.sphinxsidebar h4 { - font-family: 'Trebuchet MS', sans-serif; - color: rgb(224, 224, 224); - font-size: 1.3em; - font-weight: normal; - margin: 5px 0 0 0; - padding: 0; -} - -div.sphinxsidebar p { - color: rgb(224, 224, 224); -} - -div.sphinxsidebar p.topless { - margin: 5px 10px 10px 10px; -} - -div.sphinxsidebar ul { - margin: 10px; - padding: 0; - color: rgb(224, 224, 224); -} - -div.sphinxsidebar a { - color: rgb(210, 125, 80); -} - -div.sphinxsidebar input { - border: 1px solid rgb(210, 125, 80); - font-family: sans-serif; - font-size: 1em; -} - -/* -- hyperlink styles ------------------------------------------------------ */ - -a:link { - color: rgb(160, 96, 64); - text-decoration: none; -} - -a:visited { - color: rgb(160, 96, 64); - text-decoration: none; -} - -a:active { - color: rgb(160, 96, 64); - text-decoration: none; -} - -a:hover { - color: rgb(160, 96, 64); - text-decoration: underline; -} - -/* -- body styles ----------------------------------------------------------- */ - -div.body h1, div.body h2, div.body h3, div.body h4, div.body h5, div.body h6 { - background-color: rgb(64, 64, 64); - font-family: 'Trebuchet MS', sans-serif; - font-weight: normal; - color: rgb(224, 224, 224); - margin: 20px -20px 10px -20px; - padding: 3px 0 3px 10px; -} - -div.body h1 { - margin-top: 0; - font-size: 200%; -} - -div.body h2 { - font-size: 160%; -} - -div.body h3 { - font-size: 140%; -} - -div.body h4 { - font-size: 120%; -} - -div.body h5 { - font-size: 110%; -} - -div.body h6 { - font-size: 100%; -} - -a.headerlink { - color: rgb(210, 125, 80); - font-size: 0.8em; - padding: 0 4px 0 4px; - text-decoration: none; -} - -a.headerlink:hover { - background-color: rgb(210, 125, 80); - color: white; -} - -div.body p, div.body dd, div.body li { - text-align: justify; - line-height: 130%; -} - -div.admonition p.admonition-title + p { - display: inline; -} - -div.admonition p { - margin-bottom: 5px; -} - -div.admonition pre { - margin-bottom: 5px; -} - -div.admonition ul, div.admonition ol { - margin-bottom: 5px; -} - -div.note { - background-color: rgb(64, 64, 64); - border: 2px solid rgb(160, 96, 64); -} - -div.seealso { - background-color: rgb(64, 64, 64); - border: 2px solid rgb(160, 96, 64); -} - -div.topic { - background-color: rgb(64, 64, 64); -} - -div.warning { - background-color: rgb(64, 64, 64); - border: 2px solid rgb(160, 64, 48); -} - -p.admonition-title { - display: inline; -} - -p.admonition-title:after { - content: ":"; -} - -pre { - background-color: rgb(64, 64, 64); - border: 2px solid rgb(160, 96, 64); - border-left: none; - border-right: none; - color: rgb(224, 224, 224); - line-height: 120%; - padding: 5px; - white-space: pre-wrap; -} - -tt { - background-color: rgb(64, 64, 64); - padding: 0 1px 0 1px; - font-size: 0.95em; -} - -th { - background-color: rgb(64, 64, 64); -} - -.warning tt { - background: rgb(64, 64, 64); -} - -.note tt { - background: rgb(64, 64, 64); -} - -.viewcode-back { - font-family: sans-serif; -} - -div.viewcode-block:target { - background-color: rgb(96, 64, 48); - border-top: 2px solid rgb(160, 96, 64); - border-bottom: 2px solid rgb(160, 96, 64); -} - -table.docutils td, table.docutils th { - border-collapse: collapse; - border-color: rgb(96, 96, 96); - border-style: solid; - border-width: 2px; - padding: 4px; -} \ No newline at end of file diff --git a/docs/sphinx/source/resources/css/pygments.css b/docs/sphinx/source/resources/css/pygments.css deleted file mode 100644 index 1750bd15..00000000 --- a/docs/sphinx/source/resources/css/pygments.css +++ /dev/null @@ -1,62 +0,0 @@ -.highlight .hll { background-color: #ffffcc } -.highlight { background: #eeffcc; } -.highlight .c { color: #408090; font-style: italic } /* Comment */ -.highlight .err { border: 1px solid #FF0000 } /* Error */ -.highlight .k { color: #007020; font-weight: bold } /* Keyword */ -.highlight .o { color: #A0A0A0 } /* Operator */ -.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */ -.highlight .cp { color: #007020 } /* Comment.Preproc */ -.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */ -.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */ -.highlight .gd { color: #A00000 } /* Generic.Deleted */ -.highlight .ge { font-style: italic } /* Generic.Emph */ -.highlight .gr { color: #FF0000 } /* Generic.Error */ -.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ -.highlight .gi { color: #00A000 } /* Generic.Inserted */ -.highlight .go { color: #A0A0A0 } /* Generic.Output */ -.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */ -.highlight .gs { font-weight: bold } /* Generic.Strong */ -.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ -.highlight .gt { color: #0040D0 } /* Generic.Traceback */ -.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */ -.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */ -.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */ -.highlight .kp { color: #007020 } /* Keyword.Pseudo */ -.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */ -.highlight .kt { color: #902000 } /* Keyword.Type */ -.highlight .m { color: #208050 } /* Literal.Number */ -.highlight .s { color: #4070a0 } /* Literal.String */ -.highlight .na { color: #4070a0 } /* Name.Attribute */ -.highlight .nb { color: #007020 } /* Name.Builtin */ -.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */ -.highlight .no { color: #60add5 } /* Name.Constant */ -.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */ -.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */ -.highlight .ne { color: #007020 } /* Name.Exception */ -.highlight .nf { color: #06287e } /* Name.Function */ -.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */ -.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */ -.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */ -.highlight .nv { color: #bb60d5 } /* Name.Variable */ -.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */ -.highlight .w { color: #bbbbbb } /* Text.Whitespace */ -.highlight .mf { color: #208050 } /* Literal.Number.Float */ -.highlight .mh { color: #208050 } /* Literal.Number.Hex */ -.highlight .mi { color: #208050 } /* Literal.Number.Integer */ -.highlight .mo { color: #208050 } /* Literal.Number.Oct */ -.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */ -.highlight .sc { color: #4070a0 } /* Literal.String.Char */ -.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */ -.highlight .s2 { color: #4070a0 } /* Literal.String.Double */ -.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */ -.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */ -.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */ -.highlight .sx { color: #c65d09 } /* Literal.String.Other */ -.highlight .sr { color: #235388 } /* Literal.String.Regex */ -.highlight .s1 { color: #4070a0 } /* Literal.String.Single */ -.highlight .ss { color: #517918 } /* Literal.String.Symbol */ -.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */ -.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */ -.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */ -.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */ -.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/docs/sphinx/source/resources/pages/api.rst b/docs/sphinx/source/resources/pages/api.rst index fda3a2d3..4abfe206 100644 --- a/docs/sphinx/source/resources/pages/api.rst +++ b/docs/sphinx/source/resources/pages/api.rst @@ -1,9 +1,157 @@ Api -=== +==== -**sIBL_GUI** Api documentation is available here: `sIBL_GUI - Api `_ +Modules Summary: -.. raw:: html - -
+.. toctree:: + :maxdepth: 1 + oncilla.buildApi + oncilla.buildTocTree + oncilla.defaultSanitizer + oncilla.globals.constants + oncilla.reStructuredTextToHtml + oncilla.sliceReStructuredText + foundations.cache + foundations.common + foundations.core + foundations.dataStructures + foundations.decorators + foundations.environment + foundations.exceptions + foundations.globals.constants + foundations.io + foundations.library + foundations.namespace + foundations.nodes + foundations.parsers + foundations.pkzip + foundations.rotatingBackup + foundations.shell + foundations.strings + foundations.tcpServer + foundations.trace + foundations.ui.common + foundations.verbose + foundations.walkers + manager.component + manager.componentsManager + manager.exceptions + manager.globals.constants + manager.qobjectComponent + manager.qwidgetComponent + umbra.components.addons.projectsExplorer.models + umbra.components.addons.projectsExplorer.projectsExplorer + umbra.components.addons.projectsExplorer.views + umbra.components.addons.tcpClientUi.tcpClientUi + umbra.components.addons.tcpServerUi.tcpServerUi + umbra.components.addons.traceUi.models + umbra.components.addons.traceUi.nodes + umbra.components.addons.traceUi.traceUi + umbra.components.addons.traceUi.views + umbra.components.factory.componentsManagerUi.componentsManagerUi + umbra.components.factory.componentsManagerUi.models + umbra.components.factory.componentsManagerUi.nodes + umbra.components.factory.componentsManagerUi.views + umbra.components.factory.preferencesManager.preferencesManager + umbra.components.factory.scriptEditor.editor + umbra.components.factory.scriptEditor.editorStatus + umbra.components.factory.scriptEditor.models + umbra.components.factory.scriptEditor.nodes + umbra.components.factory.scriptEditor.scriptEditor + umbra.components.factory.scriptEditor.searchAndReplace + umbra.components.factory.scriptEditor.searchInFiles + umbra.components.factory.scriptEditor.views + umbra.components.factory.scriptEditor.workers + umbra.engine + umbra.exceptions + umbra.globals.constants + umbra.globals.runtimeGlobals + umbra.globals.uiConstants + umbra.guerilla + umbra.launcher + umbra.managers.actionsManager + umbra.managers.fileSystemEventsManager + umbra.managers.layoutsManager + umbra.managers.notificationsManager + umbra.managers.patchesManager + umbra.preferences + umbra.processing + umbra.reporter + umbra.ui.common + umbra.ui.completers + umbra.ui.delegates + umbra.ui.highlighters + umbra.ui.inputAccelerators + umbra.ui.languages + umbra.ui.models + umbra.ui.nodes + umbra.ui.themes + umbra.ui.views + umbra.ui.visualAccelerators + umbra.ui.widgets.active_QLabel + umbra.ui.widgets.active_QLabelsCollection + umbra.ui.widgets.application_QToolBar + umbra.ui.widgets.basic_QPlainTextEdit + umbra.ui.widgets.codeEditor_QPlainTextEdit + umbra.ui.widgets.delayed_QSplashScreen + umbra.ui.widgets.messageBox + umbra.ui.widgets.notification_QLabel + umbra.ui.widgets.search_QLineEdit + umbra.ui.widgets.variable_QPushButton + sibl_gui.components.addons.about.about + sibl_gui.components.addons.cachesOperations.cachesOperations + sibl_gui.components.addons.databaseOperations.databaseOperations + sibl_gui.components.addons.gpsMap.gpsMap + sibl_gui.components.addons.gpsMap.views + sibl_gui.components.addons.iblSetsScanner.iblSetsScanner + sibl_gui.components.addons.iblSetsScanner.workers + sibl_gui.components.addons.loaderScript.loaderScript + sibl_gui.components.addons.loaderScriptOptions.loaderScriptOptions + sibl_gui.components.addons.loaderScriptOptions.views + sibl_gui.components.addons.locationsBrowser.locationsBrowser + sibl_gui.components.addons.loggingNotifier.loggingNotifier + sibl_gui.components.addons.onlineUpdater.downloadManager + sibl_gui.components.addons.onlineUpdater.onlineUpdater + sibl_gui.components.addons.onlineUpdater.remoteUpdater + sibl_gui.components.addons.onlineUpdater.views + sibl_gui.components.addons.preview.imagesPreviewer + sibl_gui.components.addons.preview.preview + sibl_gui.components.addons.rawEditingUtilities.rawEditingUtilities + sibl_gui.components.addons.rewiringTool.rewiringTool + sibl_gui.components.addons.sIBLeditUtilities.sIBLeditUtilities + sibl_gui.components.addons.searchDatabase.searchDatabase + sibl_gui.components.addons.searchDatabase.views + sibl_gui.components.core.collectionsOutliner.collectionsOutliner + sibl_gui.components.core.collectionsOutliner.models + sibl_gui.components.core.collectionsOutliner.nodes + sibl_gui.components.core.collectionsOutliner.views + sibl_gui.components.core.database.database + sibl_gui.components.core.database.exceptions + sibl_gui.components.core.database.nodes + sibl_gui.components.core.database.operations + sibl_gui.components.core.database.types + sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner + sibl_gui.components.core.iblSetsOutliner.models + sibl_gui.components.core.iblSetsOutliner.views + sibl_gui.components.core.inspector.inspector + sibl_gui.components.core.inspector.models + sibl_gui.components.core.inspector.nodes + sibl_gui.components.core.inspector.views + sibl_gui.components.core.templatesOutliner.models + sibl_gui.components.core.templatesOutliner.nodes + sibl_gui.components.core.templatesOutliner.templatesOutliner + sibl_gui.components.core.templatesOutliner.views + sibl_gui.exceptions + sibl_gui.globals.constants + sibl_gui.globals.runtimeGlobals + sibl_gui.globals.uiConstants + sibl_gui.launcher + sibl_gui.libraries.freeImage.freeImage + sibl_gui.ui.caches + sibl_gui.ui.common + sibl_gui.ui.models + sibl_gui.ui.nodes + sibl_gui.ui.views + sibl_gui.ui.widgets.application_QToolBar + sibl_gui.ui.workers diff --git a/docs/sphinx/source/resources/pages/api/foundations.cache.rst b/docs/sphinx/source/resources/pages/api/foundations.cache.rst new file mode 100644 index 00000000..ccf44fcf --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/foundations.cache.rst @@ -0,0 +1,17 @@ +_`foundations.cache` +==================== + +.. automodule:: foundations.cache + +Module Attributes +----------------- + +.. attribute:: foundations.cache.LOGGER + +Classes +------- + +.. autoclass:: Cache + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/foundations.common.rst b/docs/sphinx/source/resources/pages/api/foundations.common.rst new file mode 100644 index 00000000..f366dc8e --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/foundations.common.rst @@ -0,0 +1,41 @@ +_`foundations.common` +===================== + +.. automodule:: foundations.common + +Module Attributes +----------------- + +.. attribute:: foundations.common.LOGGER + +.. attribute:: foundations.common.CONNECTION_IPS + +.. attribute:: foundations.common.DEFAULT_HOST_IP + +Functions +--------- + +.. autofunction:: uniqify + +.. autofunction:: orderedUniqify + +.. autofunction:: unpackDefault + +.. autofunction:: pathExists + +.. autofunction:: filterPath + +.. autofunction:: getFirstItem + +.. autofunction:: getLastItem + +.. autofunction:: isBinaryFile + +.. autofunction:: repeat + +.. autofunction:: dependencyResolver + +.. autofunction:: isInternetAvailable + +.. autofunction:: getHostAddress + diff --git a/docs/sphinx/source/resources/pages/api/foundations.core.rst b/docs/sphinx/source/resources/pages/api/foundations.core.rst new file mode 100644 index 00000000..ba1fa8f1 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/foundations.core.rst @@ -0,0 +1,17 @@ +_`foundations.core` +=================== + +.. automodule:: foundations.core + +Module Attributes +----------------- + +.. attribute:: foundations.core.LOGGER + +Functions +--------- + +.. autofunction:: exit + +.. autofunction:: wait + diff --git a/docs/sphinx/source/resources/pages/api/foundations.dataStructures.rst b/docs/sphinx/source/resources/pages/api/foundations.dataStructures.rst new file mode 100644 index 00000000..46744022 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/foundations.dataStructures.rst @@ -0,0 +1,29 @@ +_`foundations.dataStructures` +============================= + +.. automodule:: foundations.dataStructures + +Module Attributes +----------------- + +.. attribute:: foundations.dataStructures.LOGGER + +Classes +------- + +.. autoclass:: NestedAttribute + :show-inheritance: + :members: + +.. autoclass:: Structure + :show-inheritance: + :members: + +.. autoclass:: OrderedStructure + :show-inheritance: + :members: + +.. autoclass:: Lookup + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/foundations.decorators.rst b/docs/sphinx/source/resources/pages/api/foundations.decorators.rst new file mode 100644 index 00000000..060fa285 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/foundations.decorators.rst @@ -0,0 +1,19 @@ +_`foundations.decorators` +========================= + +.. automodule:: foundations.decorators + +Module Attributes +----------------- + +.. attribute:: foundations.decorators.LOGGER + +Functions +--------- + +.. autofunction:: executionTime + +.. autofunction:: memoize + +.. autofunction:: systemExit + diff --git a/docs/sphinx/source/resources/pages/api/foundations.environment.rst b/docs/sphinx/source/resources/pages/api/foundations.environment.rst new file mode 100644 index 00000000..56421e22 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/foundations.environment.rst @@ -0,0 +1,24 @@ +_`foundations.environment` +========================== + +.. automodule:: foundations.environment + +Module Attributes +----------------- + +.. attribute:: foundations.environment.LOGGER + +Functions +--------- + +.. autofunction:: getSystemApplicationDataDirectory + +.. autofunction:: getUserApplicationDataDirectory + +Classes +------- + +.. autoclass:: Environment + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/foundations.exceptions.rst b/docs/sphinx/source/resources/pages/api/foundations.exceptions.rst new file mode 100644 index 00000000..94bed64c --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/foundations.exceptions.rst @@ -0,0 +1,144 @@ +_`foundations.exceptions` +========================= + +.. automodule:: foundations.exceptions + +Module Attributes +----------------- + +.. attribute:: foundations.exceptions.LOGGER + +.. attribute:: foundations.exceptions.EXCEPTIONS_FRAME_SYMBOL + +Functions +--------- + +.. autofunction:: getInnerMostFrame + +.. autofunction:: extractStack + +.. autofunction:: extractArguments + +.. autofunction:: extractLocals + +.. autofunction:: extractException + +.. autofunction:: formatException + +.. autofunction:: formatReport + +.. autofunction:: baseExceptionHandler + +.. autofunction:: installExceptionHandler + +.. autofunction:: uninstallExceptionHandler + +.. autofunction:: handleExceptions + +Classes +------- + +.. autoclass:: AbstractError + :show-inheritance: + :members: + +.. autoclass:: ExecutionError + :show-inheritance: + :members: + +.. autoclass:: BreakIteration + :show-inheritance: + :members: + +.. autoclass:: AbstractParsingError + :show-inheritance: + :members: + +.. autoclass:: FileStructureParsingError + :show-inheritance: + :members: + +.. autoclass:: AttributeStructureParsingError + :show-inheritance: + :members: + +.. autoclass:: AbstractOsError + :show-inheritance: + :members: + +.. autoclass:: PathExistsError + :show-inheritance: + :members: + +.. autoclass:: DirectoryExistsError + :show-inheritance: + :members: + +.. autoclass:: FileExistsError + :show-inheritance: + :members: + +.. autoclass:: AbstractObjectError + :show-inheritance: + :members: + +.. autoclass:: ObjectTypeError + :show-inheritance: + :members: + +.. autoclass:: ObjectExistsError + :show-inheritance: + :members: + +.. autoclass:: AbstractUserError + :show-inheritance: + :members: + +.. autoclass:: ProgrammingError + :show-inheritance: + :members: + +.. autoclass:: UserError + :show-inheritance: + :members: + +.. autoclass:: AbstractNodeError + :show-inheritance: + :members: + +.. autoclass:: NodeAttributeTypeError + :show-inheritance: + :members: + +.. autoclass:: NodeAttributeExistsError + :show-inheritance: + :members: + +.. autoclass:: AbstractLibraryError + :show-inheritance: + :members: + +.. autoclass:: LibraryInstantiationError + :show-inheritance: + :members: + +.. autoclass:: LibraryInitializationError + :show-inheritance: + :members: + +.. autoclass:: LibraryExecutionError + :show-inheritance: + :members: + +.. autoclass:: AbstractServerError + :show-inheritance: + :members: + +.. autoclass:: ServerOperationError + :show-inheritance: + :members: + +.. autoclass:: AnsiEscapeCodeExistsError + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/foundations.globals.constants.rst b/docs/sphinx/source/resources/pages/api/foundations.globals.constants.rst new file mode 100644 index 00000000..9a423e8f --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/foundations.globals.constants.rst @@ -0,0 +1,12 @@ +_`foundations.globals.constants` +================================ + +.. automodule:: foundations.globals.constants + +Classes +------- + +.. autoclass:: Constants + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/foundations.io.rst b/docs/sphinx/source/resources/pages/api/foundations.io.rst new file mode 100644 index 00000000..8c8126fb --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/foundations.io.rst @@ -0,0 +1,26 @@ +_`foundations.io` +================= + +.. automodule:: foundations.io + +Module Attributes +----------------- + +.. attribute:: foundations.io.LOGGER + +Functions +--------- + +.. autofunction:: setDirectory + +.. autofunction:: copy + +.. autofunction:: remove + +Classes +------- + +.. autoclass:: File + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/foundations.library.rst b/docs/sphinx/source/resources/pages/api/foundations.library.rst new file mode 100644 index 00000000..d5409246 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/foundations.library.rst @@ -0,0 +1,21 @@ +_`foundations.library` +====================== + +.. automodule:: foundations.library + +Module Attributes +----------------- + +.. attribute:: foundations.library.LOGGER + +Classes +------- + +.. autoclass:: LibraryHook + :show-inheritance: + :members: + +.. autoclass:: Library + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/foundations.namespace.rst b/docs/sphinx/source/resources/pages/api/foundations.namespace.rst new file mode 100644 index 00000000..35b2aa12 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/foundations.namespace.rst @@ -0,0 +1,25 @@ +_`foundations.namespace` +======================== + +.. automodule:: foundations.namespace + +Module Attributes +----------------- + +.. attribute:: foundations.namespace.LOGGER + +.. attribute:: foundations.namespace.NAMESPACE_SPLITTER + +Functions +--------- + +.. autofunction:: setNamespace + +.. autofunction:: getNamespace + +.. autofunction:: removeNamespace + +.. autofunction:: getRoot + +.. autofunction:: getLeaf + diff --git a/docs/sphinx/source/resources/pages/api/foundations.nodes.rst b/docs/sphinx/source/resources/pages/api/foundations.nodes.rst new file mode 100644 index 00000000..16fc8224 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/foundations.nodes.rst @@ -0,0 +1,25 @@ +_`foundations.nodes` +==================== + +.. automodule:: foundations.nodes + +Module Attributes +----------------- + +.. attribute:: foundations.nodes.LOGGER + +Classes +------- + +.. autoclass:: Attribute + :show-inheritance: + :members: + +.. autoclass:: AbstractNode + :show-inheritance: + :members: + +.. autoclass:: AbstractCompositeNode + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/foundations.parsers.rst b/docs/sphinx/source/resources/pages/api/foundations.parsers.rst new file mode 100644 index 00000000..a930e76c --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/foundations.parsers.rst @@ -0,0 +1,30 @@ +_`foundations.parsers` +====================== + +.. automodule:: foundations.parsers + +Module Attributes +----------------- + +.. attribute:: foundations.parsers.LOGGER + +Functions +--------- + +.. autofunction:: getAttributeCompound + +Classes +------- + +.. autoclass:: AttributeCompound + :show-inheritance: + :members: + +.. autoclass:: SectionsFileParser + :show-inheritance: + :members: + +.. autoclass:: PlistFileParser + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/foundations.pkzip.rst b/docs/sphinx/source/resources/pages/api/foundations.pkzip.rst new file mode 100644 index 00000000..1555737b --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/foundations.pkzip.rst @@ -0,0 +1,17 @@ +_`foundations.pkzip` +==================== + +.. automodule:: foundations.pkzip + +Module Attributes +----------------- + +.. attribute:: foundations.pkzip.LOGGER + +Classes +------- + +.. autoclass:: Pkzip + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/foundations.rotatingBackup.rst b/docs/sphinx/source/resources/pages/api/foundations.rotatingBackup.rst new file mode 100644 index 00000000..297b6429 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/foundations.rotatingBackup.rst @@ -0,0 +1,17 @@ +_`foundations.rotatingBackup` +============================= + +.. automodule:: foundations.rotatingBackup + +Module Attributes +----------------- + +.. attribute:: foundations.rotatingBackup.LOGGER + +Classes +------- + +.. autoclass:: RotatingBackup + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/foundations.shell.rst b/docs/sphinx/source/resources/pages/api/foundations.shell.rst new file mode 100644 index 00000000..0cfd153a --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/foundations.shell.rst @@ -0,0 +1,21 @@ +_`foundations.shell` +==================== + +.. automodule:: foundations.shell + +Module Attributes +----------------- + +.. attribute:: foundations.shell.LOGGER + +.. attribute:: foundations.shell.BACKGROUND_ANSI_ESCAPE_CODES + +.. attribute:: foundations.shell.FOREGROUND_ANSI_ESCAPE_CODES + +.. attribute:: foundations.shell.AnsiEscapeCodes + +Functions +--------- + +.. autofunction:: colorize + diff --git a/docs/sphinx/source/resources/pages/api/foundations.strings.rst b/docs/sphinx/source/resources/pages/api/foundations.strings.rst new file mode 100644 index 00000000..b99f9606 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/foundations.strings.rst @@ -0,0 +1,49 @@ +_`foundations.strings` +====================== + +.. automodule:: foundations.strings + +Module Attributes +----------------- + +.. attribute:: foundations.strings.LOGGER + +.. attribute:: foundations.strings.ASCII_CHARACTERS + +Functions +--------- + +.. autofunction:: toString + +.. autofunction:: getNiceName + +.. autofunction:: getVersionRank + +.. autofunction:: getSplitextBasename + +.. autofunction:: getCommonAncestor + +.. autofunction:: getCommonPathsAncestor + +.. autofunction:: getWords + +.. autofunction:: filterWords + +.. autofunction:: replace + +.. autofunction:: removeStrip + +.. autofunction:: toForwardSlashes + +.. autofunction:: toBackwardSlashes + +.. autofunction:: toPosixPath + +.. autofunction:: getNormalizedPath + +.. autofunction:: getRandomSequence + +.. autofunction:: isEmail + +.. autofunction:: isWebsite + diff --git a/docs/sphinx/source/resources/pages/api/foundations.tcpServer.rst b/docs/sphinx/source/resources/pages/api/foundations.tcpServer.rst new file mode 100644 index 00000000..93dda049 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/foundations.tcpServer.rst @@ -0,0 +1,21 @@ +_`foundations.tcpServer` +======================== + +.. automodule:: foundations.tcpServer + +Module Attributes +----------------- + +.. attribute:: foundations.tcpServer.LOGGER + +Classes +------- + +.. autoclass:: EchoRequestsHandler + :show-inheritance: + :members: + +.. autoclass:: TCPServer + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/foundations.trace.rst b/docs/sphinx/source/resources/pages/api/foundations.trace.rst new file mode 100644 index 00000000..817c0739 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/foundations.trace.rst @@ -0,0 +1,95 @@ +_`foundations.trace` +==================== + +.. automodule:: foundations.trace + +Module Attributes +----------------- + +.. attribute:: foundations.trace.REGISTERED_MODULES + +.. attribute:: foundations.trace.TRACER_SYMBOL + +.. attribute:: foundations.trace.UNTRACABLE_SYMBOL + +.. attribute:: foundations.trace.TRACER_HOOK + +.. attribute:: foundations.trace.UNTRACABLE_NAMES + +.. attribute:: foundations.trace.NULL_OBJECT_NAME + +.. attribute:: foundations.trace.TRACE_NAMES_CACHE + +.. attribute:: foundations.trace.TRACE_WALKER_CACHE + +Functions +--------- + +.. autofunction:: isReadOnly + +.. autofunction:: setTracerHook + +.. autofunction:: getTracerHook + +.. autofunction:: isTraced + +.. autofunction:: isBaseTraced + +.. autofunction:: isUntracable + +.. autofunction:: setTraced + +.. autofunction:: setUntraced + +.. autofunction:: setUntracable + +.. autofunction:: traceWalker + +.. autofunction:: getObjectName + +.. autofunction:: getTraceName + +.. autofunction:: getMethodName + +.. autofunction:: isStaticMethod + +.. autofunction:: isClassMethod + +.. autofunction:: formatArgument + +.. autofunction:: validateTracer + +.. autofunction:: tracer + +.. autofunction:: untracer + +.. autofunction:: untracable + +.. autofunction:: traceFunction + +.. autofunction:: untraceFunction + +.. autofunction:: traceMethod + +.. autofunction:: untraceMethod + +.. autofunction:: traceProperty + +.. autofunction:: untraceProperty + +.. autofunction:: traceClass + +.. autofunction:: untraceClass + +.. autofunction:: traceModule + +.. autofunction:: untraceModule + +.. autofunction:: registerModule + +.. autofunction:: installTracer + +.. autofunction:: uninstallTracer + +.. autofunction:: evaluateTraceRequest + diff --git a/docs/sphinx/source/resources/pages/api/foundations.ui.common.rst b/docs/sphinx/source/resources/pages/api/foundations.ui.common.rst new file mode 100644 index 00000000..a6439fc8 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/foundations.ui.common.rst @@ -0,0 +1,21 @@ +_`foundations.ui.common` +======================== + +.. automodule:: foundations.ui.common + +Module Attributes +----------------- + +.. attribute:: foundations.ui.common.LOGGER + +.. attribute:: foundations.ui.common.RESOURCES_DIRECTORY + +.. attribute:: foundations.ui.common.DEFAULT_UI_FILE + +Functions +--------- + +.. autofunction:: centerWidgetOnScreen + +.. autofunction:: QWidgetFactory + diff --git a/docs/sphinx/source/resources/pages/api/foundations.verbose.rst b/docs/sphinx/source/resources/pages/api/foundations.verbose.rst new file mode 100644 index 00000000..c44318e1 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/foundations.verbose.rst @@ -0,0 +1,54 @@ +_`foundations.verbose` +====================== + +.. automodule:: foundations.verbose + +Module Attributes +----------------- + +.. attribute:: foundations.verbose.THREADS_IDENTIFIERS + +.. attribute:: foundations.verbose.INDENT_LEVEL + +.. attribute:: foundations.verbose.LOGGER + +.. attribute:: foundations.verbose.LOGGING_DEFAULT_FORMATTER + +.. attribute:: foundations.verbose.LOGGING_EXTENDED_FORMATTER + +.. attribute:: foundations.verbose.LOGGING_STANDARD_FORMATTER + +.. attribute:: foundations.verbose.TRACER_LOGGING_FUNCTION + +Functions +--------- + +.. autofunction:: indentMessage + +.. autofunction:: tracer + +.. autofunction:: installLogger + +.. autofunction:: uninstallLogger + +.. autofunction:: getLoggingConsoleHandler + +.. autofunction:: getLoggingFileHandler + +.. autofunction:: getLoggingStreamHandler + +.. autofunction:: removeLoggingHandler + +.. autofunction:: setVerbosityLevel + +Classes +------- + +.. autoclass:: Streamer + :show-inheritance: + :members: + +.. autoclass:: StandardOutputStreamer + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/foundations.walkers.rst b/docs/sphinx/source/resources/pages/api/foundations.walkers.rst new file mode 100644 index 00000000..487c7af4 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/foundations.walkers.rst @@ -0,0 +1,21 @@ +_`foundations.walkers` +====================== + +.. automodule:: foundations.walkers + +Module Attributes +----------------- + +.. attribute:: foundations.walkers.LOGGER + +Functions +--------- + +.. autofunction:: filesWalker + +.. autofunction:: depthWalker + +.. autofunction:: dictionariesWalker + +.. autofunction:: nodesWalker + diff --git a/docs/sphinx/source/resources/pages/api/manager.component.rst b/docs/sphinx/source/resources/pages/api/manager.component.rst new file mode 100644 index 00000000..acea4a8f --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/manager.component.rst @@ -0,0 +1,17 @@ +_`manager.component` +==================== + +.. automodule:: manager.component + +Module Attributes +----------------- + +.. attribute:: manager.component.LOGGER + +Classes +------- + +.. autoclass:: Component + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/manager.componentsManager.rst b/docs/sphinx/source/resources/pages/api/manager.componentsManager.rst new file mode 100644 index 00000000..2377e5da --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/manager.componentsManager.rst @@ -0,0 +1,25 @@ +_`manager.componentsManager` +============================ + +.. automodule:: manager.componentsManager + +Module Attributes +----------------- + +.. attribute:: manager.componentsManager.LOGGER + +Classes +------- + +.. autoclass:: Components + :show-inheritance: + :members: + +.. autoclass:: Profile + :show-inheritance: + :members: + +.. autoclass:: Manager + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/manager.exceptions.rst b/docs/sphinx/source/resources/pages/api/manager.exceptions.rst new file mode 100644 index 00000000..6cca0ac5 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/manager.exceptions.rst @@ -0,0 +1,48 @@ +_`manager.exceptions` +===================== + +.. automodule:: manager.exceptions + +Classes +------- + +.. autoclass:: AbstractComponentsManagerError + :show-inheritance: + :members: + +.. autoclass:: ComponentProfileError + :show-inheritance: + :members: + +.. autoclass:: ComponentModuleError + :show-inheritance: + :members: + +.. autoclass:: ComponentRegistrationError + :show-inheritance: + :members: + +.. autoclass:: ComponentInterfaceError + :show-inheritance: + :members: + +.. autoclass:: ComponentInstantiationError + :show-inheritance: + :members: + +.. autoclass:: ComponentActivationError + :show-inheritance: + :members: + +.. autoclass:: ComponentDeactivationError + :show-inheritance: + :members: + +.. autoclass:: ComponentReloadError + :show-inheritance: + :members: + +.. autoclass:: ComponentExistsError + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/manager.globals.constants.rst b/docs/sphinx/source/resources/pages/api/manager.globals.constants.rst new file mode 100644 index 00000000..bf96f068 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/manager.globals.constants.rst @@ -0,0 +1,12 @@ +_`manager.globals.constants` +============================ + +.. automodule:: manager.globals.constants + +Classes +------- + +.. autoclass:: Constants + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/manager.qobjectComponent.rst b/docs/sphinx/source/resources/pages/api/manager.qobjectComponent.rst new file mode 100644 index 00000000..cefd428f --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/manager.qobjectComponent.rst @@ -0,0 +1,17 @@ +_`manager.qobjectComponent` +=========================== + +.. automodule:: manager.qobjectComponent + +Module Attributes +----------------- + +.. attribute:: manager.qobjectComponent.LOGGER + +Classes +------- + +.. autoclass:: QObjectComponent + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/manager.qwidgetComponent.rst b/docs/sphinx/source/resources/pages/api/manager.qwidgetComponent.rst new file mode 100644 index 00000000..672819c6 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/manager.qwidgetComponent.rst @@ -0,0 +1,15 @@ +_`manager.qwidgetComponent` +=========================== + +.. automodule:: manager.qwidgetComponent + +Module Attributes +----------------- + +.. attribute:: manager.qwidgetComponent.LOGGER + +Functions +--------- + +.. autofunction:: QWidgetComponentFactory + diff --git a/docs/sphinx/source/resources/pages/api/oncilla.buildApi.rst b/docs/sphinx/source/resources/pages/api/oncilla.buildApi.rst new file mode 100644 index 00000000..ae908e32 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/oncilla.buildApi.rst @@ -0,0 +1,29 @@ +_`oncilla.buildApi` +=================== + +.. automodule:: oncilla.buildApi + +Module Attributes +----------------- + +.. attribute:: oncilla.buildApi.LOGGER + +.. attribute:: oncilla.buildApi.FILES_EXTENSION + +.. attribute:: oncilla.buildApi.TOCTREE_TEMPLATE_BEGIN + +.. attribute:: oncilla.buildApi.TOCTREE_TEMPLATE_END + +.. attribute:: oncilla.buildApi.SANITIZER + +Functions +--------- + +.. autofunction:: importSanitizer + +.. autofunction:: buildApi + +.. autofunction:: getCommandLineArguments + +.. autofunction:: main + diff --git a/docs/sphinx/source/resources/pages/api/oncilla.buildTocTree.rst b/docs/sphinx/source/resources/pages/api/oncilla.buildTocTree.rst new file mode 100644 index 00000000..2061360a --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/oncilla.buildTocTree.rst @@ -0,0 +1,25 @@ +_`oncilla.buildTocTree` +======================= + +.. automodule:: oncilla.buildTocTree + +Module Attributes +----------------- + +.. attribute:: oncilla.buildTocTree.LOGGER + +.. attribute:: oncilla.buildTocTree.FILES_EXTENSION + +.. attribute:: oncilla.buildTocTree.TOCTREE_TEMPLATE_BEGIN + +.. attribute:: oncilla.buildTocTree.TOCTREE_TEMPLATE_END + +Functions +--------- + +.. autofunction:: buildTocTree + +.. autofunction:: getCommandLineArguments + +.. autofunction:: main + diff --git a/docs/sphinx/source/resources/pages/api/oncilla.defaultSanitizer.rst b/docs/sphinx/source/resources/pages/api/oncilla.defaultSanitizer.rst new file mode 100644 index 00000000..af11443c --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/oncilla.defaultSanitizer.rst @@ -0,0 +1,19 @@ +_`oncilla.defaultSanitizer` +=========================== + +.. automodule:: oncilla.defaultSanitizer + +Module Attributes +----------------- + +.. attribute:: oncilla.defaultSanitizer.LOGGER + +.. attribute:: oncilla.defaultSanitizer.STATEMENT_UPDATE_MESSAGE + +.. attribute:: oncilla.defaultSanitizer.STATEMENT_SUBSTITUTE + +Functions +--------- + +.. autofunction:: bleach + diff --git a/docs/sphinx/source/resources/pages/api/oncilla.globals.constants.rst b/docs/sphinx/source/resources/pages/api/oncilla.globals.constants.rst new file mode 100644 index 00000000..490446fa --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/oncilla.globals.constants.rst @@ -0,0 +1,12 @@ +_`oncilla.globals.constants` +============================ + +.. automodule:: oncilla.globals.constants + +Classes +------- + +.. autoclass:: Constants + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/oncilla.reStructuredTextToHtml.rst b/docs/sphinx/source/resources/pages/api/oncilla.reStructuredTextToHtml.rst new file mode 100644 index 00000000..c29807f3 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/oncilla.reStructuredTextToHtml.rst @@ -0,0 +1,27 @@ +_`oncilla.reStructuredTextToHtml` +================================= + +.. automodule:: oncilla.reStructuredTextToHtml + +Module Attributes +----------------- + +.. attribute:: oncilla.reStructuredTextToHtml.LOGGER + +.. attribute:: oncilla.reStructuredTextToHtml.RESOURCES_DIRECTORY + +.. attribute:: oncilla.reStructuredTextToHtml.CSS_FILE + +.. attribute:: oncilla.reStructuredTextToHtml.TIDY_SETTINGS_FILE + +.. attribute:: oncilla.reStructuredTextToHtml.RST2HTML + +Functions +--------- + +.. autofunction:: reStructuredTextToHtml + +.. autofunction:: getCommandLineArguments + +.. autofunction:: main + diff --git a/docs/sphinx/source/resources/pages/api/oncilla.sliceReStructuredText.rst b/docs/sphinx/source/resources/pages/api/oncilla.sliceReStructuredText.rst new file mode 100644 index 00000000..b85ec26c --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/oncilla.sliceReStructuredText.rst @@ -0,0 +1,27 @@ +_`oncilla.sliceReStructuredText` +================================ + +.. automodule:: oncilla.sliceReStructuredText + +Module Attributes +----------------- + +.. attribute:: oncilla.sliceReStructuredText.LOGGER + +.. attribute:: oncilla.sliceReStructuredText.OUTPUT_FILES_EXTENSION + +.. attribute:: oncilla.sliceReStructuredText.SLICE_ATTRIBUTE_INDENT + +.. attribute:: oncilla.sliceReStructuredText.CONTENT_DELETION + +.. attribute:: oncilla.sliceReStructuredText.STATEMENT_SUBSTITUTE + +Functions +--------- + +.. autofunction:: sliceReStructuredText + +.. autofunction:: getCommandLineArguments + +.. autofunction:: main + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.about.about.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.about.about.rst new file mode 100644 index 00000000..32ff3f98 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.about.about.rst @@ -0,0 +1,21 @@ +_`sibl_gui.components.addons.about.about` +========================================= + +.. automodule:: sibl_gui.components.addons.about.about + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.addons.about.about.LOGGER + +.. attribute:: sibl_gui.components.addons.about.about.COMPONENT_UI_FILE + +.. attribute:: sibl_gui.components.addons.about.about.ABOUT_MESSAGE + +Classes +------- + +.. autoclass:: About + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.cachesOperations.cachesOperations.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.cachesOperations.cachesOperations.rst new file mode 100644 index 00000000..e0415714 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.cachesOperations.cachesOperations.rst @@ -0,0 +1,19 @@ +_`sibl_gui.components.addons.cachesOperations.cachesOperations` +=============================================================== + +.. automodule:: sibl_gui.components.addons.cachesOperations.cachesOperations + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.addons.cachesOperations.cachesOperations.LOGGER + +.. attribute:: sibl_gui.components.addons.cachesOperations.cachesOperations.COMPONENT_UI_FILE + +Classes +------- + +.. autoclass:: CachesOperations + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.databaseOperations.databaseOperations.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.databaseOperations.databaseOperations.rst new file mode 100644 index 00000000..b0bd2b75 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.databaseOperations.databaseOperations.rst @@ -0,0 +1,23 @@ +_`sibl_gui.components.addons.databaseOperations.databaseOperations` +=================================================================== + +.. automodule:: sibl_gui.components.addons.databaseOperations.databaseOperations + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.addons.databaseOperations.databaseOperations.LOGGER + +.. attribute:: sibl_gui.components.addons.databaseOperations.databaseOperations.COMPONENT_UI_FILE + +Classes +------- + +.. autoclass:: DatabaseType + :show-inheritance: + :members: + +.. autoclass:: DatabaseOperations + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.gpsMap.gpsMap.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.gpsMap.gpsMap.rst new file mode 100644 index 00000000..9b6a3ca8 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.gpsMap.gpsMap.rst @@ -0,0 +1,19 @@ +_`sibl_gui.components.addons.gpsMap.gpsMap` +=========================================== + +.. automodule:: sibl_gui.components.addons.gpsMap.gpsMap + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.addons.gpsMap.gpsMap.LOGGER + +.. attribute:: sibl_gui.components.addons.gpsMap.gpsMap.COMPONENT_FILE + +Classes +------- + +.. autoclass:: GpsMap + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.gpsMap.views.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.gpsMap.views.rst new file mode 100644 index 00000000..7545e679 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.gpsMap.views.rst @@ -0,0 +1,17 @@ +_`sibl_gui.components.addons.gpsMap.views` +========================================== + +.. automodule:: sibl_gui.components.addons.gpsMap.views + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.addons.gpsMap.views.LOGGER + +Classes +------- + +.. autoclass:: Map_QWebView + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.iblSetsScanner.iblSetsScanner.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.iblSetsScanner.iblSetsScanner.rst new file mode 100644 index 00000000..03701683 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.iblSetsScanner.iblSetsScanner.rst @@ -0,0 +1,17 @@ +_`sibl_gui.components.addons.iblSetsScanner.iblSetsScanner` +=========================================================== + +.. automodule:: sibl_gui.components.addons.iblSetsScanner.iblSetsScanner + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.addons.iblSetsScanner.iblSetsScanner.LOGGER + +Classes +------- + +.. autoclass:: IblSetsScanner + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.iblSetsScanner.workers.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.iblSetsScanner.workers.rst new file mode 100644 index 00000000..a627be15 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.iblSetsScanner.workers.rst @@ -0,0 +1,17 @@ +_`sibl_gui.components.addons.iblSetsScanner.workers` +==================================================== + +.. automodule:: sibl_gui.components.addons.iblSetsScanner.workers + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.addons.iblSetsScanner.workers.LOGGER + +Classes +------- + +.. autoclass:: IblSetsScanner_worker + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loaderScript.loaderScript.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loaderScript.loaderScript.rst new file mode 100644 index 00000000..933bc1ba --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loaderScript.loaderScript.rst @@ -0,0 +1,19 @@ +_`sibl_gui.components.addons.loaderScript.loaderScript` +======================================================= + +.. automodule:: sibl_gui.components.addons.loaderScript.loaderScript + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.addons.loaderScript.loaderScript.LOGGER + +.. attribute:: sibl_gui.components.addons.loaderScript.loaderScript.COMPONENT_FILE + +Classes +------- + +.. autoclass:: LoaderScript + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loaderScriptOptions.loaderScriptOptions.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loaderScriptOptions.loaderScriptOptions.rst new file mode 100644 index 00000000..3b6a643f --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loaderScriptOptions.loaderScriptOptions.rst @@ -0,0 +1,19 @@ +_`sibl_gui.components.addons.loaderScriptOptions.loaderScriptOptions` +===================================================================== + +.. automodule:: sibl_gui.components.addons.loaderScriptOptions.loaderScriptOptions + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.addons.loaderScriptOptions.loaderScriptOptions.LOGGER + +.. attribute:: sibl_gui.components.addons.loaderScriptOptions.loaderScriptOptions.COMPONENT_UI_FILE + +Classes +------- + +.. autoclass:: LoaderScriptOptions + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loaderScriptOptions.views.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loaderScriptOptions.views.rst new file mode 100644 index 00000000..09cf5ec1 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loaderScriptOptions.views.rst @@ -0,0 +1,17 @@ +_`sibl_gui.components.addons.loaderScriptOptions.views` +======================================================= + +.. automodule:: sibl_gui.components.addons.loaderScriptOptions.views + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.addons.loaderScriptOptions.views.LOGGER + +Classes +------- + +.. autoclass:: TemplatesAttributes_QTableWidget + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.locationsBrowser.locationsBrowser.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.locationsBrowser.locationsBrowser.rst new file mode 100644 index 00000000..0783e72e --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.locationsBrowser.locationsBrowser.rst @@ -0,0 +1,19 @@ +_`sibl_gui.components.addons.locationsBrowser.locationsBrowser` +=============================================================== + +.. automodule:: sibl_gui.components.addons.locationsBrowser.locationsBrowser + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.addons.locationsBrowser.locationsBrowser.LOGGER + +.. attribute:: sibl_gui.components.addons.locationsBrowser.locationsBrowser.COMPONENT_UI_FILE + +Classes +------- + +.. autoclass:: LocationsBrowser + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loggingNotifier.loggingNotifier.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loggingNotifier.loggingNotifier.rst new file mode 100644 index 00000000..6a5d463c --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.loggingNotifier.loggingNotifier.rst @@ -0,0 +1,17 @@ +_`sibl_gui.components.addons.loggingNotifier.loggingNotifier` +============================================================= + +.. automodule:: sibl_gui.components.addons.loggingNotifier.loggingNotifier + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.addons.loggingNotifier.loggingNotifier.LOGGER + +Classes +------- + +.. autoclass:: LoggingNotifier + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.downloadManager.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.downloadManager.rst new file mode 100644 index 00000000..f9aa8a9d --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.downloadManager.rst @@ -0,0 +1,19 @@ +_`sibl_gui.components.addons.onlineUpdater.downloadManager` +=========================================================== + +.. automodule:: sibl_gui.components.addons.onlineUpdater.downloadManager + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.addons.onlineUpdater.downloadManager.LOGGER + +.. attribute:: sibl_gui.components.addons.onlineUpdater.downloadManager.UI_FILE + +Classes +------- + +.. autoclass:: DownloadManager + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.onlineUpdater.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.onlineUpdater.rst new file mode 100644 index 00000000..a54e416b --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.onlineUpdater.rst @@ -0,0 +1,21 @@ +_`sibl_gui.components.addons.onlineUpdater.onlineUpdater` +========================================================= + +.. automodule:: sibl_gui.components.addons.onlineUpdater.onlineUpdater + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.addons.onlineUpdater.onlineUpdater.LOGGER + +.. attribute:: sibl_gui.components.addons.onlineUpdater.onlineUpdater.COMPONENT_UI_FILE + +.. attribute:: sibl_gui.components.addons.onlineUpdater.onlineUpdater.REPOSITORY_URL + +Classes +------- + +.. autoclass:: OnlineUpdater + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.remoteUpdater.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.remoteUpdater.rst new file mode 100644 index 00000000..8ae641b4 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.remoteUpdater.rst @@ -0,0 +1,23 @@ +_`sibl_gui.components.addons.onlineUpdater.remoteUpdater` +========================================================= + +.. automodule:: sibl_gui.components.addons.onlineUpdater.remoteUpdater + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.addons.onlineUpdater.remoteUpdater.LOGGER + +.. attribute:: sibl_gui.components.addons.onlineUpdater.remoteUpdater.UI_FILE + +Classes +------- + +.. autoclass:: ReleaseObject + :show-inheritance: + :members: + +.. autoclass:: RemoteUpdater + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.views.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.views.rst new file mode 100644 index 00000000..7a327999 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.onlineUpdater.views.rst @@ -0,0 +1,17 @@ +_`sibl_gui.components.addons.onlineUpdater.views` +================================================= + +.. automodule:: sibl_gui.components.addons.onlineUpdater.views + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.addons.onlineUpdater.views.LOGGER + +Classes +------- + +.. autoclass:: TemplatesReleases_QTableWidget + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.preview.imagesPreviewer.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.preview.imagesPreviewer.rst new file mode 100644 index 00000000..f36f7bcc --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.preview.imagesPreviewer.rst @@ -0,0 +1,23 @@ +_`sibl_gui.components.addons.preview.imagesPreviewer` +===================================================== + +.. automodule:: sibl_gui.components.addons.preview.imagesPreviewer + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.addons.preview.imagesPreviewer.LOGGER + +.. attribute:: sibl_gui.components.addons.preview.imagesPreviewer.UI_FILE + +Classes +------- + +.. autoclass:: Image_QGraphicsItem + :show-inheritance: + :members: + +.. autoclass:: ImagesPreviewer + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.preview.preview.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.preview.preview.rst new file mode 100644 index 00000000..89f5b5a3 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.preview.preview.rst @@ -0,0 +1,19 @@ +_`sibl_gui.components.addons.preview.preview` +============================================= + +.. automodule:: sibl_gui.components.addons.preview.preview + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.addons.preview.preview.LOGGER + +.. attribute:: sibl_gui.components.addons.preview.preview.COMPONENT_UI_FILE + +Classes +------- + +.. autoclass:: Preview + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.rawEditingUtilities.rawEditingUtilities.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.rawEditingUtilities.rawEditingUtilities.rst new file mode 100644 index 00000000..ec547bb2 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.rawEditingUtilities.rawEditingUtilities.rst @@ -0,0 +1,19 @@ +_`sibl_gui.components.addons.rawEditingUtilities.rawEditingUtilities` +===================================================================== + +.. automodule:: sibl_gui.components.addons.rawEditingUtilities.rawEditingUtilities + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.addons.rawEditingUtilities.rawEditingUtilities.LOGGER + +.. attribute:: sibl_gui.components.addons.rawEditingUtilities.rawEditingUtilities.COMPONENT_UI_FILE + +Classes +------- + +.. autoclass:: RawEditingUtilities + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.rewiringTool.rewiringTool.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.rewiringTool.rewiringTool.rst new file mode 100644 index 00000000..d91231c4 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.rewiringTool.rewiringTool.rst @@ -0,0 +1,19 @@ +_`sibl_gui.components.addons.rewiringTool.rewiringTool` +======================================================= + +.. automodule:: sibl_gui.components.addons.rewiringTool.rewiringTool + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.addons.rewiringTool.rewiringTool.LOGGER + +.. attribute:: sibl_gui.components.addons.rewiringTool.rewiringTool.COMPONENT_UI_FILE + +Classes +------- + +.. autoclass:: RewiringTool + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.sIBLeditUtilities.sIBLeditUtilities.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.sIBLeditUtilities.sIBLeditUtilities.rst new file mode 100644 index 00000000..915acc47 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.sIBLeditUtilities.sIBLeditUtilities.rst @@ -0,0 +1,19 @@ +_`sibl_gui.components.addons.sIBLeditUtilities.sIBLeditUtilities` +================================================================= + +.. automodule:: sibl_gui.components.addons.sIBLeditUtilities.sIBLeditUtilities + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.addons.sIBLeditUtilities.sIBLeditUtilities.LOGGER + +.. attribute:: sibl_gui.components.addons.sIBLeditUtilities.sIBLeditUtilities.COMPONENT_UI_FILE + +Classes +------- + +.. autoclass:: sIBLeditUtilities + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.searchDatabase.searchDatabase.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.searchDatabase.searchDatabase.rst new file mode 100644 index 00000000..fd710d7a --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.searchDatabase.searchDatabase.rst @@ -0,0 +1,19 @@ +_`sibl_gui.components.addons.searchDatabase.searchDatabase` +=========================================================== + +.. automodule:: sibl_gui.components.addons.searchDatabase.searchDatabase + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.addons.searchDatabase.searchDatabase.LOGGER + +.. attribute:: sibl_gui.components.addons.searchDatabase.searchDatabase.COMPONENT_UI_FILE + +Classes +------- + +.. autoclass:: SearchDatabase + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.searchDatabase.views.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.searchDatabase.views.rst new file mode 100644 index 00000000..b1dfd64f --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.addons.searchDatabase.views.rst @@ -0,0 +1,17 @@ +_`sibl_gui.components.addons.searchDatabase.views` +================================================== + +.. automodule:: sibl_gui.components.addons.searchDatabase.views + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.addons.searchDatabase.views.LOGGER + +Classes +------- + +.. autoclass:: TagsCloud_QListView + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.collectionsOutliner.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.collectionsOutliner.rst new file mode 100644 index 00000000..2c06b757 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.collectionsOutliner.rst @@ -0,0 +1,19 @@ +_`sibl_gui.components.core.collectionsOutliner.collectionsOutliner` +=================================================================== + +.. automodule:: sibl_gui.components.core.collectionsOutliner.collectionsOutliner + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.core.collectionsOutliner.collectionsOutliner.LOGGER + +.. attribute:: sibl_gui.components.core.collectionsOutliner.collectionsOutliner.COMPONENT_UI_FILE + +Classes +------- + +.. autoclass:: CollectionsOutliner + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.models.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.models.rst new file mode 100644 index 00000000..c0425ad8 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.models.rst @@ -0,0 +1,17 @@ +_`sibl_gui.components.core.collectionsOutliner.models` +====================================================== + +.. automodule:: sibl_gui.components.core.collectionsOutliner.models + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.core.collectionsOutliner.models.LOGGER + +Classes +------- + +.. autoclass:: CollectionsModel + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.nodes.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.nodes.rst new file mode 100644 index 00000000..98b23234 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.nodes.rst @@ -0,0 +1,17 @@ +_`sibl_gui.components.core.collectionsOutliner.nodes` +===================================================== + +.. automodule:: sibl_gui.components.core.collectionsOutliner.nodes + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.core.collectionsOutliner.nodes.LOGGER + +Classes +------- + +.. autoclass:: OverallCollectionNode + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.views.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.views.rst new file mode 100644 index 00000000..9a981803 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.collectionsOutliner.views.rst @@ -0,0 +1,17 @@ +_`sibl_gui.components.core.collectionsOutliner.views` +===================================================== + +.. automodule:: sibl_gui.components.core.collectionsOutliner.views + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.core.collectionsOutliner.views.LOGGER + +Classes +------- + +.. autoclass:: IblSetsCollections_QTreeView + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.database.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.database.rst new file mode 100644 index 00000000..31f9e28f --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.database.rst @@ -0,0 +1,17 @@ +_`sibl_gui.components.core.database.database` +============================================= + +.. automodule:: sibl_gui.components.core.database.database + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.core.database.database.LOGGER + +Classes +------- + +.. autoclass:: Database + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.exceptions.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.exceptions.rst new file mode 100644 index 00000000..98ddf8a1 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.exceptions.rst @@ -0,0 +1,56 @@ +_`sibl_gui.components.core.database.exceptions` +=============================================== + +.. automodule:: sibl_gui.components.core.database.exceptions + +Classes +------- + +.. autoclass:: AbstractDatabaseError + :show-inheritance: + :members: + +.. autoclass:: DatabaseOperationError + :show-inheritance: + :members: + +.. autoclass:: AbstractIblSetError + :show-inheritance: + :members: + +.. autoclass:: MissingIblSetFileError + :show-inheritance: + :members: + +.. autoclass:: MissingIblSetIconError + :show-inheritance: + :members: + +.. autoclass:: MissingIblSetPreviewImageError + :show-inheritance: + :members: + +.. autoclass:: MissingIblSetBackgroundImageError + :show-inheritance: + :members: + +.. autoclass:: MissingIblSetLightingImageError + :show-inheritance: + :members: + +.. autoclass:: MissingIblSetReflectionImageError + :show-inheritance: + :members: + +.. autoclass:: AbstractTemplateError + :show-inheritance: + :members: + +.. autoclass:: MissingTemplateFileError + :show-inheritance: + :members: + +.. autoclass:: MissingTemplateHelpFileError + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.nodes.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.nodes.rst new file mode 100644 index 00000000..ffeaef56 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.nodes.rst @@ -0,0 +1,34 @@ +_`sibl_gui.components.core.database.nodes` +========================================== + +.. automodule:: sibl_gui.components.core.database.nodes + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.core.database.nodes.LOGGER + +Functions +--------- + +.. autofunction:: getTemplateUserName + +Classes +------- + +.. autoclass:: AbstractDatabaseNode + :show-inheritance: + :members: + +.. autoclass:: IblSetNode + :show-inheritance: + :members: + +.. autoclass:: TemplateNode + :show-inheritance: + :members: + +.. autoclass:: CollectionNode + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.operations.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.operations.rst new file mode 100644 index 00000000..84ef6535 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.operations.rst @@ -0,0 +1,99 @@ +_`sibl_gui.components.core.database.operations` +=============================================== + +.. automodule:: sibl_gui.components.core.database.operations + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.core.database.operations.LOGGER + +.. attribute:: sibl_gui.components.core.database.operations.DATABASE_EXCEPTIONS + +.. attribute:: sibl_gui.components.core.database.operations.DEFAULT_SESSION_MAKER + +.. attribute:: sibl_gui.components.core.database.operations.DEFAULT_SESSION + +Functions +--------- + +.. autofunction:: createSession + +.. autofunction:: getSession + +.. autofunction:: query + +.. autofunction:: commit + +.. autofunction:: addItem + +.. autofunction:: addStandardItem + +.. autofunction:: removeItem + +.. autofunction:: removeStandardItem + +.. autofunction:: updateItemContent + +.. autofunction:: updateItemLocation + +.. autofunction:: filterItems + +.. autofunction:: itemExists + +.. autofunction:: getIblSets + +.. autofunction:: filterIblSets + +.. autofunction:: iblSetExists + +.. autofunction:: addIblSet + +.. autofunction:: removeIblSet + +.. autofunction:: updateIblSetContent + +.. autofunction:: updateIblSetLocation + +.. autofunction:: checkIblSetsTableIntegrity + +.. autofunction:: getCollections + +.. autofunction:: filterCollections + +.. autofunction:: getCollectionsByType + +.. autofunction:: filterCollectionsByType + +.. autofunction:: filterIblSetsCollections + +.. autofunction:: filterTemplatesCollections + +.. autofunction:: collectionExists + +.. autofunction:: addCollection + +.. autofunction:: removeCollection + +.. autofunction:: getCollectionsIblSets + +.. autofunction:: getCollectionIblSetsCount + +.. autofunction:: getCollectionTemplatesCount + +.. autofunction:: getTemplates + +.. autofunction:: filterTemplates + +.. autofunction:: templateExists + +.. autofunction:: addTemplate + +.. autofunction:: removeTemplate + +.. autofunction:: updateTemplateContent + +.. autofunction:: updateTemplateLocation + +.. autofunction:: checkTemplatesTableIntegrity + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.types.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.types.rst new file mode 100644 index 00000000..ca8b86d4 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.database.types.rst @@ -0,0 +1,27 @@ +_`sibl_gui.components.core.database.types` +========================================== + +.. automodule:: sibl_gui.components.core.database.types + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.core.database.types.LOGGER + +.. attribute:: sibl_gui.components.core.database.types.Base + +Classes +------- + +.. autoclass:: IblSet + :show-inheritance: + :members: + +.. autoclass:: Template + :show-inheritance: + :members: + +.. autoclass:: Collection + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner.rst new file mode 100644 index 00000000..bb9fb036 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner.rst @@ -0,0 +1,19 @@ +_`sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner` +=========================================================== + +.. automodule:: sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner.LOGGER + +.. attribute:: sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner.COMPONENT_UI_FILE + +Classes +------- + +.. autoclass:: IblSetsOutliner + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.iblSetsOutliner.models.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.iblSetsOutliner.models.rst new file mode 100644 index 00000000..4ecfa465 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.iblSetsOutliner.models.rst @@ -0,0 +1,17 @@ +_`sibl_gui.components.core.iblSetsOutliner.models` +================================================== + +.. automodule:: sibl_gui.components.core.iblSetsOutliner.models + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.core.iblSetsOutliner.models.LOGGER + +Classes +------- + +.. autoclass:: IblSetsModel + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.iblSetsOutliner.views.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.iblSetsOutliner.views.rst new file mode 100644 index 00000000..ca4da7d7 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.iblSetsOutliner.views.rst @@ -0,0 +1,21 @@ +_`sibl_gui.components.core.iblSetsOutliner.views` +================================================= + +.. automodule:: sibl_gui.components.core.iblSetsOutliner.views + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.core.iblSetsOutliner.views.LOGGER + +Classes +------- + +.. autoclass:: Thumbnails_QListView + :show-inheritance: + :members: + +.. autoclass:: Details_QTreeView + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.inspector.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.inspector.rst new file mode 100644 index 00000000..0870c7b9 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.inspector.rst @@ -0,0 +1,27 @@ +_`sibl_gui.components.core.inspector.inspector` +=============================================== + +.. automodule:: sibl_gui.components.core.inspector.inspector + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.core.inspector.inspector.LOGGER + +.. attribute:: sibl_gui.components.core.inspector.inspector.COMPONENT_UI_FILE + +Classes +------- + +.. autoclass:: Plate + :show-inheritance: + :members: + +.. autoclass:: Light + :show-inheritance: + :members: + +.. autoclass:: Inspector + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.models.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.models.rst new file mode 100644 index 00000000..2781c86e --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.models.rst @@ -0,0 +1,17 @@ +_`sibl_gui.components.core.inspector.models` +============================================ + +.. automodule:: sibl_gui.components.core.inspector.models + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.core.inspector.models.LOGGER + +Classes +------- + +.. autoclass:: PlatesModel + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.nodes.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.nodes.rst new file mode 100644 index 00000000..976f0d29 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.nodes.rst @@ -0,0 +1,17 @@ +_`sibl_gui.components.core.inspector.nodes` +=========================================== + +.. automodule:: sibl_gui.components.core.inspector.nodes + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.core.inspector.nodes.LOGGER + +Classes +------- + +.. autoclass:: PlatesNode + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.views.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.views.rst new file mode 100644 index 00000000..f0f07238 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.inspector.views.rst @@ -0,0 +1,17 @@ +_`sibl_gui.components.core.inspector.views` +=========================================== + +.. automodule:: sibl_gui.components.core.inspector.views + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.core.inspector.views.LOGGER + +Classes +------- + +.. autoclass:: Plates_QListView + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.models.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.models.rst new file mode 100644 index 00000000..cd86dced --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.models.rst @@ -0,0 +1,17 @@ +_`sibl_gui.components.core.templatesOutliner.models` +==================================================== + +.. automodule:: sibl_gui.components.core.templatesOutliner.models + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.core.templatesOutliner.models.LOGGER + +Classes +------- + +.. autoclass:: TemplatesModel + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.nodes.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.nodes.rst new file mode 100644 index 00000000..61b3277c --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.nodes.rst @@ -0,0 +1,17 @@ +_`sibl_gui.components.core.templatesOutliner.nodes` +=================================================== + +.. automodule:: sibl_gui.components.core.templatesOutliner.nodes + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.core.templatesOutliner.nodes.LOGGER + +Classes +------- + +.. autoclass:: SoftwareNode + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.templatesOutliner.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.templatesOutliner.rst new file mode 100644 index 00000000..619da029 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.templatesOutliner.rst @@ -0,0 +1,19 @@ +_`sibl_gui.components.core.templatesOutliner.templatesOutliner` +=============================================================== + +.. automodule:: sibl_gui.components.core.templatesOutliner.templatesOutliner + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.core.templatesOutliner.templatesOutliner.LOGGER + +.. attribute:: sibl_gui.components.core.templatesOutliner.templatesOutliner.COMPONENT_UI_FILE + +Classes +------- + +.. autoclass:: TemplatesOutliner + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.views.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.views.rst new file mode 100644 index 00000000..c18ad58b --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.components.core.templatesOutliner.views.rst @@ -0,0 +1,17 @@ +_`sibl_gui.components.core.templatesOutliner.views` +=================================================== + +.. automodule:: sibl_gui.components.core.templatesOutliner.views + +Module Attributes +----------------- + +.. attribute:: sibl_gui.components.core.templatesOutliner.views.LOGGER + +Classes +------- + +.. autoclass:: Templates_QTreeView + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.exceptions.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.exceptions.rst new file mode 100644 index 00000000..599f6602 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.exceptions.rst @@ -0,0 +1,36 @@ +_`sibl_gui.exceptions` +====================== + +.. automodule:: sibl_gui.exceptions + +Classes +------- + +.. autoclass:: AbstractNetworkError + :show-inheritance: + :members: + +.. autoclass:: NetworkError + :show-inheritance: + :members: + +.. autoclass:: SocketConnectionError + :show-inheritance: + :members: + +.. autoclass:: Win32OLEServerConnectionError + :show-inheritance: + :members: + +.. autoclass:: AbstractCacheError + :show-inheritance: + :members: + +.. autoclass:: CacheExistsError + :show-inheritance: + :members: + +.. autoclass:: CacheOperationError + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.globals.constants.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.globals.constants.rst new file mode 100644 index 00000000..40bbc4e0 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.globals.constants.rst @@ -0,0 +1,12 @@ +_`sibl_gui.globals.constants` +============================= + +.. automodule:: sibl_gui.globals.constants + +Classes +------- + +.. autoclass:: Constants + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.globals.runtimeGlobals.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.globals.runtimeGlobals.rst new file mode 100644 index 00000000..f9cd2f54 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.globals.runtimeGlobals.rst @@ -0,0 +1,12 @@ +_`sibl_gui.globals.runtimeGlobals` +================================== + +.. automodule:: sibl_gui.globals.runtimeGlobals + +Classes +------- + +.. autoclass:: RuntimeGlobals + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.globals.uiConstants.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.globals.uiConstants.rst new file mode 100644 index 00000000..7dbe4ec4 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.globals.uiConstants.rst @@ -0,0 +1,12 @@ +_`sibl_gui.globals.uiConstants` +=============================== + +.. automodule:: sibl_gui.globals.uiConstants + +Classes +------- + +.. autoclass:: UiConstants + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.launcher.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.launcher.rst new file mode 100644 index 00000000..8b0b76ac --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.launcher.rst @@ -0,0 +1,24 @@ +_`sibl_gui.launcher` +==================== + +.. automodule:: sibl_gui.launcher + +Module Attributes +----------------- + +.. attribute:: sibl_gui.launcher.LOGGER + +Functions +--------- + +.. autofunction:: extendCommandLineParametersParser + +.. autofunction:: main + +Classes +------- + +.. autoclass:: sIBL_GUI + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.libraries.freeImage.freeImage.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.libraries.freeImage.freeImage.rst new file mode 100644 index 00000000..849c6263 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.libraries.freeImage.freeImage.rst @@ -0,0 +1,740 @@ +_`sibl_gui.libraries.freeImage.freeImage` +========================================= + +.. automodule:: sibl_gui.libraries.freeImage.freeImage + +Module Attributes +----------------- + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.LOGGER + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREEIMAGE_LIBRARY_PATH + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREEIMAGE_MAJOR_VERSION + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREEIMAGE_MINOR_VERSION + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREEIMAGE_RELEASE_SERIAL + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREEIMAGE_LOOKUP + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.INT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.BOOL + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.BYTE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.WORD + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.DWORD + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.LONG + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.DOUBLE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.BYTE_P + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREEIMAGE_COLORORDER_BGR + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREEIMAGE_COLORORDER_RGB + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.RGBQUAD + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.RGBTRIPLE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.BITMAPINFOHEADER + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.BITMAPINFO + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.PBITMAPINFO + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIRGB16 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIRGBA16 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIRGBF + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIRGBAF + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FICOMPLEX + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_RGBA_RGB_MASK + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_RGBA_LOOKUP + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI16_555_RED_MASK + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI16_555_GREEN_MASK + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI16_555_BLUE_MASK + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI16_555_RED_SHIFT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI16_555_GREEN_SHIFT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI16_555_BLUE_SHIFT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI16_565_RED_MASK + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI16_565_GREEN_MASK + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI16_565_BLUE_MASK + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI16_565_RED_SHIFT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI16_565_GREEN_SHIFT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI16_565_BLUE_SHIFT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI16_LOOKUP + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIICC_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIICC_COLOR_IS_CMYK + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIICC_LOOKUP + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREE_IMAGE_FORMAT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_UNKNOWN + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_BMP + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_ICO + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_JPEG + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_JNG + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_KOALA + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_LBM + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_IFF + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_MNG + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_PBM + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_PBMRAW + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_PCD + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_PCX + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_PGM + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_PGMRAW + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_PNG + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_PPM + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_PPMRAW + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_RAS + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_TARGA + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_TIFF + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_WBMP + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_PSD + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_CUT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_XBM + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_XPM + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_DDS + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_GIF + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_HDR + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_FAXG3 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_SGI + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_EXR + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_J2K + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_JP2 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_PFM + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_PICT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_RAW + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_LOOKUP + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREE_IMAGE_TYPE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIT_UNKNOWN + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIT_BITMAP + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIT_UINT16 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIT_INT16 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIT_UINT32 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIT_INT32 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIT_FLOAT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIT_DOUBLE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIT_COMPLEX + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIT_RGB16 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIT_RGBA16 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIT_RGBF + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIT_RGBAF + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIT_LOOKUP + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREE_IMAGE_COLOR_TYPE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIC_MINISWHITE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIC_MINISBLACK + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIC_RGB + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIC_PALETTE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIC_RGBALPHA + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIC_CMYK + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIC_LOOKUP + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREE_IMAGE_QUANTIZE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIQ_WUQUANT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIQ_NNQUANT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIQ_LOOKUP + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREE_IMAGE_DITHER + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FID_FS + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FID_BAYER4x4 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FID_BAYER8x8 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FID_CLUSTER6x6 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FID_CLUSTER8x8 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FID_CLUSTER16x16 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FID_BAYER16x16 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FID_LOOKUP + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREE_IMAGE_JPEG_OPERATION + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIJPEG_OP_NONE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIJPEG_OP_FLIP_H + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIJPEG_OP_FLIP_V + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIJPEG_OP_TRANSPOSE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIJPEG_OP_TRANSVERSE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIJPEG_OP_ROTATE_90 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIJPEG_OP_ROTATE_180 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIJPEG_OP_ROTATE_270 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIJPEG_LOOKUP + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREE_IMAGE_TMO + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FITMO_DRAGO03 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FITMO_REINHARD05 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FITMO_FATTAL02 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FITMO_LOOKUP + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREE_IMAGE_FILTER + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FILTER_BOX + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FILTER_BICUBIC + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FILTER_BILINEAR + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FILTER_BSPLINE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FILTER_CATMULLROM + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FILTER_LANCZOS3 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FILTER_LOOKUP + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREE_IMAGE_COLOR_CHANNEL + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FICC_RGB + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FICC_RED + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FICC_GREEN + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FICC_BLUE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FICC_ALPHA + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FICC_BLACK + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FICC_REAL + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FICC_IMAG + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FICC_MAG + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FICC_PHASE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FICC_LOOKUP + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREE_IMAGE_MDTYPE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_NOTYPE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_BYTE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_ASCII + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_SHORT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_LONG + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_RATIONAL + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_SBYTE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_UNDEFINED + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_SSHORT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_SLONG + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_SRATIONAL + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_FLOAT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_DOUBLE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_IFD + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_PALETTE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIDT_LOOKUP + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREE_IMAGE_MDMODEL + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIMD_NODATA + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIMD_COMMENTS + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIMD_EXIF_MAIN + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIMD_EXIF_EXIF + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIMD_EXIF_GPS + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIMD_EXIF_MAKERNOTE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIMD_EXIF_INTEROP + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIMD_IPTC + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIMD_XMP + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIMD_GEOTIFF + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIMD_ANIMATION + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIMD_CUSTOM + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIMD_EXIF_RAW + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIMD_LOOKUP + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.fi_handle + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_ReadProc + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_WriteProc + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_SeekProc + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_TellProc + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_FormatProc + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_DescriptionProc + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_ExtensionListProc + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_RegExprProc + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_OpenProc + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_CloseProc + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_PageCountProc + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_PageCapabilityProc + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_LoadProc + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_SaveProc + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_ValidateProc + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_MimeProc + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_SupportsExportBPPProc + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_SupportsExportTypeProc + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_SupportsICCProfilesProc + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_SupportsNoPixelsProc + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_InitProc + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FIF_LOAD_NOPIXELS + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.BMP_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.BMP_SAVE_RLE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.CUT_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.DDS_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.EXR_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.EXR_FLOAT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.EXR_NONE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.EXR_ZIP + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.EXR_PIZ + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.EXR_PXR24 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.EXR_B44 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.EXR_LC + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FAXG3_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.GIF_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.GIF_LOAD256 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.GIF_PLAYBACK + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.HDR_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.ICO_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.ICO_MAKEALPHA + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.IFF_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.J2K_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.JP2_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_FAST + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_ACCURATE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_CMYK + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_EXIFROTATE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_QUALITYSUPERB + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_QUALITYGOOD + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_QUALITYNORMAL + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_QUALITYAVERAGE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_QUALITYBAD + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_PROGRESSIVE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_SUBSAMPLING_411 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_SUBSAMPLING_420 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_SUBSAMPLING_422 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_SUBSAMPLING_444 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_OPTIMIZE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.JPEG_BASELINE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.KOALA_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.LBM_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.MNG_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.PCD_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.PCD_BASE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.PCD_BASEDIV4 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.PCD_BASEDIV16 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.PCX_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.PFM_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.PICT_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.PNG_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.PNG_IGNOREGAMMA + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.PNG_Z_BEST_SPEED + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.PNG_Z_DEFAULT_COMPRESSION + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.PNG_Z_BEST_COMPRESSION + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.PNG_Z_NO_COMPRESSION + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.PNG_INTERLACED + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.PNM_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.PNM_SAVE_RAW + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.PNM_SAVE_ASCII + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.PSD_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.PSD_CMYK + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.PSD_LAB + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.RAS_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.RAW_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.RAW_PREVIEW + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.RAW_DISPLAY + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.RAW_HALFSIZE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.SGI_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.TARGA_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.TARGA_LOAD_RGB888 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.TIFF_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.TIFF_CMYK + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.TIFF_PACKBITS + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.TIFF_DEFLATE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.TIFF_ADOBE_DEFLATE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.TIFF_NONE + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.TIFF_CCITTFAX3 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.TIFF_CCITTFAX4 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.TIFF_LZW + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.TIFF_JPEG + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.TIFF_LOGLUV + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.WBMP_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.XBM_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.XPM_DEFAULT + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_COLOR_IS_RGB_COLOR + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_COLOR_IS_RGBA_COLOR + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_COLOR_FIND_EQUAL_COLOR + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_COLOR_ALPHA_IS_INDEX + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_COLOR_PALETTE_SEARCH_MASK + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_COLOR_LOOKUP + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.BPP_1 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.BPP_4 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.BPP_8 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.BPP_16 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.BPP_24 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.BPP_32 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.BPP_48 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.BPP_64 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.BPP_96 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.BPP_1TO8 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.BPP_16TO32 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.BPP_1TO32 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.BPP_1TO48 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.BPP_LOOKUP + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.CPC_8 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.CPC_16 + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.CPC_LOOKUP + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_DEFAULT_NULL + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_DEFAULT_GAMMA + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FI_DEFAULT_LOOKUP + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FreeImage_OutputMessageFunctionStdCall + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FreeImage_OutputMessageFunction + +.. attribute:: sibl_gui.libraries.freeImage.freeImage.FREEIMAGE_FUNCTIONS + +Functions +--------- + +.. autofunction:: pointer + +.. autofunction:: unchecked + +.. autofunction:: getFreeImageLibraryPath + +Classes +------- + +.. autoclass:: FIBITMAP + :show-inheritance: + :members: + +.. autoclass:: FIMULTIBITMAP + :show-inheritance: + :members: + +.. autoclass:: tagRGBQUAD + :show-inheritance: + :members: + +.. autoclass:: tagRGBTRIPLE + :show-inheritance: + :members: + +.. autoclass:: tagBITMAPINFOHEADER + :show-inheritance: + :members: + +.. autoclass:: tagBITMAPINFO + :show-inheritance: + :members: + +.. autoclass:: tagFIRGB16 + :show-inheritance: + :members: + +.. autoclass:: tagFIRGBA16 + :show-inheritance: + :members: + +.. autoclass:: tagFIRGBF + :show-inheritance: + :members: + +.. autoclass:: tagFIRGBAF + :show-inheritance: + :members: + +.. autoclass:: tagFICOMPLEX + :show-inheritance: + :members: + +.. autoclass:: FIICCPROFILE + :show-inheritance: + :members: + +.. autoclass:: FIMETADATA + :show-inheritance: + :members: + +.. autoclass:: FITAG + :show-inheritance: + :members: + +.. autoclass:: FreeImageIO + :show-inheritance: + :members: + +.. autoclass:: FIMEMORY + :show-inheritance: + :members: + +.. autoclass:: Plugin + :show-inheritance: + :members: + +.. autoclass:: ImageInformationsHeader + :show-inheritance: + :members: + +.. autoclass:: Image + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.ui.caches.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.ui.caches.rst new file mode 100644 index 00000000..76b84318 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.ui.caches.rst @@ -0,0 +1,25 @@ +_`sibl_gui.ui.caches` +===================== + +.. automodule:: sibl_gui.ui.caches + +Module Attributes +----------------- + +.. attribute:: sibl_gui.ui.caches.LOGGER + +Classes +------- + +.. autoclass:: CacheMetrics + :show-inheritance: + :members: + +.. autoclass:: AbstractResourcesCache + :show-inheritance: + :members: + +.. autoclass:: AsynchronousGraphicsItemsCache + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.ui.common.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.ui.common.rst new file mode 100644 index 00000000..233c7dad --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.ui.common.rst @@ -0,0 +1,37 @@ +_`sibl_gui.ui.common` +===================== + +.. automodule:: sibl_gui.ui.common + +Module Attributes +----------------- + +.. attribute:: sibl_gui.ui.common.LOGGER + +Functions +--------- + +.. autofunction:: convertImage + +.. autofunction:: getThumbnailPath + +.. autofunction:: extractThumbnail + +.. autofunction:: loadGraphicsItem + +.. autofunction:: getGraphicsItem + +.. autofunction:: getIcon + +.. autofunction:: getPixmap + +.. autofunction:: getImage + +.. autofunction:: createPixmap + +.. autofunction:: getImageInformationsHeader + +.. autofunction:: filterImagePath + +.. autofunction:: getFormatedShotDate + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.ui.models.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.ui.models.rst new file mode 100644 index 00000000..40cde7f9 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.ui.models.rst @@ -0,0 +1,17 @@ +_`sibl_gui.ui.models` +===================== + +.. automodule:: sibl_gui.ui.models + +Module Attributes +----------------- + +.. attribute:: sibl_gui.ui.models.LOGGER + +Classes +------- + +.. autoclass:: GraphModel + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.ui.nodes.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.ui.nodes.rst new file mode 100644 index 00000000..4294a924 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.ui.nodes.rst @@ -0,0 +1,25 @@ +_`sibl_gui.ui.nodes` +==================== + +.. automodule:: sibl_gui.ui.nodes + +Module Attributes +----------------- + +.. attribute:: sibl_gui.ui.nodes.LOGGER + +Classes +------- + +.. autoclass:: Mixin_GraphModelObject + :show-inheritance: + :members: + +.. autoclass:: GraphModelAttribute + :show-inheritance: + :members: + +.. autoclass:: GraphModelNode + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.ui.views.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.ui.views.rst new file mode 100644 index 00000000..9378c5fb --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.ui.views.rst @@ -0,0 +1,25 @@ +_`sibl_gui.ui.views` +==================== + +.. automodule:: sibl_gui.ui.views + +Module Attributes +----------------- + +.. attribute:: sibl_gui.ui.views.LOGGER + +Classes +------- + +.. autoclass:: Mixin_AbstractView + :show-inheritance: + :members: + +.. autoclass:: Abstract_QListView + :show-inheritance: + :members: + +.. autoclass:: Abstract_QTreeView + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.ui.widgets.application_QToolBar.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.ui.widgets.application_QToolBar.rst new file mode 100644 index 00000000..3b9b8932 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.ui.widgets.application_QToolBar.rst @@ -0,0 +1,17 @@ +_`sibl_gui.ui.widgets.application_QToolBar` +=========================================== + +.. automodule:: sibl_gui.ui.widgets.application_QToolBar + +Module Attributes +----------------- + +.. attribute:: sibl_gui.ui.widgets.application_QToolBar.LOGGER + +Classes +------- + +.. autoclass:: Application_QToolBar + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.ui.workers.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.ui.workers.rst new file mode 100644 index 00000000..c97f3fec --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.ui.workers.rst @@ -0,0 +1,17 @@ +_`sibl_gui.ui.workers` +====================== + +.. automodule:: sibl_gui.ui.workers + +Module Attributes +----------------- + +.. attribute:: sibl_gui.ui.workers.LOGGER + +Classes +------- + +.. autoclass:: GraphicsItem_worker + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.addons.projectsExplorer.models.rst b/docs/sphinx/source/resources/pages/api/umbra.components.addons.projectsExplorer.models.rst new file mode 100644 index 00000000..6727d8c5 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.components.addons.projectsExplorer.models.rst @@ -0,0 +1,17 @@ +_`umbra.components.addons.projectsExplorer.models` +================================================== + +.. automodule:: umbra.components.addons.projectsExplorer.models + +Module Attributes +----------------- + +.. attribute:: umbra.components.addons.projectsExplorer.models.LOGGER + +Classes +------- + +.. autoclass:: ProjectsProxyModel + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.addons.projectsExplorer.projectsExplorer.rst b/docs/sphinx/source/resources/pages/api/umbra.components.addons.projectsExplorer.projectsExplorer.rst new file mode 100644 index 00000000..0dda8142 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.components.addons.projectsExplorer.projectsExplorer.rst @@ -0,0 +1,19 @@ +_`umbra.components.addons.projectsExplorer.projectsExplorer` +============================================================ + +.. automodule:: umbra.components.addons.projectsExplorer.projectsExplorer + +Module Attributes +----------------- + +.. attribute:: umbra.components.addons.projectsExplorer.projectsExplorer.LOGGER + +.. attribute:: umbra.components.addons.projectsExplorer.projectsExplorer.COMPONENT_UI_FILE + +Classes +------- + +.. autoclass:: ProjectsExplorer + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.addons.projectsExplorer.views.rst b/docs/sphinx/source/resources/pages/api/umbra.components.addons.projectsExplorer.views.rst new file mode 100644 index 00000000..05c3c5ff --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.components.addons.projectsExplorer.views.rst @@ -0,0 +1,17 @@ +_`umbra.components.addons.projectsExplorer.views` +================================================= + +.. automodule:: umbra.components.addons.projectsExplorer.views + +Module Attributes +----------------- + +.. attribute:: umbra.components.addons.projectsExplorer.views.LOGGER + +Classes +------- + +.. autoclass:: Projects_QTreeView + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.addons.tcpClientUi.tcpClientUi.rst b/docs/sphinx/source/resources/pages/api/umbra.components.addons.tcpClientUi.tcpClientUi.rst new file mode 100644 index 00000000..cb91ed63 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.components.addons.tcpClientUi.tcpClientUi.rst @@ -0,0 +1,19 @@ +_`umbra.components.addons.tcpClientUi.tcpClientUi` +================================================== + +.. automodule:: umbra.components.addons.tcpClientUi.tcpClientUi + +Module Attributes +----------------- + +.. attribute:: umbra.components.addons.tcpClientUi.tcpClientUi.LOGGER + +.. attribute:: umbra.components.addons.tcpClientUi.tcpClientUi.COMPONENT_UI_FILE + +Classes +------- + +.. autoclass:: TCPClientUi + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.addons.tcpServerUi.tcpServerUi.rst b/docs/sphinx/source/resources/pages/api/umbra.components.addons.tcpServerUi.tcpServerUi.rst new file mode 100644 index 00000000..3bb3be97 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.components.addons.tcpServerUi.tcpServerUi.rst @@ -0,0 +1,23 @@ +_`umbra.components.addons.tcpServerUi.tcpServerUi` +================================================== + +.. automodule:: umbra.components.addons.tcpServerUi.tcpServerUi + +Module Attributes +----------------- + +.. attribute:: umbra.components.addons.tcpServerUi.tcpServerUi.LOGGER + +.. attribute:: umbra.components.addons.tcpServerUi.tcpServerUi.COMPONENT_UI_FILE + +Classes +------- + +.. autoclass:: RequestsStackDataHandler + :show-inheritance: + :members: + +.. autoclass:: TCPServerUi + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.models.rst b/docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.models.rst new file mode 100644 index 00000000..de2db37a --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.models.rst @@ -0,0 +1,17 @@ +_`umbra.components.addons.traceUi.models` +========================================= + +.. automodule:: umbra.components.addons.traceUi.models + +Module Attributes +----------------- + +.. attribute:: umbra.components.addons.traceUi.models.LOGGER + +Classes +------- + +.. autoclass:: ModulesModel + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.nodes.rst b/docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.nodes.rst new file mode 100644 index 00000000..725e5269 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.nodes.rst @@ -0,0 +1,17 @@ +_`umbra.components.addons.traceUi.nodes` +======================================== + +.. automodule:: umbra.components.addons.traceUi.nodes + +Module Attributes +----------------- + +.. attribute:: umbra.components.addons.traceUi.nodes.LOGGER + +Classes +------- + +.. autoclass:: ModuleNode + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.traceUi.rst b/docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.traceUi.rst new file mode 100644 index 00000000..27412365 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.traceUi.rst @@ -0,0 +1,19 @@ +_`umbra.components.addons.traceUi.traceUi` +========================================== + +.. automodule:: umbra.components.addons.traceUi.traceUi + +Module Attributes +----------------- + +.. attribute:: umbra.components.addons.traceUi.traceUi.LOGGER + +.. attribute:: umbra.components.addons.traceUi.traceUi.COMPONENT_UI_FILE + +Classes +------- + +.. autoclass:: TraceUi + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.views.rst b/docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.views.rst new file mode 100644 index 00000000..90411a4b --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.components.addons.traceUi.views.rst @@ -0,0 +1,17 @@ +_`umbra.components.addons.traceUi.views` +======================================== + +.. automodule:: umbra.components.addons.traceUi.views + +Module Attributes +----------------- + +.. attribute:: umbra.components.addons.traceUi.views.LOGGER + +Classes +------- + +.. autoclass:: Modules_QTreeView + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.componentsManagerUi.rst b/docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.componentsManagerUi.rst new file mode 100644 index 00000000..17554fd9 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.componentsManagerUi.rst @@ -0,0 +1,19 @@ +_`umbra.components.factory.componentsManagerUi.componentsManagerUi` +=================================================================== + +.. automodule:: umbra.components.factory.componentsManagerUi.componentsManagerUi + +Module Attributes +----------------- + +.. attribute:: umbra.components.factory.componentsManagerUi.componentsManagerUi.LOGGER + +.. attribute:: umbra.components.factory.componentsManagerUi.componentsManagerUi.COMPONENT_UI_FILE + +Classes +------- + +.. autoclass:: ComponentsManagerUi + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.models.rst b/docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.models.rst new file mode 100644 index 00000000..c7cc6f48 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.models.rst @@ -0,0 +1,17 @@ +_`umbra.components.factory.componentsManagerUi.models` +====================================================== + +.. automodule:: umbra.components.factory.componentsManagerUi.models + +Module Attributes +----------------- + +.. attribute:: umbra.components.factory.componentsManagerUi.models.LOGGER + +Classes +------- + +.. autoclass:: ComponentsModel + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.nodes.rst b/docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.nodes.rst new file mode 100644 index 00000000..7df9b6dd --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.nodes.rst @@ -0,0 +1,21 @@ +_`umbra.components.factory.componentsManagerUi.nodes` +===================================================== + +.. automodule:: umbra.components.factory.componentsManagerUi.nodes + +Module Attributes +----------------- + +.. attribute:: umbra.components.factory.componentsManagerUi.nodes.LOGGER + +Classes +------- + +.. autoclass:: PathNode + :show-inheritance: + :members: + +.. autoclass:: ComponentNode + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.views.rst b/docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.views.rst new file mode 100644 index 00000000..240fc084 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.components.factory.componentsManagerUi.views.rst @@ -0,0 +1,17 @@ +_`umbra.components.factory.componentsManagerUi.views` +===================================================== + +.. automodule:: umbra.components.factory.componentsManagerUi.views + +Module Attributes +----------------- + +.. attribute:: umbra.components.factory.componentsManagerUi.views.LOGGER + +Classes +------- + +.. autoclass:: Components_QTreeView + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.factory.preferencesManager.preferencesManager.rst b/docs/sphinx/source/resources/pages/api/umbra.components.factory.preferencesManager.preferencesManager.rst new file mode 100644 index 00000000..7fd817cd --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.components.factory.preferencesManager.preferencesManager.rst @@ -0,0 +1,19 @@ +_`umbra.components.factory.preferencesManager.preferencesManager` +================================================================= + +.. automodule:: umbra.components.factory.preferencesManager.preferencesManager + +Module Attributes +----------------- + +.. attribute:: umbra.components.factory.preferencesManager.preferencesManager.LOGGER + +.. attribute:: umbra.components.factory.preferencesManager.preferencesManager.COMPONENT_UI_FILE + +Classes +------- + +.. autoclass:: PreferencesManager + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.editor.rst b/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.editor.rst new file mode 100644 index 00000000..74c354de --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.editor.rst @@ -0,0 +1,17 @@ +_`umbra.components.factory.scriptEditor.editor` +=============================================== + +.. automodule:: umbra.components.factory.scriptEditor.editor + +Module Attributes +----------------- + +.. attribute:: umbra.components.factory.scriptEditor.editor.LOGGER + +Classes +------- + +.. autoclass:: Editor + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.editorStatus.rst b/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.editorStatus.rst new file mode 100644 index 00000000..58178709 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.editorStatus.rst @@ -0,0 +1,19 @@ +_`umbra.components.factory.scriptEditor.editorStatus` +===================================================== + +.. automodule:: umbra.components.factory.scriptEditor.editorStatus + +Module Attributes +----------------- + +.. attribute:: umbra.components.factory.scriptEditor.editorStatus.LOGGER + +.. attribute:: umbra.components.factory.scriptEditor.editorStatus.UI_FILE + +Classes +------- + +.. autoclass:: EditorStatus + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.models.rst b/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.models.rst new file mode 100644 index 00000000..89437388 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.models.rst @@ -0,0 +1,29 @@ +_`umbra.components.factory.scriptEditor.models` +=============================================== + +.. automodule:: umbra.components.factory.scriptEditor.models + +Module Attributes +----------------- + +.. attribute:: umbra.components.factory.scriptEditor.models.LOGGER + +Classes +------- + +.. autoclass:: ProjectsModel + :show-inheritance: + :members: + +.. autoclass:: LanguagesModel + :show-inheritance: + :members: + +.. autoclass:: PatternsModel + :show-inheritance: + :members: + +.. autoclass:: SearchResultsModel + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.nodes.rst b/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.nodes.rst new file mode 100644 index 00000000..a934d019 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.nodes.rst @@ -0,0 +1,45 @@ +_`umbra.components.factory.scriptEditor.nodes` +============================================== + +.. automodule:: umbra.components.factory.scriptEditor.nodes + +Module Attributes +----------------- + +.. attribute:: umbra.components.factory.scriptEditor.nodes.LOGGER + +Classes +------- + +.. autoclass:: EditorNode + :show-inheritance: + :members: + +.. autoclass:: FileNode + :show-inheritance: + :members: + +.. autoclass:: DirectoryNode + :show-inheritance: + :members: + +.. autoclass:: ProjectNode + :show-inheritance: + :members: + +.. autoclass:: PatternNode + :show-inheritance: + :members: + +.. autoclass:: SearchFileNode + :show-inheritance: + :members: + +.. autoclass:: SearchOccurenceNode + :show-inheritance: + :members: + +.. autoclass:: ReplaceResultNode + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.scriptEditor.rst b/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.scriptEditor.rst new file mode 100644 index 00000000..7a9f953a --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.scriptEditor.rst @@ -0,0 +1,19 @@ +_`umbra.components.factory.scriptEditor.scriptEditor` +===================================================== + +.. automodule:: umbra.components.factory.scriptEditor.scriptEditor + +Module Attributes +----------------- + +.. attribute:: umbra.components.factory.scriptEditor.scriptEditor.LOGGER + +.. attribute:: umbra.components.factory.scriptEditor.scriptEditor.COMPONENT_UI_FILE + +Classes +------- + +.. autoclass:: ScriptEditor + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.searchAndReplace.rst b/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.searchAndReplace.rst new file mode 100644 index 00000000..bd199da1 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.searchAndReplace.rst @@ -0,0 +1,23 @@ +_`umbra.components.factory.scriptEditor.searchAndReplace` +========================================================= + +.. automodule:: umbra.components.factory.scriptEditor.searchAndReplace + +Module Attributes +----------------- + +.. attribute:: umbra.components.factory.scriptEditor.searchAndReplace.LOGGER + +.. attribute:: umbra.components.factory.scriptEditor.searchAndReplace.UI_FILE + +Classes +------- + +.. autoclass:: ValidationFilter + :show-inheritance: + :members: + +.. autoclass:: SearchAndReplace + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.searchInFiles.rst b/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.searchInFiles.rst new file mode 100644 index 00000000..f9a11c0c --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.searchInFiles.rst @@ -0,0 +1,19 @@ +_`umbra.components.factory.scriptEditor.searchInFiles` +====================================================== + +.. automodule:: umbra.components.factory.scriptEditor.searchInFiles + +Module Attributes +----------------- + +.. attribute:: umbra.components.factory.scriptEditor.searchInFiles.LOGGER + +.. attribute:: umbra.components.factory.scriptEditor.searchInFiles.UI_FILE + +Classes +------- + +.. autoclass:: SearchInFiles + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.views.rst b/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.views.rst new file mode 100644 index 00000000..fd4c2fe8 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.views.rst @@ -0,0 +1,21 @@ +_`umbra.components.factory.scriptEditor.views` +============================================== + +.. automodule:: umbra.components.factory.scriptEditor.views + +Module Attributes +----------------- + +.. attribute:: umbra.components.factory.scriptEditor.views.LOGGER + +Classes +------- + +.. autoclass:: SearchResults_QTreeView + :show-inheritance: + :members: + +.. autoclass:: ScriptEditor_QTabWidget + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.workers.rst b/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.workers.rst new file mode 100644 index 00000000..275248dc --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.components.factory.scriptEditor.workers.rst @@ -0,0 +1,29 @@ +_`umbra.components.factory.scriptEditor.workers` +================================================ + +.. automodule:: umbra.components.factory.scriptEditor.workers + +Module Attributes +----------------- + +.. attribute:: umbra.components.factory.scriptEditor.workers.LOGGER + +Classes +------- + +.. autoclass:: Occurence + :show-inheritance: + :members: + +.. autoclass:: SearchResult + :show-inheritance: + :members: + +.. autoclass:: CacheData + :show-inheritance: + :members: + +.. autoclass:: Search_worker + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.engine.rst b/docs/sphinx/source/resources/pages/api/umbra.engine.rst new file mode 100644 index 00000000..d27291e3 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.engine.rst @@ -0,0 +1,38 @@ +_`umbra.engine` +=============== + +.. automodule:: umbra.engine + +Module Attributes +----------------- + +.. attribute:: umbra.engine.LOGGER + +.. attribute:: umbra.engine.SESSION_HEADER_TEXT + +.. attribute:: umbra.engine.SESSION_FOOTER_TEXT + +Functions +--------- + +.. autofunction:: showProcessing + +.. autofunction:: encapsulateProcessing + +.. autofunction:: setUserApplicationDataDirectory + +.. autofunction:: getCommandLineParametersParser + +.. autofunction:: getLoggingFile + +.. autofunction:: run + +.. autofunction:: exit + +Classes +------- + +.. autoclass:: Umbra + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.exceptions.rst b/docs/sphinx/source/resources/pages/api/umbra.exceptions.rst new file mode 100644 index 00000000..0bbbaf1b --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.exceptions.rst @@ -0,0 +1,89 @@ +_`umbra.exceptions` +=================== + +.. automodule:: umbra.exceptions + +Functions +--------- + +.. autofunction:: notifyExceptionHandler + +Classes +------- + +.. autoclass:: AbstractEngineError + :show-inheritance: + :members: + +.. autoclass:: EngineConfigurationError + :show-inheritance: + :members: + +.. autoclass:: EngineInitializationError + :show-inheritance: + :members: + +.. autoclass:: ResourceExistsError + :show-inheritance: + :members: + +.. autoclass:: AbstractActionsManagerError + :show-inheritance: + :members: + +.. autoclass:: CategoryExistsError + :show-inheritance: + :members: + +.. autoclass:: ActionExistsError + :show-inheritance: + :members: + +.. autoclass:: AbstractPatchesManagerError + :show-inheritance: + :members: + +.. autoclass:: PatchRegistrationError + :show-inheritance: + :members: + +.. autoclass:: PatchInterfaceError + :show-inheritance: + :members: + +.. autoclass:: PatchApplyError + :show-inheritance: + :members: + +.. autoclass:: AbstractLayoutsManagerError + :show-inheritance: + :members: + +.. autoclass:: LayoutRegistrationError + :show-inheritance: + :members: + +.. autoclass:: LayoutExistError + :show-inheritance: + :members: + +.. autoclass:: AbstractFileSystemEventsManagerError + :show-inheritance: + :members: + +.. autoclass:: PathRegistrationError + :show-inheritance: + :members: + +.. autoclass:: PathExistsError + :show-inheritance: + :members: + +.. autoclass:: AbstractLanguageError + :show-inheritance: + :members: + +.. autoclass:: LanguageGrammarError + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.globals.constants.rst b/docs/sphinx/source/resources/pages/api/umbra.globals.constants.rst new file mode 100644 index 00000000..263bff3c --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.globals.constants.rst @@ -0,0 +1,12 @@ +_`umbra.globals.constants` +========================== + +.. automodule:: umbra.globals.constants + +Classes +------- + +.. autoclass:: Constants + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.globals.runtimeGlobals.rst b/docs/sphinx/source/resources/pages/api/umbra.globals.runtimeGlobals.rst new file mode 100644 index 00000000..8d75195b --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.globals.runtimeGlobals.rst @@ -0,0 +1,12 @@ +_`umbra.globals.runtimeGlobals` +=============================== + +.. automodule:: umbra.globals.runtimeGlobals + +Classes +------- + +.. autoclass:: RuntimeGlobals + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.globals.uiConstants.rst b/docs/sphinx/source/resources/pages/api/umbra.globals.uiConstants.rst new file mode 100644 index 00000000..c72b33b0 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.globals.uiConstants.rst @@ -0,0 +1,12 @@ +_`umbra.globals.uiConstants` +============================ + +.. automodule:: umbra.globals.uiConstants + +Classes +------- + +.. autoclass:: UiConstants + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.guerilla.rst b/docs/sphinx/source/resources/pages/api/umbra.guerilla.rst new file mode 100644 index 00000000..5143312c --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.guerilla.rst @@ -0,0 +1,12 @@ +_`umbra.guerilla` +================= + +.. automodule:: umbra.guerilla + +Functions +--------- + +.. autofunction:: attributeWarfare + +.. autofunction:: baseWarfare + diff --git a/docs/sphinx/source/resources/pages/api/umbra.launcher.rst b/docs/sphinx/source/resources/pages/api/umbra.launcher.rst new file mode 100644 index 00000000..d0d5f31e --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.launcher.rst @@ -0,0 +1,10 @@ +_`umbra.launcher` +================= + +.. automodule:: umbra.launcher + +Functions +--------- + +.. autofunction:: main + diff --git a/docs/sphinx/source/resources/pages/api/umbra.managers.actionsManager.rst b/docs/sphinx/source/resources/pages/api/umbra.managers.actionsManager.rst new file mode 100644 index 00000000..45b5bba8 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.managers.actionsManager.rst @@ -0,0 +1,17 @@ +_`umbra.managers.actionsManager` +================================ + +.. automodule:: umbra.managers.actionsManager + +Module Attributes +----------------- + +.. attribute:: umbra.managers.actionsManager.LOGGER + +Classes +------- + +.. autoclass:: ActionsManager + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.managers.fileSystemEventsManager.rst b/docs/sphinx/source/resources/pages/api/umbra.managers.fileSystemEventsManager.rst new file mode 100644 index 00000000..f21e25d6 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.managers.fileSystemEventsManager.rst @@ -0,0 +1,17 @@ +_`umbra.managers.fileSystemEventsManager` +========================================= + +.. automodule:: umbra.managers.fileSystemEventsManager + +Module Attributes +----------------- + +.. attribute:: umbra.managers.fileSystemEventsManager.LOGGER + +Classes +------- + +.. autoclass:: FileSystemEventsManager + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.managers.layoutsManager.rst b/docs/sphinx/source/resources/pages/api/umbra.managers.layoutsManager.rst new file mode 100644 index 00000000..845e4748 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.managers.layoutsManager.rst @@ -0,0 +1,21 @@ +_`umbra.managers.layoutsManager` +================================ + +.. automodule:: umbra.managers.layoutsManager + +Module Attributes +----------------- + +.. attribute:: umbra.managers.layoutsManager.LOGGER + +Classes +------- + +.. autoclass:: Layout + :show-inheritance: + :members: + +.. autoclass:: LayoutsManager + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.managers.notificationsManager.rst b/docs/sphinx/source/resources/pages/api/umbra.managers.notificationsManager.rst new file mode 100644 index 00000000..383ca586 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.managers.notificationsManager.rst @@ -0,0 +1,21 @@ +_`umbra.managers.notificationsManager` +====================================== + +.. automodule:: umbra.managers.notificationsManager + +Module Attributes +----------------- + +.. attribute:: umbra.managers.notificationsManager.LOGGER + +Classes +------- + +.. autoclass:: Notification + :show-inheritance: + :members: + +.. autoclass:: NotificationsManager + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.managers.patchesManager.rst b/docs/sphinx/source/resources/pages/api/umbra.managers.patchesManager.rst new file mode 100644 index 00000000..54eb03ed --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.managers.patchesManager.rst @@ -0,0 +1,21 @@ +_`umbra.managers.patchesManager` +================================ + +.. automodule:: umbra.managers.patchesManager + +Module Attributes +----------------- + +.. attribute:: umbra.managers.patchesManager.LOGGER + +Classes +------- + +.. autoclass:: Patch + :show-inheritance: + :members: + +.. autoclass:: PatchesManager + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.preferences.rst b/docs/sphinx/source/resources/pages/api/umbra.preferences.rst new file mode 100644 index 00000000..2910876b --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.preferences.rst @@ -0,0 +1,17 @@ +_`umbra.preferences` +==================== + +.. automodule:: umbra.preferences + +Module Attributes +----------------- + +.. attribute:: umbra.preferences.LOGGER + +Classes +------- + +.. autoclass:: Preferences + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.processing.rst b/docs/sphinx/source/resources/pages/api/umbra.processing.rst new file mode 100644 index 00000000..cf2f6d97 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.processing.rst @@ -0,0 +1,19 @@ +_`umbra.processing` +=================== + +.. automodule:: umbra.processing + +Module Attributes +----------------- + +.. attribute:: umbra.processing.LOGGER + +.. attribute:: umbra.processing.UI_FILE + +Classes +------- + +.. autoclass:: Processing + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.reporter.rst b/docs/sphinx/source/resources/pages/api/umbra.reporter.rst new file mode 100644 index 00000000..6e285f23 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.reporter.rst @@ -0,0 +1,36 @@ +_`umbra.reporter` +================= + +.. automodule:: umbra.reporter + +Module Attributes +----------------- + +.. attribute:: umbra.reporter.LOGGER + +.. attribute:: umbra.reporter.UI_FILE + +Functions +--------- + +.. autofunction:: baseExceptionHandler + +.. autofunction:: systemExitExceptionHandler + +.. autofunction:: criticalExceptionHandler + +.. autofunction:: installExceptionReporter + +.. autofunction:: uninstallExceptionReporter + +.. autofunction:: enableExceptionReporter + +.. autofunction:: disableExceptionReporter + +Classes +------- + +.. autoclass:: Reporter + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.common.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.common.rst new file mode 100644 index 00000000..d9c61c03 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.ui.common.rst @@ -0,0 +1,44 @@ +_`umbra.ui.common` +================== + +.. automodule:: umbra.ui.common + +Module Attributes +----------------- + +.. attribute:: umbra.ui.common.LOGGER + +Functions +--------- + +.. autofunction:: getApplicationInstance + +.. autofunction:: parseLocation + +.. autofunction:: getResourcePath + +.. autofunction:: setWindowDefaultIcon + +.. autofunction:: getSectionsFileParser + +.. autofunction:: storeLastBrowsedPath + +.. autofunction:: getQVariantAsString + +.. autofunction:: parentsWalker + +.. autofunction:: signalsBlocker + +.. autofunction:: showWaitCursor + +.. autofunction:: setToolBoxHeight + +.. autofunction:: setChildrenPadding + +Classes +------- + +.. autoclass:: Location + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.completers.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.completers.rst new file mode 100644 index 00000000..ab4aae66 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.ui.completers.rst @@ -0,0 +1,17 @@ +_`umbra.ui.completers` +====================== + +.. automodule:: umbra.ui.completers + +Module Attributes +----------------- + +.. attribute:: umbra.ui.completers.LOGGER + +Classes +------- + +.. autoclass:: DefaultCompleter + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.delegates.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.delegates.rst new file mode 100644 index 00000000..9f7ea8bd --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.ui.delegates.rst @@ -0,0 +1,21 @@ +_`umbra.ui.delegates` +===================== + +.. automodule:: umbra.ui.delegates + +Module Attributes +----------------- + +.. attribute:: umbra.ui.delegates.LOGGER + +Classes +------- + +.. autoclass:: Style + :show-inheritance: + :members: + +.. autoclass:: RichText_QStyledItemDelegate + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.highlighters.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.highlighters.rst new file mode 100644 index 00000000..ff6cbf76 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.ui.highlighters.rst @@ -0,0 +1,29 @@ +_`umbra.ui.highlighters` +======================== + +.. automodule:: umbra.ui.highlighters + +Module Attributes +----------------- + +.. attribute:: umbra.ui.highlighters.LOGGER + +Classes +------- + +.. autoclass:: Rule + :show-inheritance: + :members: + +.. autoclass:: FormatsTree + :show-inheritance: + :members: + +.. autoclass:: AbstractHighlighter + :show-inheritance: + :members: + +.. autoclass:: DefaultHighlighter + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.inputAccelerators.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.inputAccelerators.rst new file mode 100644 index 00000000..26ee02fd --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.ui.inputAccelerators.rst @@ -0,0 +1,29 @@ +_`umbra.ui.inputAccelerators` +============================= + +.. automodule:: umbra.ui.inputAccelerators + +Module Attributes +----------------- + +.. attribute:: umbra.ui.inputAccelerators.LOGGER + +Functions +--------- + +.. autofunction:: getEditorCapability + +.. autofunction:: isSymbolsPairComplete + +.. autofunction:: performCompletion + +.. autofunction:: indentationPreEventInputAccelerators + +.. autofunction:: indentationPostEventInputAccelerators + +.. autofunction:: completionPreEventInputAccelerators + +.. autofunction:: completionPostEventInputAccelerators + +.. autofunction:: symbolsExpandingPreEventInputAccelerators + diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.languages.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.languages.rst new file mode 100644 index 00000000..d1b6c18b --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.ui.languages.rst @@ -0,0 +1,46 @@ +_`umbra.ui.languages` +===================== + +.. automodule:: umbra.ui.languages + +Module Attributes +----------------- + +.. attribute:: umbra.ui.languages.LOGGER + +.. attribute:: umbra.ui.languages.PYTHON_GRAMMAR_FILE + +.. attribute:: umbra.ui.languages.LOGGING_GRAMMAR_FILE + +.. attribute:: umbra.ui.languages.TEXT_GRAMMAR_FILE + +.. attribute:: umbra.ui.languages.LANGUAGES_ACCELERATORS + +.. attribute:: umbra.ui.languages.DEFAULT_INDENT_MARKER + +.. attribute:: umbra.ui.languages.PYTHON_LANGUAGE + +.. attribute:: umbra.ui.languages.LOGGING_LANGUAGE + +.. attribute:: umbra.ui.languages.TEXT_LANGUAGE + +Functions +--------- + +.. autofunction:: getObjectFromLanguageAccelerators + +.. autofunction:: getLanguageDescription + +.. autofunction:: getPythonLanguage + +.. autofunction:: getLoggingLanguage + +.. autofunction:: getTextLanguage + +Classes +------- + +.. autoclass:: Language + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.models.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.models.rst new file mode 100644 index 00000000..0bd5fd55 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.ui.models.rst @@ -0,0 +1,17 @@ +_`umbra.ui.models` +================== + +.. automodule:: umbra.ui.models + +Module Attributes +----------------- + +.. attribute:: umbra.ui.models.LOGGER + +Classes +------- + +.. autoclass:: GraphModel + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.nodes.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.nodes.rst new file mode 100644 index 00000000..137c8a88 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.ui.nodes.rst @@ -0,0 +1,33 @@ +_`umbra.ui.nodes` +================= + +.. automodule:: umbra.ui.nodes + +Module Attributes +----------------- + +.. attribute:: umbra.ui.nodes.LOGGER + +Classes +------- + +.. autoclass:: Mixin_GraphModelObject + :show-inheritance: + :members: + +.. autoclass:: GraphModelAttribute + :show-inheritance: + :members: + +.. autoclass:: GraphModelNode + :show-inheritance: + :members: + +.. autoclass:: DefaultNode + :show-inheritance: + :members: + +.. autoclass:: FormatNode + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.themes.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.themes.rst new file mode 100644 index 00000000..d5285b37 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.ui.themes.rst @@ -0,0 +1,21 @@ +_`umbra.ui.themes` +================== + +.. automodule:: umbra.ui.themes + +Module Attributes +----------------- + +.. attribute:: umbra.ui.themes.LOGGER + +.. attribute:: umbra.ui.themes.DEFAULT_FORMAT + +.. attribute:: umbra.ui.themes.DEFAULT_THEME + +.. attribute:: umbra.ui.themes.LOGGING_THEME + +Functions +--------- + +.. autofunction:: getFormat + diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.views.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.views.rst new file mode 100644 index 00000000..04a68c45 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.ui.views.rst @@ -0,0 +1,53 @@ +_`umbra.ui.views` +================= + +.. automodule:: umbra.ui.views + +Module Attributes +----------------- + +.. attribute:: umbra.ui.views.LOGGER + +Classes +------- + +.. autoclass:: ReadOnlyFilter + :show-inheritance: + :members: + +.. autoclass:: Mixin_AbstractBase + :show-inheritance: + :members: + +.. autoclass:: Mixin_AbstractView + :show-inheritance: + :members: + +.. autoclass:: Mixin_AbstractWidget + :show-inheritance: + :members: + +.. autoclass:: Abstract_QListView + :show-inheritance: + :members: + +.. autoclass:: Abstract_QTableView + :show-inheritance: + :members: + +.. autoclass:: Abstract_QTreeView + :show-inheritance: + :members: + +.. autoclass:: Abstract_QListWidget + :show-inheritance: + :members: + +.. autoclass:: Abstract_QTableWidget + :show-inheritance: + :members: + +.. autoclass:: Abstract_QTreeWidget + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.visualAccelerators.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.visualAccelerators.rst new file mode 100644 index 00000000..a8bc898f --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.ui.visualAccelerators.rst @@ -0,0 +1,19 @@ +_`umbra.ui.visualAccelerators` +============================== + +.. automodule:: umbra.ui.visualAccelerators + +Module Attributes +----------------- + +.. attribute:: umbra.ui.visualAccelerators.LOGGER + +Functions +--------- + +.. autofunction:: highlightCurrentLine + +.. autofunction:: highlightOccurences + +.. autofunction:: highlightMatchingSymbolsPairs + diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.active_QLabel.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.active_QLabel.rst new file mode 100644 index 00000000..a01b5b8b --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.active_QLabel.rst @@ -0,0 +1,17 @@ +_`umbra.ui.widgets.active_QLabel` +================================= + +.. automodule:: umbra.ui.widgets.active_QLabel + +Module Attributes +----------------- + +.. attribute:: umbra.ui.widgets.active_QLabel.LOGGER + +Classes +------- + +.. autoclass:: Active_QLabel + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.active_QLabelsCollection.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.active_QLabelsCollection.rst new file mode 100644 index 00000000..9a4d2131 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.active_QLabelsCollection.rst @@ -0,0 +1,17 @@ +_`umbra.ui.widgets.active_QLabelsCollection` +============================================ + +.. automodule:: umbra.ui.widgets.active_QLabelsCollection + +Module Attributes +----------------- + +.. attribute:: umbra.ui.widgets.active_QLabelsCollection.LOGGER + +Classes +------- + +.. autoclass:: Active_QLabelsCollection + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.application_QToolBar.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.application_QToolBar.rst new file mode 100644 index 00000000..64aff334 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.application_QToolBar.rst @@ -0,0 +1,17 @@ +_`umbra.ui.widgets.application_QToolBar` +======================================== + +.. automodule:: umbra.ui.widgets.application_QToolBar + +Module Attributes +----------------- + +.. attribute:: umbra.ui.widgets.application_QToolBar.LOGGER + +Classes +------- + +.. autoclass:: Application_QToolBar + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.basic_QPlainTextEdit.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.basic_QPlainTextEdit.rst new file mode 100644 index 00000000..338737d3 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.basic_QPlainTextEdit.rst @@ -0,0 +1,26 @@ +_`umbra.ui.widgets.basic_QPlainTextEdit` +======================================== + +.. automodule:: umbra.ui.widgets.basic_QPlainTextEdit + +Module Attributes +----------------- + +.. attribute:: umbra.ui.widgets.basic_QPlainTextEdit.LOGGER + +Functions +--------- + +.. autofunction:: editBlock + +.. autofunction:: anchorTextCursor + +.. autofunction:: centerTextCursor + +Classes +------- + +.. autoclass:: Basic_QPlainTextEdit + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.codeEditor_QPlainTextEdit.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.codeEditor_QPlainTextEdit.rst new file mode 100644 index 00000000..10784227 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.codeEditor_QPlainTextEdit.rst @@ -0,0 +1,21 @@ +_`umbra.ui.widgets.codeEditor_QPlainTextEdit` +============================================= + +.. automodule:: umbra.ui.widgets.codeEditor_QPlainTextEdit + +Module Attributes +----------------- + +.. attribute:: umbra.ui.widgets.codeEditor_QPlainTextEdit.LOGGER + +Classes +------- + +.. autoclass:: LinesNumbers_QWidget + :show-inheritance: + :members: + +.. autoclass:: CodeEditor_QPlainTextEdit + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.delayed_QSplashScreen.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.delayed_QSplashScreen.rst new file mode 100644 index 00000000..017f26f0 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.delayed_QSplashScreen.rst @@ -0,0 +1,17 @@ +_`umbra.ui.widgets.delayed_QSplashScreen` +========================================= + +.. automodule:: umbra.ui.widgets.delayed_QSplashScreen + +Module Attributes +----------------- + +.. attribute:: umbra.ui.widgets.delayed_QSplashScreen.LOGGER + +Classes +------- + +.. autoclass:: Delayed_QSplashScreen + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.messageBox.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.messageBox.rst new file mode 100644 index 00000000..97291a4e --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.messageBox.rst @@ -0,0 +1,15 @@ +_`umbra.ui.widgets.messageBox` +============================== + +.. automodule:: umbra.ui.widgets.messageBox + +Module Attributes +----------------- + +.. attribute:: umbra.ui.widgets.messageBox.LOGGER + +Functions +--------- + +.. autofunction:: messageBox + diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.notification_QLabel.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.notification_QLabel.rst new file mode 100644 index 00000000..e55d2a70 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.notification_QLabel.rst @@ -0,0 +1,17 @@ +_`umbra.ui.widgets.notification_QLabel` +======================================= + +.. automodule:: umbra.ui.widgets.notification_QLabel + +Module Attributes +----------------- + +.. attribute:: umbra.ui.widgets.notification_QLabel.LOGGER + +Classes +------- + +.. autoclass:: Notification_QLabel + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.search_QLineEdit.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.search_QLineEdit.rst new file mode 100644 index 00000000..2842e9d2 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.search_QLineEdit.rst @@ -0,0 +1,17 @@ +_`umbra.ui.widgets.search_QLineEdit` +==================================== + +.. automodule:: umbra.ui.widgets.search_QLineEdit + +Module Attributes +----------------- + +.. attribute:: umbra.ui.widgets.search_QLineEdit.LOGGER + +Classes +------- + +.. autoclass:: Search_QLineEdit + :show-inheritance: + :members: + diff --git a/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.variable_QPushButton.rst b/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.variable_QPushButton.rst new file mode 100644 index 00000000..9ff4fea6 --- /dev/null +++ b/docs/sphinx/source/resources/pages/api/umbra.ui.widgets.variable_QPushButton.rst @@ -0,0 +1,17 @@ +_`umbra.ui.widgets.variable_QPushButton` +======================================== + +.. automodule:: umbra.ui.widgets.variable_QPushButton + +Module Attributes +----------------- + +.. attribute:: umbra.ui.widgets.variable_QPushButton.LOGGER + +Classes +------- + +.. autoclass:: Variable_QPushButton + :show-inheritance: + :members: + diff --git a/utilities/css/style.css b/utilities/css/style.css deleted file mode 100644 index d5a89142..00000000 --- a/utilities/css/style.css +++ /dev/null @@ -1,78 +0,0 @@ -body { - background-color: rgb(32, 32, 32); - color: rgb(192, 192, 192); - text-align: justify; - font-size: 10pt; - margin: 10px 10px 10px 10px; -} - -A:link { - color: rgb(160, 96, 64); - text-decoration: none; -} - -A:visited { - text-decoration: none; - color: rgb(160, 96, 64); -} - -A:active { - text-decoration: none; - color: rgb(160, 96, 64); -} - -A:hover { - text-decoration: underline; - color: rgb(160, 96, 64); -} - -table { - border-color: rgb(96, 96, 96); - border-collapse: collapse; - border-style: solid; - border-width: 2px; -} - -pre { - background-color: rgb(64, 64, 64); - border: 2px solid rgb(160, 96, 64); - border-left: none; - border-right: none; - color: rgb(224, 224, 224); - font-size: 12pt; - padding: 5px; - white-space: pre-wrap; -} - -tt { - background-color: rgb(64, 64, 64); - color: rgb(224, 224, 224); - padding: 5px; - white-space: pre-wrap; - white-space: -moz-pre-wrap !important; -} - -::-webkit-scrollbar { - height: 12px; - width: 12px; -} - -::-webkit-scrollbar-track-piece { - background-color: rgb(48, 48, 48); -} - -::-webkit-scrollbar-thumb:horizontal, ::-webkit-scrollbar-thumb:vertical { - background-color: rgb(96, 96, 96); -} - -::-webkit-scrollbar-thumb:horizontal:hover, ::-webkit-scrollbar-thumb:vertical:hover { - background-color: rgb(128, 128, 128); -} - -::-webkit-scrollbar-thumb:horizontal { - width: 50px; -} - -::-webkit-scrollbar-thumb:vertical { - height: 50px; -} \ No newline at end of file diff --git a/utilities/getSphinxDocumentationApi.py b/utilities/getSphinxDocumentationApi.py deleted file mode 100755 index a7940b89..00000000 --- a/utilities/getSphinxDocumentationApi.py +++ /dev/null @@ -1,261 +0,0 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- - -""" -**getSphinxDocumentationApi.py** - -**Platform:** - Windows, Linux, Mac Os X. - -**Description:** - Gets Sphinx documentation Api files. - -**Others:** - -""" - -#********************************************************************************************************************** -#*** Future imports. -#********************************************************************************************************************** -from __future__ import unicode_literals - -#********************************************************************************************************************** -#*** External imports. -#********************************************************************************************************************** -import os -import re -import shutil -import sys -if sys.version_info[:2] <= (2, 6): - from ordereddict import OrderedDict -else: - from collections import OrderedDict - -#********************************************************************************************************************** -#*** Internal imports. -#********************************************************************************************************************** -import foundations.common -import foundations.strings -import foundations.verbose -import foundations.walkers -from foundations.io import File - -sys.path.append(os.path.join(os.path.dirname(os.path.abspath(__file__)), "libraries")) -import python.pyclbr as moduleBrowser - -#********************************************************************************************************************** -#*** Module attributes. -#********************************************************************************************************************** -__author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" -__license__ = "GPL V3.0 - http://www.gnu.org/licenses/" -__maintainer__ = "Thomas Mansencal" -__email__ = "thomas.mansencal@gmail.com" -__status__ = "Production" - -__all__ = ["LOGGER", - "FILES_EXTENSION", - "TOCTREE_TEMPLATE_BEGIN", - "TOCTREE_TEMPLATE_END", - "EXCLUDED_PYTHON_MODULES", - "STATEMENTS_UPDATE_MESSAGGE", - "DECORATORS_COMMENT_MESSAGE", - "CONTENT_SUBSTITUTIONS", - "getSphinxDocumentationApi"] - -LOGGER = foundations.verbose.installLogger() - -FILES_EXTENSION = ".rst" - -TOCTREE_TEMPLATE_BEGIN = ["Api\n", - "====\n", - "\n", - "Modules Summary:\n", - "\n", - ".. toctree::\n", - " :maxdepth: 1\n", - "\n"] - -TOCTREE_TEMPLATE_END = [] - -EXCLUDED_PYTHON_MODULES = ("tests", - "defaultScript\.py", - "001_migrate_3-x-x_to_4-0-0\.py", - "002_migrate_4-x-x_to_4-0-2\.py", - "003_migrate_4-x-x_to_4-0-3\.py", - "004_migrate_4-x-x_to_4-0-7\.py", - "001_dummy\.py") - -STATEMENTS_UPDATE_MESSAGGE = "#**********************************************************************************************************************\n" \ - "#***\tSphinx: Statements updated for auto-documentation purpose.\n" \ - "#**********************************************************************************************************************" - -DECORATORS_COMMENT_MESSAGE = "#***\tSphinx: Decorator commented for auto-documentation purpose." - -CONTENT_SUBSTITUTIONS = {"^_initializeApplication\(\)$" : "{0}".format(STATEMENTS_UPDATE_MESSAGGE), - "Initializes the class.\n" : - ".. Sphinx: Statements updated for auto-documentation purpose.\n", - "PYTHON_LANGUAGE \= getPythonLanguage\(\)" : - "{0}\n{1}".format(STATEMENTS_UPDATE_MESSAGGE, "PYTHON_LANGUAGE = None"), - "LOGGING_LANGUAGE \= getLoggingLanguage\(\)" : - "{0}\n{1}".format(STATEMENTS_UPDATE_MESSAGGE, "LOGGING_LANGUAGE = None"), - "TEXT_LANGUAGE \= getTextLanguage\(\)" : - "{0}\n{1}".format(STATEMENTS_UPDATE_MESSAGGE, "TEXT_LANGUAGE = None")} - -foundations.verbose.getLoggingConsoleHandler() -foundations.verbose.setVerbosityLevel(3) - -#********************************************************************************************************************** -#*** Module classes and definitions. -#********************************************************************************************************************** -def getSphinxDocumentationApi(packages, cloneDirectory, outputDirectory, apiFile): - """ - Gets Sphinx documentation API. - - :param packages: Packages. - :type packages: unicode - :param cloneDirectory: Source clone directory. - :type cloneDirectory: unicode - :param outputDirectory: Content directory. - :type outputDirectory: unicode - :param apiFile: API file. - :type apiFile: unicode - """ - - LOGGER.info("{0} | Building Sphinx documentation API!".format(getSphinxDocumentationApi.__name__)) - - if os.path.exists(cloneDirectory): - shutil.rmtree(cloneDirectory) - os.makedirs(cloneDirectory) - - packagesModules = {"apiModules" : [], - "testsModules" : []} - for package in packages.split(","): - package = __import__(package) - path = foundations.common.getFirstItem(package.__path__) - sourceDirectory = os.path.dirname(path) - - for file in sorted(list(foundations.walkers.filesWalker(sourceDirectory, filtersIn=("{0}.*\.ui$".format(path),)))): - LOGGER.info("{0} | Ui file: '{1}'".format(getSphinxDocumentationApi.__name__, file)) - targetDirectory = os.path.dirname(file).replace(sourceDirectory, "") - directory = "{0}{1}".format(cloneDirectory, targetDirectory) - if not foundations.common.pathExists(directory): - os.makedirs(directory) - source = os.path.join(directory, os.path.basename(file)) - shutil.copyfile(file, source) - - modules = [] - for file in sorted(list(foundations.walkers.filesWalker(sourceDirectory, filtersIn=("{0}.*\.py$".format(path),), - filtersOut=EXCLUDED_PYTHON_MODULES))): - LOGGER.info("{0} | Python file: '{1}'".format(getSphinxDocumentationApi.__name__, file)) - module = "{0}.{1}" .format((".".join(os.path.dirname(file).replace(sourceDirectory, "").split("/"))), - foundations.strings.getSplitextBasename(file)).strip(".") - LOGGER.info("{0} | Module name: '{1}'".format(getSphinxDocumentationApi.__name__, module)) - directory = os.path.dirname(os.path.join(cloneDirectory, module.replace(".", "/"))) - if not foundations.common.pathExists(directory): - os.makedirs(directory) - source = os.path.join(directory, os.path.basename(file)) - shutil.copyfile(file, source) - - sourceFile = File(source) - sourceFile.cache() - trimFromIndex = trimEndIndex = None - inMultilineString = inDecorator = False - for i, line in enumerate(sourceFile.content): - if re.search(r"__name__ +\=\= +\"__main__\"", line): - trimFromIndex = i - for pattern, value in CONTENT_SUBSTITUTIONS.iteritems(): - if re.search(pattern, line): - sourceFile.content[i] = re.sub(pattern, value, line) - - strippedLine = line.strip() - if re.search(r"^\"\"\"", strippedLine): - inMultilineString = not inMultilineString - - if inMultilineString: - continue - - if re.search(r"^@\w+", strippedLine) and \ - not re.search(r"@property", strippedLine) and \ - not re.search(r"^@\w+\.setter", strippedLine) and \ - not re.search(r"^@\w+\.deleter", strippedLine): - inDecorator = True - indent = re.search(r"^([ \t]*)", line) - - if re.search(r"^[ \t]*def \w+", sourceFile.content[i]) or \ - re.search(r"^[ \t]*class \w+", sourceFile.content[i]): - inDecorator = False - - if not inDecorator: - continue - - sourceFile.content[i] = "{0}{1} {2}".format(indent.groups()[0], DECORATORS_COMMENT_MESSAGE, line) - - if trimFromIndex: - LOGGER.info("{0} | Trimming '__main__' statements!".format(getSphinxDocumentationApi.__name__)) - content = [sourceFile.content[i] for i in range(trimFromIndex)] - content.append("{0}\n".format(STATEMENTS_UPDATE_MESSAGGE)) - sourceFile.content = content - sourceFile.write() - - if "__init__.py" in file: - continue - - rstFilePath = "{0}{1}".format(module, FILES_EXTENSION) - LOGGER.info("{0} | Building API file: '{1}'".format(getSphinxDocumentationApi.__name__, rstFilePath)) - rstFile = File(os.path.join(outputDirectory, rstFilePath)) - header = ["_`{0}`\n".format(module), - "==={0}\n".format("="*len(module)), - "\n", - ".. automodule:: {0}\n".format(module), - "\n"] - rstFile.content.extend(header) - - functions = OrderedDict() - classes = OrderedDict() - moduleAttributes = OrderedDict() - for member, object in moduleBrowser._readmodule(module, [source, ]).iteritems(): - if object.__class__ == moduleBrowser.Function: - if not member.startswith("_"): - functions[member] = [".. autofunction:: {0}\n".format(member)] - elif object.__class__ == moduleBrowser.Class: - classes[member] = [".. autoclass:: {0}\n".format(member), - " :show-inheritance:\n", - " :members:\n"] - elif object.__class__ == moduleBrowser.Global: - if not member.startswith("_"): - moduleAttributes[member] = [".. attribute:: {0}.{1}\n".format(module, member)] - - moduleAttributes and rstFile.content.append("Module Attributes\n-----------------\n\n") - for moduleAttribute in moduleAttributes.itervalues(): - rstFile.content.extend(moduleAttribute) - rstFile.content.append("\n") - - functions and rstFile.content.append("Functions\n---------\n\n") - for function in functions.itervalues(): - rstFile.content.extend(function) - rstFile.content.append("\n") - - classes and rstFile.content.append("Classes\n-------\n\n") - for class_ in classes.itervalues(): - rstFile.content.extend(class_) - rstFile.content.append("\n") - - rstFile.write() - modules.append(module) - - packagesModules["apiModules"].extend([module for module in modules if not "tests" in module]) - packagesModules["testsModules"].extend([module for module in modules if "tests" in module]) - - apiFile = File(apiFile) - apiFile.content.extend(TOCTREE_TEMPLATE_BEGIN) - for module in packagesModules["apiModules"]: - apiFile.content.append(" {0} <{1}>\n".format(module, "api/{0}".format(module))) - for module in packagesModules["testsModules"]: - apiFile.content.append(" {0} <{1}>\n".format(module, "api/{0}".format(module))) - apiFile.content.extend(TOCTREE_TEMPLATE_END) - apiFile.write() - -if __name__ == "__main__": - arguments = map(unicode, sys.argv) - getSphinxDocumentationApi(arguments[1], arguments[2], arguments[3], arguments[4]) diff --git a/utilities/getSphinxDocumentationTocTree.py b/utilities/getSphinxDocumentationTocTree.py deleted file mode 100644 index bb224542..00000000 --- a/utilities/getSphinxDocumentationTocTree.py +++ /dev/null @@ -1,133 +0,0 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- - -""" -**getSphinxDocumentationTocTree.py** - -**Platform:** - Windows, Linux, Mac Os X. - -**Description:** - Gets Sphinx documentation Toc Tree file. - -**Others:** - -""" - -#********************************************************************************************************************** -#*** Future imports. -#********************************************************************************************************************** -from __future__ import unicode_literals - -#********************************************************************************************************************** -#*** External imports. -#********************************************************************************************************************** -import glob -import os -import re -import sys -if sys.version_info[:2] <= (2, 6): - from ordereddict import OrderedDict -else: - from collections import OrderedDict - -#********************************************************************************************************************** -#*** Internal imports. -#********************************************************************************************************************** -import foundations.strings -import foundations.verbose -from foundations.io import File - -#********************************************************************************************************************** -#*** Module attributes. -#********************************************************************************************************************** -__author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" -__license__ = "GPL V3.0 - http://www.gnu.org/licenses/" -__maintainer__ = "Thomas Mansencal" -__email__ = "thomas.mansencal@gmail.com" -__status__ = "Production" - -__all__ = ["LOGGER", - "FILES_EXTENSION", - "TOCTREE_TEMPLATE_BEGIN", - "TOCTREE_TEMPLATE_END", - "getSphinxDocumentationTocTree"] - -LOGGER = foundations.verbose.installLogger() - -FILES_EXTENSION = ".rst" - -TOCTREE_TEMPLATE_BEGIN = ["Welcome to {0} |version|'s documentation!\n", - "{0}\n", - "\n", - "Contents:\n", - "\n", - ".. toctree::\n", - " :maxdepth: 2\n", - " :numbered:\n"] -TOCTREE_TEMPLATE_END = ["Search:\n", - "==================\n", - "\n", - "* :ref:`genindex`\n", - "* :ref:`modindex`\n", - "* :ref:`search`\n", ] - -foundations.verbose.getLoggingConsoleHandler() -foundations.verbose.setVerbosityLevel(3) - -#********************************************************************************************************************** -#*** Module classes and definitions. -#********************************************************************************************************************** -def getSphinxDocumentationTocTree(title, fileIn, fileOut, contentDirectory): - """ - Gets Sphinx documentation index file. - - :param title: Package title. - :type title: unicode - :param fileIn: File to convert. - :type fileIn: unicode - :param fileOut: Output file. - :type fileOut: unicode - :param contentDirectory: Content directory. - :type contentDirectory: unicode - """ - - LOGGER.info("{0} | Building Sphinx documentation index '{1}' file!".format(getSphinxDocumentationTocTree.__name__, - fileOut)) - file = File(fileIn) - file.cache() - - existingFiles = [foundations.strings.getSplitextBasename(item) - for item in glob.glob("{0}/*{1}".format(contentDirectory, FILES_EXTENSION))] - relativeDirectory = contentDirectory.replace("{0}/".format(os.path.dirname(fileOut)), "") - - tocTree = ["\n"] - for line in file.content: - search = re.search(r"`([a-zA-Z_ ]+)`_", line) - if not search: - continue - - item = search.groups()[0] - code = "{0}{1}".format(item[0].lower(), item.replace(" ", "")[1:]) - if code in existingFiles: - link = "{0}/{1}".format(relativeDirectory, code) - data = "{0}{1}{2} <{3}>\n".format(" ", " " * line.index("-"), item, link) - LOGGER.info("{0} | Adding '{1}' entry to Toc Tree!".format(getSphinxDocumentationTocTree.__name__, - data.replace("\n", ""))) - tocTree.append(data) - tocTree.append("\n") - - TOCTREE_TEMPLATE_BEGIN[0] = TOCTREE_TEMPLATE_BEGIN[0].format(title) - TOCTREE_TEMPLATE_BEGIN[1] = TOCTREE_TEMPLATE_BEGIN[1].format("=" * len(TOCTREE_TEMPLATE_BEGIN[0])) - content = TOCTREE_TEMPLATE_BEGIN - content.extend(tocTree) - content.extend(TOCTREE_TEMPLATE_END) - - file = File(fileOut) - file.content = content - file.write() - -if __name__ == "__main__": - arguments = map(unicode, sys.argv) - getSphinxDocumentationTocTree(arguments[1], arguments[2], arguments[3], arguments[4]) diff --git a/utilities/libraries/__init__.py b/utilities/libraries/__init__.py deleted file mode 100644 index e69de29b..00000000 diff --git a/utilities/libraries/python/__init__.py b/utilities/libraries/python/__init__.py deleted file mode 100644 index e69de29b..00000000 diff --git a/utilities/libraries/python/pyclbr.py b/utilities/libraries/python/pyclbr.py deleted file mode 100644 index 89d0c444..00000000 --- a/utilities/libraries/python/pyclbr.py +++ /dev/null @@ -1,360 +0,0 @@ -"""Parse a Python module and describe its classes and methods. - -Parse enough of a Python file to recognize imports and class and -method definitions, and to find out the superclasses of a class. - -The interface consists of a single function: - readmodule_ex(module [, path]) -where module is the name of a Python module, and path is an optional -list of directories where the module is to be searched. If present, -path is prepended to the system search path sys.path. The return -value is a dictionary. The keys of the dictionary are the names of -the classes defined in the module (including classes that are defined -via the from XXX import YYY construct). The values are class -instances of the class Class defined here. One special key/value pair -is present for packages: the key '__path__' has a list as its value -which contains the package search path. - -A class is described by the class Class in this module. Instances -of this class have the following instance variables: - module -- the module name - name -- the name of the class - super -- a list of super classes (Class instances) - methods -- a dictionary of methods - file -- the file in which the class was defined - lineno -- the line in the file on which the class statement occurred -The dictionary of methods uses the method names as keys and the line -numbers on which the method was defined as values. -If the name of a super class is not recognized, the corresponding -entry in the list of super classes is not a class instance but a -string giving the name of the **super** class. Since import statements -are recognized and imported modules are scanned as well, this -shouldn't happen often. - -A function is described by the class Function in this module. -Instances of this class have the following instance variables: - module -- the module name - name -- the name of the class - file -- the file in which the class was defined - lineno -- the line in the file on which the class statement occurred -""" - -import sys -import imp -import tokenize -from token import NAME, DEDENT, OP -from operator import itemgetter -if sys.version_info[:2] <= (2, 6): - from ordereddict import OrderedDict -else: - from collections import OrderedDict - -__all__ = ["readmodule", "readmodule_ex", "Class", "Function"] - -_modules = {} # cache of modules we've seen - -# each Python class is represented by an instance of this class -class Class: - '''Class to represent a Python class.''' - def __init__(self, module, name, super, file, lineno): - self.module = module - self.name = name - if super is None: - super = [] - self.super = super - self.methods = OrderedDict() - self.file = file - self.lineno = lineno - - def _addmethod(self, name, lineno): - self.methods[name] = lineno - -class Function: - '''Class to represent a top-level Python function''' - def __init__(self, module, name, file, lineno): - self.module = module - self.name = name - self.file = file - self.lineno = lineno - -class Global: - '''Class to represent a top-level Python global''' - def __init__(self, module, name, file, lineno): - self.module = module - self.name = name - self.file = file - self.lineno = lineno - -def readmodule(module, path=None): - '''Backwards compatible interface. - - Call readmodule_ex() and then only keep Class objects from the - resulting dictionary.''' - - res = {} - for key, value in _readmodule(module, path or []).items(): - if isinstance(value, Class): - res[key] = value - return res - -def readmodule_ex(module, path=None): - '''Read a module file and return a dictionary of classes. - - Search for MODULE in PATH and sys.path, read and parse the - module and return a dictionary with one entry for each class - found in the module. - ''' - return _readmodule(module, path or []) - -def _readmodule(module, path, inpackage=None): - '''Do the hard work for readmodule[_ex]. - - If INPACKAGE is given, it must be the dotted name of the package in - which we are searching for a submodule, and then PATH must be the - package search path; otherwise, we are searching for a top-level - module, and PATH is combined with sys.path. - ''' - # Compute the full module name (prepending inpackage if set) - if inpackage is not None: - fullmodule = "%s.%s" % (inpackage, module) - else: - fullmodule = module - - # Check in the cache - if fullmodule in _modules: - return _modules[fullmodule] - - # Initialize the dict for this module's contents - dict = OrderedDict() - - # Check if it is a built-in module; we don't do much for these - if module in sys.builtin_module_names and inpackage is None: - _modules[module] = dict - return dict - - # Check for a dotted module name - i = module.rfind('.') - if i >= 0: - package = module[:i] - submodule = module[i + 1:] - parent = _readmodule(package, path, inpackage) - if inpackage is not None: - package = "%s.%s" % (inpackage, package) - return _readmodule(submodule, parent['__path__'], package) - - # Search the path for the module - f = None - if inpackage is not None: - f, fname, (_s, _m, ty) = imp.find_module(module, path) - else: - f, fname, (_s, _m, ty) = imp.find_module(module, path + sys.path) - if ty == imp.PKG_DIRECTORY: - dict['__path__'] = [fname] - path = [fname] + path - f, fname, (_s, _m, ty) = imp.find_module('__init__', [fname]) - _modules[fullmodule] = dict - if ty != imp.PY_SOURCE: - # not Python source, can't do anything with this module - f.close() - return dict - - stack = [] # stack of (class, indent) pairs - - g = tokenize.generate_tokens(f.readline) - try: - for tokentype, token, start, _end, _line in g: - if tokentype == DEDENT: - lineno, thisindent = start - # close nested classes and defs - while stack and stack[-1][1] >= thisindent: - del stack[-1] - elif token == 'def': - lineno, thisindent = start - # close previous nested classes and defs - while stack and stack[-1][1] >= thisindent: - del stack[-1] - tokentype, meth_name, start = g.next()[0:3] - if tokentype != NAME: - continue # Syntax error - if stack: - cur_class = stack[-1][0] - if isinstance(cur_class, Class): - # it's a method - cur_class._addmethod(meth_name, lineno) - # else it's a nested def - else: - # it's a function - dict[meth_name] = Function(fullmodule, meth_name, - fname, lineno) - stack.append((None, thisindent)) # Marker for nested fns - elif token == 'class': - lineno, thisindent = start - # close previous nested classes and defs - while stack and stack[-1][1] >= thisindent: - del stack[-1] - tokentype, class_name, start = g.next()[0:3] - if tokentype != NAME: - continue # Syntax error - # parse what follows the class name - tokentype, token, start = g.next()[0:3] - inherit = None - if token == '(': - names = [] # List of superclasses - # there's a list of superclasses - level = 1 - super = [] # Tokens making up current superclass - while True: - tokentype, token, start = g.next()[0:3] - if token in (')', ',') and level == 1: - n = "".join(super) - if n in dict: - # we know this super class - n = dict[n] - else: - c = n.split('.') - if len(c) > 1: - # super class is of the form - # module.class: look in module for - # class - m = c[-2] - c = c[-1] - if m in _modules: - d = _modules[m] - if c in d: - n = d[c] - names.append(n) - super = [] - if token == '(': - level += 1 - elif token == ')': - level -= 1 - if level == 0: - break - elif token == ',' and level == 1: - pass - # only use NAME and OP (== dot) tokens for type name - elif tokentype in (NAME, OP) and level == 1: - super.append(token) - # expressions in the base list are not supported - inherit = names - cur_class = Class(fullmodule, class_name, inherit, - fname, lineno) - if not stack: - dict[class_name] = cur_class - stack.append((cur_class, thisindent)) - elif token == 'import' and start[1] == 0: - modules = _getnamelist(g) - for mod, _mod2 in modules: - try: - # Recursively read the imported module - if inpackage is None: - _readmodule(mod, path) - else: - try: - _readmodule(mod, path, inpackage) - except ImportError: - _readmodule(mod, []) - except: - # If we can't find or parse the imported module, - # too bad -- don't die here. - pass - elif token == 'from' and start[1] == 0: - mod, token = _getname(g) - if not mod or token != "import": - continue - names = _getnamelist(g) - try: - # Recursively read the imported module - d = _readmodule(mod, path, inpackage) - except: - # If we can't find or parse the imported module, - # too bad -- don't die here. - continue - # add any classes that were defined in the imported module - # to our name space if they were mentioned in the list - for n, n2 in names: - if n in d: - dict[n2 or n] = d[n] - elif n == '*': - # don't add names that start with _ - for n in d: - if n[0] != '_': - dict[n] = d[n] - elif tokentype == NAME and start[1] == 0: - name = token - line = _line - tokentype, token = g.next()[0:2] - if tokentype == OP and token == "=": - dict[name] = Global(fullmodule, name, fname, _line) - except StopIteration: - pass - - f.close() - return dict - -def _getnamelist(g): - # Helper to get a comma-separated list of dotted names plus 'as' - # clauses. Return a list of pairs (name, name2) where name2 is - # the 'as' name, or None if there is no 'as' clause. - names = [] - while True: - name, token = _getname(g) - if not name: - break - if token == 'as': - name2, token = _getname(g) - else: - name2 = None - names.append((name, name2)) - while token != "," and "\n" not in token: - token = g.next()[1] - if token != ",": - break - return names - -def _getname(g): - # Helper to get a dotted name, return a pair (name, token) where - # name is the dotted name, or None if there was no dotted name, - # and token is the next input token. - parts = [] - tokentype, token = g.next()[0:2] - if tokentype != NAME and token != '*': - return (None, token) - parts.append(token) - while True: - tokentype, token = g.next()[0:2] - if token != '.': - break - tokentype, token = g.next()[0:2] - if tokentype != NAME: - break - parts.append(token) - return (".".join(parts), token) - -def _main(): - # Main program for testing. - import os - mod = sys.argv[1] - if os.path.exists(mod): - path = [os.path.dirname(mod)] - mod = os.path.basename(mod) - if mod.lower().endswith(".py"): - mod = mod[:-3] - else: - path = [] - dict = readmodule_ex(mod, path) - objs = dict.values() - objs.sort(lambda a, b: cmp(getattr(a, 'lineno', 0), - getattr(b, 'lineno', 0))) - for obj in objs: - if isinstance(obj, Class): - print "class", obj.name, obj.super, obj.lineno - methods = sorted(obj.methods.iteritems(), key=itemgetter(1)) - for name, lineno in methods: - if name != "__path__": - print " def", name, lineno - elif isinstance(obj, Function): - print "def", obj.name, obj.lineno - -if __name__ == "__main__": - _main() diff --git a/utilities/reStructuredTextToHtml.py b/utilities/reStructuredTextToHtml.py deleted file mode 100644 index fb12f15f..00000000 --- a/utilities/reStructuredTextToHtml.py +++ /dev/null @@ -1,92 +0,0 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- - -""" -**reStructuredTextToHtml.py** - -**Platform:** - Windows, Linux, Mac Os X. - -**Description:** - Converts a reStructuredText file to html. - -**Others:** - -""" - -#********************************************************************************************************************** -#*** Future imports. -#********************************************************************************************************************** -from __future__ import unicode_literals - -#********************************************************************************************************************** -#*** External imports. -#********************************************************************************************************************** -import os -import sys - -#********************************************************************************************************************** -#*** Internal imports. -#********************************************************************************************************************** -import foundations.verbose -from foundations.io import File - -#********************************************************************************************************************** -#*** Module attributes. -#********************************************************************************************************************** -__author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" -__license__ = "GPL V3.0 - http://www.gnu.org/licenses/" -__maintainer__ = "Thomas Mansencal" -__email__ = "thomas.mansencal@gmail.com" -__status__ = "Production" - -__all__ = ["LOGGER", - "RST2HTML", - "CSS_FILE", - "TIDY_SETTINGS_FILE", - "NORMALIZATION", - "reStructuredTextToHtml"] - -LOGGER = foundations.verbose.installLogger() - -RST2HTML = "/Users/$USER/Documents/Development/VirtualEnv/HDRLabs/bin/rst2html.py" -CSS_FILE = "css/style.css" -TIDY_SETTINGS_FILE = "tidy/tidySettings.rc" - -NORMALIZATION = {"document": "document"} - -foundations.verbose.getLoggingConsoleHandler() -foundations.verbose.setVerbosityLevel(3) - -#********************************************************************************************************************** -#*** Module classes and definitions. -#********************************************************************************************************************** -def reStructuredTextToHtml(fileIn, fileOut): - """ - Outputs a reStructuredText file to html. - - :param fileIn: File to convert. - :type fileIn: unicode - :param fileOut: Output file. - :type fileOut: unicode - """ - - LOGGER.info("{0} | Converting '{1}' reStructuredText file to html!".format(reStructuredTextToHtml.__name__, fileIn)) - os.system("{0} --stylesheet-path='{1}' '{2}' > '{3}'".format(RST2HTML, - os.path.join(os.path.dirname(__file__), CSS_FILE), - fileIn, - fileOut)) - - LOGGER.info("{0} | Formatting html file!".format("Tidy")) - os.system("tidy -config {0} -m '{1}'".format(os.path.join(os.path.dirname(__file__), TIDY_SETTINGS_FILE), fileOut)) - - file = File(fileOut) - file.cache() - LOGGER.info("{0} | Replacing spaces with tabs!".format(reStructuredTextToHtml.__name__)) - file.content = [line.replace(" " * 4, "\t") for line in file.content] - file.write() - -if __name__ == "__main__": - arguments = map(unicode, sys.argv) - reStructuredTextToHtml(arguments[1], arguments[2]) diff --git a/utilities/sanitizer.py b/utilities/sanitizer.py new file mode 100644 index 00000000..c6a92ede --- /dev/null +++ b/utilities/sanitizer.py @@ -0,0 +1,107 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- + +""" +**sanitizer.py** + +**Platform:** + Windows, Linux, Mac Os X. + +**Description:** + Sanitizes python module file. :func:`bleach` definition is called by **Oncilla** package. + +**Others:** + +""" + +#********************************************************************************************************************** +#*** Future imports. +#********************************************************************************************************************** +from __future__ import unicode_literals + +#********************************************************************************************************************** +#*** External imports. +#********************************************************************************************************************** +import re + +#********************************************************************************************************************** +#*** Internal imports. +#********************************************************************************************************************** +import foundations.strings +import foundations.verbose +from foundations.io import File + +#********************************************************************************************************************** +#*** Module attributes. +#********************************************************************************************************************** +__author__ = "Thomas Mansencal" +__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" +__license__ = "GPL V3.0 - http://www.gnu.org/licenses/" +__maintainer__ = "Thomas Mansencal" +__email__ = "thomas.mansencal@gmail.com" +__status__ = "Production" + +__all__ = ["LOGGER", + "STATEMENT_UPDATE_MESSAGE", + "STATEMENT_SUBSTITUTE", + "bleach"] + +LOGGER = foundations.verbose.installLogger() + +STATEMENT_UPDATE_MESSAGE = "# Oncilla: Statement commented by auto-documentation process: " + +STATEMENT_SUBSTITUTE = ("(\n)(?P\s*if\s+__name__\s+==\s+[\"']__main__[\"']\s*:.*)", + "(\n)(?P\s*@(?!property|\w+\.setter|\w+\.deleter).*?)(\n+\s*def\s+)", + "(?Psys.path.append\(os.path.join\(os.path.dirname\(os.path.abspath\(__file__\)\), \"libraries\"\)\))", + "(?Pimport python.pyclbr as moduleBrowser)", + "(\n)(?P\s*_initializeApplication\(\))") + +STATEMENT_REPLACE = {"PYTHON_LANGUAGE = getPythonLanguage()": \ + "{0}\nPYTHON_LANGUAGE = None".format(STATEMENT_UPDATE_MESSAGE), + "LOGGING_LANGUAGE = getLoggingLanguage()": \ + "{0}\nLOGGING_LANGUAGE = None".format(STATEMENT_UPDATE_MESSAGE), + "TEXT_LANGUAGE = getTextLanguage()": \ + "{0}\nTEXT_LANGUAGE = None".format(STATEMENT_UPDATE_MESSAGE)} + +STATEMENT_IGNORE = ("@handleExceptions(ZeroDivisionError)",) + +#********************************************************************************************************************** +#*** Module classes and definitions. +#********************************************************************************************************************** +def bleach(file): + """ + Sanitizes given python module. + + :param file: Python module file. + :type file: unicode + :return: Definition success. + :rtype: bool + """ + + LOGGER.info("{0} | Sanitizing '{1}' python module!".format(__name__, file)) + + sourceFile = File(file) + content = sourceFile.read() + for pattern in STATEMENT_SUBSTITUTE: + matches = [match for match in re.finditer(pattern, content, re.DOTALL)] + + offset = 0 + for match in matches: + if any(map(lambda x: x in match.group("bleach"), STATEMENT_IGNORE)): + continue + + start, end = match.start("bleach"), match.end("bleach") + substitution = "{0}{1}".format(STATEMENT_UPDATE_MESSAGE, + re.sub("\n", "\n{0}".format(STATEMENT_UPDATE_MESSAGE), + match.group("bleach"))) + content = "".join((content[0: start + offset], + substitution, + content[end + offset:])) + offset += len(substitution) - len(match.group("bleach")) + + content = foundations.strings.replace(content, STATEMENT_REPLACE) + + sourceFile.content = [content] + sourceFile.write() + + return True diff --git a/utilities/sliceDocumentation.py b/utilities/sliceDocumentation.py deleted file mode 100644 index 09b28fcc..00000000 --- a/utilities/sliceDocumentation.py +++ /dev/null @@ -1,128 +0,0 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- - -""" -**sliceDocumentation.py** - -**Platform:** - Windows, Linux, Mac Os X. - -**Description:** - Slices given documentation file. - -**Others:** - -""" - -#********************************************************************************************************************** -#*** Future imports. -#********************************************************************************************************************** -from __future__ import unicode_literals - -#********************************************************************************************************************** -#*** External imports. -#********************************************************************************************************************** -import os -import re -import sys -if sys.version_info[:2] <= (2, 6): - from ordereddict import OrderedDict -else: - from collections import OrderedDict - -#********************************************************************************************************************** -#*** Internal imports. -#********************************************************************************************************************** -import foundations.verbose -from foundations.io import File - -#********************************************************************************************************************** -#*** Module attributes. -#********************************************************************************************************************** -__author__ = "Thomas Mansencal" -__copyright__ = "Copyright (C) 2008 - 2014 - Thomas Mansencal" -__license__ = "GPL V3.0 - http://www.gnu.org/licenses/" -__maintainer__ = "Thomas Mansencal" -__email__ = "thomas.mansencal@gmail.com" -__status__ = "Production" - -__all__ = ["LOGGER", - "OUTPUT_FILES_EXTENSION", - "SLICE_ATTRIBUTE_INDENT", - "CONTENT_DELETION", - "CONTENT_SUBSTITUTIONS", - "sliceDocumentation"] - -LOGGER = foundations.verbose.installLogger() - -OUTPUT_FILES_EXTENSION = "rst" -SLICE_ATTRIBUTE_INDENT = 2 -CONTENT_DELETION = () -CONTENT_SUBSTITUTIONS = {"resources/": "../", - " \|":" |" } - -foundations.verbose.getLoggingConsoleHandler() -foundations.verbose.setVerbosityLevel(3) - - -#********************************************************************************************************************** -#*** Module classes and definitions. -#********************************************************************************************************************** -def sliceDocumentation(fileIn, outputDirectory): - """ - This Definition slices given documentation file. - - :param fileIn: File to convert. - :type fileIn: unicode - :param outputDirectory: Output directory. - :type outputDirectory: unicode - """ - - LOGGER.info("{0} | Slicing '{1}' file!".format(sliceDocumentation.__name__, fileIn)) - file = File(fileIn) - file.cache() - - slices = OrderedDict() - for i, line in enumerate(file.content): - search = re.search(r"^\.\. \.(\w+)", line) - if search: - slices[search.groups()[0]] = i + SLICE_ATTRIBUTE_INDENT - - index = 0 - for slice, sliceStart in slices.iteritems(): - sliceFile = File(os.path.join(outputDirectory, "{0}.{1}".format(slice, OUTPUT_FILES_EXTENSION))) - LOGGER.info("{0} | Outputing '{1}' file!".format(sliceDocumentation.__name__, sliceFile.path)) - sliceEnd = index < (len(slices.values()) - 1) and slices.values()[index + 1] - SLICE_ATTRIBUTE_INDENT or \ - len(file.content) - - for i in range(sliceStart, sliceEnd): - skipLine = False - for item in CONTENT_DELETION: - if re.search(item, file.content[i]): - LOGGER.info("{0} | Skipping Line '{1}' with '{2}' content!".format(sliceDocumentation.__name__, - i, - item)) - skipLine = True - break - - if skipLine: - continue - - line = file.content[i] - for pattern, value in CONTENT_SUBSTITUTIONS.iteritems(): - line = re.sub(pattern, value, line) - - search = re.search(r"- `[\w ]+`_ \(([\w\.]+)\)", line) - if search: - LOGGER.info("{0} | Updating Line '{1}' link: '{2}'!".format(sliceDocumentation.__name__, - i, - search.groups()[0])) - line = "- :ref:`{0}`\n".format(search.groups()[0]) - sliceFile.content.append(line) - - sliceFile.write() - index += 1 - -if __name__ == "__main__": - arguments = map(unicode, sys.argv) - sliceDocumentation(arguments[1], arguments[2]) diff --git a/utilities/tidy/tidySettings.rc b/utilities/tidy/tidySettings.rc deleted file mode 100644 index 21f13a0a..00000000 --- a/utilities/tidy/tidySettings.rc +++ /dev/null @@ -1,10 +0,0 @@ -char-encoding: raw -doctype: omit -indent: true -indent-spaces: 4 -output-xhtml: true -merge-divs:true -quiet: true -show-warnings: false -wrap: 0 -tidy-mark: false \ No newline at end of file From 5f97a5331e8f6467e1cdfa24d7e7d9a0596e7687 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Tue, 18 Mar 2014 22:34:13 +0100 Subject: [PATCH 24/54] Implement "foundations.parsers.SectionsFileParser.parse" method changes. --- .../components/addons/loaderScript/loaderScript.py | 11 ++++------- .../addons/loaderScriptOptions/loaderScriptOptions.py | 5 ++--- sibl_gui/components/addons/preview/preview.py | 2 +- sibl_gui/components/core/database/types.py | 4 ++-- sibl_gui/components/core/inspector/inspector.py | 2 +- 5 files changed, 10 insertions(+), 14 deletions(-) diff --git a/sibl_gui/components/addons/loaderScript/loaderScript.py b/sibl_gui/components/addons/loaderScript/loaderScript.py index 6537c074..57cbaacf 100644 --- a/sibl_gui/components/addons/loaderScript/loaderScript.py +++ b/sibl_gui/components/addons/loaderScript/loaderScript.py @@ -738,8 +738,7 @@ def __templatesOutliner_view_selectionModel__selectionChanged(self, selectedItem LOGGER.debug("> Parsing '{0}' Template for '{1}' section.".format(template.name, self.__templateRemoteConnectionSection)) templateSectionsFileParser = foundations.parsers.SectionsFileParser(template.path) - templateSectionsFileParser.read() and templateSectionsFileParser.parse( - rawSections=(self.__templateScriptSection)) + templateSectionsFileParser.parse(rawSections=(self.__templateScriptSection)) if not self.__templateRemoteConnectionSection in templateSectionsFileParser.sections: return @@ -895,8 +894,7 @@ def sendLoaderScriptToSoftware(self, template, loaderScriptPath): LOGGER.info("{0} | Starting remote connection!".format(self.__class__.__name__)) templateSectionsFileParser = foundations.parsers.SectionsFileParser(template.path) - templateSectionsFileParser.read() and templateSectionsFileParser.parse( - rawSections=(self.__templateScriptSection)) + templateSectionsFileParser.parse(rawSections=(self.__templateScriptSection)) connectionType = foundations.parsers.getAttributeCompound("ConnectionType", templateSectionsFileParser.getValue("ConnectionType", self.__templateRemoteConnectionSection)) @@ -1007,8 +1005,7 @@ def getLoaderScript(self, template, iblSet, overrideKeys): LOGGER.debug("> Parsing Template file: '{0}'.".format(template)) templateSectionsFileParser = foundations.parsers.SectionsFileParser(template) - templateSectionsFileParser.read() and templateSectionsFileParser.parse( - rawSections=(self.__templateScriptSection)) + templateSectionsFileParser.parse(rawSections=(self.__templateScriptSection)) templateSections = dict.copy(templateSectionsFileParser.sections) for attribute, value in dict.copy(templateSections[self.__templateIblSetAttributesSection]).iteritems(): @@ -1023,7 +1020,7 @@ def getLoaderScript(self, template, iblSet, overrideKeys): LOGGER.debug("> Parsing Ibl Set file: '{0}'.".format(iblSet)) iblSetSectionsFileParser = foundations.parsers.SectionsFileParser(iblSet) - iblSetSectionsFileParser.read() and iblSetSectionsFileParser.parse() + iblSetSectionsFileParser.parse() iblSetSections = dict.copy(iblSetSectionsFileParser.sections) LOGGER.debug("> Flattening Ibl Set file attributes.") diff --git a/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py b/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py index 8f757b03..67fef365 100644 --- a/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py +++ b/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py @@ -995,7 +995,7 @@ def __views_setUi(self): if templateSettingsFile: LOGGER.debug("> Accessing '{0}' Template settings file: '{1}'.".format(template.name, templateSettingsFile)) templateSettingsSectionsFileParser = SectionsFileParser(templateSettingsFile) - templateSettingsSectionsFileParser.read() and templateSettingsSectionsFileParser.parse() + templateSettingsSectionsFileParser.parse() commonAttributesOverrides.update( templateSettingsSectionsFileParser.sections[self.__templateCommonAttributesSection]) additionalAttributesOverrides.update( @@ -1006,8 +1006,7 @@ def __views_setUi(self): LOGGER.debug("> Parsing '{0}' Template for '{1}' and '{2}' section.".format( template.name, self.__templateCommonAttributesSection, self.__templateAdditionalAttributesSection)) templateSectionsFileParser = SectionsFileParser(template.path) - templateSectionsFileParser.read() and templateSectionsFileParser.parse( - rawSections=(self.__templateScriptSection)) + templateSectionsFileParser.parse(rawSections=(self.__templateScriptSection)) self.__view_setUi(templateSectionsFileParser.sections.get(self.__templateCommonAttributesSection, {}), self.__commonView, commonAttributesOverrides) diff --git a/sibl_gui/components/addons/preview/preview.py b/sibl_gui/components/addons/preview/preview.py index 5af3fb4a..36afbfde 100644 --- a/sibl_gui/components/addons/preview/preview.py +++ b/sibl_gui/components/addons/preview/preview.py @@ -1054,7 +1054,7 @@ def getIblSetImagesPaths(self, iblSet, imageType): if foundations.common.pathExists(iblSet.path): LOGGER.debug("> Parsing Inspector Ibl Set file: '{0}'.".format(iblSet)) sectionsFileParser = SectionsFileParser(iblSet.path) - sectionsFileParser.read() and sectionsFileParser.parse() + sectionsFileParser.parse() for section in sectionsFileParser.sections: if re.search(r"Plate\d+", section): imagePaths.append(os.path.normpath(os.path.join(os.path.dirname(iblSet.path), diff --git a/sibl_gui/components/core/database/types.py b/sibl_gui/components/core/database/types.py index b6a29f2a..53e2f4b8 100644 --- a/sibl_gui/components/core/database/types.py +++ b/sibl_gui/components/core/database/types.py @@ -174,7 +174,7 @@ def setContent(self): """ sectionsFileParser = SectionsFileParser(self.path) - sectionsFileParser.read() and sectionsFileParser.parse() + sectionsFileParser.parse() if sectionsFileParser.sections: self.title = sectionsFileParser.getValue("Name", "Header") @@ -317,7 +317,7 @@ def setContent(self): """ sectionsFileParser = SectionsFileParser(self.path) - sectionsFileParser.read() and sectionsFileParser.parse(rawSections=("Script")) + sectionsFileParser.parse(rawSections=("Script")) if sectionsFileParser.sections: self.helpFile = foundations.parsers.getAttributeCompound("HelpFile", diff --git a/sibl_gui/components/core/inspector/inspector.py b/sibl_gui/components/core/inspector/inspector.py index 5687b10d..84c6694a 100644 --- a/sibl_gui/components/core/inspector/inspector.py +++ b/sibl_gui/components/core/inspector/inspector.py @@ -1392,7 +1392,7 @@ def __setActiveIblSetParser(self): if not self.__sectionsFileParsersCache.getContent(self.__activeIblSet.path): sectionsFileParser = SectionsFileParser(self.__activeIblSet.path) - sectionsFileParser.read() and sectionsFileParser.parse() + sectionsFileParser.parse() self.__sectionsFileParsersCache.addContent(**{self.__activeIblSet.path : sectionsFileParser}) @foundations.exceptions.handleExceptions(foundations.exceptions.FileExistsError) From dda904b6c7ae032d3f420952ce13e4d3477abc98 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Wed, 19 Mar 2014 23:34:04 +0100 Subject: [PATCH 25/54] Update "sibl_gui.__init__" module. --- sibl_gui/__init__.py | 4 +++- sibl_gui/globals/constants.py | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/sibl_gui/__init__.py b/sibl_gui/__init__.py index 3fb4857c..55ad412a 100644 --- a/sibl_gui/__init__.py +++ b/sibl_gui/__init__.py @@ -23,9 +23,11 @@ __email__ = "thomas.mansencal@gmail.com" __status__ = "Production" -__all__ = ["DEFAULT_CODEC"] +__all__ = ["DEFAULT_CODEC", + "CODEC_ERROR"] DEFAULT_CODEC = "utf-8" +CODEC_ERROR = "ignore" #********************************************************************************************************************** #*** Encoding manipulations. diff --git a/sibl_gui/globals/constants.py b/sibl_gui/globals/constants.py index c061ed78..e33126dd 100644 --- a/sibl_gui/globals/constants.py +++ b/sibl_gui/globals/constants.py @@ -66,7 +66,7 @@ class Constants(): defaultCodec = sibl_gui.DEFAULT_CODEC """Default codec: '**utf-8**' ( String )""" - codecError = "ignore" + codecError = sibl_gui.CODEC_ERROR """Default codec error behavior: '**ignore**' ( String )""" applicationDirectory = os.sep.join(("sIBL_GUI", ".".join((majorVersion, minorVersion)))) From 3383e80d3c4e11ef3ad3f0ac8c5e979de271dc7c Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Wed, 19 Mar 2014 23:34:43 +0100 Subject: [PATCH 26/54] Implement "Foundations" package changes. --- sibl_gui/ui/widgets/application_QToolBar.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sibl_gui/ui/widgets/application_QToolBar.py b/sibl_gui/ui/widgets/application_QToolBar.py index 78c186f6..e9825e7b 100644 --- a/sibl_gui/ui/widgets/application_QToolBar.py +++ b/sibl_gui/ui/widgets/application_QToolBar.py @@ -32,8 +32,8 @@ #*** Internal imports. #********************************************************************************************************************** import foundations.exceptions +import foundations.guerilla import foundations.verbose -import umbra.guerilla import umbra.ui.widgets.application_QToolBar from umbra.globals.uiConstants import UiConstants from umbra.ui.widgets.active_QLabel import Active_QLabel @@ -61,7 +61,7 @@ class Application_QToolBar(umbra.ui.widgets.application_QToolBar.Application_QTo Defines defines the Application toolbar. """ - __metaclass__ = umbra.guerilla.baseWarfare + __metaclass__ = foundations.guerilla.baseWarfare #****************************************************************************************************************** #*** Class methods. From 745b93c576f63f450ac49a094c8aa94aeac1e9cf Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Sat, 22 Mar 2014 09:26:10 +0100 Subject: [PATCH 27/54] Implement "Umbra" package changes. --- sibl_gui/launcher.py | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/sibl_gui/launcher.py b/sibl_gui/launcher.py index 0cd205ca..f5d497a5 100644 --- a/sibl_gui/launcher.py +++ b/sibl_gui/launcher.py @@ -122,20 +122,11 @@ class sIBL_GUI(umbra.engine.Umbra): def __init__(self, parent=None, - componentsPaths=None, - requisiteComponents=None, - visibleComponents=None, *args, **kwargs): """ Initializes the class. - :param componentsPaths: Components componentsPaths. - :type componentsPaths: tuple or list - :param requisiteComponents: Requisite components names. - :type requisiteComponents: tuple or list - :param visibleComponents: Visible components names. - :type visibleComponents: tuple or list :param \*args: Arguments. :type \*args: \* :param \*\*kwargs: Keywords arguments. @@ -146,9 +137,6 @@ def __init__(self, umbra.engine.Umbra.__init__(self, parent, - componentsPaths, - requisiteComponents, - visibleComponents, *args, **kwargs) From f3c66e5114de93d2fe2ceb5e09b9248bbee09bee Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Sat, 22 Mar 2014 09:26:34 +0100 Subject: [PATCH 28/54] Update ".gitignore" file. --- .gitignore | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index b500e581..b4d565a4 100644 --- a/.gitignore +++ b/.gitignore @@ -20,4 +20,5 @@ releases/Windows/ sibl_gui/resources/images/builders/ docs/sphinx/build/ docs/sphinx/source/resources/packages/ -utilities/dmgCanvas/ \ No newline at end of file +utilities/dmgCanvas/ +.idea/ \ No newline at end of file From 2e0243e2e690c1500a181791d90ea61888bcb735 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Sat, 22 Mar 2014 13:09:12 +0100 Subject: [PATCH 29/54] Ensure "onlineUpdater" component downloaded templates directory is writable. Close #197. --- sibl_gui/components/addons/onlineUpdater/remoteUpdater.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/sibl_gui/components/addons/onlineUpdater/remoteUpdater.py b/sibl_gui/components/addons/onlineUpdater/remoteUpdater.py index ec9cfd2a..b43986a4 100644 --- a/sibl_gui/components/addons/onlineUpdater/remoteUpdater.py +++ b/sibl_gui/components/addons/onlineUpdater/remoteUpdater.py @@ -42,6 +42,7 @@ #********************************************************************************************************************** import foundations.dataStructures import foundations.exceptions +import foundations.io import foundations.ui.common import foundations.verbose import umbra.ui.common @@ -760,6 +761,12 @@ def __Get_Latest_Templates_pushButton__clicked(self, checked): if not downloadDirectory: return + if not foundations.io.isWritable(downloadDirectory): + self.__container.engine.notificationsManager.exceptify( + "{0} | '{1}' directory is not writable".format( + self.__class__.__name__, downloadDirectory)) + return + LOGGER.debug("> Templates download directory: '{0}'.".format(downloadDirectory)) self.__downloadManager = DownloadManager(self, self.__networkAccessManager, From 3cd495602930f33076e4ec1cba0e63aa0b7f8c9c Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Sat, 22 Mar 2014 14:06:00 +0100 Subject: [PATCH 30/54] Prevent "IndexError" exception in "inspector" component. Closes #204. --- sibl_gui/components/core/inspector/inspector.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/sibl_gui/components/core/inspector/inspector.py b/sibl_gui/components/core/inspector/inspector.py index 84c6694a..ffdb7663 100644 --- a/sibl_gui/components/core/inspector/inspector.py +++ b/sibl_gui/components/core/inspector/inspector.py @@ -1073,7 +1073,7 @@ def deactivate(self): def initializeUi(self): """ Initializes the Component ui. - + :return: Method success. :rtype: bool """ @@ -1259,7 +1259,7 @@ def __view_selectionModel__selectionChanged(self, selectedItems, deselectedItems def __engine_fileSystemEventsManager__fileChanged(self, file): """ Defines the slot triggered by the **fileSystemEventsManager** when a file is changed. - + :param file: File changed. :type file: unicode """ @@ -1279,7 +1279,7 @@ def __engine_fileSystemEventsManager__fileChanged(self, file): def __engine_imagesCaches_QPixmap__contentAdded(self, paths): """ Defines the slot triggered by the **QPixmap** images cache when content is added. - + :param paths: Added content. :type paths: list """ @@ -1433,7 +1433,7 @@ def __drawActiveIblSetOverlay(self): sectionsFileParser = self.__sectionsFileParsersCache.getContent(iblSetPath) if sectionsFileParser is None: raise foundations.exceptions.ExecutionError( - "'{1}' Ibl Set file 'SectionsFileParser' instance not found!".format(iblSetPath)) + "'{0}' Ibl Set file 'SectionsFileParser' instance not found!".format(iblSetPath)) for section in sectionsFileParser.sections: if section == "Sun": From 961ee42da363f9fe1ef7bcce6b0f033679af18d6 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Sat, 22 Mar 2014 14:25:56 +0100 Subject: [PATCH 31/54] Prevent "ValueError" exception in "sibl_gui.components.core.inspector.inspector.Inspector.__drawActiveIblSetOverlay" method when invalid lights colors attributes are used. Closes #205. --- .../components/core/inspector/inspector.py | 214 ++++++++++-------- 1 file changed, 117 insertions(+), 97 deletions(-) diff --git a/sibl_gui/components/core/inspector/inspector.py b/sibl_gui/components/core/inspector/inspector.py index ffdb7663..ca0e2403 100644 --- a/sibl_gui/components/core/inspector/inspector.py +++ b/sibl_gui/components/core/inspector/inspector.py @@ -25,6 +25,7 @@ import os import re import sys + if sys.version_info[:2] <= (2, 6): from ordereddict import OrderedDict else: @@ -270,7 +271,7 @@ def uiResourcesDirectory(self, value): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "uiResourcesDirectory")) + "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "uiResourcesDirectory")) @uiResourcesDirectory.deleter @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) @@ -280,7 +281,7 @@ def uiResourcesDirectory(self): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "uiResourcesDirectory")) + "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "uiResourcesDirectory")) @property def uiPreviousImage(self): @@ -304,7 +305,7 @@ def uiPreviousImage(self, value): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "uiPreviousImage")) + "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "uiPreviousImage")) @uiPreviousImage.deleter @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) @@ -314,7 +315,7 @@ def uiPreviousImage(self): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "uiPreviousImage")) + "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "uiPreviousImage")) @property def uiNextImage(self): @@ -338,7 +339,7 @@ def uiNextImage(self, value): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "uiNextImage")) + "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "uiNextImage")) @uiNextImage.deleter @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) @@ -348,7 +349,7 @@ def uiNextImage(self): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "uiNextImage")) + "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "uiNextImage")) @property def uiLoadingImage(self): @@ -372,7 +373,7 @@ def uiLoadingImage(self, value): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "uiLoadingImage")) + "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "uiLoadingImage")) @uiLoadingImage.deleter @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) @@ -382,7 +383,7 @@ def uiLoadingImage(self): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "uiLoadingImage")) + "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "uiLoadingImage")) @property def dockArea(self): @@ -406,7 +407,7 @@ def dockArea(self, value): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "dockArea")) + "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "dockArea")) @dockArea.deleter @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) @@ -416,7 +417,7 @@ def dockArea(self): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "dockArea")) + "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "dockArea")) @property def listViewIconSize(self): @@ -452,7 +453,7 @@ def listViewIconSize(self): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "listViewIconSize")) + "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "listViewIconSize")) @property def engine(self): @@ -476,7 +477,7 @@ def engine(self, value): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "engine")) + "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "engine")) @engine.deleter @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) @@ -486,7 +487,7 @@ def engine(self): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "engine")) + "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "engine")) @property def iblSetsOutliner(self): @@ -510,7 +511,7 @@ def iblSetsOutliner(self, value): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "iblSetsOutliner")) + "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "iblSetsOutliner")) @iblSetsOutliner.deleter @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) @@ -520,7 +521,7 @@ def iblSetsOutliner(self): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "iblSetsOutliner")) + "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "iblSetsOutliner")) @property def sectionsFileParsersCache(self): @@ -544,7 +545,7 @@ def sectionsFileParsersCache(self, value): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "sectionsFileParsersCache")) + "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "sectionsFileParsersCache")) @sectionsFileParsersCache.deleter @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) @@ -554,7 +555,7 @@ def sectionsFileParsersCache(self): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "sectionsFileParsersCache")) + "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "sectionsFileParsersCache")) @property def model(self): @@ -578,7 +579,7 @@ def model(self, value): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "model")) + "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "model")) @model.deleter @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) @@ -588,7 +589,7 @@ def model(self): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "model")) + "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "model")) @property def view(self): @@ -612,7 +613,7 @@ def view(self, value): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "view")) + "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "view")) @view.deleter @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) @@ -622,7 +623,7 @@ def view(self): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "view")) + "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "view")) @property def thumbnailsSize(self): @@ -646,7 +647,8 @@ def thumbnailsSize(self, value): """ if value is not None: - assert type(value) is unicode, "'{0}' attribute: '{1}' type is not 'unicode'!".format("thumbnailsSize", value) + assert type(value) is unicode, "'{0}' attribute: '{1}' type is not 'unicode'!".format("thumbnailsSize", + value) self.__thumbnailsSize = value @thumbnailsSize.deleter @@ -657,7 +659,7 @@ def thumbnailsSize(self): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "thumbnailsSize")) + "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "thumbnailsSize")) @property def activeIblSet(self): @@ -681,7 +683,7 @@ def activeIblSet(self, value): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "activeIblSet")) + "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "activeIblSet")) @activeIblSet.deleter @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) @@ -691,7 +693,7 @@ def activeIblSet(self): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "activeIblSet")) + "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "activeIblSet")) @property def inspectorPlates(self): @@ -715,7 +717,7 @@ def inspectorPlates(self, value): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "inspectorPlates")) + "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "inspectorPlates")) @inspectorPlates.deleter @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) @@ -725,7 +727,7 @@ def inspectorPlates(self): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "inspectorPlates")) + "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "inspectorPlates")) @property def noPreviewImageText(self): @@ -749,7 +751,7 @@ def noPreviewImageText(self, value): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "noPreviewImageText")) + "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "noPreviewImageText")) @noPreviewImageText.deleter @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) @@ -759,7 +761,7 @@ def noPreviewImageText(self): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "noPreviewImageText")) + "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "noPreviewImageText")) @property def noActiveIblSetText(self): @@ -783,7 +785,7 @@ def noActiveIblSetText(self, value): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "noActiveIblSetText")) + "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "noActiveIblSetText")) @noActiveIblSetText.deleter @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) @@ -793,7 +795,7 @@ def noActiveIblSetText(self): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "noActiveIblSetText")) + "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "noActiveIblSetText")) @property def activeIblSetToolTipText(self): @@ -817,7 +819,7 @@ def activeIblSetToolTipText(self, value): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "activeIblSetToolTipText")) + "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "activeIblSetToolTipText")) @activeIblSetToolTipText.deleter @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) @@ -827,7 +829,7 @@ def activeIblSetToolTipText(self): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "activeIblSetToolTipText")) + "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "activeIblSetToolTipText")) @property def lightLabelRadius(self): @@ -851,7 +853,7 @@ def lightLabelRadius(self, value): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "lightLabelRadius")) + "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "lightLabelRadius")) @lightLabelRadius.deleter @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) @@ -861,7 +863,7 @@ def lightLabelRadius(self): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "lightLabelRadius")) + "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "lightLabelRadius")) @property def lightLabelTextOffset(self): @@ -885,7 +887,7 @@ def lightLabelTextOffset(self, value): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "lightLabelTextOffset")) + "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "lightLabelTextOffset")) @lightLabelTextOffset.deleter @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) @@ -895,7 +897,7 @@ def lightLabelTextOffset(self): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "lightLabelTextOffset")) + "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "lightLabelTextOffset")) @property def lightLabelTextMargin(self): @@ -919,7 +921,7 @@ def lightLabelTextMargin(self, value): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "lightLabelTextMargin")) + "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "lightLabelTextMargin")) @lightLabelTextMargin.deleter @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) @@ -929,7 +931,7 @@ def lightLabelTextMargin(self): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "lightLabelTextMargin")) + "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "lightLabelTextMargin")) @property def lightLabelTextHeight(self): @@ -953,7 +955,7 @@ def lightLabelTextHeight(self, value): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "lightLabelTextHeight")) + "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "lightLabelTextHeight")) @lightLabelTextHeight.deleter @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) @@ -963,7 +965,7 @@ def lightLabelTextHeight(self): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "lightLabelTextHeight")) + "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "lightLabelTextHeight")) @property def lightLabelTextFont(self): @@ -987,7 +989,7 @@ def lightLabelTextFont(self, value): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "lightLabelTextFont")) + "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "lightLabelTextFont")) @lightLabelTextFont.deleter @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) @@ -997,7 +999,7 @@ def lightLabelTextFont(self): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "lightLabelTextFont")) + "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "lightLabelTextFont")) @property def unnamedLightName(self): @@ -1022,7 +1024,7 @@ def unnamedLightName(self, value): if value is not None: assert type(value) is unicode, "'{0}' attribute: '{1}' type is not 'unicode'!".format( - "unnamedLightName", value) + "unnamedLightName", value) self.__unnamedLightName = value @unnamedLightName.deleter @@ -1033,7 +1035,7 @@ def unnamedLightName(self): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "unnamedLightName")) + "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "unnamedLightName")) #****************************************************************************************************************** #*** Class methods. @@ -1068,7 +1070,7 @@ def deactivate(self): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' Component cannot be deactivated!".format(self.__class__.__name__, self.__name)) + "{0} | '{1}' Component cannot be deactivated!".format(self.__class__.__name__, self.__name)) def initializeUi(self): """ @@ -1081,8 +1083,8 @@ def initializeUi(self): LOGGER.debug("> Initializing '{0}' Component ui.".format(self.__class__.__name__)) self.__pixmapPlaceholder = \ - sibl_gui.ui.common.getPixmap(os.path.join(self.__uiResourcesDirectory, self.__uiLoadingImage), - asynchronousLoading=False) + sibl_gui.ui.common.getPixmap(os.path.join(self.__uiResourcesDirectory, self.__uiLoadingImage), + asynchronousLoading=False) self.__sectionsFileParsersCache = foundations.cache.Cache() @@ -1093,9 +1095,10 @@ def initializeUi(self): self.Plates_listView.setObjectName("Plates_listView") self.Plates_frame_gridLayout.addWidget(self.Plates_listView, 0, 1) self.__view = self.Plates_listView - self.__view.storeModelSelection = self.__view.restoreModelSelection = lambda:True + self.__view.storeModelSelection = self.__view.restoreModelSelection = lambda: True - self.Previous_Ibl_Set_pushButton.setIcon(QIcon(os.path.join(self.__uiResourcesDirectory, self.__uiPreviousImage))) + self.Previous_Ibl_Set_pushButton.setIcon( + QIcon(os.path.join(self.__uiResourcesDirectory, self.__uiPreviousImage))) self.Next_Ibl_Set_pushButton.setIcon(QIcon(os.path.join(self.__uiResourcesDirectory, self.__uiNextImage))) self.Previous_Plate_pushButton.setIcon(QIcon(os.path.join(self.__uiResourcesDirectory, self.__uiPreviousImage))) self.Next_Plate_pushButton.setIcon(QIcon(os.path.join(self.__uiResourcesDirectory, self.__uiNextImage))) @@ -1135,7 +1138,7 @@ def uninitializeUi(self): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' Component ui cannot be uninitialized!".format(self.__class__.__name__, self.name)) + "{0} | '{1}' Component ui cannot be uninitialized!".format(self.__class__.__name__, self.name)) def addWidget(self): """ @@ -1158,7 +1161,7 @@ def removeWidget(self): """ raise foundations.exceptions.ProgrammingError( - "{0} | '{1}' Component Widget cannot be removed!".format(self.__class__.__name__, self.name)) + "{0} | '{1}' Component Widget cannot be removed!".format(self.__class__.__name__, self.name)) def __Inspector_DockWidget_setUi(self): """ @@ -1176,8 +1179,8 @@ def __Inspector_DockWidget_setUi(self): else: if foundations.common.pathExists(self.__activeIblSet.backgroundImage): pixmap = sibl_gui.ui.common.getPixmap(self.__activeIblSet.backgroundImage, - size=self.__thumbnailsSize, - placeholder=self.__pixmapPlaceholder) + size=self.__thumbnailsSize, + placeholder=self.__pixmapPlaceholder) previewAvailable = True if previewAvailable: @@ -1185,17 +1188,17 @@ def __Inspector_DockWidget_setUi(self): self.__drawActiveIblSetOverlay() else: self.Image_label.setText(self.__noPreviewImageText.format( - sibl_gui.ui.common.filterImagePath(self.__activeIblSet.icon), - self.__activeIblSet.author, - self.__activeIblSet.link)) + sibl_gui.ui.common.filterImagePath(self.__activeIblSet.icon), + self.__activeIblSet.author, + self.__activeIblSet.link)) self.Image_label.setToolTip(self.__activeIblSetToolTipText.format( - self.__activeIblSet.title, - self.__activeIblSet.author or Constants.nullObject, - self.__activeIblSet.location or Constants.nullObject, - sibl_gui.ui.common.getFormatedShotDate(self.__activeIblSet.date, - self.__activeIblSet.time) or Constants.nullObject, - self.__activeIblSet.comment or Constants.nullObject)) + self.__activeIblSet.title, + self.__activeIblSet.author or Constants.nullObject, + self.__activeIblSet.location or Constants.nullObject, + sibl_gui.ui.common.getFormatedShotDate(self.__activeIblSet.date, + self.__activeIblSet.time) or Constants.nullObject, + self.__activeIblSet.comment or Constants.nullObject)) self.Details_label.setText("

Comment: {0}
".format(self.__activeIblSet.comment)) @@ -1285,10 +1288,10 @@ def __engine_imagesCaches_QPixmap__contentAdded(self, paths): """ if not self.__activeIblSet: - return + return if foundations.common.getFirstItem(paths) in (self.__activeIblSet.previewImage, - self.__activeIblSet.backgroundImage): + self.__activeIblSet.backgroundImage): self.__Inspector_DockWidget_setUi() def __iblSetsOutliner__modelReset(self): @@ -1393,7 +1396,7 @@ def __setActiveIblSetParser(self): if not self.__sectionsFileParsersCache.getContent(self.__activeIblSet.path): sectionsFileParser = SectionsFileParser(self.__activeIblSet.path) sectionsFileParser.parse() - self.__sectionsFileParsersCache.addContent(**{self.__activeIblSet.path : sectionsFileParser}) + self.__sectionsFileParsersCache.addContent(**{self.__activeIblSet.path: sectionsFileParser}) @foundations.exceptions.handleExceptions(foundations.exceptions.FileExistsError) def __setActiveIblSetPlates(self): @@ -1404,21 +1407,23 @@ def __setActiveIblSetPlates(self): path = self.__activeIblSet.path if not foundations.common.pathExists(path): raise foundations.exceptions.FileExistsError( - "{0} | Exception raised while retrieving Plates: '{1}' Ibl Set file doesn't exists!".format( - self.__class__.__name__, self.__activeIblSet.title)) + "{0} | Exception raised while retrieving Plates: '{1}' Ibl Set file doesn't exists!".format( + self.__class__.__name__, self.__activeIblSet.title)) sectionsFileParser = self.__sectionsFileParsersCache.getContent(path) self.__inspectorPlates = OrderedDict() for section in sectionsFileParser.sections: if re.search(r"Plate\d+", section): self.__inspectorPlates[section] = \ - Plate(name=foundations.strings.getSplitextBasename(sectionsFileParser.getValue("PLATEfile", section)), - icon=os.path.normpath(os.path.join(os.path.dirname(self.__activeIblSet.path), - sectionsFileParser.getValue("PLATEthumb", section))), - previewImage=os.path.normpath(os.path.join(os.path.dirname(self.__activeIblSet.path), - sectionsFileParser.getValue("PLATEpreview", section))), - image=os.path.normpath(os.path.join(os.path.dirname(self.__activeIblSet.path), - sectionsFileParser.getValue("PLATEfile", section)))) + Plate( + name=foundations.strings.getSplitextBasename(sectionsFileParser.getValue("PLATEfile", section)), + icon=os.path.normpath(os.path.join(os.path.dirname(self.__activeIblSet.path), + sectionsFileParser.getValue("PLATEthumb", section))), + previewImage=os.path.normpath(os.path.join(os.path.dirname(self.__activeIblSet.path), + sectionsFileParser.getValue("PLATEpreview", + section))), + image=os.path.normpath(os.path.join(os.path.dirname(self.__activeIblSet.path), + sectionsFileParser.getValue("PLATEfile", section)))) @foundations.exceptions.handleExceptions(foundations.exceptions.ExecutionError) def __drawActiveIblSetOverlay(self): @@ -1433,22 +1438,36 @@ def __drawActiveIblSetOverlay(self): sectionsFileParser = self.__sectionsFileParsersCache.getContent(iblSetPath) if sectionsFileParser is None: raise foundations.exceptions.ExecutionError( - "'{0}' Ibl Set file 'SectionsFileParser' instance not found!".format(iblSetPath)) + "'{0}' Ibl Set file 'SectionsFileParser' instance not found!".format(iblSetPath)) for section in sectionsFileParser.sections: if section == "Sun": - self.__drawLightLabel(painter, Light(name="Sun", + try: + self.__drawLightLabel(painter, + Light(name="Sun", color=[int(value) for value in sectionsFileParser.getValue( - "SUNcolor", section).split(",")], + "SUNcolor", section).split(",")], uCoordinate=float(sectionsFileParser.getValue("SUNu", section)), vCoordinate=float(sectionsFileParser.getValue("SUNv", section)))) + except ValueError as Error: + raise foundations.exceptions.ExecutionError( + "'{0}' Ibl Set file 'Sun' section 'SUNcolor' attribute is invalid!".format(iblSetPath)) + elif re.search(r"Light\d+", section): - self.__drawLightLabel(painter, Light(name=sectionsFileParser.getValue( - "LIGHTname", section) or self.__unnamedLightName, - color=[int(value) for value in sectionsFileParser.getValue( - "LIGHTcolor", section).split(",")], - uCoordinate=float(sectionsFileParser.getValue("LIGHTu", section)), - vCoordinate=float(sectionsFileParser.getValue("LIGHTv", section)))) + try: + self.__drawLightLabel(painter, Light(name=sectionsFileParser.getValue( + "LIGHTname", section) or self.__unnamedLightName, + color=[int(value) for value in sectionsFileParser.getValue( + "LIGHTcolor", section).split(",")], + uCoordinate=float( + sectionsFileParser.getValue("LIGHTu", section)), + vCoordinate=float( + sectionsFileParser.getValue("LIGHTv", section)))) + except ValueError as Error: + raise foundations.exceptions.ExecutionError( + "'{0}' Ibl Set file '{1}' section 'LIGHTcolor' attribute is invalid!".format(iblSetPath, + section)) + painter.end() def __drawLightLabel(self, painter, light): @@ -1477,18 +1496,18 @@ def __drawLightLabel(self, painter, light): textWidth = painter.fontMetrics().width(light.name.title()) xLabelTextOffset = -(self.__lightLabelTextOffset + textWidth) if \ - pointX + textWidth + self.__lightLabelTextMargin + self.__lightLabelTextOffset > width else \ - self.__lightLabelTextOffset + pointX + textWidth + self.__lightLabelTextMargin + self.__lightLabelTextOffset > width else \ + self.__lightLabelTextOffset yLabelTextOffset = -(self.__lightLabelTextOffset + self.__lightLabelTextHeight) if \ - pointY - (self.__lightLabelTextHeight + self.__lightLabelTextMargin + self.__lightLabelTextOffset) < 0 else \ - self.__lightLabelTextOffset + pointY - (self.__lightLabelTextHeight + self.__lightLabelTextMargin + self.__lightLabelTextOffset) < 0 else \ + self.__lightLabelTextOffset painter.drawText(pointX + xLabelTextOffset, pointY - yLabelTextOffset, light.name.title()) painter.drawLine(pointX, - pointY, - pointX + (xLabelTextOffset + textWidth if xLabelTextOffset < 0 else xLabelTextOffset), - pointY - (yLabelTextOffset + self.__lightLabelTextHeight \ - if yLabelTextOffset < 0 else yLabelTextOffset)) + pointY, + pointX + (xLabelTextOffset + textWidth if xLabelTextOffset < 0 else xLabelTextOffset), + pointY - (yLabelTextOffset + self.__lightLabelTextHeight \ + if yLabelTextOffset < 0 else yLabelTextOffset)) painter.drawEllipse(QPoint(pointX, pointY), self.__lightLabelRadius, self.__lightLabelRadius) @@ -1522,10 +1541,10 @@ def setPlates(self): for name, plate in self.__inspectorPlates.iteritems(): plateNode = PlatesNode(plate, - name=name, - parent=rootNode, - nodeFlags=nodeFlags, - attributesFlags=attributesFlags) + name=name, + parent=rootNode, + nodeFlags=nodeFlags, + attributesFlags=attributesFlags) plateNode.roles[Qt.DisplayRole] = "" plateNode.roles[Qt.DecorationRole] = foundations.common.filterPath(plate.icon) @@ -1545,7 +1564,8 @@ def loopThroughIblSets(self, backward=False): if self.__activeIblSet: model = self.__iblSetsOutliner.model - activeIblSetNode = [node for node in model.rootNode.children if node.databaseItem.path == self.__activeIblSet.path] + activeIblSetNode = [node for node in model.rootNode.children if + node.databaseItem.path == self.__activeIblSet.path] activeIblSetNode = foundations.common.getFirstItem(activeIblSetNode) if not activeIblSetNode: return True From 6217bcab06c59b8bb7648601f73d5df66fac93b9 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Sat, 22 Mar 2014 16:09:07 +0100 Subject: [PATCH 32/54] Code formatting. --- .../loaderScriptOptions/loaderScriptOptions.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py b/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py index 67fef365..240542b8 100644 --- a/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py +++ b/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py @@ -775,7 +775,7 @@ def deactivate(self): def initializeUi(self): """ Initializes the Component ui. - + :return: Method success. :rtype: bool """ @@ -808,7 +808,7 @@ def initializeUi(self): def uninitializeUi(self): """ Uninitializes the Component ui. - + :return: Method success. :rtype: bool """ @@ -887,7 +887,7 @@ def __view_setUi(self, section, view, overrides): for row, attribute in enumerate(section): LOGGER.debug("> Current attribute: '{0}'.".format(attribute)) - overridesValue = attribute in overrides and overrides[attribute] or None + overridesValue = overrides[attribute] if attribute in overrides else None LOGGER.debug("> Settings value: '{0}'.".format(overridesValue or Constants.nullObject)) attributeCompound = foundations.parsers.getAttributeCompound(attribute, section[attribute]) @@ -898,7 +898,7 @@ def __view_setUi(self, section, view, overrides): LOGGER.debug("> Attribute type: '{0}'.".format(attributeCompound.type)) if attributeCompound.type == "Boolean": - state = int(overridesValue or attributeCompound.value) and True or False + state = True if int(overridesValue if overridesValue is not None else attributeCompound.value) else False item = Variable_QPushButton(self, state, (self.__uiLightGrayColor, self.__uiDarkGrayColor), @@ -912,7 +912,7 @@ def __view_setUi(self, section, view, overrides): item = QDoubleSpinBox() item.setMinimum(0) item.setMaximum(65535) - item.setValue(float(overridesValue or attributeCompound.value)) + item.setValue(float(overridesValue if overridesValue is not None else attributeCompound.value)) # Signals / Slots. item.valueChanged.connect(self.__view__valueChanged) @@ -926,7 +926,7 @@ def __view_setUi(self, section, view, overrides): # Signals / Slots. item.currentIndexChanged.connect(self.__view__valueChanged) elif attributeCompound.type == "String": - item = QLineEdit(QString(overridesValue or attributeCompound.value)) + item = QLineEdit(QString(overridesValue if overridesValue is not None else attributeCompound.value)) item.setAlignment(Qt.AlignCenter) # Signals / Slots. From f1dbfef6567adf04036c9e237fad29e2299acdea Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Sat, 22 Mar 2014 19:36:59 +0100 Subject: [PATCH 33/54] Handle exceptions in various components. --- .../loaderScriptOptions.py | 1 + .../locationsBrowser/locationsBrowser.py | 20 +++++----- .../components/core/inspector/inspector.py | 39 +++++++------------ 3 files changed, 26 insertions(+), 34 deletions(-) diff --git a/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py b/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py index 240542b8..e02a4aef 100644 --- a/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py +++ b/sibl_gui/components/addons/loaderScriptOptions/loaderScriptOptions.py @@ -855,6 +855,7 @@ def removeWidget(self): return True + @foundations.exceptions.handleExceptions(ValueError) def __view_setUi(self, section, view, overrides): """ Defines and sets the given View. diff --git a/sibl_gui/components/addons/locationsBrowser/locationsBrowser.py b/sibl_gui/components/addons/locationsBrowser/locationsBrowser.py index e62c386e..4c6c9e89 100644 --- a/sibl_gui/components/addons/locationsBrowser/locationsBrowser.py +++ b/sibl_gui/components/addons/locationsBrowser/locationsBrowser.py @@ -64,7 +64,7 @@ class LocationsBrowser(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)): """ | Defines the :mod:`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 + | 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 :mod:`sibl_gui.components.core.preferencesManager.preferencesManager` Component ui. @@ -521,7 +521,7 @@ def deactivate(self): def initializeUi(self): """ Initializes the Component ui. - + :return: Method success. :rtype: bool """ @@ -551,7 +551,7 @@ def initializeUi(self): def uninitializeUi(self): """ Uninitializes the Component ui. - + :return: Method success. :rtype: bool """ @@ -620,7 +620,7 @@ def __addActions(self): self.__inspector.Inspector_Overall_frame.addAction( self.__engine.actionsManager.registerAction( "Actions|Umbra|Components|core.inspector|Open Ibl Set location ...", - slot=self.__inspector_openActiveIblSetLocationsAction__triggered)) + slot=self.__inspector_openActiveIblSetLocationAction__triggered)) self.__componentsManagerUi.view.addAction( self.__engine.actionsManager.registerAction( "Actions|Umbra|Components|factory.ComponentsManagerUi|Open Component(s) Location(s) ...", @@ -641,10 +641,10 @@ def __removeActions(self): for view in self.__iblSetsOutliner.views: view.removeAction(self.__engine.actionsManager.getAction(openIblSetsLocationsAction)) self.__engine.actionsManager.unregisterAction(openIblSetsLocationsAction) - openActiveIblSetLocationsAction = "Actions|Umbra|Components|core.inspector|Open Ibl Set location ..." + openActiveIblSetLocationAction = "Actions|Umbra|Components|core.inspector|Open Ibl Set location ..." self.__inspector.Inspector_Overall_frame.removeAction( - self.__engine.actionsManager.getAction(openActiveIblSetLocationsAction)) - self.__engine.actionsManager.unregisterAction(openActiveIblSetLocationsAction) + self.__engine.actionsManager.getAction(openActiveIblSetLocationAction)) + self.__engine.actionsManager.unregisterAction(openActiveIblSetLocationAction) openComponentsLocationsAction = \ "Actions|Umbra|Components|factory.ComponentsManagerUi|Open Component(s) Location(s) ..." self.__componentsManagerUi.view.removeAction( @@ -669,7 +669,7 @@ def __iblSetsOutliner_views_openIblSetsLocationsAction__triggered(self, checked) return self.openIblSetsLocationsUi() - def __inspector_openActiveIblSetLocationsAction__triggered(self, checked): + def __inspector_openActiveIblSetLocationAction__triggered(self, checked): """ Defines the slot triggered by **'Actions|Umbra|Components|core.inspector|Open Ibl Set location ...'** action. @@ -679,7 +679,7 @@ def __inspector_openActiveIblSetLocationsAction__triggered(self, checked): :rtype: bool """ - return self.openActiveIblSetLocationsUi() + return self.openActiveIblSetLocationUi() def __componentsManagerUi_view_openComponentsLocationsAction__triggered(self, checked): """ @@ -795,7 +795,7 @@ def openIblSetsLocationsUi(self): @foundations.exceptions.handleExceptions(umbra.exceptions.notifyExceptionHandler, foundations.exceptions.FileExistsError) - def openActiveIblSetLocationsUi(self): + def openActiveIblSetLocationUi(self): """ Opens :mod:`sibl_gui.components.core.inspector.inspector` Component Ibl Set directory. diff --git a/sibl_gui/components/core/inspector/inspector.py b/sibl_gui/components/core/inspector/inspector.py index ca0e2403..06263bf5 100644 --- a/sibl_gui/components/core/inspector/inspector.py +++ b/sibl_gui/components/core/inspector/inspector.py @@ -1425,7 +1425,7 @@ def __setActiveIblSetPlates(self): image=os.path.normpath(os.path.join(os.path.dirname(self.__activeIblSet.path), sectionsFileParser.getValue("PLATEfile", section)))) - @foundations.exceptions.handleExceptions(foundations.exceptions.ExecutionError) + @foundations.exceptions.handleExceptions(foundations.exceptions.ExecutionError, ValueError) def __drawActiveIblSetOverlay(self): """ Draws an overlay on :obj:`Inspector.Image_Label` Widget. @@ -1442,31 +1442,22 @@ def __drawActiveIblSetOverlay(self): for section in sectionsFileParser.sections: if section == "Sun": - try: - self.__drawLightLabel(painter, - Light(name="Sun", - color=[int(value) for value in sectionsFileParser.getValue( - "SUNcolor", section).split(",")], - uCoordinate=float(sectionsFileParser.getValue("SUNu", section)), - vCoordinate=float(sectionsFileParser.getValue("SUNv", section)))) - except ValueError as Error: - raise foundations.exceptions.ExecutionError( - "'{0}' Ibl Set file 'Sun' section 'SUNcolor' attribute is invalid!".format(iblSetPath)) + self.__drawLightLabel(painter, + Light(name="Sun", + color=[int(value) for value in sectionsFileParser.getValue( + "SUNcolor", section).split(",")], + uCoordinate=float(sectionsFileParser.getValue("SUNu", section)), + vCoordinate=float(sectionsFileParser.getValue("SUNv", section)))) elif re.search(r"Light\d+", section): - try: - self.__drawLightLabel(painter, Light(name=sectionsFileParser.getValue( - "LIGHTname", section) or self.__unnamedLightName, - color=[int(value) for value in sectionsFileParser.getValue( - "LIGHTcolor", section).split(",")], - uCoordinate=float( - sectionsFileParser.getValue("LIGHTu", section)), - vCoordinate=float( - sectionsFileParser.getValue("LIGHTv", section)))) - except ValueError as Error: - raise foundations.exceptions.ExecutionError( - "'{0}' Ibl Set file '{1}' section 'LIGHTcolor' attribute is invalid!".format(iblSetPath, - section)) + self.__drawLightLabel(painter, Light(name=sectionsFileParser.getValue( + "LIGHTname", section) or self.__unnamedLightName, + color=[int(value) for value in sectionsFileParser.getValue( + "LIGHTcolor", section).split(",")], + uCoordinate=float( + sectionsFileParser.getValue("LIGHTu", section)), + vCoordinate=float( + sectionsFileParser.getValue("LIGHTv", section)))) painter.end() From be19e64bf6f472721107599e847d2fbff55ed925 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Sat, 22 Mar 2014 20:35:54 +0100 Subject: [PATCH 34/54] Prevent "AttributeError" exception in "sibl_gui.components.core.inspector.inspector.Inspector.__setActiveIblSet" method when no active iblSet is defined. Closes #206. --- sibl_gui/components/core/inspector/inspector.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/sibl_gui/components/core/inspector/inspector.py b/sibl_gui/components/core/inspector/inspector.py index 06263bf5..b27a93fd 100644 --- a/sibl_gui/components/core/inspector/inspector.py +++ b/sibl_gui/components/core/inspector/inspector.py @@ -1382,7 +1382,8 @@ def __setActiveIblSet(self): self.__activeIblSet = foundations.common.getFirstItem(selectedIblSets) if not self.__activeIblSet: rootNode = self.__iblSetsOutliner.model.rootNode - self.__activeIblSet = rootNode.children and foundations.common.getFirstItem(rootNode.children).databaseItem + childNode = foundations.common.getFirstItem(rootNode.children) + self.__activeIblSet = childNode.databaseItem if childNode is not None else None self.__activeIblSet and self.__setActiveIblSetParser() def __setActiveIblSetParser(self): From e496fd900d99fbfd790729dad9f5b6cc7478e0c7 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Sun, 23 Mar 2014 11:08:15 +0100 Subject: [PATCH 35/54] Remove unused imports. --- sibl_gui/components/core/inspector/inspector.py | 1 - 1 file changed, 1 deletion(-) diff --git a/sibl_gui/components/core/inspector/inspector.py b/sibl_gui/components/core/inspector/inspector.py index b27a93fd..c613332f 100644 --- a/sibl_gui/components/core/inspector/inspector.py +++ b/sibl_gui/components/core/inspector/inspector.py @@ -62,7 +62,6 @@ from sibl_gui.components.core.inspector.nodes import PlatesNode from sibl_gui.components.core.inspector.views import Plates_QListView from umbra.globals.constants import Constants -from umbra.globals.uiConstants import UiConstants #********************************************************************************************************************** #*** Module attributes. From f78e7111ab59fa389abf3f10ada3200028d756e0 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Sun, 23 Mar 2014 11:11:32 +0100 Subject: [PATCH 36/54] Restore ibl set icon in "inspector" component plates view. Closes #207. --- sibl_gui/components/core/inspector/inspector.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/sibl_gui/components/core/inspector/inspector.py b/sibl_gui/components/core/inspector/inspector.py index c613332f..6638fa5c 100644 --- a/sibl_gui/components/core/inspector/inspector.py +++ b/sibl_gui/components/core/inspector/inspector.py @@ -1524,7 +1524,8 @@ def setPlates(self): name=self.__activeIblSet.title, parent=rootNode, nodeFlags=nodeFlags, - attributesFlags=attributesFlags) + attributesFlags=attributesFlags, + iconPath = self.__activeIblSet.icon) iblSetNode.roles[Qt.DisplayRole] = "" if not self.__inspectorPlates: From 41a9653eb7e1bde343eac4293aff6f690bb0eb03 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Sun, 23 Mar 2014 12:54:07 +0100 Subject: [PATCH 37/54] Handle exception while searching in tags cloud using an invalid pattern in "searchDatabase" component. Closes #209. --- .../addons/searchDatabase/searchDatabase.py | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/sibl_gui/components/addons/searchDatabase/searchDatabase.py b/sibl_gui/components/addons/searchDatabase/searchDatabase.py index 9cd980ff..def237c4 100644 --- a/sibl_gui/components/addons/searchDatabase/searchDatabase.py +++ b/sibl_gui/components/addons/searchDatabase/searchDatabase.py @@ -616,10 +616,14 @@ def setTagsCloudMatchingIblsSets(self, pattern, flags=re.IGNORECASE): if patternTokens != patternsDefault: for pattern in patternTokens: patternMatched = False - for tag in tagsCloud: - if re.search(pattern, tag, flags=flags): - patternMatched = True - break + try: + pattern = re.compile(pattern, flags) + for tag in tagsCloud: + if re.search(pattern, tag, flags=flags): + patternMatched = True + break + except re.error: + LOGGER.warning("!> {0} | '{1}' regex pattern is invalid!".format(self.__class__.__name__, pattern)) patternsMatched *= patternMatched if patternsMatched: From 7fde2dfdf3d6c1defe292e69322530e13d1a2a48 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Sun, 23 Mar 2014 12:56:43 +0100 Subject: [PATCH 38/54] Update verbose statement. --- sibl_gui/components/addons/iblSetsScanner/workers.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sibl_gui/components/addons/iblSetsScanner/workers.py b/sibl_gui/components/addons/iblSetsScanner/workers.py index 3986a8fa..0842889a 100644 --- a/sibl_gui/components/addons/iblSetsScanner/workers.py +++ b/sibl_gui/components/addons/iblSetsScanner/workers.py @@ -262,7 +262,7 @@ def scanIblSetsDirectories(self): session=self.__databaseSession): self.__newIblSets.append(path) else: - LOGGER.warning("!> '{0}' directory doesn't exists and won't be scanned for new Ibl Sets!".format(directory)) + LOGGER.warning("!> {0} | '{1}' directory doesn't exists and won't be scanned for new Ibl Sets!".format(self.__class__.__name__, directory)) self.__databaseSession.close() From 1d0b6fb18c26c412b30a9b61ea70f2edc388f833 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Sun, 23 Mar 2014 16:06:36 +0100 Subject: [PATCH 39/54] Handle "WindowsError" in "database" component while retrieving stats on a non existing file. Closes #212. --- sibl_gui/components/core/database/operations.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/sibl_gui/components/core/database/operations.py b/sibl_gui/components/core/database/operations.py index 2488d16a..1edea619 100644 --- a/sibl_gui/components/core/database/operations.py +++ b/sibl_gui/components/core/database/operations.py @@ -209,6 +209,10 @@ def addStandardItem(type, name, path, collection, session=None): session = getSession(session) if not filterItems(query(type), "^{0}$".format(re.escape(path)), "path"): + if not foundations.common.pathExists(path): + LOGGER.warning("!> {0} | '{1}' file doesn't exists!".format(__name__, path)) + return False + osStats = ",".join((foundations.strings.toString(stat) for stat in os.stat(path))) databaseItem = type(name=name, path=path, collection=collection, osStats=osStats) if databaseItem.setContent(): @@ -268,6 +272,10 @@ def updateItemContent(item, session=None): LOGGER.debug("> Updating '{0}' '{1}' content.".format(item.name, item.__class__.__name__)) + if not foundations.common.pathExists(item.path): + LOGGER.warning("!> {0} | '{1}' file doesn't exists!".format(__name__, item.path)) + return False + item.osStats = ",".join(map(foundations.strings.toString, os.stat(item.path))) if item.setContent(): return commit(getSession(session)) From 21d5da683b56b911065c6fc3f5a4633a1893b5ec Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Sun, 23 Mar 2014 18:04:19 +0100 Subject: [PATCH 40/54] Prevent exception in "sibl_gui.ui.common.getFormattedShotDate" definition. Closes #213. --- .../resources/pages/api/sibl_gui.ui.common.rst | 2 +- sibl_gui/components/addons/gpsMap/gpsMap.py | 8 ++++---- sibl_gui/components/core/database/nodes.py | 12 ++++++------ sibl_gui/components/core/inspector/inspector.py | 2 +- sibl_gui/ui/common.py | 14 +++++++------- 5 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/sphinx/source/resources/pages/api/sibl_gui.ui.common.rst b/docs/sphinx/source/resources/pages/api/sibl_gui.ui.common.rst index 233c7dad..b844e671 100644 --- a/docs/sphinx/source/resources/pages/api/sibl_gui.ui.common.rst +++ b/docs/sphinx/source/resources/pages/api/sibl_gui.ui.common.rst @@ -33,5 +33,5 @@ Functions .. autofunction:: filterImagePath -.. autofunction:: getFormatedShotDate +.. autofunction:: getFormattedShotDate diff --git a/sibl_gui/components/addons/gpsMap/gpsMap.py b/sibl_gui/components/addons/gpsMap/gpsMap.py index 7b2c6b52..f1a6335b 100644 --- a/sibl_gui/components/addons/gpsMap/gpsMap.py +++ b/sibl_gui/components/addons/gpsMap/gpsMap.py @@ -488,7 +488,7 @@ def deactivate(self): def initializeUi(self): """ Initializes the Component ui. - + :return: Method success. :rtype: bool """ @@ -523,7 +523,7 @@ def initializeUi(self): def uninitializeUi(self): """ Uninitializes the Component ui. - + :return: Method success. :rtype: bool """ @@ -644,7 +644,7 @@ def setMarkersUi(self): :return: Method success. :rtype: bool - + :note: May require user interaction. """ @@ -676,7 +676,7 @@ def setMarker(self, iblSet): LOGGER.debug("> Ibl Set '{0}' provides GEO coordinates.".format(iblSet.name)) shotDateString = "Shot Date: {0}".format( - sibl_gui.ui.common.getFormatedShotDate(iblSet.date, iblSet.time) or Constants.nullObject) + sibl_gui.ui.common.getFormattedShotDate(iblSet.date, iblSet.time) or Constants.nullObject) content = "

{0}

\ Author: {1}
\ Location: {2}
{3}
\ diff --git a/sibl_gui/components/core/database/nodes.py b/sibl_gui/components/core/database/nodes.py index f4066aec..63e2f631 100644 --- a/sibl_gui/components/core/database/nodes.py +++ b/sibl_gui/components/core/database/nodes.py @@ -213,7 +213,7 @@ def toolTipText(self): def __initializeNode(self, attributesFlags=int(Qt.ItemIsSelectable | Qt.ItemIsEnabled)): """ Initializes the node. - + :param attributesFlags: Attributes flags. :type attributesFlags: int """ @@ -242,7 +242,7 @@ def updateNode(self): def updateNodeAttributes(self): """ Updates the Node attributes from the database item attributes. - + :return: Method success. :rtype: bool """ @@ -434,7 +434,7 @@ def updateNode(self): def updateNodeAttributes(self): """ Updates the node attributes from the database item attributes. - + :return: Method success. :rtype: bool """ @@ -463,7 +463,7 @@ def updateToolTip(self): self.roles[Qt.ToolTipRole] = self.toolTipText.format(self.databaseItem.title, self.databaseItem.author or Constants.nullObject, self.databaseItem.location or Constants.nullObject, - sibl_gui.ui.common.getFormatedShotDate(self.databaseItem.date, + sibl_gui.ui.common.getFormattedShotDate(self.databaseItem.date, self.databaseItem.time) or Constants.nullObject, self.databaseItem.comment or Constants.nullObject) return True @@ -565,7 +565,7 @@ def updateNode(self): def updateNodeAttributes(self): """ Updates the node attributes from the database item attributes. - + :return: Method success. :rtype: bool """ @@ -694,7 +694,7 @@ def updateNode(self): def updateNodeAttributes(self): """ Updates the node attributes from the database item attributes. - + :return: Method success. :rtype: bool """ diff --git a/sibl_gui/components/core/inspector/inspector.py b/sibl_gui/components/core/inspector/inspector.py index 6638fa5c..8491f64c 100644 --- a/sibl_gui/components/core/inspector/inspector.py +++ b/sibl_gui/components/core/inspector/inspector.py @@ -1195,7 +1195,7 @@ def __Inspector_DockWidget_setUi(self): self.__activeIblSet.title, self.__activeIblSet.author or Constants.nullObject, self.__activeIblSet.location or Constants.nullObject, - sibl_gui.ui.common.getFormatedShotDate(self.__activeIblSet.date, + sibl_gui.ui.common.getFormattedShotDate(self.__activeIblSet.date, self.__activeIblSet.time) or Constants.nullObject, self.__activeIblSet.comment or Constants.nullObject)) diff --git a/sibl_gui/ui/common.py b/sibl_gui/ui/common.py index 28a0e632..a3138464 100644 --- a/sibl_gui/ui/common.py +++ b/sibl_gui/ui/common.py @@ -70,7 +70,7 @@ "createPixmap", "getImageInformationsHeader", "filterImagePath", - "getFormatedShotDate"] + "getFormattedShotDate"] LOGGER = foundations.verbose.installLogger() @@ -367,9 +367,9 @@ def filterImagePath(path): else: return umbra.ui.common.getResourcePath(UiConstants.missingImage) -def getFormatedShotDate(date, time): +def getFormattedShotDate(date, time): """ - Returns a formated shot date. + Returns a formatted shot date. :param date: Ibl Set date key value. :type date: unicode @@ -379,13 +379,13 @@ def getFormatedShotDate(date, time): :rtype: unicode """ - LOGGER.debug("> Formating shot date with '{0}' date and '{1}' time.".format(date, time)) + LOGGER.debug("> Formatting shot date with '{0}' date and '{1}' time.".format(date, time)) - if date and time and date != Constants.nullObject and time != Constants.nullObject: - shotTime = "{0}H{1}".format(*time.split(":")) + if not Constants.nullObject in (time, date): + shotTime = "{0}H{1}".format(*foundations.common.unpackDefault(time.split(":"), 2, Constants.nullObject)) shotDate = date.replace(":", "/")[2:] + " - " + shotTime - LOGGER.debug("> Formated shot date: '{0}'.".format(shotDate)) + LOGGER.debug("> Formatted shot date: '{0}'.".format(shotDate)) return shotDate else: return Constants.nullObject From 10426077ec7befc6a637068baece742db39bfb1a Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Sun, 23 Mar 2014 20:56:09 +0100 Subject: [PATCH 41/54] Update "sibl_gui.ui.common.getFormattedShotDate" definition. --- sibl_gui/ui/common.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sibl_gui/ui/common.py b/sibl_gui/ui/common.py index a3138464..35279312 100644 --- a/sibl_gui/ui/common.py +++ b/sibl_gui/ui/common.py @@ -382,7 +382,7 @@ def getFormattedShotDate(date, time): LOGGER.debug("> Formatting shot date with '{0}' date and '{1}' time.".format(date, time)) if not Constants.nullObject in (time, date): - shotTime = "{0}H{1}".format(*foundations.common.unpackDefault(time.split(":"), 2, Constants.nullObject)) + shotTime = "{0}H{1}".format(*foundations.common.unpackDefault(time.split(":"), 2, "?")) shotDate = date.replace(":", "/")[2:] + " - " + shotTime LOGGER.debug("> Formatted shot date: '{0}'.".format(shotDate)) From aa1b333383ebc6bb5ed3e6efef4e380705c521fb Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Sun, 23 Mar 2014 23:45:22 +0100 Subject: [PATCH 42/54] Update various docstrings. --- sibl_gui/exceptions.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/sibl_gui/exceptions.py b/sibl_gui/exceptions.py index e4b39d62..f6eeae03 100644 --- a/sibl_gui/exceptions.py +++ b/sibl_gui/exceptions.py @@ -8,7 +8,7 @@ Windows, Linux, Mac Os X. **Description:** - Defines **sIBL_GUI** package exceptions. + Defines **sIBL_GUI** package exceptions. **Others:** @@ -59,35 +59,35 @@ class NetworkError(AbstractNetworkError): class SocketConnectionError(AbstractNetworkError): """ - Defines socket connection exceptions. + Defines socket connection exception. """ pass class Win32OLEServerConnectionError(AbstractNetworkError): """ - Defines Win32OLE Server connection exceptions. + Defines Win32OLE Server connection exception. """ pass class AbstractCacheError(foundations.exceptions.AbstractError): """ - Defines the abstract base class for caching related exceptions. + Defines the abstract base class for caching related exception. """ pass class CacheExistsError(foundations.exceptions.AbstractError): """ - Defines non existing cache exceptions. + Defines non existing cache exception. """ pass class CacheOperationError(foundations.exceptions.AbstractError): """ - Defines cache operations exceptions. + Defines cache operations exception. """ pass From da5164856d96e3f12849f0d83318085bb9643cf2 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Sun, 23 Mar 2014 23:50:30 +0100 Subject: [PATCH 43/54] Update documentation / help files. --- docs/sphinx/source/resources/pages/api.rst | 2 +- .../pages/api/foundations.common.rst | 2 - .../pages/api/foundations.exceptions.rst | 32 ++++++++ ....guerilla.rst => foundations.guerilla.rst} | 6 +- .../resources/pages/api/foundations.io.rst | 6 ++ .../pages/api/foundations.strings.rst | 4 +- .../pages/api/foundations.verbose.rst | 2 + utilities/css/style.css | 78 +++++++++++++++++++ 8 files changed, 124 insertions(+), 8 deletions(-) rename docs/sphinx/source/resources/pages/api/{umbra.guerilla.rst => foundations.guerilla.rst} (51%) create mode 100644 utilities/css/style.css diff --git a/docs/sphinx/source/resources/pages/api.rst b/docs/sphinx/source/resources/pages/api.rst index 4abfe206..e72f3b76 100644 --- a/docs/sphinx/source/resources/pages/api.rst +++ b/docs/sphinx/source/resources/pages/api.rst @@ -20,6 +20,7 @@ Modules Summary: foundations.environment foundations.exceptions foundations.globals.constants + foundations.guerilla foundations.io foundations.library foundations.namespace @@ -68,7 +69,6 @@ Modules Summary: umbra.globals.constants umbra.globals.runtimeGlobals umbra.globals.uiConstants - umbra.guerilla umbra.launcher umbra.managers.actionsManager umbra.managers.fileSystemEventsManager diff --git a/docs/sphinx/source/resources/pages/api/foundations.common.rst b/docs/sphinx/source/resources/pages/api/foundations.common.rst index f366dc8e..bf731af4 100644 --- a/docs/sphinx/source/resources/pages/api/foundations.common.rst +++ b/docs/sphinx/source/resources/pages/api/foundations.common.rst @@ -29,8 +29,6 @@ Functions .. autofunction:: getLastItem -.. autofunction:: isBinaryFile - .. autofunction:: repeat .. autofunction:: dependencyResolver diff --git a/docs/sphinx/source/resources/pages/api/foundations.exceptions.rst b/docs/sphinx/source/resources/pages/api/foundations.exceptions.rst index 94bed64c..33d949de 100644 --- a/docs/sphinx/source/resources/pages/api/foundations.exceptions.rst +++ b/docs/sphinx/source/resources/pages/api/foundations.exceptions.rst @@ -62,6 +62,38 @@ Classes :show-inheritance: :members: +.. autoclass:: AbstractIOError + :show-inheritance: + :members: + +.. autoclass:: FileReadError + :show-inheritance: + :members: + +.. autoclass:: FileWriteError + :show-inheritance: + :members: + +.. autoclass:: UrlReadError + :show-inheritance: + :members: + +.. autoclass:: UrlWriteError + :show-inheritance: + :members: + +.. autoclass:: DirectoryCreationError + :show-inheritance: + :members: + +.. autoclass:: PathCopyError + :show-inheritance: + :members: + +.. autoclass:: PathRemoveError + :show-inheritance: + :members: + .. autoclass:: AbstractOsError :show-inheritance: :members: diff --git a/docs/sphinx/source/resources/pages/api/umbra.guerilla.rst b/docs/sphinx/source/resources/pages/api/foundations.guerilla.rst similarity index 51% rename from docs/sphinx/source/resources/pages/api/umbra.guerilla.rst rename to docs/sphinx/source/resources/pages/api/foundations.guerilla.rst index 5143312c..54c3e9a1 100644 --- a/docs/sphinx/source/resources/pages/api/umbra.guerilla.rst +++ b/docs/sphinx/source/resources/pages/api/foundations.guerilla.rst @@ -1,7 +1,7 @@ -_`umbra.guerilla` -================= +_`foundations.guerilla` +======================= -.. automodule:: umbra.guerilla +.. automodule:: foundations.guerilla Functions --------- diff --git a/docs/sphinx/source/resources/pages/api/foundations.io.rst b/docs/sphinx/source/resources/pages/api/foundations.io.rst index 8c8126fb..4bebdf5e 100644 --- a/docs/sphinx/source/resources/pages/api/foundations.io.rst +++ b/docs/sphinx/source/resources/pages/api/foundations.io.rst @@ -17,6 +17,12 @@ Functions .. autofunction:: remove +.. autofunction:: isReadable + +.. autofunction:: isWritable + +.. autofunction:: isBinaryFile + Classes ------- diff --git a/docs/sphinx/source/resources/pages/api/foundations.strings.rst b/docs/sphinx/source/resources/pages/api/foundations.strings.rst index b99f9606..1a12caff 100644 --- a/docs/sphinx/source/resources/pages/api/foundations.strings.rst +++ b/docs/sphinx/source/resources/pages/api/foundations.strings.rst @@ -10,11 +10,11 @@ Module Attributes .. attribute:: foundations.strings.ASCII_CHARACTERS +.. attribute:: foundations.strings.toString + Functions --------- -.. autofunction:: toString - .. autofunction:: getNiceName .. autofunction:: getVersionRank diff --git a/docs/sphinx/source/resources/pages/api/foundations.verbose.rst b/docs/sphinx/source/resources/pages/api/foundations.verbose.rst index c44318e1..0f7ebd2b 100644 --- a/docs/sphinx/source/resources/pages/api/foundations.verbose.rst +++ b/docs/sphinx/source/resources/pages/api/foundations.verbose.rst @@ -23,6 +23,8 @@ Module Attributes Functions --------- +.. autofunction:: toUnicode + .. autofunction:: indentMessage .. autofunction:: tracer diff --git a/utilities/css/style.css b/utilities/css/style.css new file mode 100644 index 00000000..d5a89142 --- /dev/null +++ b/utilities/css/style.css @@ -0,0 +1,78 @@ +body { + background-color: rgb(32, 32, 32); + color: rgb(192, 192, 192); + text-align: justify; + font-size: 10pt; + margin: 10px 10px 10px 10px; +} + +A:link { + color: rgb(160, 96, 64); + text-decoration: none; +} + +A:visited { + text-decoration: none; + color: rgb(160, 96, 64); +} + +A:active { + text-decoration: none; + color: rgb(160, 96, 64); +} + +A:hover { + text-decoration: underline; + color: rgb(160, 96, 64); +} + +table { + border-color: rgb(96, 96, 96); + border-collapse: collapse; + border-style: solid; + border-width: 2px; +} + +pre { + background-color: rgb(64, 64, 64); + border: 2px solid rgb(160, 96, 64); + border-left: none; + border-right: none; + color: rgb(224, 224, 224); + font-size: 12pt; + padding: 5px; + white-space: pre-wrap; +} + +tt { + background-color: rgb(64, 64, 64); + color: rgb(224, 224, 224); + padding: 5px; + white-space: pre-wrap; + white-space: -moz-pre-wrap !important; +} + +::-webkit-scrollbar { + height: 12px; + width: 12px; +} + +::-webkit-scrollbar-track-piece { + background-color: rgb(48, 48, 48); +} + +::-webkit-scrollbar-thumb:horizontal, ::-webkit-scrollbar-thumb:vertical { + background-color: rgb(96, 96, 96); +} + +::-webkit-scrollbar-thumb:horizontal:hover, ::-webkit-scrollbar-thumb:vertical:hover { + background-color: rgb(128, 128, 128); +} + +::-webkit-scrollbar-thumb:horizontal { + width: 50px; +} + +::-webkit-scrollbar-thumb:vertical { + height: 50px; +} \ No newline at end of file From 5a0168ebd71285106a0a9b0748dcb9f11d879710 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Mon, 24 Mar 2014 22:55:03 +0100 Subject: [PATCH 44/54] Update utilities. --- docs/donations/Make_A_Donation.html | 2 +- docs/help/sIBL_GUI_Manual.html | 81 ++++++++++++++---------- releases/sIBL_GUI_Dependencies.rc | 8 +-- utilities/darwinBuild.sh | 15 +++-- utilities/getDependenciesInformations.py | 49 ++++++++++---- utilities/getDocumentation.sh | 47 -------------- utilities/getHDRLabsDocumentation.py | 72 +++++++++++++++++---- utilities/getPackagePath.py | 61 +++++++++++++++++- utilities/listImports.py | 53 ++++++++++++++-- utilities/recursiveRemove.py | 51 ++++++++++++++- utilities/windowsBuild.sh | 9 +-- 11 files changed, 315 insertions(+), 133 deletions(-) delete mode 100755 utilities/getDocumentation.sh diff --git a/docs/donations/Make_A_Donation.html b/docs/donations/Make_A_Donation.html index d456d235..d25e8a66 100644 --- a/docs/donations/Make_A_Donation.html +++ b/docs/donations/Make_A_Donation.html @@ -2,7 +2,7 @@ - + diff --git a/releases/sIBL_GUI_Dependencies.rc b/releases/sIBL_GUI_Dependencies.rc index 1e464bba..a9834517 100644 --- a/releases/sIBL_GUI_Dependencies.rc +++ b/releases/sIBL_GUI_Dependencies.rc @@ -1,5 +1,5 @@ [Dependencies] -Foundations=v2.0.8 -Manager=v2.0.4 -Umbra=v1.0.8 -sIBL_GUI_Templates=v2.1.0 +Oncilla=Foundations=v2.0.8-65-g505a443 +Manager=v2.0.3-35-g7d74430 +Umbra=v1.0.5-112-g3d23b01 +sIBL_GUI_Templates=v2.1.1-6-g3587914 diff --git a/utilities/darwinBuild.sh b/utilities/darwinBuild.sh index 0b68ff96..c9f22857 100755 --- a/utilities/darwinBuild.sh +++ b/utilities/darwinBuild.sh @@ -26,11 +26,12 @@ echo Cleanup - Begin echo ------------------------------------------------------------------------------- rm -rf $BUILD $DISTRIBUTION $DEPENDENCIES $BUNDLE packages="foundations,manager,umbra,sibl_gui" +types=".pyc,.pyo,.DS_Store,Thumbs.db" for package in $packages do - for type in ".pyc,.pyo,.DS_Store,Thumbs.db" + for type in $types do - python $UTILITIES/recursiveRemove.py $( $UTILITIES/getPackagePath.py $package ) $type + python $UTILITIES/recursiveRemove.py --input $( $UTILITIES/getPackagePath.py --package $package ) --pattern $type done done echo ------------------------------------------------------------------------------- @@ -41,9 +42,9 @@ echo --------------------------------------------------------------------------- echo ------------------------------------------------------------------------------- echo Build - Begin echo ------------------------------------------------------------------------------- -mv sibl_gui/launcher.py sibl_gui/sIBL_GUI\ $MAJOR_VERSION.py +mv sibl_gui/launcher.py sibl_gui/sIBL_GUI\ $MAJOR_VERSION.py python $PYINSTALLER/pyinstaller.py --noconfirm --noconsole -o releases/Darwin --hidden-import=ConfigParser --hidden-import=PyQt4 --hidden-import=PyQt4.QtCore --hidden-import=PyQt4.QtGui --hidden-import=PyQt4.QtNetwork --hidden-import=PyQt4.QtWebKit --hidden-import=PyQt4.uic --hidden-import=PyQt4.uic.Compiler --hidden-import=PyQt4.uic.Compiler.PyQt4 --hidden-import=PyQt4.uic.Compiler.compiler --hidden-import=PyQt4.uic.Compiler.indenter --hidden-import=PyQt4.uic.Compiler.logging --hidden-import=PyQt4.uic.Compiler.misc --hidden-import=PyQt4.uic.Compiler.proxy_metaclass --hidden-import=PyQt4.uic.Compiler.qobjectcreator --hidden-import=PyQt4.uic.Compiler.qtproxies --hidden-import=PyQt4.uic.Compiler.re --hidden-import=PyQt4.uic.Compiler.sys --hidden-import=PyQt4.uic.PyQt4 --hidden-import=PyQt4.uic.exceptions --hidden-import=PyQt4.uic.icon_cache --hidden-import=PyQt4.uic.logging --hidden-import=PyQt4.uic.objcreator --hidden-import=PyQt4.uic.os --hidden-import=PyQt4.uic.port_v2 --hidden-import=PyQt4.uic.port_v2.PyQt4 --hidden-import=PyQt4.uic.port_v2.as_string --hidden-import=PyQt4.uic.port_v2.ascii_upper --hidden-import=PyQt4.uic.port_v2.cStringIO --hidden-import=PyQt4.uic.port_v2.load_plugin --hidden-import=PyQt4.uic.port_v2.proxy_base --hidden-import=PyQt4.uic.port_v2.re --hidden-import=PyQt4.uic.port_v2.string --hidden-import=PyQt4.uic.port_v2.string_io --hidden-import=PyQt4.uic.properties --hidden-import=PyQt4.uic.re --hidden-import=PyQt4.uic.sys --hidden-import=PyQt4.uic.uiparser --hidden-import=PyQt4.uic.xml --hidden-import=Queue --hidden-import=SocketServer --hidden-import=StringIO --hidden-import=UserDict --hidden-import=__builtin__ --hidden-import=__future__ --hidden-import=__main__ --hidden-import=_abcoll --hidden-import=_ast --hidden-import=_bisect --hidden-import=_codecs --hidden-import=_collections --hidden-import=_ctypes --hidden-import=_functools --hidden-import=_hashlib --hidden-import=_heapq --hidden-import=_io --hidden-import=_locale --hidden-import=_random --hidden-import=_scproxy --hidden-import=_socket --hidden-import=_sqlite3 --hidden-import=_sre --hidden-import=_ssl --hidden-import=_struct --hidden-import=_virtualenv_distutils --hidden-import=_warnings --hidden-import=_weakref --hidden-import=_weakrefset --hidden-import=abc --hidden-import=array --hidden-import=ast --hidden-import=atexit --hidden-import=base64 --hidden-import=binascii --hidden-import=bisect --hidden-import=cPickle --hidden-import=cStringIO --hidden-import=cgi --hidden-import=code --hidden-import=codecs --hidden-import=codeop --hidden-import=collections --hidden-import=contextlib --hidden-import=copy --hidden-import=copy_reg --hidden-import=ctypes --hidden-import=ctypes._ctypes --hidden-import=ctypes._endian --hidden-import=ctypes.ctypes --hidden-import=ctypes.macholib --hidden-import=ctypes.macholib.dyld --hidden-import=ctypes.macholib.dylib --hidden-import=ctypes.macholib.framework --hidden-import=ctypes.macholib.itertools --hidden-import=ctypes.macholib.os --hidden-import=ctypes.macholib.re --hidden-import=ctypes.os --hidden-import=ctypes.struct --hidden-import=ctypes.sys --hidden-import=ctypes.util --hidden-import=datetime --hidden-import=decimal --hidden-import=decorator --hidden-import=dis --hidden-import=distutils --hidden-import=distutils.debug --hidden-import=distutils.dep_util --hidden-import=distutils.dist --hidden-import=distutils.distutils --hidden-import=distutils.email --hidden-import=distutils.errors --hidden-import=distutils.fancy_getopt --hidden-import=distutils.getopt --hidden-import=distutils.imp --hidden-import=distutils.log --hidden-import=distutils.opcode --hidden-import=distutils.os --hidden-import=distutils.re --hidden-import=distutils.spawn --hidden-import=distutils.stat --hidden-import=distutils.string --hidden-import=distutils.sys --hidden-import=distutils.sysconfig --hidden-import=distutils.text_file --hidden-import=distutils.util --hidden-import=distutils.warnings --hidden-import=email --hidden-import=email.Charset --hidden-import=email.Encoders --hidden-import=email.Errors --hidden-import=email.FeedParser --hidden-import=email.Generator --hidden-import=email.Header --hidden-import=email.Iterators --hidden-import=email.MIMEAudio --hidden-import=email.MIMEBase --hidden-import=email.MIMEImage --hidden-import=email.MIMEMessage --hidden-import=email.MIMEMultipart --hidden-import=email.MIMENonMultipart --hidden-import=email.MIMEText --hidden-import=email.Message --hidden-import=email.Parser --hidden-import=email.Utils --hidden-import=email._parseaddr --hidden-import=email.base64 --hidden-import=email.base64MIME --hidden-import=email.base64mime --hidden-import=email.binascii --hidden-import=email.cStringIO --hidden-import=email.charset --hidden-import=email.codecs --hidden-import=email.email --hidden-import=email.encoders --hidden-import=email.errors --hidden-import=email.feedparser --hidden-import=email.generator --hidden-import=email.header --hidden-import=email.iterators --hidden-import=email.message --hidden-import=email.mime --hidden-import=email.mime.audio --hidden-import=email.mime.base --hidden-import=email.mime.cStringIO --hidden-import=email.mime.email --hidden-import=email.mime.image --hidden-import=email.mime.imghdr --hidden-import=email.mime.message --hidden-import=email.mime.multipart --hidden-import=email.mime.nonmultipart --hidden-import=email.mime.sndhdr --hidden-import=email.mime.text --hidden-import=email.os --hidden-import=email.parser --hidden-import=email.quopri --hidden-import=email.quopriMIME --hidden-import=email.quoprimime --hidden-import=email.random --hidden-import=email.re --hidden-import=email.socket --hidden-import=email.string --hidden-import=email.sys --hidden-import=email.time --hidden-import=email.urllib --hidden-import=email.utils --hidden-import=email.uu --hidden-import=email.warnings --hidden-import=encodings --hidden-import=encodings.__builtin__ --hidden-import=encodings.aliases --hidden-import=encodings.ascii --hidden-import=encodings.codecs --hidden-import=encodings.encodings --hidden-import=encodings.utf_8 --hidden-import=errno --hidden-import=exceptions --hidden-import=fcntl --hidden-import=fnmatch --hidden-import=functools --hidden-import=gc --hidden-import=genericpath --hidden-import=getopt --hidden-import=getpass --hidden-import=gettext --hidden-import=grp --hidden-import=hashlib --hidden-import=heapq --hidden-import=httplib --hidden-import=imghdr --hidden-import=imp --hidden-import=inspect --hidden-import=io --hidden-import=itertools --hidden-import=keyword --hidden-import=linecache --hidden-import=locale --hidden-import=logging --hidden-import=logging.atexit --hidden-import=logging.cStringIO --hidden-import=logging.codecs --hidden-import=logging.os --hidden-import=logging.sys --hidden-import=logging.thread --hidden-import=logging.threading --hidden-import=logging.time --hidden-import=logging.traceback --hidden-import=logging.warnings --hidden-import=logging.weakref --hidden-import=logilab --hidden-import=marshal --hidden-import=math --hidden-import=migrate --hidden-import=migrate.changeset --hidden-import=migrate.changeset.StringIO --hidden-import=migrate.changeset.UserDict --hidden-import=migrate.changeset.ansisql --hidden-import=migrate.changeset.constraint --hidden-import=migrate.changeset.databases --hidden-import=migrate.changeset.databases.UserDict --hidden-import=migrate.changeset.databases.copy --hidden-import=migrate.changeset.databases.firebird --hidden-import=migrate.changeset.databases.migrate --hidden-import=migrate.changeset.databases.mysql --hidden-import=migrate.changeset.databases.oracle --hidden-import=migrate.changeset.databases.postgres --hidden-import=migrate.changeset.databases.sqlalchemy --hidden-import=migrate.changeset.databases.sqlite --hidden-import=migrate.changeset.databases.visitor --hidden-import=migrate.changeset.migrate --hidden-import=migrate.changeset.re --hidden-import=migrate.changeset.schema --hidden-import=migrate.changeset.sqlalchemy --hidden-import=migrate.changeset.warnings --hidden-import=migrate.exceptions --hidden-import=migrate.migrate --hidden-import=migrate.versioning --hidden-import=migrate.versioning.ConfigParser --hidden-import=migrate.versioning.api --hidden-import=migrate.versioning.cfgparse --hidden-import=migrate.versioning.config --hidden-import=migrate.versioning.datetime --hidden-import=migrate.versioning.genmodel --hidden-import=migrate.versioning.inspect --hidden-import=migrate.versioning.logging --hidden-import=migrate.versioning.migrate --hidden-import=migrate.versioning.os --hidden-import=migrate.versioning.pathed --hidden-import=migrate.versioning.pkg_resources --hidden-import=migrate.versioning.re --hidden-import=migrate.versioning.repository --hidden-import=migrate.versioning.schema --hidden-import=migrate.versioning.schemadiff --hidden-import=migrate.versioning.script --hidden-import=migrate.versioning.script.StringIO --hidden-import=migrate.versioning.script.base --hidden-import=migrate.versioning.script.inspect --hidden-import=migrate.versioning.script.logging --hidden-import=migrate.versioning.script.migrate --hidden-import=migrate.versioning.script.py --hidden-import=migrate.versioning.script.shutil --hidden-import=migrate.versioning.script.sql --hidden-import=migrate.versioning.script.warnings --hidden-import=migrate.versioning.shutil --hidden-import=migrate.versioning.sqlalchemy --hidden-import=migrate.versioning.string --hidden-import=migrate.versioning.sys --hidden-import=migrate.versioning.tempita --hidden-import=migrate.versioning.template --hidden-import=migrate.versioning.util --hidden-import=migrate.versioning.util.decorator --hidden-import=migrate.versioning.util.importpath --hidden-import=migrate.versioning.util.keyedinstance --hidden-import=migrate.versioning.util.logging --hidden-import=migrate.versioning.util.migrate --hidden-import=migrate.versioning.util.os --hidden-import=migrate.versioning.util.pkg_resources --hidden-import=migrate.versioning.util.sqlalchemy --hidden-import=migrate.versioning.util.sys --hidden-import=migrate.versioning.util.warnings --hidden-import=migrate.versioning.version --hidden-import=mimetools --hidden-import=new --hidden-import=numbers --hidden-import=opcode --hidden-import=operator --hidden-import=optparse --hidden-import=os --hidden-import=os.path --hidden-import=pickle --hidden-import=pkg_resources --hidden-import=pkgutil --hidden-import=platform --hidden-import=plistlib --hidden-import=posix --hidden-import=posixpath --hidden-import=pwd --hidden-import=pyexpat --hidden-import=pyexpat.errors --hidden-import=pyexpat.model --hidden-import=quopri --hidden-import=random --hidden-import=re --hidden-import=rfc822 --hidden-import=select --hidden-import=sets --hidden-import=shutil --hidden-import=signal --hidden-import=sip --hidden-import=site --hidden-import=sitecustomize --hidden-import=sndhdr --hidden-import=socket --hidden-import=sqlalchemy --hidden-import=sqlalchemy.codecs --hidden-import=sqlalchemy.collections --hidden-import=sqlalchemy.connectors --hidden-import=sqlalchemy.connectors.mxodbc --hidden-import=sqlalchemy.connectors.mysqldb --hidden-import=sqlalchemy.connectors.pyodbc --hidden-import=sqlalchemy.connectors.re --hidden-import=sqlalchemy.connectors.sqlalchemy --hidden-import=sqlalchemy.connectors.sys --hidden-import=sqlalchemy.connectors.urllib --hidden-import=sqlalchemy.connectors.warnings --hidden-import=sqlalchemy.connectors.zxJDBC --hidden-import=sqlalchemy.cprocessors --hidden-import=sqlalchemy.cresultproxy --hidden-import=sqlalchemy.databases --hidden-import=sqlalchemy.databases.sqlalchemy --hidden-import=sqlalchemy.datetime --hidden-import=sqlalchemy.dialects --hidden-import=sqlalchemy.dialects.access --hidden-import=sqlalchemy.dialects.access.base --hidden-import=sqlalchemy.dialects.access.sqlalchemy --hidden-import=sqlalchemy.dialects.drizzle --hidden-import=sqlalchemy.dialects.drizzle.base --hidden-import=sqlalchemy.dialects.drizzle.mysqldb --hidden-import=sqlalchemy.dialects.drizzle.sqlalchemy --hidden-import=sqlalchemy.dialects.firebird --hidden-import=sqlalchemy.dialects.firebird.base --hidden-import=sqlalchemy.dialects.firebird.datetime --hidden-import=sqlalchemy.dialects.firebird.kinterbasdb --hidden-import=sqlalchemy.dialects.firebird.re --hidden-import=sqlalchemy.dialects.firebird.sqlalchemy --hidden-import=sqlalchemy.dialects.informix --hidden-import=sqlalchemy.dialects.informix.base --hidden-import=sqlalchemy.dialects.informix.datetime --hidden-import=sqlalchemy.dialects.informix.informixdb --hidden-import=sqlalchemy.dialects.informix.re --hidden-import=sqlalchemy.dialects.informix.sqlalchemy --hidden-import=sqlalchemy.dialects.maxdb --hidden-import=sqlalchemy.dialects.maxdb.base --hidden-import=sqlalchemy.dialects.maxdb.datetime --hidden-import=sqlalchemy.dialects.maxdb.itertools --hidden-import=sqlalchemy.dialects.maxdb.re --hidden-import=sqlalchemy.dialects.maxdb.sapdb --hidden-import=sqlalchemy.dialects.maxdb.sqlalchemy --hidden-import=sqlalchemy.dialects.mssql --hidden-import=sqlalchemy.dialects.mssql.adodbapi --hidden-import=sqlalchemy.dialects.mssql.base --hidden-import=sqlalchemy.dialects.mssql.datetime --hidden-import=sqlalchemy.dialects.mssql.decimal --hidden-import=sqlalchemy.dialects.mssql.information_schema --hidden-import=sqlalchemy.dialects.mssql.mxodbc --hidden-import=sqlalchemy.dialects.mssql.operator --hidden-import=sqlalchemy.dialects.mssql.pymssql --hidden-import=sqlalchemy.dialects.mssql.pyodbc --hidden-import=sqlalchemy.dialects.mssql.re --hidden-import=sqlalchemy.dialects.mssql.sqlalchemy --hidden-import=sqlalchemy.dialects.mssql.sys --hidden-import=sqlalchemy.dialects.mssql.zxjdbc --hidden-import=sqlalchemy.dialects.mysql --hidden-import=sqlalchemy.dialects.mysql.array --hidden-import=sqlalchemy.dialects.mysql.base --hidden-import=sqlalchemy.dialects.mysql.datetime --hidden-import=sqlalchemy.dialects.mysql.inspect --hidden-import=sqlalchemy.dialects.mysql.mysqlconnector --hidden-import=sqlalchemy.dialects.mysql.mysqldb --hidden-import=sqlalchemy.dialects.mysql.oursql --hidden-import=sqlalchemy.dialects.mysql.pymysql --hidden-import=sqlalchemy.dialects.mysql.pyodbc --hidden-import=sqlalchemy.dialects.mysql.re --hidden-import=sqlalchemy.dialects.mysql.sqlalchemy --hidden-import=sqlalchemy.dialects.mysql.sys --hidden-import=sqlalchemy.dialects.mysql.zxjdbc --hidden-import=sqlalchemy.dialects.oracle --hidden-import=sqlalchemy.dialects.oracle.base --hidden-import=sqlalchemy.dialects.oracle.collections --hidden-import=sqlalchemy.dialects.oracle.cx_oracle --hidden-import=sqlalchemy.dialects.oracle.datetime --hidden-import=sqlalchemy.dialects.oracle.decimal --hidden-import=sqlalchemy.dialects.oracle.random --hidden-import=sqlalchemy.dialects.oracle.re --hidden-import=sqlalchemy.dialects.oracle.sqlalchemy --hidden-import=sqlalchemy.dialects.oracle.zxjdbc --hidden-import=sqlalchemy.dialects.postgresql --hidden-import=sqlalchemy.dialects.postgresql.base --hidden-import=sqlalchemy.dialects.postgresql.logging --hidden-import=sqlalchemy.dialects.postgresql.pg8000 --hidden-import=sqlalchemy.dialects.postgresql.psycopg2 --hidden-import=sqlalchemy.dialects.postgresql.pypostgresql --hidden-import=sqlalchemy.dialects.postgresql.re --hidden-import=sqlalchemy.dialects.postgresql.sqlalchemy --hidden-import=sqlalchemy.dialects.postgresql.uuid --hidden-import=sqlalchemy.dialects.postgresql.zxjdbc --hidden-import=sqlalchemy.dialects.sqlite --hidden-import=sqlalchemy.dialects.sqlite.base --hidden-import=sqlalchemy.dialects.sqlite.datetime --hidden-import=sqlalchemy.dialects.sqlite.os --hidden-import=sqlalchemy.dialects.sqlite.pysqlite --hidden-import=sqlalchemy.dialects.sqlite.re --hidden-import=sqlalchemy.dialects.sqlite.sqlalchemy --hidden-import=sqlalchemy.dialects.sqlite.sqlite3 --hidden-import=sqlalchemy.dialects.sybase --hidden-import=sqlalchemy.dialects.sybase.base --hidden-import=sqlalchemy.dialects.sybase.operator --hidden-import=sqlalchemy.dialects.sybase.pyodbc --hidden-import=sqlalchemy.dialects.sybase.pysybase --hidden-import=sqlalchemy.dialects.sybase.sqlalchemy --hidden-import=sqlalchemy.engine --hidden-import=sqlalchemy.engine.StringIO --hidden-import=sqlalchemy.engine.base --hidden-import=sqlalchemy.engine.codecs --hidden-import=sqlalchemy.engine.collections --hidden-import=sqlalchemy.engine.ddl --hidden-import=sqlalchemy.engine.default --hidden-import=sqlalchemy.engine.inspect --hidden-import=sqlalchemy.engine.itertools --hidden-import=sqlalchemy.engine.operator --hidden-import=sqlalchemy.engine.random --hidden-import=sqlalchemy.engine.re --hidden-import=sqlalchemy.engine.reflection --hidden-import=sqlalchemy.engine.sqlalchemy --hidden-import=sqlalchemy.engine.strategies --hidden-import=sqlalchemy.engine.sys --hidden-import=sqlalchemy.engine.threadlocal --hidden-import=sqlalchemy.engine.url --hidden-import=sqlalchemy.engine.urllib --hidden-import=sqlalchemy.engine.weakref --hidden-import=sqlalchemy.event --hidden-import=sqlalchemy.events --hidden-import=sqlalchemy.exc --hidden-import=sqlalchemy.ext --hidden-import=sqlalchemy.ext.declarative --hidden-import=sqlalchemy.ext.sqlalchemy --hidden-import=sqlalchemy.inspect --hidden-import=sqlalchemy.interfaces --hidden-import=sqlalchemy.log --hidden-import=sqlalchemy.logging --hidden-import=sqlalchemy.orm --hidden-import=sqlalchemy.orm.attributes --hidden-import=sqlalchemy.orm.collections --hidden-import=sqlalchemy.orm.copy --hidden-import=sqlalchemy.orm.dependency --hidden-import=sqlalchemy.orm.deprecated_interfaces --hidden-import=sqlalchemy.orm.descriptor_props --hidden-import=sqlalchemy.orm.evaluator --hidden-import=sqlalchemy.orm.events --hidden-import=sqlalchemy.orm.exc --hidden-import=sqlalchemy.orm.identity --hidden-import=sqlalchemy.orm.inspect --hidden-import=sqlalchemy.orm.instrumentation --hidden-import=sqlalchemy.orm.interfaces --hidden-import=sqlalchemy.orm.itertools --hidden-import=sqlalchemy.orm.mapper --hidden-import=sqlalchemy.orm.operator --hidden-import=sqlalchemy.orm.persistence --hidden-import=sqlalchemy.orm.properties --hidden-import=sqlalchemy.orm.query --hidden-import=sqlalchemy.orm.re --hidden-import=sqlalchemy.orm.scoping --hidden-import=sqlalchemy.orm.session --hidden-import=sqlalchemy.orm.sets --hidden-import=sqlalchemy.orm.sqlalchemy --hidden-import=sqlalchemy.orm.state --hidden-import=sqlalchemy.orm.strategies --hidden-import=sqlalchemy.orm.sync --hidden-import=sqlalchemy.orm.sys --hidden-import=sqlalchemy.orm.types --hidden-import=sqlalchemy.orm.unitofwork --hidden-import=sqlalchemy.orm.util --hidden-import=sqlalchemy.orm.weakref --hidden-import=sqlalchemy.pool --hidden-import=sqlalchemy.processors --hidden-import=sqlalchemy.re --hidden-import=sqlalchemy.schema --hidden-import=sqlalchemy.sql --hidden-import=sqlalchemy.sql.collections --hidden-import=sqlalchemy.sql.compiler --hidden-import=sqlalchemy.sql.decimal --hidden-import=sqlalchemy.sql.expression --hidden-import=sqlalchemy.sql.functions --hidden-import=sqlalchemy.sql.itertools --hidden-import=sqlalchemy.sql.operator --hidden-import=sqlalchemy.sql.operators --hidden-import=sqlalchemy.sql.re --hidden-import=sqlalchemy.sql.sqlalchemy --hidden-import=sqlalchemy.sql.sys --hidden-import=sqlalchemy.sql.util --hidden-import=sqlalchemy.sql.visitors --hidden-import=sqlalchemy.sqlalchemy --hidden-import=sqlalchemy.sys --hidden-import=sqlalchemy.time --hidden-import=sqlalchemy.traceback --hidden-import=sqlalchemy.types --hidden-import=sqlalchemy.util --hidden-import=sqlalchemy.util._collections --hidden-import=sqlalchemy.util.cPickle --hidden-import=sqlalchemy.util.collections --hidden-import=sqlalchemy.util.compat --hidden-import=sqlalchemy.util.contextlib --hidden-import=sqlalchemy.util.decimal --hidden-import=sqlalchemy.util.deprecations --hidden-import=sqlalchemy.util.functools --hidden-import=sqlalchemy.util.hashlib --hidden-import=sqlalchemy.util.inspect --hidden-import=sqlalchemy.util.itertools --hidden-import=sqlalchemy.util.langhelpers --hidden-import=sqlalchemy.util.operator --hidden-import=sqlalchemy.util.queue --hidden-import=sqlalchemy.util.re --hidden-import=sqlalchemy.util.sets --hidden-import=sqlalchemy.util.sqlalchemy --hidden-import=sqlalchemy.util.sys --hidden-import=sqlalchemy.util.threading --hidden-import=sqlalchemy.util.time --hidden-import=sqlalchemy.util.topological --hidden-import=sqlalchemy.util.types --hidden-import=sqlalchemy.util.urlparse --hidden-import=sqlalchemy.util.warnings --hidden-import=sqlalchemy.util.weakref --hidden-import=sqlalchemy.weakref --hidden-import=sqlite3 --hidden-import=sqlite3._sqlite3 --hidden-import=sqlite3.datetime --hidden-import=sqlite3.dbapi2 --hidden-import=sqlite3.time --hidden-import=sre_compile --hidden-import=sre_constants --hidden-import=sre_parse --hidden-import=ssl --hidden-import=stat --hidden-import=string --hidden-import=strop --hidden-import=struct --hidden-import=sys --hidden-import=tempfile --hidden-import=tempita --hidden-import=tempita._looper --hidden-import=tempita.cStringIO --hidden-import=tempita.cgi --hidden-import=tempita.compat3 --hidden-import=tempita.os --hidden-import=tempita.re --hidden-import=tempita.sys --hidden-import=tempita.tempita --hidden-import=tempita.tokenize --hidden-import=tempita.urllib --hidden-import=termios --hidden-import=textwrap --hidden-import=thread --hidden-import=threading --hidden-import=time --hidden-import=token --hidden-import=tokenize --hidden-import=traceback --hidden-import=types --hidden-import=urllib --hidden-import=urllib2 --hidden-import=urlparse --hidden-import=uu --hidden-import=uuid --hidden-import=warnings --hidden-import=weakref --hidden-import=xml --hidden-import=xml.etree --hidden-import=xml.etree.ElementPath --hidden-import=xml.etree.ElementTree --hidden-import=xml.etree.re --hidden-import=xml.etree.sys --hidden-import=xml.etree.warnings --hidden-import=xml.etree.xml --hidden-import=xml.parsers --hidden-import=xml.parsers.expat --hidden-import=xml.parsers.pyexpat --hidden-import=zipfile --hidden-import=zipimport --hidden-import=zlib sibl_gui/sIBL_GUI\ $MAJOR_VERSION.py -mv sibl_gui/sIBL_GUI\ $MAJOR_VERSION.py sibl_gui/launcher.py +mv sibl_gui/sIBL_GUI\ $MAJOR_VERSION.py sibl_gui/launcher.py echo ------------------------------------------------------------------------------- echo Build - End echo ------------------------------------------------------------------------------- @@ -55,7 +56,7 @@ echo --------------------------------------------------------------------------- packages="foundations,manager,umbra,sibl_gui" for package in $packages do - cp -r $( $UTILITIES/getPackagePath.py $package ) $DEPENDENCIES/ + cp -r $( $UTILITIES/getPackagePath.py --package $package ) $DEPENDENCIES/ done packages="umbra,sibl_gui" extensions="bmp,icns,ico" @@ -69,7 +70,7 @@ do done done cp $SOURCE/sibl_gui/resources/images/Icon_Light_256.icns $RESOURCES/icon-windowed.icns -python $UTILITIES/recursiveRemove.py $BUNDLE .pyc +python $UTILITIES/recursiveRemove.py --input $BUNDLE --pattern .pyc rm -f $DEPENDENCIES/sibl_gui/libraries/freeImage/resources/*.dll rm -f $DEPENDENCIES/sibl_gui/libraries/freeImage/resources/*.so rm -rf $DEPENDENCIES/sibl_gui/resources/templates/3dsMax* @@ -83,7 +84,7 @@ echo --------------------------------------------------------------------------- echo ------------------------------------------------------------------------------- echo Templates ReStructuredText Files Cleanup - Begin echo ------------------------------------------------------------------------------- -python $UTILITIES/recursiveRemove.py $BUNDLE/ .rst +python $UTILITIES/recursiveRemove.py --input $BUNDLE/ --pattern .rst echo ------------------------------------------------------------------------------- echo Templates ReStructuredText Files Cleanup - End echo ------------------------------------------------------------------------------- diff --git a/utilities/getDependenciesInformations.py b/utilities/getDependenciesInformations.py index 1032ddb5..5e840cb4 100755 --- a/utilities/getDependenciesInformations.py +++ b/utilities/getDependenciesInformations.py @@ -24,6 +24,7 @@ #********************************************************************************************************************** import subprocess import sys + if sys.version_info[:2] <= (2, 6): from ordereddict import OrderedDict else: @@ -32,6 +33,7 @@ #********************************************************************************************************************** #*** Internal imports. #********************************************************************************************************************** +import foundations.decorators import foundations.verbose from foundations.io import File @@ -46,29 +48,32 @@ __status__ = "Production" __all__ = ["LOGGER", - "GIT_EXECUTABLE", - "FOUNDATIONS_DIRECTORY", - "MANAGER_DIRECTORY", - "UMBRA_DIRECTORY" - "TEMPLATES_DIRECTORY", - "DEPENDENCIES", - "DEPENDENCIES_FILE", - "getDependenciesInformations"] + "GIT_EXECUTABLE", + "ONCILLA_DIRECTORY", + "FOUNDATIONS_DIRECTORY", + "MANAGER_DIRECTORY", + "UMBRA_DIRECTORY" + "TEMPLATES_DIRECTORY", + "DEPENDENCIES", + "DEPENDENCIES_FILE", + "getDependenciesInformations", + "main"] LOGGER = foundations.verbose.installLogger() GIT_EXECUTABLE = "/usr/local/git/bin/git" +ONCILLA_DIRECTORY = "../../Oncilla" FOUNDATIONS_DIRECTORY = "../../Foundations" MANAGER_DIRECTORY = "../../Manager" UMBRA_DIRECTORY = "../../Umbra" TEMPLATES_DIRECTORY = "../../sIBL_GUI_Templates" -DEPENDENCIES = OrderedDict((("Foundations", FOUNDATIONS_DIRECTORY), +DEPENDENCIES = OrderedDict((("Oncilla", ONCILLA_DIRECTORY), + ("Foundations", FOUNDATIONS_DIRECTORY), ("Manager", MANAGER_DIRECTORY), ("Umbra", UMBRA_DIRECTORY), ("sIBL_GUI_Templates", TEMPLATES_DIRECTORY))) DEPENDENCIES_FILE = "../releases/sIBL_GUI_Dependencies.rc" -LOGGER = foundations.verbose.installLogger() foundations.verbose.getLoggingConsoleHandler() foundations.verbose.setVerbosityLevel(3) @@ -78,19 +83,35 @@ def getDependenciesInformations(): """ Gets sIBL_GUI dependencies informations file. + + :return: Definition success. + :rtype: bool """ content = ["[Dependencies]\n"] for dependency, path in DEPENDENCIES.iteritems(): release = subprocess.Popen("cd {0} && {1} describe".format(path, GIT_EXECUTABLE), - shell=True, - stdout=subprocess.PIPE, - stderr=subprocess.PIPE).communicate()[0] + shell=True, + stdout=subprocess.PIPE, + stderr=subprocess.PIPE).communicate()[0] LOGGER.info("{0} | '{1}': '{2}'.".format(getDependenciesInformations.__name__, dependency, release.strip())) content.append("{0}={1}".format(dependency, release)) file = File(DEPENDENCIES_FILE) file.content = content file.write() + return True + +@foundations.decorators.systemExit +def main(): + """ + Starts the Application. + + :return: Definition success. + :rtype: bool + """ + + return getDependenciesInformations() + if __name__ == "__main__": - getDependenciesInformations() + main() diff --git a/utilities/getDocumentation.sh b/utilities/getDocumentation.sh deleted file mode 100755 index 3a52b61c..00000000 --- a/utilities/getDocumentation.sh +++ /dev/null @@ -1,47 +0,0 @@ -#!/usr/bin/env bash -echo ------------------------------------------------------------------------------- -echo sIBL_GUI - Documentation Build -echo ------------------------------------------------------------------------------- - -export PROJECT=$( dirname "${BASH_SOURCE[0]}" )/.. - -export UTILITIES=$PROJECT/utilities -export DOCUMENTATION=$PROJECT/docs/documentation -export HELP=$PROJECT/docs/help -export SPHINX=$PROJECT/docs/sphinx - -#! Inline documentation build. -echo ------------------------------------------------------------------------------- -echo Inline Documentation Build - Begin -echo ------------------------------------------------------------------------------- -python $UTILITIES/reStructuredTextToHtml.py "$HELP/sIBL_GUI_Manual.rst" "$HELP/sIBL_GUI_Manual.html" -echo ------------------------------------------------------------------------------- -echo Inline Documentation Build - End -echo ------------------------------------------------------------------------------- - -#! HDRLabs documentation build. -echo ------------------------------------------------------------------------------- -echo HDRLabs Documentation Build - Begin -echo ------------------------------------------------------------------------------- -python $UTILITIES/getHDRLabsDocumentation.py "$HELP/sIBL_GUI_Manual.html" "$HELP/sIBL_GUI_Manual_Body.html" -echo ------------------------------------------------------------------------------- -echo HDRLabs Documentation Build - End -echo ------------------------------------------------------------------------------- - -#! Sphinx documentation build. -echo ------------------------------------------------------------------------------- -echo Sphinx Documentation Build - Begin -echo ------------------------------------------------------------------------------- -python $UTILITIES/sliceDocumentation.py "$HELP/sIBL_GUI_Manual.rst" "$SPHINX/source/resources/pages" -python $UTILITIES/sliceDocumentation.py "$PROJECT/CHANGES.rst" "$SPHINX/source/resources/pages" -python $UTILITIES/getSphinxDocumentationTocTree.py "sIBL_GUI" "$SPHINX/source/resources/pages/tocTree.rst" "$SPHINX/source/index.rst" "$SPHINX/source/resources/pages" -rm -rf $SPHINX/build -rm -rf $SPHINX/source/resources/packages -rm $SPHINX/source/resources/pages/api/* -rm "$SPHINX/source/resources/pages/tocTree.rst" -python $UTILITIES/getSphinxDocumentationApi.py "foundations,manager,umbra,sibl_gui" "$SPHINX/source/resources/packages" "$SPHINX/source/resources/pages/api" "$SPHINX/source/resources/pages/api.rst" -export PYTHONPATH=$SPHINX/source/resources/packages -sphinx-build -b html -d $SPHINX/build/doctrees $SPHINX/source $SPHINX/build/html -echo ------------------------------------------------------------------------------- -echo Sphinx Documentation Build - End -echo ------------------------------------------------------------------------------- diff --git a/utilities/getHDRLabsDocumentation.py b/utilities/getHDRLabsDocumentation.py index 1d6a079a..94896f4e 100644 --- a/utilities/getHDRLabsDocumentation.py +++ b/utilities/getHDRLabsDocumentation.py @@ -22,12 +22,14 @@ #********************************************************************************************************************** #*** External imports. #********************************************************************************************************************** +import argparse import re import sys #********************************************************************************************************************** #*** Internal imports. #********************************************************************************************************************** +import foundations.decorators import foundations.verbose from foundations.io import File @@ -41,7 +43,7 @@ __email__ = "thomas.mansencal@gmail.com" __status__ = "Production" -__all__ = ["LOGGER", "getHDRLabsDocumentation"] +__all__ = ["LOGGER", "getHDRLabsDocumentation", "getCommandLineArguments", "main"] LOGGER = foundations.verbose.installLogger() @@ -51,18 +53,20 @@ #********************************************************************************************************************** #*** Module classes and definitions. #********************************************************************************************************************** -def getHDRLabsDocumentation(fileIn, fileOut): +def getHDRLabsDocumentation(input, output): """ Extracts sIBL_GUI Documentation body for HDRLabs.com. - :param fileIn: File to convert. - :type fileIn: unicode - :param fileOut: Output file. - :type fileOut: unicode + :param input: Input file to extract documentation body. + :type input: unicode + :param output: Output html file. + :type output: unicode + :return: Definition success. + :rtype: bool """ - LOGGER.info("{0} | Extracting 'body' tag content from {1}' file!".format(getHDRLabsDocumentation.__name__, fileIn)) - file = File(fileIn) + LOGGER.info("{0} | Extracting 'body' tag content from {1}' file!".format(getHDRLabsDocumentation.__name__, input)) + file = File(input) file.cache() LOGGER.info("{0} | Processing 'body' data!".format(getHDRLabsDocumentation.__name__)) @@ -76,10 +80,56 @@ def getHDRLabsDocumentation(fileIn, fileOut): not skipLine and content.append("{0}\n".format(line.replace("\t", "", 2))) - file = File(fileOut) + file = File(output) file.content = content file.write() + return True + +def getCommandLineArguments(): + """ + Retrieves command line arguments. + + :return: Namespace. + :rtype: Namespace + """ + + parser = argparse.ArgumentParser(add_help=False) + + parser.add_argument("-h", + "--help", + action="help", + help="'Displays this help message and exit.'") + + parser.add_argument("-i", + "--input", + type=unicode, + dest="input", + help="'Input file to extract documentation body.'") + + parser.add_argument("-o", + "--output", + type=unicode, + dest="output", + help="'Output html file.'") + + if len(sys.argv) == 1: + parser.print_help() + sys.exit(1) + + return parser.parse_args() + +@foundations.decorators.systemExit +def main(): + """ + Starts the Application. + + :return: Definition success. + :rtype: bool + """ + + args = getCommandLineArguments() + return getHDRLabsDocumentation(args.input, args.output) + if __name__ == "__main__": - arguments = map(unicode, sys.argv) - getHDRLabsDocumentation(arguments[1], arguments[2]) + main() diff --git a/utilities/getPackagePath.py b/utilities/getPackagePath.py index e7e07b22..9adc6a26 100755 --- a/utilities/getPackagePath.py +++ b/utilities/getPackagePath.py @@ -22,8 +22,15 @@ #********************************************************************************************************************** #*** External imports. #********************************************************************************************************************** +import argparse import sys +#********************************************************************************************************************** +#*** Internal imports. +#********************************************************************************************************************** +import foundations.decorators +import foundations.verbose + #********************************************************************************************************************** #*** Module attributes. #********************************************************************************************************************** @@ -34,7 +41,11 @@ __email__ = "thomas.mansencal@gmail.com" __status__ = "Production" -__all__ = ["getPackagePath"] +__all__ = ["LOGGER", "getPackagePath", "getCommandLineArguments", "main"] + +LOGGER = foundations.verbose.installLogger() +foundations.verbose.getLoggingConsoleHandler() +foundations.verbose.setVerbosityLevel(3) #********************************************************************************************************************** #*** Module classes and definitions. @@ -42,10 +53,56 @@ def getPackagePath(package): """ Writes given package path to stdout. + + :param package: Package to retrieve the path. + :type package: unicode + :return: Definition success. + :rtype: bool """ package = __import__(package) sys.stdout.write(package.__path__[0]) + return True + +def getCommandLineArguments(): + """ + Retrieves command line arguments. + + :return: Namespace. + :rtype: Namespace + """ + + parser = argparse.ArgumentParser(add_help=False) + + parser.add_argument("-h", + "--help", + action="help", + help="'Displays this help message and exit.'") + + parser.add_argument("-p", + "--package", + type=unicode, + dest="package", + help="'Package to retrieve the path.'") + + if len(sys.argv) == 1: + parser.print_help() + sys.exit(1) + + return parser.parse_args() + +@foundations.decorators.systemExit +def main(): + """ + Starts the Application. + + :return: Definition success. + :rtype: bool + """ + + args = getCommandLineArguments() + return getPackagePath(args.package) + if __name__ == "__main__": - getPackagePath(sys.argv[1]) + main() diff --git a/utilities/listImports.py b/utilities/listImports.py index a05e74c7..e9f8275b 100644 --- a/utilities/listImports.py +++ b/utilities/listImports.py @@ -22,12 +22,14 @@ #********************************************************************************************************************** #*** External imports. #********************************************************************************************************************** +import argparse import re import sys #********************************************************************************************************************** #*** Internal imports. #********************************************************************************************************************** +import foundations.decorators import foundations.verbose import foundations.walkers from foundations.io import File @@ -42,7 +44,7 @@ __email__ = "thomas.mansencal@gmail.com" __status__ = "Production" -__all__ = ["LOGGER", "IMPORTS", "FILTERS_IN", "FILTERS_OUT", "listImports"] +__all__ = ["LOGGER", "IMPORTS", "FILTERS_IN", "FILTERS_OUT", "listImports", "getCommandLineArguments", "main"] LOGGER = foundations.verbose.installLogger() @@ -79,13 +81,54 @@ def listImports(packages, filtersIn, filtersOut): source.cache() for line in source.content: if not re.search("foundations|manager|umbra|sibl_gui", line): - search = re.search("^\s*import\s*(?P[\w+\.]+)|^\s*from\s*(?P[\w+\.]+)\s+import", line) + search = re.search("^\s*import\s*(?P[\w+\.]+)|^\s*from\s*(?P[\w+\.]+)\s+import", + line) if search: statement = search.group("moduleA") or search.group("moduleB") statement != "_" and imports.add(statement) return imports -if __name__ == "__main__": - arguments = map(unicode, sys.argv) - imports = listImports(arguments[1].split(","), filtersIn=FILTERS_IN, filtersOut=FILTERS_OUT) +def getCommandLineArguments(): + """ + Retrieves command line arguments. + + :return: Namespace. + :rtype: Namespace + """ + + parser = argparse.ArgumentParser(add_help=False) + + parser.add_argument("-h", + "--help", + action="help", + help="'Displays this help message and exit.'") + + parser.add_argument("-p", + "--packages", + nargs="*", + dest="packages", + help="'Packages.'") + + if len(sys.argv) == 1: + parser.print_help() + sys.exit(1) + + return parser.parse_args() + +@foundations.decorators.systemExit +def main(): + """ + Starts the Application. + + :return: Definition success. + :rtype: bool + """ + + args = getCommandLineArguments() + args.packages = args.packages if all(args.packages) else [] + imports = listImports(args.packages, filtersIn=FILTERS_IN, filtersOut=FILTERS_OUT) LOGGER.info("{0} | Imports: \"{1}\"".format(listImports.__name__, ",".join(sorted(imports)))) + return True + +if __name__ == "__main__": + main() diff --git a/utilities/recursiveRemove.py b/utilities/recursiveRemove.py index 0c9544ac..b38b893f 100644 --- a/utilities/recursiveRemove.py +++ b/utilities/recursiveRemove.py @@ -22,6 +22,7 @@ #********************************************************************************************************************** #*** External imports. #********************************************************************************************************************** +import argparse import os import sys @@ -35,7 +36,7 @@ __email__ = "thomas.mansencal@gmail.com" __status__ = "Production" -__all__ = ["recursiveRemove", "remove"] +__all__ = ["recursiveRemove", "remove", "getCommandLineArguments" , "main"] #********************************************************************************************************************** #*** Module classes and definitions. @@ -72,6 +73,50 @@ def remove(item): except: print("{0} | '{1}' file removing failed!".format(remove.__name__, item)) +def getCommandLineArguments(): + """ + Retrieves command line arguments. + + :return: Namespace. + :rtype: Namespace + """ + + parser = argparse.ArgumentParser(add_help=False) + + parser.add_argument("-h", + "--help", + action="help", + help="'Displays this help message and exit.'") + + parser.add_argument("-i", + "--input", + type=unicode, + dest="input", + help="'Input directory to recurse.'") + + parser.add_argument("-p", + "--pattern", + type=unicode, + dest="pattern", + help="'Pattern to match.'") + + if len(sys.argv) == 1: + parser.print_help() + sys.exit(1) + + return parser.parse_args() + +def main(): + """ + Starts the Application. + + :return: Definition success. + :rtype: bool + """ + + args = getCommandLineArguments() + return 0 if recursiveRemove(args.input, args.pattern) else 1 + if __name__ == "__main__": - arguments = map(unicode, sys.argv) - recursiveRemove(arguments[1], arguments[2]) + main() + diff --git a/utilities/windowsBuild.sh b/utilities/windowsBuild.sh index 817e502f..96b4ccf3 100755 --- a/utilities/windowsBuild.sh +++ b/utilities/windowsBuild.sh @@ -26,11 +26,12 @@ echo Cleanup - Begin echo ------------------------------------------------------------------------------- rm -rf $BUILD $DISTRIBUTION $DEPENDENCIES $BUNDLE packages="foundations,manager,umbra,sibl_gui" +types=".pyc,.pyo,.DS_Store,Thumbs.db" for package in $packages do - for type in ".pyc,.pyo,.DS_Store,Thumbs.db" + for type in $types do - python $UTILITIES/recursiveRemove.py $( $UTILITIES/getPackagePath.py $package ) $type + python $UTILITIES/recursiveRemove.py --input $( $UTILITIES/getPackagePath.py --package $package ) --pattern $type done done echo ------------------------------------------------------------------------------- @@ -55,7 +56,7 @@ echo --------------------------------------------------------------------------- cp -r $DISTRIBUTION/sIBL_GUI $BUNDLE for package in $packages do - cp -rL $( cygpath --unix $( $UTILITIES/getPackagePath.py $package ) ) $DEPENDENCIES/$package + cp -rL $( cygpath --unix $( $UTILITIES/getPackagePath.py --package $package ) ) $DEPENDENCIES/$package done packages="umbra,sibl_gui" extensions="bmp,icns,ico" @@ -78,7 +79,7 @@ echo --------------------------------------------------------------------------- echo ------------------------------------------------------------------------------- echo Templates Textile Files Cleanup - Begin echo ------------------------------------------------------------------------------- -python $UTILITIES/recursiveRemove.py $DEPENDENCIES/sibl_gui/resources/templates/ .rst +python $UTILITIES/recursiveRemove.py --input $DEPENDENCIES/sibl_gui/resources/templates/ --pattern .rst echo ------------------------------------------------------------------------------- echo Templates Textile Files Cleanup - End echo ------------------------------------------------------------------------------- From 5997a359bfaf5cc413350552c901a925054e0837 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Mon, 31 Mar 2014 21:33:38 +0200 Subject: [PATCH 45/54] Update various utilities. --- utilities/darwinBuild.sh | 2 +- utilities/listImports.py | 2 +- utilities/windowsSetup.py | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/utilities/darwinBuild.sh b/utilities/darwinBuild.sh index c9f22857..78e6a533 100755 --- a/utilities/darwinBuild.sh +++ b/utilities/darwinBuild.sh @@ -43,7 +43,7 @@ echo --------------------------------------------------------------------------- echo Build - Begin echo ------------------------------------------------------------------------------- mv sibl_gui/launcher.py sibl_gui/sIBL_GUI\ $MAJOR_VERSION.py -python $PYINSTALLER/pyinstaller.py --noconfirm --noconsole -o releases/Darwin --hidden-import=ConfigParser --hidden-import=PyQt4 --hidden-import=PyQt4.QtCore --hidden-import=PyQt4.QtGui --hidden-import=PyQt4.QtNetwork --hidden-import=PyQt4.QtWebKit --hidden-import=PyQt4.uic --hidden-import=PyQt4.uic.Compiler --hidden-import=PyQt4.uic.Compiler.PyQt4 --hidden-import=PyQt4.uic.Compiler.compiler --hidden-import=PyQt4.uic.Compiler.indenter --hidden-import=PyQt4.uic.Compiler.logging --hidden-import=PyQt4.uic.Compiler.misc --hidden-import=PyQt4.uic.Compiler.proxy_metaclass --hidden-import=PyQt4.uic.Compiler.qobjectcreator --hidden-import=PyQt4.uic.Compiler.qtproxies --hidden-import=PyQt4.uic.Compiler.re --hidden-import=PyQt4.uic.Compiler.sys --hidden-import=PyQt4.uic.PyQt4 --hidden-import=PyQt4.uic.exceptions --hidden-import=PyQt4.uic.icon_cache --hidden-import=PyQt4.uic.logging --hidden-import=PyQt4.uic.objcreator --hidden-import=PyQt4.uic.os --hidden-import=PyQt4.uic.port_v2 --hidden-import=PyQt4.uic.port_v2.PyQt4 --hidden-import=PyQt4.uic.port_v2.as_string --hidden-import=PyQt4.uic.port_v2.ascii_upper --hidden-import=PyQt4.uic.port_v2.cStringIO --hidden-import=PyQt4.uic.port_v2.load_plugin --hidden-import=PyQt4.uic.port_v2.proxy_base --hidden-import=PyQt4.uic.port_v2.re --hidden-import=PyQt4.uic.port_v2.string --hidden-import=PyQt4.uic.port_v2.string_io --hidden-import=PyQt4.uic.properties --hidden-import=PyQt4.uic.re --hidden-import=PyQt4.uic.sys --hidden-import=PyQt4.uic.uiparser --hidden-import=PyQt4.uic.xml --hidden-import=Queue --hidden-import=SocketServer --hidden-import=StringIO --hidden-import=UserDict --hidden-import=__builtin__ --hidden-import=__future__ --hidden-import=__main__ --hidden-import=_abcoll --hidden-import=_ast --hidden-import=_bisect --hidden-import=_codecs --hidden-import=_collections --hidden-import=_ctypes --hidden-import=_functools --hidden-import=_hashlib --hidden-import=_heapq --hidden-import=_io --hidden-import=_locale --hidden-import=_random --hidden-import=_scproxy --hidden-import=_socket --hidden-import=_sqlite3 --hidden-import=_sre --hidden-import=_ssl --hidden-import=_struct --hidden-import=_virtualenv_distutils --hidden-import=_warnings --hidden-import=_weakref --hidden-import=_weakrefset --hidden-import=abc --hidden-import=array --hidden-import=ast --hidden-import=atexit --hidden-import=base64 --hidden-import=binascii --hidden-import=bisect --hidden-import=cPickle --hidden-import=cStringIO --hidden-import=cgi --hidden-import=code --hidden-import=codecs --hidden-import=codeop --hidden-import=collections --hidden-import=contextlib --hidden-import=copy --hidden-import=copy_reg --hidden-import=ctypes --hidden-import=ctypes._ctypes --hidden-import=ctypes._endian --hidden-import=ctypes.ctypes --hidden-import=ctypes.macholib --hidden-import=ctypes.macholib.dyld --hidden-import=ctypes.macholib.dylib --hidden-import=ctypes.macholib.framework --hidden-import=ctypes.macholib.itertools --hidden-import=ctypes.macholib.os --hidden-import=ctypes.macholib.re --hidden-import=ctypes.os --hidden-import=ctypes.struct --hidden-import=ctypes.sys --hidden-import=ctypes.util --hidden-import=datetime --hidden-import=decimal --hidden-import=decorator --hidden-import=dis --hidden-import=distutils --hidden-import=distutils.debug --hidden-import=distutils.dep_util --hidden-import=distutils.dist --hidden-import=distutils.distutils --hidden-import=distutils.email --hidden-import=distutils.errors --hidden-import=distutils.fancy_getopt --hidden-import=distutils.getopt --hidden-import=distutils.imp --hidden-import=distutils.log --hidden-import=distutils.opcode --hidden-import=distutils.os --hidden-import=distutils.re --hidden-import=distutils.spawn --hidden-import=distutils.stat --hidden-import=distutils.string --hidden-import=distutils.sys --hidden-import=distutils.sysconfig --hidden-import=distutils.text_file --hidden-import=distutils.util --hidden-import=distutils.warnings --hidden-import=email --hidden-import=email.Charset --hidden-import=email.Encoders --hidden-import=email.Errors --hidden-import=email.FeedParser --hidden-import=email.Generator --hidden-import=email.Header --hidden-import=email.Iterators --hidden-import=email.MIMEAudio --hidden-import=email.MIMEBase --hidden-import=email.MIMEImage --hidden-import=email.MIMEMessage --hidden-import=email.MIMEMultipart --hidden-import=email.MIMENonMultipart --hidden-import=email.MIMEText --hidden-import=email.Message --hidden-import=email.Parser --hidden-import=email.Utils --hidden-import=email._parseaddr --hidden-import=email.base64 --hidden-import=email.base64MIME --hidden-import=email.base64mime --hidden-import=email.binascii --hidden-import=email.cStringIO --hidden-import=email.charset --hidden-import=email.codecs --hidden-import=email.email --hidden-import=email.encoders --hidden-import=email.errors --hidden-import=email.feedparser --hidden-import=email.generator --hidden-import=email.header --hidden-import=email.iterators --hidden-import=email.message --hidden-import=email.mime --hidden-import=email.mime.audio --hidden-import=email.mime.base --hidden-import=email.mime.cStringIO --hidden-import=email.mime.email --hidden-import=email.mime.image --hidden-import=email.mime.imghdr --hidden-import=email.mime.message --hidden-import=email.mime.multipart --hidden-import=email.mime.nonmultipart --hidden-import=email.mime.sndhdr --hidden-import=email.mime.text --hidden-import=email.os --hidden-import=email.parser --hidden-import=email.quopri --hidden-import=email.quopriMIME --hidden-import=email.quoprimime --hidden-import=email.random --hidden-import=email.re --hidden-import=email.socket --hidden-import=email.string --hidden-import=email.sys --hidden-import=email.time --hidden-import=email.urllib --hidden-import=email.utils --hidden-import=email.uu --hidden-import=email.warnings --hidden-import=encodings --hidden-import=encodings.__builtin__ --hidden-import=encodings.aliases --hidden-import=encodings.ascii --hidden-import=encodings.codecs --hidden-import=encodings.encodings --hidden-import=encodings.utf_8 --hidden-import=errno --hidden-import=exceptions --hidden-import=fcntl --hidden-import=fnmatch --hidden-import=functools --hidden-import=gc --hidden-import=genericpath --hidden-import=getopt --hidden-import=getpass --hidden-import=gettext --hidden-import=grp --hidden-import=hashlib --hidden-import=heapq --hidden-import=httplib --hidden-import=imghdr --hidden-import=imp --hidden-import=inspect --hidden-import=io --hidden-import=itertools --hidden-import=keyword --hidden-import=linecache --hidden-import=locale --hidden-import=logging --hidden-import=logging.atexit --hidden-import=logging.cStringIO --hidden-import=logging.codecs --hidden-import=logging.os --hidden-import=logging.sys --hidden-import=logging.thread --hidden-import=logging.threading --hidden-import=logging.time --hidden-import=logging.traceback --hidden-import=logging.warnings --hidden-import=logging.weakref --hidden-import=logilab --hidden-import=marshal --hidden-import=math --hidden-import=migrate --hidden-import=migrate.changeset --hidden-import=migrate.changeset.StringIO --hidden-import=migrate.changeset.UserDict --hidden-import=migrate.changeset.ansisql --hidden-import=migrate.changeset.constraint --hidden-import=migrate.changeset.databases --hidden-import=migrate.changeset.databases.UserDict --hidden-import=migrate.changeset.databases.copy --hidden-import=migrate.changeset.databases.firebird --hidden-import=migrate.changeset.databases.migrate --hidden-import=migrate.changeset.databases.mysql --hidden-import=migrate.changeset.databases.oracle --hidden-import=migrate.changeset.databases.postgres --hidden-import=migrate.changeset.databases.sqlalchemy --hidden-import=migrate.changeset.databases.sqlite --hidden-import=migrate.changeset.databases.visitor --hidden-import=migrate.changeset.migrate --hidden-import=migrate.changeset.re --hidden-import=migrate.changeset.schema --hidden-import=migrate.changeset.sqlalchemy --hidden-import=migrate.changeset.warnings --hidden-import=migrate.exceptions --hidden-import=migrate.migrate --hidden-import=migrate.versioning --hidden-import=migrate.versioning.ConfigParser --hidden-import=migrate.versioning.api --hidden-import=migrate.versioning.cfgparse --hidden-import=migrate.versioning.config --hidden-import=migrate.versioning.datetime --hidden-import=migrate.versioning.genmodel --hidden-import=migrate.versioning.inspect --hidden-import=migrate.versioning.logging --hidden-import=migrate.versioning.migrate --hidden-import=migrate.versioning.os --hidden-import=migrate.versioning.pathed --hidden-import=migrate.versioning.pkg_resources --hidden-import=migrate.versioning.re --hidden-import=migrate.versioning.repository --hidden-import=migrate.versioning.schema --hidden-import=migrate.versioning.schemadiff --hidden-import=migrate.versioning.script --hidden-import=migrate.versioning.script.StringIO --hidden-import=migrate.versioning.script.base --hidden-import=migrate.versioning.script.inspect --hidden-import=migrate.versioning.script.logging --hidden-import=migrate.versioning.script.migrate --hidden-import=migrate.versioning.script.py --hidden-import=migrate.versioning.script.shutil --hidden-import=migrate.versioning.script.sql --hidden-import=migrate.versioning.script.warnings --hidden-import=migrate.versioning.shutil --hidden-import=migrate.versioning.sqlalchemy --hidden-import=migrate.versioning.string --hidden-import=migrate.versioning.sys --hidden-import=migrate.versioning.tempita --hidden-import=migrate.versioning.template --hidden-import=migrate.versioning.util --hidden-import=migrate.versioning.util.decorator --hidden-import=migrate.versioning.util.importpath --hidden-import=migrate.versioning.util.keyedinstance --hidden-import=migrate.versioning.util.logging --hidden-import=migrate.versioning.util.migrate --hidden-import=migrate.versioning.util.os --hidden-import=migrate.versioning.util.pkg_resources --hidden-import=migrate.versioning.util.sqlalchemy --hidden-import=migrate.versioning.util.sys --hidden-import=migrate.versioning.util.warnings --hidden-import=migrate.versioning.version --hidden-import=mimetools --hidden-import=new --hidden-import=numbers --hidden-import=opcode --hidden-import=operator --hidden-import=optparse --hidden-import=os --hidden-import=os.path --hidden-import=pickle --hidden-import=pkg_resources --hidden-import=pkgutil --hidden-import=platform --hidden-import=plistlib --hidden-import=posix --hidden-import=posixpath --hidden-import=pwd --hidden-import=pyexpat --hidden-import=pyexpat.errors --hidden-import=pyexpat.model --hidden-import=quopri --hidden-import=random --hidden-import=re --hidden-import=rfc822 --hidden-import=select --hidden-import=sets --hidden-import=shutil --hidden-import=signal --hidden-import=sip --hidden-import=site --hidden-import=sitecustomize --hidden-import=sndhdr --hidden-import=socket --hidden-import=sqlalchemy --hidden-import=sqlalchemy.codecs --hidden-import=sqlalchemy.collections --hidden-import=sqlalchemy.connectors --hidden-import=sqlalchemy.connectors.mxodbc --hidden-import=sqlalchemy.connectors.mysqldb --hidden-import=sqlalchemy.connectors.pyodbc --hidden-import=sqlalchemy.connectors.re --hidden-import=sqlalchemy.connectors.sqlalchemy --hidden-import=sqlalchemy.connectors.sys --hidden-import=sqlalchemy.connectors.urllib --hidden-import=sqlalchemy.connectors.warnings --hidden-import=sqlalchemy.connectors.zxJDBC --hidden-import=sqlalchemy.cprocessors --hidden-import=sqlalchemy.cresultproxy --hidden-import=sqlalchemy.databases --hidden-import=sqlalchemy.databases.sqlalchemy --hidden-import=sqlalchemy.datetime --hidden-import=sqlalchemy.dialects --hidden-import=sqlalchemy.dialects.access --hidden-import=sqlalchemy.dialects.access.base --hidden-import=sqlalchemy.dialects.access.sqlalchemy --hidden-import=sqlalchemy.dialects.drizzle --hidden-import=sqlalchemy.dialects.drizzle.base --hidden-import=sqlalchemy.dialects.drizzle.mysqldb --hidden-import=sqlalchemy.dialects.drizzle.sqlalchemy --hidden-import=sqlalchemy.dialects.firebird --hidden-import=sqlalchemy.dialects.firebird.base --hidden-import=sqlalchemy.dialects.firebird.datetime --hidden-import=sqlalchemy.dialects.firebird.kinterbasdb --hidden-import=sqlalchemy.dialects.firebird.re --hidden-import=sqlalchemy.dialects.firebird.sqlalchemy --hidden-import=sqlalchemy.dialects.informix --hidden-import=sqlalchemy.dialects.informix.base --hidden-import=sqlalchemy.dialects.informix.datetime --hidden-import=sqlalchemy.dialects.informix.informixdb --hidden-import=sqlalchemy.dialects.informix.re --hidden-import=sqlalchemy.dialects.informix.sqlalchemy --hidden-import=sqlalchemy.dialects.maxdb --hidden-import=sqlalchemy.dialects.maxdb.base --hidden-import=sqlalchemy.dialects.maxdb.datetime --hidden-import=sqlalchemy.dialects.maxdb.itertools --hidden-import=sqlalchemy.dialects.maxdb.re --hidden-import=sqlalchemy.dialects.maxdb.sapdb --hidden-import=sqlalchemy.dialects.maxdb.sqlalchemy --hidden-import=sqlalchemy.dialects.mssql --hidden-import=sqlalchemy.dialects.mssql.adodbapi --hidden-import=sqlalchemy.dialects.mssql.base --hidden-import=sqlalchemy.dialects.mssql.datetime --hidden-import=sqlalchemy.dialects.mssql.decimal --hidden-import=sqlalchemy.dialects.mssql.information_schema --hidden-import=sqlalchemy.dialects.mssql.mxodbc --hidden-import=sqlalchemy.dialects.mssql.operator --hidden-import=sqlalchemy.dialects.mssql.pymssql --hidden-import=sqlalchemy.dialects.mssql.pyodbc --hidden-import=sqlalchemy.dialects.mssql.re --hidden-import=sqlalchemy.dialects.mssql.sqlalchemy --hidden-import=sqlalchemy.dialects.mssql.sys --hidden-import=sqlalchemy.dialects.mssql.zxjdbc --hidden-import=sqlalchemy.dialects.mysql --hidden-import=sqlalchemy.dialects.mysql.array --hidden-import=sqlalchemy.dialects.mysql.base --hidden-import=sqlalchemy.dialects.mysql.datetime --hidden-import=sqlalchemy.dialects.mysql.inspect --hidden-import=sqlalchemy.dialects.mysql.mysqlconnector --hidden-import=sqlalchemy.dialects.mysql.mysqldb --hidden-import=sqlalchemy.dialects.mysql.oursql --hidden-import=sqlalchemy.dialects.mysql.pymysql --hidden-import=sqlalchemy.dialects.mysql.pyodbc --hidden-import=sqlalchemy.dialects.mysql.re --hidden-import=sqlalchemy.dialects.mysql.sqlalchemy --hidden-import=sqlalchemy.dialects.mysql.sys --hidden-import=sqlalchemy.dialects.mysql.zxjdbc --hidden-import=sqlalchemy.dialects.oracle --hidden-import=sqlalchemy.dialects.oracle.base --hidden-import=sqlalchemy.dialects.oracle.collections --hidden-import=sqlalchemy.dialects.oracle.cx_oracle --hidden-import=sqlalchemy.dialects.oracle.datetime --hidden-import=sqlalchemy.dialects.oracle.decimal --hidden-import=sqlalchemy.dialects.oracle.random --hidden-import=sqlalchemy.dialects.oracle.re --hidden-import=sqlalchemy.dialects.oracle.sqlalchemy --hidden-import=sqlalchemy.dialects.oracle.zxjdbc --hidden-import=sqlalchemy.dialects.postgresql --hidden-import=sqlalchemy.dialects.postgresql.base --hidden-import=sqlalchemy.dialects.postgresql.logging --hidden-import=sqlalchemy.dialects.postgresql.pg8000 --hidden-import=sqlalchemy.dialects.postgresql.psycopg2 --hidden-import=sqlalchemy.dialects.postgresql.pypostgresql --hidden-import=sqlalchemy.dialects.postgresql.re --hidden-import=sqlalchemy.dialects.postgresql.sqlalchemy --hidden-import=sqlalchemy.dialects.postgresql.uuid --hidden-import=sqlalchemy.dialects.postgresql.zxjdbc --hidden-import=sqlalchemy.dialects.sqlite --hidden-import=sqlalchemy.dialects.sqlite.base --hidden-import=sqlalchemy.dialects.sqlite.datetime --hidden-import=sqlalchemy.dialects.sqlite.os --hidden-import=sqlalchemy.dialects.sqlite.pysqlite --hidden-import=sqlalchemy.dialects.sqlite.re --hidden-import=sqlalchemy.dialects.sqlite.sqlalchemy --hidden-import=sqlalchemy.dialects.sqlite.sqlite3 --hidden-import=sqlalchemy.dialects.sybase --hidden-import=sqlalchemy.dialects.sybase.base --hidden-import=sqlalchemy.dialects.sybase.operator --hidden-import=sqlalchemy.dialects.sybase.pyodbc --hidden-import=sqlalchemy.dialects.sybase.pysybase --hidden-import=sqlalchemy.dialects.sybase.sqlalchemy --hidden-import=sqlalchemy.engine --hidden-import=sqlalchemy.engine.StringIO --hidden-import=sqlalchemy.engine.base --hidden-import=sqlalchemy.engine.codecs --hidden-import=sqlalchemy.engine.collections --hidden-import=sqlalchemy.engine.ddl --hidden-import=sqlalchemy.engine.default --hidden-import=sqlalchemy.engine.inspect --hidden-import=sqlalchemy.engine.itertools --hidden-import=sqlalchemy.engine.operator --hidden-import=sqlalchemy.engine.random --hidden-import=sqlalchemy.engine.re --hidden-import=sqlalchemy.engine.reflection --hidden-import=sqlalchemy.engine.sqlalchemy --hidden-import=sqlalchemy.engine.strategies --hidden-import=sqlalchemy.engine.sys --hidden-import=sqlalchemy.engine.threadlocal --hidden-import=sqlalchemy.engine.url --hidden-import=sqlalchemy.engine.urllib --hidden-import=sqlalchemy.engine.weakref --hidden-import=sqlalchemy.event --hidden-import=sqlalchemy.events --hidden-import=sqlalchemy.exc --hidden-import=sqlalchemy.ext --hidden-import=sqlalchemy.ext.declarative --hidden-import=sqlalchemy.ext.sqlalchemy --hidden-import=sqlalchemy.inspect --hidden-import=sqlalchemy.interfaces --hidden-import=sqlalchemy.log --hidden-import=sqlalchemy.logging --hidden-import=sqlalchemy.orm --hidden-import=sqlalchemy.orm.attributes --hidden-import=sqlalchemy.orm.collections --hidden-import=sqlalchemy.orm.copy --hidden-import=sqlalchemy.orm.dependency --hidden-import=sqlalchemy.orm.deprecated_interfaces --hidden-import=sqlalchemy.orm.descriptor_props --hidden-import=sqlalchemy.orm.evaluator --hidden-import=sqlalchemy.orm.events --hidden-import=sqlalchemy.orm.exc --hidden-import=sqlalchemy.orm.identity --hidden-import=sqlalchemy.orm.inspect --hidden-import=sqlalchemy.orm.instrumentation --hidden-import=sqlalchemy.orm.interfaces --hidden-import=sqlalchemy.orm.itertools --hidden-import=sqlalchemy.orm.mapper --hidden-import=sqlalchemy.orm.operator --hidden-import=sqlalchemy.orm.persistence --hidden-import=sqlalchemy.orm.properties --hidden-import=sqlalchemy.orm.query --hidden-import=sqlalchemy.orm.re --hidden-import=sqlalchemy.orm.scoping --hidden-import=sqlalchemy.orm.session --hidden-import=sqlalchemy.orm.sets --hidden-import=sqlalchemy.orm.sqlalchemy --hidden-import=sqlalchemy.orm.state --hidden-import=sqlalchemy.orm.strategies --hidden-import=sqlalchemy.orm.sync --hidden-import=sqlalchemy.orm.sys --hidden-import=sqlalchemy.orm.types --hidden-import=sqlalchemy.orm.unitofwork --hidden-import=sqlalchemy.orm.util --hidden-import=sqlalchemy.orm.weakref --hidden-import=sqlalchemy.pool --hidden-import=sqlalchemy.processors --hidden-import=sqlalchemy.re --hidden-import=sqlalchemy.schema --hidden-import=sqlalchemy.sql --hidden-import=sqlalchemy.sql.collections --hidden-import=sqlalchemy.sql.compiler --hidden-import=sqlalchemy.sql.decimal --hidden-import=sqlalchemy.sql.expression --hidden-import=sqlalchemy.sql.functions --hidden-import=sqlalchemy.sql.itertools --hidden-import=sqlalchemy.sql.operator --hidden-import=sqlalchemy.sql.operators --hidden-import=sqlalchemy.sql.re --hidden-import=sqlalchemy.sql.sqlalchemy --hidden-import=sqlalchemy.sql.sys --hidden-import=sqlalchemy.sql.util --hidden-import=sqlalchemy.sql.visitors --hidden-import=sqlalchemy.sqlalchemy --hidden-import=sqlalchemy.sys --hidden-import=sqlalchemy.time --hidden-import=sqlalchemy.traceback --hidden-import=sqlalchemy.types --hidden-import=sqlalchemy.util --hidden-import=sqlalchemy.util._collections --hidden-import=sqlalchemy.util.cPickle --hidden-import=sqlalchemy.util.collections --hidden-import=sqlalchemy.util.compat --hidden-import=sqlalchemy.util.contextlib --hidden-import=sqlalchemy.util.decimal --hidden-import=sqlalchemy.util.deprecations --hidden-import=sqlalchemy.util.functools --hidden-import=sqlalchemy.util.hashlib --hidden-import=sqlalchemy.util.inspect --hidden-import=sqlalchemy.util.itertools --hidden-import=sqlalchemy.util.langhelpers --hidden-import=sqlalchemy.util.operator --hidden-import=sqlalchemy.util.queue --hidden-import=sqlalchemy.util.re --hidden-import=sqlalchemy.util.sets --hidden-import=sqlalchemy.util.sqlalchemy --hidden-import=sqlalchemy.util.sys --hidden-import=sqlalchemy.util.threading --hidden-import=sqlalchemy.util.time --hidden-import=sqlalchemy.util.topological --hidden-import=sqlalchemy.util.types --hidden-import=sqlalchemy.util.urlparse --hidden-import=sqlalchemy.util.warnings --hidden-import=sqlalchemy.util.weakref --hidden-import=sqlalchemy.weakref --hidden-import=sqlite3 --hidden-import=sqlite3._sqlite3 --hidden-import=sqlite3.datetime --hidden-import=sqlite3.dbapi2 --hidden-import=sqlite3.time --hidden-import=sre_compile --hidden-import=sre_constants --hidden-import=sre_parse --hidden-import=ssl --hidden-import=stat --hidden-import=string --hidden-import=strop --hidden-import=struct --hidden-import=sys --hidden-import=tempfile --hidden-import=tempita --hidden-import=tempita._looper --hidden-import=tempita.cStringIO --hidden-import=tempita.cgi --hidden-import=tempita.compat3 --hidden-import=tempita.os --hidden-import=tempita.re --hidden-import=tempita.sys --hidden-import=tempita.tempita --hidden-import=tempita.tokenize --hidden-import=tempita.urllib --hidden-import=termios --hidden-import=textwrap --hidden-import=thread --hidden-import=threading --hidden-import=time --hidden-import=token --hidden-import=tokenize --hidden-import=traceback --hidden-import=types --hidden-import=urllib --hidden-import=urllib2 --hidden-import=urlparse --hidden-import=uu --hidden-import=uuid --hidden-import=warnings --hidden-import=weakref --hidden-import=xml --hidden-import=xml.etree --hidden-import=xml.etree.ElementPath --hidden-import=xml.etree.ElementTree --hidden-import=xml.etree.re --hidden-import=xml.etree.sys --hidden-import=xml.etree.warnings --hidden-import=xml.etree.xml --hidden-import=xml.parsers --hidden-import=xml.parsers.expat --hidden-import=xml.parsers.pyexpat --hidden-import=zipfile --hidden-import=zipimport --hidden-import=zlib sibl_gui/sIBL_GUI\ $MAJOR_VERSION.py +python $PYINSTALLER/pyinstaller.py --noconfirm --noconsole -o releases/Darwin --hidden-import=ConfigParser --hidden-import=PyQt.uic --hidden-import=PyQt4 --hidden-import=PyQt4.QtCore --hidden-import=PyQt4.QtGui --hidden-import=PyQt4.QtNetwork --hidden-import=PyQt4.QtWebKit --hidden-import=PyQt4.uic --hidden-import=PyQt4.uic.Compiler --hidden-import=PyQt4.uic.Compiler.PyQt4 --hidden-import=PyQt4.uic.Compiler.compiler --hidden-import=PyQt4.uic.Compiler.indenter --hidden-import=PyQt4.uic.Compiler.logging --hidden-import=PyQt4.uic.Compiler.misc --hidden-import=PyQt4.uic.Compiler.proxy_metaclass --hidden-import=PyQt4.uic.Compiler.qobjectcreator --hidden-import=PyQt4.uic.Compiler.qtproxies --hidden-import=PyQt4.uic.Compiler.re --hidden-import=PyQt4.uic.Compiler.sys --hidden-import=PyQt4.uic.PyQt4 --hidden-import=PyQt4.uic.exceptions --hidden-import=PyQt4.uic.icon_cache --hidden-import=PyQt4.uic.logging --hidden-import=PyQt4.uic.objcreator --hidden-import=PyQt4.uic.os --hidden-import=PyQt4.uic.port_v2 --hidden-import=PyQt4.uic.port_v2.PyQt4 --hidden-import=PyQt4.uic.port_v2.as_string --hidden-import=PyQt4.uic.port_v2.ascii_upper --hidden-import=PyQt4.uic.port_v2.cStringIO --hidden-import=PyQt4.uic.port_v2.load_plugin --hidden-import=PyQt4.uic.port_v2.proxy_base --hidden-import=PyQt4.uic.port_v2.re --hidden-import=PyQt4.uic.port_v2.string --hidden-import=PyQt4.uic.port_v2.string_io --hidden-import=PyQt4.uic.properties --hidden-import=PyQt4.uic.re --hidden-import=PyQt4.uic.sys --hidden-import=PyQt4.uic.uiparser --hidden-import=PyQt4.uic.xml --hidden-import=Queue --hidden-import=SocketServer --hidden-import=StringIO --hidden-import=UserDict --hidden-import=__builtin__ --hidden-import=__future__ --hidden-import=__main__ --hidden-import=_abcoll --hidden-import=_ast --hidden-import=_bisect --hidden-import=_codecs --hidden-import=_collections --hidden-import=_ctypes --hidden-import=_functools --hidden-import=_hashlib --hidden-import=_heapq --hidden-import=_io --hidden-import=_locale --hidden-import=_random --hidden-import=_scproxy --hidden-import=_socket --hidden-import=_sqlite3 --hidden-import=_sre --hidden-import=_ssl --hidden-import=_struct --hidden-import=_virtualenv_distutils --hidden-import=_warnings --hidden-import=_weakref --hidden-import=_weakrefset --hidden-import=abc --hidden-import=array --hidden-import=ast --hidden-import=atexit --hidden-import=base64 --hidden-import=binascii --hidden-import=bisect --hidden-import=cPickle --hidden-import=cStringIO --hidden-import=cgi --hidden-import=code --hidden-import=codecs --hidden-import=codeop --hidden-import=collections --hidden-import=contextlib --hidden-import=copy --hidden-import=copy_reg --hidden-import=counter --hidden-import=ctypes --hidden-import=ctypes._ctypes --hidden-import=ctypes._endian --hidden-import=ctypes.ctypes --hidden-import=ctypes.macholib --hidden-import=ctypes.macholib.dyld --hidden-import=ctypes.macholib.dylib --hidden-import=ctypes.macholib.framework --hidden-import=ctypes.macholib.itertools --hidden-import=ctypes.macholib.os --hidden-import=ctypes.macholib.re --hidden-import=ctypes.os --hidden-import=ctypes.struct --hidden-import=ctypes.sys --hidden-import=ctypes.util --hidden-import=datetime --hidden-import=decimal --hidden-import=decorator --hidden-import=dis --hidden-import=distutils --hidden-import=distutils.debug --hidden-import=distutils.dep_util --hidden-import=distutils.dist --hidden-import=distutils.distutils --hidden-import=distutils.email --hidden-import=distutils.errors --hidden-import=distutils.fancy_getopt --hidden-import=distutils.getopt --hidden-import=distutils.imp --hidden-import=distutils.log --hidden-import=distutils.opcode --hidden-import=distutils.os --hidden-import=distutils.re --hidden-import=distutils.spawn --hidden-import=distutils.stat --hidden-import=distutils.string --hidden-import=distutils.sys --hidden-import=distutils.sysconfig --hidden-import=distutils.text_file --hidden-import=distutils.util --hidden-import=distutils.warnings --hidden-import=email --hidden-import=email.Charset --hidden-import=email.Encoders --hidden-import=email.Errors --hidden-import=email.FeedParser --hidden-import=email.Generator --hidden-import=email.Header --hidden-import=email.Iterators --hidden-import=email.MIMEAudio --hidden-import=email.MIMEBase --hidden-import=email.MIMEImage --hidden-import=email.MIMEMessage --hidden-import=email.MIMEMultipart --hidden-import=email.MIMENonMultipart --hidden-import=email.MIMEText --hidden-import=email.Message --hidden-import=email.Parser --hidden-import=email.Utils --hidden-import=email._parseaddr --hidden-import=email.base64 --hidden-import=email.base64MIME --hidden-import=email.base64mime --hidden-import=email.binascii --hidden-import=email.cStringIO --hidden-import=email.charset --hidden-import=email.codecs --hidden-import=email.email --hidden-import=email.encoders --hidden-import=email.errors --hidden-import=email.feedparser --hidden-import=email.generator --hidden-import=email.header --hidden-import=email.iterators --hidden-import=email.message --hidden-import=email.mime --hidden-import=email.mime.audio --hidden-import=email.mime.base --hidden-import=email.mime.cStringIO --hidden-import=email.mime.email --hidden-import=email.mime.image --hidden-import=email.mime.imghdr --hidden-import=email.mime.message --hidden-import=email.mime.multipart --hidden-import=email.mime.nonmultipart --hidden-import=email.mime.sndhdr --hidden-import=email.mime.text --hidden-import=email.os --hidden-import=email.parser --hidden-import=email.quopri --hidden-import=email.quopriMIME --hidden-import=email.quoprimime --hidden-import=email.random --hidden-import=email.re --hidden-import=email.socket --hidden-import=email.string --hidden-import=email.sys --hidden-import=email.time --hidden-import=email.urllib --hidden-import=email.utils --hidden-import=email.uu --hidden-import=email.warnings --hidden-import=encodings --hidden-import=encodings.__builtin__ --hidden-import=encodings.aliases --hidden-import=encodings.ascii --hidden-import=encodings.codecs --hidden-import=encodings.encodings --hidden-import=encodings.utf_8 --hidden-import=errno --hidden-import=exceptions --hidden-import=fcntl --hidden-import=fnmatch --hidden-import=functools --hidden-import=gc --hidden-import=genericpath --hidden-import=getopt --hidden-import=getpass --hidden-import=gettext --hidden-import=grp --hidden-import=hashlib --hidden-import=heapq --hidden-import=httplib --hidden-import=imghdr --hidden-import=imp --hidden-import=inspect --hidden-import=io --hidden-import=itertools --hidden-import=keyword --hidden-import=linecache --hidden-import=locale --hidden-import=logging --hidden-import=logging.atexit --hidden-import=logging.cStringIO --hidden-import=logging.codecs --hidden-import=logging.os --hidden-import=logging.sys --hidden-import=logging.thread --hidden-import=logging.threading --hidden-import=logging.time --hidden-import=logging.traceback --hidden-import=logging.warnings --hidden-import=logging.weakref --hidden-import=logilab --hidden-import=marshal --hidden-import=math --hidden-import=migrate --hidden-import=migrate.changeset --hidden-import=migrate.changeset.StringIO --hidden-import=migrate.changeset.UserDict --hidden-import=migrate.changeset.ansisql --hidden-import=migrate.changeset.constraint --hidden-import=migrate.changeset.databases --hidden-import=migrate.changeset.databases.UserDict --hidden-import=migrate.changeset.databases.copy --hidden-import=migrate.changeset.databases.firebird --hidden-import=migrate.changeset.databases.migrate --hidden-import=migrate.changeset.databases.mysql --hidden-import=migrate.changeset.databases.oracle --hidden-import=migrate.changeset.databases.postgres --hidden-import=migrate.changeset.databases.sqlalchemy --hidden-import=migrate.changeset.databases.sqlite --hidden-import=migrate.changeset.databases.visitor --hidden-import=migrate.changeset.migrate --hidden-import=migrate.changeset.re --hidden-import=migrate.changeset.schema --hidden-import=migrate.changeset.sqlalchemy --hidden-import=migrate.changeset.warnings --hidden-import=migrate.exceptions --hidden-import=migrate.migrate --hidden-import=migrate.versioning --hidden-import=migrate.versioning.ConfigParser --hidden-import=migrate.versioning.api --hidden-import=migrate.versioning.cfgparse --hidden-import=migrate.versioning.config --hidden-import=migrate.versioning.datetime --hidden-import=migrate.versioning.genmodel --hidden-import=migrate.versioning.inspect --hidden-import=migrate.versioning.logging --hidden-import=migrate.versioning.migrate --hidden-import=migrate.versioning.os --hidden-import=migrate.versioning.pathed --hidden-import=migrate.versioning.pkg_resources --hidden-import=migrate.versioning.re --hidden-import=migrate.versioning.repository --hidden-import=migrate.versioning.schema --hidden-import=migrate.versioning.schemadiff --hidden-import=migrate.versioning.script --hidden-import=migrate.versioning.script.StringIO --hidden-import=migrate.versioning.script.base --hidden-import=migrate.versioning.script.inspect --hidden-import=migrate.versioning.script.logging --hidden-import=migrate.versioning.script.migrate --hidden-import=migrate.versioning.script.py --hidden-import=migrate.versioning.script.shutil --hidden-import=migrate.versioning.script.sql --hidden-import=migrate.versioning.script.warnings --hidden-import=migrate.versioning.shutil --hidden-import=migrate.versioning.sqlalchemy --hidden-import=migrate.versioning.string --hidden-import=migrate.versioning.sys --hidden-import=migrate.versioning.tempita --hidden-import=migrate.versioning.template --hidden-import=migrate.versioning.util --hidden-import=migrate.versioning.util.decorator --hidden-import=migrate.versioning.util.importpath --hidden-import=migrate.versioning.util.keyedinstance --hidden-import=migrate.versioning.util.logging --hidden-import=migrate.versioning.util.migrate --hidden-import=migrate.versioning.util.os --hidden-import=migrate.versioning.util.pkg_resources --hidden-import=migrate.versioning.util.sqlalchemy --hidden-import=migrate.versioning.util.sys --hidden-import=migrate.versioning.util.warnings --hidden-import=migrate.versioning.version --hidden-import=mimetools --hidden-import=new --hidden-import=numbers --hidden-import=opcode --hidden-import=operator --hidden-import=optparse --hidden-import=ordereddict --hidden-import=os --hidden-import=os.path --hidden-import=pickle --hidden-import=pkg_resources --hidden-import=pkgutil --hidden-import=platform --hidden-import=plistlib --hidden-import=posix --hidden-import=posixpath --hidden-import=pwd --hidden-import=pyexpat --hidden-import=pyexpat.errors --hidden-import=pyexpat.model --hidden-import=quopri --hidden-import=random --hidden-import=re --hidden-import=rfc822 --hidden-import=select --hidden-import=sets --hidden-import=shutil --hidden-import=signal --hidden-import=sip --hidden-import=site --hidden-import=sitecustomize --hidden-import=sndhdr --hidden-import=socket --hidden-import=sqlalchemy --hidden-import=sqlalchemy.codecs --hidden-import=sqlalchemy.collections --hidden-import=sqlalchemy.connectors --hidden-import=sqlalchemy.connectors.mxodbc --hidden-import=sqlalchemy.connectors.mysqldb --hidden-import=sqlalchemy.connectors.pyodbc --hidden-import=sqlalchemy.connectors.re --hidden-import=sqlalchemy.connectors.sqlalchemy --hidden-import=sqlalchemy.connectors.sys --hidden-import=sqlalchemy.connectors.urllib --hidden-import=sqlalchemy.connectors.warnings --hidden-import=sqlalchemy.connectors.zxJDBC --hidden-import=sqlalchemy.cprocessors --hidden-import=sqlalchemy.cresultproxy --hidden-import=sqlalchemy.databases --hidden-import=sqlalchemy.databases.sqlalchemy --hidden-import=sqlalchemy.datetime --hidden-import=sqlalchemy.dialects --hidden-import=sqlalchemy.dialects.access --hidden-import=sqlalchemy.dialects.access.base --hidden-import=sqlalchemy.dialects.access.sqlalchemy --hidden-import=sqlalchemy.dialects.drizzle --hidden-import=sqlalchemy.dialects.drizzle.base --hidden-import=sqlalchemy.dialects.drizzle.mysqldb --hidden-import=sqlalchemy.dialects.drizzle.sqlalchemy --hidden-import=sqlalchemy.dialects.firebird --hidden-import=sqlalchemy.dialects.firebird.base --hidden-import=sqlalchemy.dialects.firebird.datetime --hidden-import=sqlalchemy.dialects.firebird.kinterbasdb --hidden-import=sqlalchemy.dialects.firebird.re --hidden-import=sqlalchemy.dialects.firebird.sqlalchemy --hidden-import=sqlalchemy.dialects.informix --hidden-import=sqlalchemy.dialects.informix.base --hidden-import=sqlalchemy.dialects.informix.datetime --hidden-import=sqlalchemy.dialects.informix.informixdb --hidden-import=sqlalchemy.dialects.informix.re --hidden-import=sqlalchemy.dialects.informix.sqlalchemy --hidden-import=sqlalchemy.dialects.maxdb --hidden-import=sqlalchemy.dialects.maxdb.base --hidden-import=sqlalchemy.dialects.maxdb.datetime --hidden-import=sqlalchemy.dialects.maxdb.itertools --hidden-import=sqlalchemy.dialects.maxdb.re --hidden-import=sqlalchemy.dialects.maxdb.sapdb --hidden-import=sqlalchemy.dialects.maxdb.sqlalchemy --hidden-import=sqlalchemy.dialects.mssql --hidden-import=sqlalchemy.dialects.mssql.adodbapi --hidden-import=sqlalchemy.dialects.mssql.base --hidden-import=sqlalchemy.dialects.mssql.datetime --hidden-import=sqlalchemy.dialects.mssql.decimal --hidden-import=sqlalchemy.dialects.mssql.information_schema --hidden-import=sqlalchemy.dialects.mssql.mxodbc --hidden-import=sqlalchemy.dialects.mssql.operator --hidden-import=sqlalchemy.dialects.mssql.pymssql --hidden-import=sqlalchemy.dialects.mssql.pyodbc --hidden-import=sqlalchemy.dialects.mssql.re --hidden-import=sqlalchemy.dialects.mssql.sqlalchemy --hidden-import=sqlalchemy.dialects.mssql.sys --hidden-import=sqlalchemy.dialects.mssql.zxjdbc --hidden-import=sqlalchemy.dialects.mysql --hidden-import=sqlalchemy.dialects.mysql.array --hidden-import=sqlalchemy.dialects.mysql.base --hidden-import=sqlalchemy.dialects.mysql.datetime --hidden-import=sqlalchemy.dialects.mysql.inspect --hidden-import=sqlalchemy.dialects.mysql.mysqlconnector --hidden-import=sqlalchemy.dialects.mysql.mysqldb --hidden-import=sqlalchemy.dialects.mysql.oursql --hidden-import=sqlalchemy.dialects.mysql.pymysql --hidden-import=sqlalchemy.dialects.mysql.pyodbc --hidden-import=sqlalchemy.dialects.mysql.re --hidden-import=sqlalchemy.dialects.mysql.sqlalchemy --hidden-import=sqlalchemy.dialects.mysql.sys --hidden-import=sqlalchemy.dialects.mysql.zxjdbc --hidden-import=sqlalchemy.dialects.oracle --hidden-import=sqlalchemy.dialects.oracle.base --hidden-import=sqlalchemy.dialects.oracle.collections --hidden-import=sqlalchemy.dialects.oracle.cx_oracle --hidden-import=sqlalchemy.dialects.oracle.datetime --hidden-import=sqlalchemy.dialects.oracle.decimal --hidden-import=sqlalchemy.dialects.oracle.random --hidden-import=sqlalchemy.dialects.oracle.re --hidden-import=sqlalchemy.dialects.oracle.sqlalchemy --hidden-import=sqlalchemy.dialects.oracle.zxjdbc --hidden-import=sqlalchemy.dialects.postgresql --hidden-import=sqlalchemy.dialects.postgresql.base --hidden-import=sqlalchemy.dialects.postgresql.logging --hidden-import=sqlalchemy.dialects.postgresql.pg8000 --hidden-import=sqlalchemy.dialects.postgresql.psycopg2 --hidden-import=sqlalchemy.dialects.postgresql.pypostgresql --hidden-import=sqlalchemy.dialects.postgresql.re --hidden-import=sqlalchemy.dialects.postgresql.sqlalchemy --hidden-import=sqlalchemy.dialects.postgresql.uuid --hidden-import=sqlalchemy.dialects.postgresql.zxjdbc --hidden-import=sqlalchemy.dialects.sqlite --hidden-import=sqlalchemy.dialects.sqlite.base --hidden-import=sqlalchemy.dialects.sqlite.datetime --hidden-import=sqlalchemy.dialects.sqlite.os --hidden-import=sqlalchemy.dialects.sqlite.pysqlite --hidden-import=sqlalchemy.dialects.sqlite.re --hidden-import=sqlalchemy.dialects.sqlite.sqlalchemy --hidden-import=sqlalchemy.dialects.sqlite.sqlite3 --hidden-import=sqlalchemy.dialects.sybase --hidden-import=sqlalchemy.dialects.sybase.base --hidden-import=sqlalchemy.dialects.sybase.operator --hidden-import=sqlalchemy.dialects.sybase.pyodbc --hidden-import=sqlalchemy.dialects.sybase.pysybase --hidden-import=sqlalchemy.dialects.sybase.sqlalchemy --hidden-import=sqlalchemy.engine --hidden-import=sqlalchemy.engine.StringIO --hidden-import=sqlalchemy.engine.base --hidden-import=sqlalchemy.engine.codecs --hidden-import=sqlalchemy.engine.collections --hidden-import=sqlalchemy.engine.ddl --hidden-import=sqlalchemy.engine.default --hidden-import=sqlalchemy.engine.inspect --hidden-import=sqlalchemy.engine.itertools --hidden-import=sqlalchemy.engine.operator --hidden-import=sqlalchemy.engine.random --hidden-import=sqlalchemy.engine.re --hidden-import=sqlalchemy.engine.reflection --hidden-import=sqlalchemy.engine.sqlalchemy --hidden-import=sqlalchemy.engine.strategies --hidden-import=sqlalchemy.engine.sys --hidden-import=sqlalchemy.engine.threadlocal --hidden-import=sqlalchemy.engine.url --hidden-import=sqlalchemy.engine.urllib --hidden-import=sqlalchemy.engine.weakref --hidden-import=sqlalchemy.event --hidden-import=sqlalchemy.events --hidden-import=sqlalchemy.exc --hidden-import=sqlalchemy.ext --hidden-import=sqlalchemy.ext.declarative --hidden-import=sqlalchemy.ext.sqlalchemy --hidden-import=sqlalchemy.inspect --hidden-import=sqlalchemy.interfaces --hidden-import=sqlalchemy.log --hidden-import=sqlalchemy.logging --hidden-import=sqlalchemy.orm --hidden-import=sqlalchemy.orm.attributes --hidden-import=sqlalchemy.orm.collections --hidden-import=sqlalchemy.orm.copy --hidden-import=sqlalchemy.orm.dependency --hidden-import=sqlalchemy.orm.deprecated_interfaces --hidden-import=sqlalchemy.orm.descriptor_props --hidden-import=sqlalchemy.orm.evaluator --hidden-import=sqlalchemy.orm.events --hidden-import=sqlalchemy.orm.exc --hidden-import=sqlalchemy.orm.identity --hidden-import=sqlalchemy.orm.inspect --hidden-import=sqlalchemy.orm.instrumentation --hidden-import=sqlalchemy.orm.interfaces --hidden-import=sqlalchemy.orm.itertools --hidden-import=sqlalchemy.orm.mapper --hidden-import=sqlalchemy.orm.operator --hidden-import=sqlalchemy.orm.persistence --hidden-import=sqlalchemy.orm.properties --hidden-import=sqlalchemy.orm.query --hidden-import=sqlalchemy.orm.re --hidden-import=sqlalchemy.orm.scoping --hidden-import=sqlalchemy.orm.session --hidden-import=sqlalchemy.orm.sets --hidden-import=sqlalchemy.orm.sqlalchemy --hidden-import=sqlalchemy.orm.state --hidden-import=sqlalchemy.orm.strategies --hidden-import=sqlalchemy.orm.sync --hidden-import=sqlalchemy.orm.sys --hidden-import=sqlalchemy.orm.types --hidden-import=sqlalchemy.orm.unitofwork --hidden-import=sqlalchemy.orm.util --hidden-import=sqlalchemy.orm.weakref --hidden-import=sqlalchemy.pool --hidden-import=sqlalchemy.processors --hidden-import=sqlalchemy.re --hidden-import=sqlalchemy.schema --hidden-import=sqlalchemy.sql --hidden-import=sqlalchemy.sql.collections --hidden-import=sqlalchemy.sql.compiler --hidden-import=sqlalchemy.sql.decimal --hidden-import=sqlalchemy.sql.expression --hidden-import=sqlalchemy.sql.functions --hidden-import=sqlalchemy.sql.itertools --hidden-import=sqlalchemy.sql.operator --hidden-import=sqlalchemy.sql.operators --hidden-import=sqlalchemy.sql.re --hidden-import=sqlalchemy.sql.sqlalchemy --hidden-import=sqlalchemy.sql.sys --hidden-import=sqlalchemy.sql.util --hidden-import=sqlalchemy.sql.visitors --hidden-import=sqlalchemy.sqlalchemy --hidden-import=sqlalchemy.sys --hidden-import=sqlalchemy.time --hidden-import=sqlalchemy.traceback --hidden-import=sqlalchemy.types --hidden-import=sqlalchemy.util --hidden-import=sqlalchemy.util._collections --hidden-import=sqlalchemy.util.cPickle --hidden-import=sqlalchemy.util.collections --hidden-import=sqlalchemy.util.compat --hidden-import=sqlalchemy.util.contextlib --hidden-import=sqlalchemy.util.decimal --hidden-import=sqlalchemy.util.deprecations --hidden-import=sqlalchemy.util.functools --hidden-import=sqlalchemy.util.hashlib --hidden-import=sqlalchemy.util.inspect --hidden-import=sqlalchemy.util.itertools --hidden-import=sqlalchemy.util.langhelpers --hidden-import=sqlalchemy.util.operator --hidden-import=sqlalchemy.util.queue --hidden-import=sqlalchemy.util.re --hidden-import=sqlalchemy.util.sets --hidden-import=sqlalchemy.util.sqlalchemy --hidden-import=sqlalchemy.util.sys --hidden-import=sqlalchemy.util.threading --hidden-import=sqlalchemy.util.time --hidden-import=sqlalchemy.util.topological --hidden-import=sqlalchemy.util.types --hidden-import=sqlalchemy.util.urlparse --hidden-import=sqlalchemy.util.warnings --hidden-import=sqlalchemy.util.weakref --hidden-import=sqlalchemy.weakref --hidden-import=sqlite3 --hidden-import=sqlite3._sqlite3 --hidden-import=sqlite3.datetime --hidden-import=sqlite3.dbapi2 --hidden-import=sqlite3.time --hidden-import=sre_compile --hidden-import=sre_constants --hidden-import=sre_parse --hidden-import=ssl --hidden-import=stat --hidden-import=string --hidden-import=strop --hidden-import=struct --hidden-import=sys --hidden-import=tempfile --hidden-import=tempita --hidden-import=tempita._looper --hidden-import=tempita.cStringIO --hidden-import=tempita.cgi --hidden-import=tempita.compat3 --hidden-import=tempita.os --hidden-import=tempita.re --hidden-import=tempita.sys --hidden-import=tempita.tempita --hidden-import=tempita.tokenize --hidden-import=tempita.urllib --hidden-import=termios --hidden-import=textwrap --hidden-import=thread --hidden-import=threading --hidden-import=time --hidden-import=token --hidden-import=tokenize --hidden-import=traceback --hidden-import=types --hidden-import=urllib --hidden-import=urllib2 --hidden-import=urlparse --hidden-import=uu --hidden-import=uuid --hidden-import=warnings --hidden-import=weakref --hidden-import=win32com.client --hidden-import=xml --hidden-import=xml.etree --hidden-import=xml.etree.ElementPath --hidden-import=xml.etree.ElementTree --hidden-import=xml.etree.re --hidden-import=xml.etree.sys --hidden-import=xml.etree.warnings --hidden-import=xml.etree.xml --hidden-import=xml.parsers --hidden-import=xml.parsers.expat --hidden-import=xml.parsers.pyexpat --hidden-import=zipfile --hidden-import=zipimport --hidden-import=zlib sibl_gui/sIBL_GUI\ $MAJOR_VERSION.py mv sibl_gui/sIBL_GUI\ $MAJOR_VERSION.py sibl_gui/launcher.py echo ------------------------------------------------------------------------------- echo Build - End diff --git a/utilities/listImports.py b/utilities/listImports.py index e9f8275b..db85343a 100644 --- a/utilities/listImports.py +++ b/utilities/listImports.py @@ -80,7 +80,7 @@ def listImports(packages, filtersIn, filtersOut): source = File(file) source.cache() for line in source.content: - if not re.search("foundations|manager|umbra|sibl_gui", line): + if not re.search("oncilla|foundations|manager|umbra|sibl_gui", line): search = re.search("^\s*import\s*(?P[\w+\.]+)|^\s*from\s*(?P[\w+\.]+)\s+import", line) if search: diff --git a/utilities/windowsSetup.py b/utilities/windowsSetup.py index a184e88c..4fa9c989 100644 --- a/utilities/windowsSetup.py +++ b/utilities/windowsSetup.py @@ -40,7 +40,7 @@ os.path.join(HOMEPATH, "support\\useUnicode.py"), "z:/Documents/Development/sIBL_GUI/sibl_gui/launcher.py"], pathex=["C:\\cygwin\\home\\KelSolaar"], - excludes=["foundations", "manager", "umbra", "sibl_gui"]) + excludes=["oncilla", "foundations", "manager", "umbra", "sibl_gui"]) pyz = PYZ(a.pure) From 14ed59b8d9e38e83db7cbd9a76025c48940e940f Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Mon, 31 Mar 2014 23:02:37 +0200 Subject: [PATCH 46/54] Update class attributes docstrings. --- sibl_gui/components/core/database/nodes.py | 20 +- sibl_gui/components/core/database/types.py | 15 +- sibl_gui/components/core/inspector/nodes.py | 5 +- .../core/templatesOutliner/nodes.py | 5 +- sibl_gui/globals/constants.py | 140 ++++++++--- sibl_gui/globals/uiConstants.py | 230 ++++++++++++++---- sibl_gui/ui/nodes.py | 5 +- 7 files changed, 336 insertions(+), 84 deletions(-) diff --git a/sibl_gui/components/core/database/nodes.py b/sibl_gui/components/core/database/nodes.py index 63e2f631..e95565e8 100644 --- a/sibl_gui/components/core/database/nodes.py +++ b/sibl_gui/components/core/database/nodes.py @@ -78,7 +78,10 @@ class AbstractDatabaseNode(sibl_gui.ui.nodes.GraphModelNode): """ __family = "AbstractDatabaseNode" - """Node family. ( String )""" + """ + :param __family: Node family. + :type __family: unicode + """ def __init__(self, databaseItem, @@ -303,7 +306,10 @@ class IblSetNode(AbstractDatabaseNode): """ __family = "IblSet" - """Node family. ( String )""" + """ + :param __family: Node family. + :type __family: unicode + """ def __init__(self, databaseItem, @@ -474,7 +480,10 @@ class TemplateNode(AbstractDatabaseNode): """ __family = "Template" - """Node family. ( String )""" + """ + :param __family: Node family. + :type __family: unicode + """ def __init__(self, databaseItem, @@ -604,7 +613,10 @@ class CollectionNode(AbstractDatabaseNode): """ __family = "Collection" - """Node family. ( String )""" + """ + :param __family: Node family. + :type __family: unicode + """ def __init__(self, databaseItem, diff --git a/sibl_gui/components/core/database/types.py b/sibl_gui/components/core/database/types.py index 53e2f4b8..a7ad505d 100644 --- a/sibl_gui/components/core/database/types.py +++ b/sibl_gui/components/core/database/types.py @@ -60,7 +60,10 @@ class IblSet(Base): """ __tablename__ = "IblSets" - """Table name. ( String )""" + """ + :param __tablename__: Table name. + :type __tablename__: unicode + """ id = sqlalchemy.Column(sqlalchemy.Integer, primary_key=True) name = sqlalchemy.Column(sqlalchemy.String) @@ -213,7 +216,10 @@ class Template(Base): """ __tablename__ = "Templates" - """Table name. ( String )""" + """ + :param __tablename__: Table name. + :type __tablename__: unicode + """ id = sqlalchemy.Column(sqlalchemy.Integer, primary_key=True) name = sqlalchemy.Column(sqlalchemy.String) @@ -360,7 +366,10 @@ class Collection(Base): """ __tablename__ = "Collections" - """Table name. ( String )""" + """ + :param __tablename__: Table name. + :type __tablename__: unicode + """ id = sqlalchemy.Column(sqlalchemy.Integer, primary_key=True) name = sqlalchemy.Column(sqlalchemy.String) diff --git a/sibl_gui/components/core/inspector/nodes.py b/sibl_gui/components/core/inspector/nodes.py index 9603c5dd..fcabd149 100644 --- a/sibl_gui/components/core/inspector/nodes.py +++ b/sibl_gui/components/core/inspector/nodes.py @@ -56,7 +56,10 @@ class PlatesNode(sibl_gui.ui.nodes.GraphModelNode): """ __family = "Plate" - """Node family. ( String )""" + """ + :param __family: Node family. + :type __family: unicode + """ def __init__(self, plate, diff --git a/sibl_gui/components/core/templatesOutliner/nodes.py b/sibl_gui/components/core/templatesOutliner/nodes.py index db59493b..3e213917 100644 --- a/sibl_gui/components/core/templatesOutliner/nodes.py +++ b/sibl_gui/components/core/templatesOutliner/nodes.py @@ -55,7 +55,10 @@ class SoftwareNode(sibl_gui.ui.nodes.GraphModelNode): """ __family = "Software" - """Node family. ( String )""" + """ + :param __family: Node family. + :type __family: unicode + """ def __init__(self, name=None, diff --git a/sibl_gui/globals/constants.py b/sibl_gui/globals/constants.py index e33126dd..c74deb5a 100644 --- a/sibl_gui/globals/constants.py +++ b/sibl_gui/globals/constants.py @@ -51,47 +51,101 @@ class Constants(): """ applicationName = "sIBL_GUI" - """Package Application name: '**sIBL_GUI**' ( String )""" + """ + :param applicationName: Package Application name. + :type applicationName: unicode + """ majorVersion = "4" - """Package major version: '**4**' ( String )""" + """ + :param majorVersion: Package major version. + :type majorVersion: unicode + """ minorVersion = "0" - """Package minor version: '**0**' ( String )""" + """ + :param minorVersion: Package minor version. + :type minorVersion: unicode + """ changeVersion = "8" - """Package change version: '**8**' ( String )""" + """ + :param changeVersion: Package change version. + :type changeVersion: unicode + """ releaseVersion = ".".join((majorVersion, minorVersion, changeVersion)) - """Package release version: '**4.0.8**' ( String )""" + """ + :param releaseVersion: Package release version. + :type releaseVersion: unicode + """ logger = "sIBL_GUI_Logger" - """Package logger name: '**sIBL_GUI_Logger**' ( String )""" + """ + :param logger: Package logger name. + :type logger: unicode + """ defaultCodec = sibl_gui.DEFAULT_CODEC - """Default codec: '**utf-8**' ( String )""" + """ + :param defaultCodec: Default codec. + :type defaultCodec: unicode + """ codecError = sibl_gui.CODEC_ERROR - """Default codec error behavior: '**ignore**' ( String )""" + """ + :param codecError: Default codec error behavior. + :type codecError: unicode + """ applicationDirectory = os.sep.join(("sIBL_GUI", ".".join((majorVersion, minorVersion)))) - """Package Application directory: '**sIBL_GUI**' ( String )""" + """ + :param applicationDirectory: Package Application directory. + :type applicationDirectory: unicode + """ if platform.system() == "Windows" or platform.system() == "Microsoft" or platform.system() == "Darwin": providerDirectory = "HDRLabs" - """Package provider directory: '**HDRLabs** on Windows / Darwin, **.HDRLabs** on Linux' ( String )""" + """ + :param providerDirectory: Package provider directory. + :type providerDirectory: unicode + """ elif platform.system() == "Linux": providerDirectory = ".HDRLabs" - """Package provider directory: '**HDRLabs** on Windows / Darwin, **.HDRLabs** on Linux' ( String )""" + """ + :param providerDirectory: Package provider directory. + :type providerDirectory: unicode + """ databaseDirectory = "database" - """Application Database directory: '**database**' ( String )""" + """ + :param databaseDirectory: Application Database directory. + :type databaseDirectory: unicode + """ patchesDirectory = "patches" - """Application patches directory: '**patches**' ( String )""" + """ + :param patchesDirectory: Application patches directory. + :type patchesDirectory: unicode + """ settingsDirectory = "settings" - """Application settings directory: '**settings**' ( String )""" + """ + :param settingsDirectory: Application settings directory. + :type settingsDirectory: unicode + """ userComponentsDirectory = "components" - """Application user components directory: '**components**' ( String )""" + """ + :param userComponentsDirectory: Application user components directory. + :type userComponentsDirectory: unicode + """ loggingDirectory = "logging" - """Application logging directory: '**logging**' ( String )""" + """ + :param loggingDirectory: Application logging directory. + :type loggingDirectory: unicode + """ templatesDirectory = "templates" - """Application templates directory: '**templates**' ( String )""" + """ + :param templatesDirectory: Application templates directory. + :type templatesDirectory: unicode + """ ioDirectory = "io" - """Application io directory: '**io**' ( String )""" + """ + :param ioDirectory: Application io directory. + :type ioDirectory: unicode + """ preferencesDirectories = (databaseDirectory, patchesDirectory, @@ -100,30 +154,60 @@ class Constants(): loggingDirectory, templatesDirectory, ioDirectory) - """Application preferences directories ( Tuple )""" + """ + :param preferencesDirectories: Application preferences directories. + :type preferencesDirectories: tuple + """ coreComponentsDirectory = "components/core" - """Application core components directory: '**components/core**' ( String )""" + """ + :param coreComponentsDirectory: Application core components directory. + :type coreComponentsDirectory: unicode + """ addonsComponentsDirectory = "components/addons" - """Application addons components directory: '**components/addons**' ( String )""" + """ + :param addonsComponentsDirectory: Application addons components directory. + :type addonsComponentsDirectory: unicode + """ resourcesDirectory = "resources" - """Application resources directory: '**resources**' ( String )""" + """ + :param resourcesDirectory: Application resources directory. + :type resourcesDirectory: unicode + """ patchesFile = "sIBL_GUI_Patches.rc" - """Application settings file: '**sIBL_GUI_Patches.rc**' ( String )""" + """ + :param patchesFile: Application settings file. + :type patchesFile: unicode + """ databaseFile = "sIBL_GUI_Database.sqlite" - """Application Database file: '**sIBL_GUI_Database.sqlite**' ( String )""" + """ + :param databaseFile: Application Database file. + :type databaseFile: unicode + """ settingsFile = "sIBL_GUI_Settings.rc" - """Application settings file: '**sIBL_GUI_Settings.rc**' ( String )""" + """ + :param settingsFile: Application settings file. + :type settingsFile: unicode + """ loggingFile = "sIBL_GUI_Logging_{0}.log" - """Application logging file: '**sIBL_GUI_Logging_{0}.log**' ( String )""" + """ + :param loggingFile: Application logging file. + :type loggingFile: unicode + """ databaseMigrationsFilesExtension = "py" - """Application Database migrations files extension: '**py**' ( String )""" + """ + :param databaseMigrationsFilesExtension: Application Database migrations files extension. + :type databaseMigrationsFilesExtension: unicode + """ librariesDirectory = "libraries" - """Application libraries directory: '**libraries**' ( String )""" + """ + :param librariesDirectory: Application libraries directory. + :type librariesDirectory: unicode + """ if platform.system() == "Windows" or platform.system() == "Microsoft": freeImageLibrary = os.path.join(librariesDirectory, "freeImage/resources/FreeImage.dll") """FreeImage library path: '**freeImage/resources/FreeImage.dll** on Windows, diff --git a/sibl_gui/globals/uiConstants.py b/sibl_gui/globals/uiConstants.py index d3c3ffcb..e49b121f 100644 --- a/sibl_gui/globals/uiConstants.py +++ b/sibl_gui/globals/uiConstants.py @@ -40,105 +40,231 @@ class UiConstants(): """ uiFile = "sIBL_GUI.ui" - """Application ui file: '**sIBL_GUI.ui**' ( String )""" + """ + :param uiFile: Application ui file. + :type uiFile: unicode + """ windowsStylesheetFile = "styles/Windows_styleSheet.qss" - """Application Windows Os stylesheet file: '**styles/Windows_styleSheet.qss**' ( String )""" + """ + :param windowsStylesheetFile: Application Windows Os stylesheet file. + :type windowsStylesheetFile: unicode + """ darwinStylesheetFile = "styles/Darwin_styleSheet.qss" - """Application Mac Os X Os stylesheet file: '**styles/Darwin_styleSheet.qss**' ( String )""" + """ + :param darwinStylesheetFile: Application Mac Os X Os stylesheet file. + :type darwinStylesheetFile: unicode + """ linuxStylesheetFile = "styles/Linux_styleSheet.qss" - """Application Linux Os stylesheet file: '**styles/Linux_styleSheet.qss**' ( String )""" + """ + :param linuxStylesheetFile: Application Linux Os stylesheet file. + :type linuxStylesheetFile: unicode + """ windowsStyle = "plastique" - """Application Windows Os style: '**plastique**' ( String )""" + """ + :param windowsStyle: Application Windows Os style. + :type windowsStyle: unicode + """ darwinStyle = "plastique" - """Application Mac Os X Os style: '**plastique**' ( String )""" + """ + :param darwinStyle: Application Mac Os X Os style. + :type darwinStyle: unicode + """ linuxStyle = "plastique" - """Application Linux Os style: '**plastique**' ( String )""" + """ + :param linuxStyle: Application Linux Os style. + :type linuxStyle: unicode + """ settingsFile = "preferences/Default_Settings.rc" - """Application defaults settings file: '**preferences/Default_Settings.rc**' ( String )""" + """ + :param settingsFile: Application defaults settings file. + :type settingsFile: unicode + """ layoutsFile = "layouts/Default_Layouts.rc" - """Application defaults layouts file: '**layouts/Default_Layouts.rc**' ( String )""" + """ + :param layoutsFile: Application defaults layouts file. + :type layoutsFile: unicode + """ applicationWindowsIcon = "images/Icon_Light.png" - """Application icon file: '**images/Icon_Light.png**' ( String )""" + """ + :param applicationWindowsIcon: Application icon file. + :type applicationWindowsIcon: unicode + """ splashScreenImage = "images/sIBL_GUI_SpashScreen.png" - """Application splashscreen image: '**images/sIBL_GUI_SpashScreen.png**' ( String )""" + """ + :param splashScreenImage: Application splashscreen image. + :type splashScreenImage: unicode + """ logoImage = "images/sIBL_GUI_Logo.png" - """Application logo image: '**images/sIBL_GUI_Logo.png**' ( String )""" + """ + :param logoImage: Application logo image. + :type logoImage: unicode + """ defaultToolbarIconSize = 32 - """Application toolbar icons size: '**32**' ( Integer )""" + """ + :param defaultToolbarIconSize: Application toolbar icons size. + :type defaultToolbarIconSize: int + """ centralWidgetIcon = "images/Central_Widget.png" - """Application **Central Widget** icon: '**images/Central_Widget.png**' ( String )""" + """ + :param centralWidgetIcon: Application **Central Widget** icon. + :type centralWidgetIcon: unicode + """ centralWidgetHoverIcon = "images/Central_Widget_Hover.png" - """Application **Central Widget** hover icon: '**images/Central_Widget_Hover.png**' ( String )""" + """ + :param centralWidgetHoverIcon: Application **Central Widget** hover icon. + :type centralWidgetHoverIcon: unicode + """ centralWidgetActiveIcon = "images/Central_Widget_Active.png" - """Application **Central Widget** active icon: '**images/Central_Widget_Active.png**' ( String )""" + """ + :param centralWidgetActiveIcon: Application **Central Widget** active icon. + :type centralWidgetActiveIcon: unicode + """ customLayoutsIcon = "images/Custom_Layouts.png" - """Application **Custom Layouts** icon: '**images/Custom_Layouts.png**' ( String )""" + """ + :param customLayoutsIcon: Application **Custom Layouts** icon. + :type customLayoutsIcon: unicode + """ customLayoutsHoverIcon = "images/Custom_Layouts_Hover.png" - """Application **Custom Layouts** hover icon: '**images/Custom_Layouts_Hover.png**' ( String )""" + """ + :param customLayoutsHoverIcon: Application **Custom Layouts** hover icon. + :type customLayoutsHoverIcon: unicode + """ customLayoutsActiveIcon = "images/Custom_Layouts_Active.png" - """Application **Custom Layouts** active icon: '**images/Custom_Layouts_Active.png**' ( String )""" + """ + :param customLayoutsActiveIcon: Application **Custom Layouts** active icon. + :type customLayoutsActiveIcon: unicode + """ miscellaneousIcon = "images/Miscellaneous.png" - """Application **Miscellaneous** icon: '**images/Miscellaneous.png**' ( String )""" + """ + :param miscellaneousIcon: Application **Miscellaneous** icon. + :type miscellaneousIcon: unicode + """ miscellaneousHoverIcon = "images/Miscellaneous_Hover.png" - """Application **Miscellaneous** hover icon: '**images/Miscellaneous_Hover.png**' ( String )""" + """ + :param miscellaneousHoverIcon: Application **Miscellaneous** hover icon. + :type miscellaneousHoverIcon: unicode + """ miscellaneousActiveIcon = "images/Miscellaneous_Active.png" - """Application **Miscellaneous** active icon: '**images/Miscellaneous_Active.png**' ( String )""" + """ + :param miscellaneousActiveIcon: Application **Miscellaneous** active icon. + :type miscellaneousActiveIcon: unicode + """ libraryIcon = "images/Library.png" - """Application **Library** icon: '**images/Library.png**' ( String )""" + """ + :param libraryIcon: Application **Library** icon. + :type libraryIcon: unicode + """ libraryHoverIcon = "images/Library_Hover.png" - """Application **Library** hover icon: '**images/Library_Hover.png**' ( String )""" + """ + :param libraryHoverIcon: Application **Library** hover icon. + :type libraryHoverIcon: unicode + """ libraryActiveIcon = "images/Library_Active.png" - """Application **Library** active icon: '**images/Library_Active.png**' ( String )""" + """ + :param libraryActiveIcon: Application **Library** active icon. + :type libraryActiveIcon: unicode + """ inspectIcon = "images/Inspect.png" - """Application **Inspect** icon: '**images/Inspect.png**' ( String )""" + """ + :param inspectIcon: Application **Inspect** icon. + :type inspectIcon: unicode + """ inspectHoverIcon = "images/Inspect_Hover.png" - """Application **Inspect** hover icon: '**images/Inspect_Hover.png**' ( String )""" + """ + :param inspectHoverIcon: Application **Inspect** hover icon. + :type inspectHoverIcon: unicode + """ inspectActiveIcon = "images/Inspect_Active.png" - """Application **Inspect** active icon: '**images/Inspect_Active.png**' ( String )""" + """ + :param inspectActiveIcon: Application **Inspect** active icon. + :type inspectActiveIcon: unicode + """ exportIcon = "images/Export.png" - """Application **Export** icon: '**images/Export.png**' ( String )""" + """ + :param exportIcon: Application **Export** icon. + :type exportIcon: unicode + """ exportHoverIcon = "images/Export_Hover.png" - """Application **Export** hover icon: '**images/Export_Hover.png**' ( String )""" + """ + :param exportHoverIcon: Application **Export** hover icon. + :type exportHoverIcon: unicode + """ exportActiveIcon = "images/Export_Active.png" - """Application **Export** active icon: '**images/Export_Active.png**' ( String )""" + """ + :param exportActiveIcon: Application **Export** active icon. + :type exportActiveIcon: unicode + """ editIcon = "images/Edit.png" - """Application **Edit** icon: '**images/Edit.png**' ( String )""" + """ + :param editIcon: Application **Edit** icon. + :type editIcon: unicode + """ editHoverIcon = "images/Edit_Hover.png" - """Application **Edit** hover icon: '**images/Edit_Hover.png**' ( String )""" + """ + :param editHoverIcon: Application **Edit** hover icon. + :type editHoverIcon: unicode + """ editActiveIcon = "images/Edit_Active.png" - """Application **Edit** active icon: '**images/Edit_Active.png**' ( String )""" + """ + :param editActiveIcon: Application **Edit** active icon. + :type editActiveIcon: unicode + """ preferencesIcon = "images/Preferences.png" - """Application **Preferences** icon: '**images/Preferences.png**' ( String )""" + """ + :param preferencesIcon: Application **Preferences** icon. + :type preferencesIcon: unicode + """ preferencesHoverIcon = "images/Preferences_Hover.png" - """Application **Preferences** hover icon: '**images/Preferences_Hover.png**' ( String )""" + """ + :param preferencesHoverIcon: Application **Preferences** hover icon. + :type preferencesHoverIcon: unicode + """ preferencesActiveIcon = "images/Preferences_Active.png" - """Application **Preferences** active icon: '**images/Preferences_Active.png**' ( String )""" + """ + :param preferencesActiveIcon: Application **Preferences** active icon. + :type preferencesActiveIcon: unicode + """ formatErrorImage = "images/Thumbnail_Format_Not_Supported_Yet.png" - """Application format error image thumbnail: '**images/Thumbnail_Format_Not_Supported_Yet.png**' ( String )""" + """ + :param formatErrorImage: Application format error image thumbnail. + :type formatErrorImage: unicode + """ missingImage = "images/Thumbnail_Not_Found.png" - """Application missing image thumbnail: '**images/Thumbnail_Not_Found.png**' ( String )""" + """ + :param missingImage: Application missing image thumbnail. + :type missingImage: unicode + """ loadingImage = "images/Loading.png" - """Application loading image thumbnail: '**images/Loading.png**' ( String )""" + """ + :param loadingImage: Application loading image thumbnail. + :type loadingImage: unicode + """ startupLayout = "startupCentric" - """Application startup layout: '**startupCentric**' ( String )""" + """ + :param startupLayout: Application startup layout. + :type startupLayout: unicode + """ developmentLayout = "editCentric" - """Application development layout: '**"editCentric"**' ( String )""" + """ + :param developmentLayout: Application development layout. + :type developmentLayout: unicode + """ helpFile = "http://kelsolaar.hdrlabs.com/sIBL_GUI/Support/Documentation/Help/index.html" """Application online help file: @@ -154,14 +280,20 @@ class UiConstants(): "Jpeg" : "\.jpeg$", "Jpg" : "\.jpg$", "Png" : "\.png$" } - """Application native image file formats. ( Dictionary )""" + """ + :param nativeImageFormats: Application native image file formats. + :type nativeImageFormats: dict + """ thirdPartyImageFormats = {"Exr" : ("\.exr$"), "Hdr" : ("\.hdr$"), "Tif" : ("\.tif$"), "Tiff" : ("\.tiff$"), "Tga" : ("\.tga$")} - """Application third party image file formats. ( Dictionary )""" + """ + :param thirdPartyImageFormats: Application third party image file formats. + :type thirdPartyImageFormats: dict + """ thumbnailsSizes = { "Default" : None, "XLarge" : 512, @@ -170,11 +302,17 @@ class UiConstants(): "Small" : 64, "XSmall" : 32, "Special1" : 600} - """Application thumbnails sizes. ( Dictionary )""" + """ + :param thumbnailsSizes: Application thumbnails sizes. + :type thumbnailsSizes: dict + """ thumbnailsCacheDirectory = "thumbnails" """Thumbnails cache directory.""" crittercismId = "5075c158d5f9b9796b000002" - """Crittercism Id: '**51290b3589ea7429250004fe**' ( String )""" + """ + :param crittercismId: Crittercism Id. + :type crittercismId: unicode + """ diff --git a/sibl_gui/ui/nodes.py b/sibl_gui/ui/nodes.py index 233cfda1..608fdf83 100644 --- a/sibl_gui/ui/nodes.py +++ b/sibl_gui/ui/nodes.py @@ -190,7 +190,10 @@ class GraphModelNode(umbra.ui.nodes.GraphModelNode, Mixin_GraphModelObject): """ __family = "GraphModel" - """Node family. ( String )""" + """ + :param __family: Node family. + :type __family: unicode + """ def __init__(self, name=None, From 30f84311c38653b6e75c26cff9ea1482c9c38fe7 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Mon, 31 Mar 2014 23:28:02 +0200 Subject: [PATCH 47/54] Update package version attribute name. --- docs/sphinx/source/conf.py | 2 +- setup.py | 2 +- sibl_gui/components/addons/about/about.py | 2 +- .../addons/onlineUpdater/onlineUpdater.py | 4 ++-- sibl_gui/globals/constants.py | 6 +++--- .../testsSibl_gui/testsGlobals/testsConstants.py | 14 +++++++------- 6 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index fd78d8e6..52f89297 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -58,7 +58,7 @@ # The short X.Y version. version = str(Constants.majorVersion) # The full version, including alpha/beta/rc tags. -release = str(Constants.releaseVersion) +release = str(Constants.version) # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/setup.py b/setup.py index 77bc0d4d..7d4c555d 100644 --- a/setup.py +++ b/setup.py @@ -82,7 +82,7 @@ def getLongDescription(): return "".join(description) setup(name=sibl_gui.globals.constants.Constants.applicationName, - version=sibl_gui.globals.constants.Constants.releaseVersion, + version=sibl_gui.globals.constants.Constants.version, author=sibl_gui.globals.constants.__author__, author_email=sibl_gui.globals.constants.__email__, include_package_data=True, diff --git a/sibl_gui/components/addons/about/about.py b/sibl_gui/components/addons/about/about.py index ebf97aaf..cc660b25 100644 --- a/sibl_gui/components/addons/about/about.py +++ b/sibl_gui/components/addons/about/about.py @@ -456,7 +456,7 @@ def __miscellaneousMenu_aboutAction__triggered(self, checked): umbra.ui.common.setWindowDefaultIcon(self) aboutMessage = ABOUT_MESSAGE.format(os.path.join(self.__uiResourcesDirectory, self.__uiLogoImage), - Constants.releaseVersion.replace(".", " . "), + Constants.version.replace(".", " . "), os.path.join(self.__uiResourcesDirectory, self.__uiGpl3Image)) self.About_label.setText(aboutMessage) diff --git a/sibl_gui/components/addons/onlineUpdater/onlineUpdater.py b/sibl_gui/components/addons/onlineUpdater/onlineUpdater.py index 432a87ab..c6a5895e 100644 --- a/sibl_gui/components/addons/onlineUpdater/onlineUpdater.py +++ b/sibl_gui/components/addons/onlineUpdater/onlineUpdater.py @@ -825,11 +825,11 @@ def __releasesFileReply__finished(self): LOGGER.info("{0} | '{1}' repository remote object skipped by '{2}' command line parameter value!".format( self.__class__.__name__, remoteObject, "databaseReadOnly")) else: - if Constants.releaseVersion != sectionsFileParser.getValue("Release", remoteObject): + if Constants.version != sectionsFileParser.getValue("Release", remoteObject): releases[remoteObject] = ReleaseObject(name=remoteObject, repositoryVersion=sectionsFileParser.getValue("Release", remoteObject), - localVersion=Constants.releaseVersion, + localVersion=Constants.version, url=sectionsFileParser.getValue("Url", remoteObject), type=sectionsFileParser.getValue("Type", remoteObject), comment=None) diff --git a/sibl_gui/globals/constants.py b/sibl_gui/globals/constants.py index c74deb5a..ce65f3a9 100644 --- a/sibl_gui/globals/constants.py +++ b/sibl_gui/globals/constants.py @@ -70,10 +70,10 @@ class Constants(): :param changeVersion: Package change version. :type changeVersion: unicode """ - releaseVersion = ".".join((majorVersion, minorVersion, changeVersion)) + version = ".".join((majorVersion, minorVersion, changeVersion)) """ - :param releaseVersion: Package release version. - :type releaseVersion: unicode + :param version: Package version. + :type version: unicode """ logger = "sIBL_GUI_Logger" diff --git a/sibl_gui/tests/testsSibl_gui/testsGlobals/testsConstants.py b/sibl_gui/tests/testsSibl_gui/testsGlobals/testsConstants.py index 37961ddb..56ad1851 100644 --- a/sibl_gui/tests/testsSibl_gui/testsGlobals/testsConstants.py +++ b/sibl_gui/tests/testsSibl_gui/testsGlobals/testsConstants.py @@ -62,7 +62,7 @@ def testRequiredAttributes(self): "majorVersion", "minorVersion", "changeVersion", - "releaseVersion", + "version", "logger", "defaultCodec", "codecError", @@ -102,28 +102,28 @@ def testMajorVersionAttribute(self): Tests :attr:`sibl_gui.globals.constants.Constants.majorVersion` attribute. """ - self.assertRegexpMatches(Constants.releaseVersion, "\d") + self.assertRegexpMatches(Constants.version, "\d") def testMinorVersionAttribute(self): """ Tests :attr:`sibl_gui.globals.constants.Constants.minorVersion` attribute. """ - self.assertRegexpMatches(Constants.releaseVersion, "\d") + self.assertRegexpMatches(Constants.version, "\d") def testChangeVersionAttribute(self): """ Tests :attr:`sibl_gui.globals.constants.Constants.changeVersion` attribute. """ - self.assertRegexpMatches(Constants.releaseVersion, "\d") + self.assertRegexpMatches(Constants.version, "\d") - def testReleaseVersionAttribute(self): + def testversionAttribute(self): """ - Tests :attr:`sibl_gui.globals.constants.Constants.releaseVersion` attribute. + Tests :attr:`sibl_gui.globals.constants.Constants.version` attribute. """ - self.assertRegexpMatches(Constants.releaseVersion, "\d\.\d\.\d") + self.assertRegexpMatches(Constants.version, "\d\.\d\.\d") def testLoggerAttribute(self): """ From 061e8238d0b3523a01d5d9f9937352cf9e293131 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Tue, 1 Apr 2014 00:40:59 +0200 Subject: [PATCH 48/54] Update documentation / help files. --- docs/help/sIBL_GUI_Manual.html | 81 ++++++++----------- .../pages/api/foundations.environment.rst | 2 + 2 files changed, 37 insertions(+), 46 deletions(-) diff --git a/docs/help/sIBL_GUI_Manual.html b/docs/help/sIBL_GUI_Manual.html index 01014acd..0a7eb86d 100644 --- a/docs/help/sIBL_GUI_Manual.html +++ b/docs/help/sIBL_GUI_Manual.html @@ -8,82 +8,71 @@ /**/ diff --git a/docs/sphinx/source/resources/pages/api/foundations.environment.rst b/docs/sphinx/source/resources/pages/api/foundations.environment.rst index 56421e22..d393da96 100644 --- a/docs/sphinx/source/resources/pages/api/foundations.environment.rst +++ b/docs/sphinx/source/resources/pages/api/foundations.environment.rst @@ -11,6 +11,8 @@ Module Attributes Functions --------- +.. autofunction:: getTemporaryDirectory + .. autofunction:: getSystemApplicationDataDirectory .. autofunction:: getUserApplicationDataDirectory From 8e826500c6e9e1d3eab3cf0c65bc5596b6ac29e4 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Tue, 1 Apr 2014 00:41:26 +0200 Subject: [PATCH 49/54] Update "CHANGES.rst" file. --- CHANGES.rst | 50 ++++++++++++++++++- .../sphinx/source/resources/pages/changes.rst | 48 ++++++++++++++++++ 2 files changed, 97 insertions(+), 1 deletion(-) diff --git a/CHANGES.rst b/CHANGES.rst index 224df737..f3abc421 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,4 +1,4 @@ -**sIBL_GUI** - 4.0.7 - Stable +**sIBL_GUI** - 4.0.8 - Stable ============================= .. .changes @@ -16,6 +16,54 @@ Changes

+4.0.8 - Stable +-------------- + +| **sIBL_GUI** 4.0.8 - Stable - Milestone: https://github.com/KelSolaar/sIBL_GUI/issues?milestone=10&page=1&state=closed +| **Umbra** 1.0.9 - Stable - Milestone: https://github.com/KelSolaar/Umbra/issues?milestone=10&state=closed +| **Manager** 2.0.5 - Stable - Milestone: https://github.com/KelSolaar/Manager/issues?milestone=4&state=closed +| **Foundations** 2.1.0 - Stable - Milestone: https://github.com/KelSolaar/Foundations/issues?milestone=8&page=1&state=closed + +- Handled **WindowsError** in **database** component while retrieving stats on a non existing file. +- Handled exception while searching in tags cloud using an invalid regex pattern in **searchDatabase** component. +- Handled potential **IOError** exceptions related to **foundations.common.foundations.common.isBinaryFile** definition usage when accessing a locked file. +- Prevented exception in **sibl_gui.ui.common.getFormattedShotDate** definition. +- Prevented **AttributeError** exception in **sibl_gui.components.core.inspector.inspector.Inspector.__setActiveIblSet** method when no active iblSet is defined. +- Prevented **ValueError** exception in **sibl_gui.components.core.inspector.inspector.Inspector.__drawActiveIblSetOverlay** method when invalid lights colors attributes are used. +- Prevented **IndexError** exception in **inspector** component. +- Prevented exception reports stacking. +- Prevented **AttributeError** exception in **umbra.components.scriptEditor.scriptEditor.ScriptEditor.__editor__modificationChanged** method. +- Prevented files reloading on exit in **scriptEditor** component. +- Fixed long startup delay when no Internet connection is available. +- Fixed **notificationsManager** notifiers insertion order. +- Fixed caching issue in **foundations.parsers.SectionsFileParser.write** method. +- Handled **BadZipfile** exception in **foundations.pkzip.Pkzip.extractZipFile** method. +- Ensured **fileSystemEventsManager** manager doesn't compares integer paths modification times to float ones. +- Ensured **Softimage_Arnold_Lightsmith** Template compatibility with **SItoA 2.8.0** by removing deprecated legacy light filter code. +- Ensured directional light position is correct in **Maya_Arnold_Standard** and **Maya_Arnold_Dome_Light** Templates. +- Ensured Templates are downloaded into **Factory** directory only if writable. +- Ensured Ibl Set icon is properly displayed in **inspector** component plates view. +- Ensured **Softimage_Arnold_*** Templates compatibility with latest **SItoA** build. +- Ensured **notificationsManager** has a maximum number of displayed notifiers at same time. +- Ensured **foundations.parsers.SectionsFileParser.parse** method reads current file content if no content has been previously set. +- Ensured that loggers and their formatters receive unicode data. +- Removed **miCreateOtherOptionsNodesForURG** mel procedure call in **Maya_MR_Standard** Template. +- Removed dependency on **ordereddict** for Python versions that already include it. +- Moved **foundations.common.isBinaryFile** definition into **foundations.io** module. +- Added **foundations.shell.** module. +- Extracted documentation utilities to their own repository. +- Pass various globals variables through arguments in **umbra.engine.Umbra** class. +- Refactored magic methods implementation in various managers. +- Implemented fall-back preferences directory support. +- Implemented **get** method in various managers. +- Implemented **__setitem__** method in various managers. +- Implemented magic methods tests for **foundations.parsers.SectionsFileParser** class. +- Implemented **foundations.parsers.SectionsFileParser.setValue** method. +- Implemented support for **ANSI** escape codes. +- Implemented new documentation theme. +- Reformatted package docstrings. +- Verbosed **PyQt** version on startup. + 4.0.7 - Stable -------------- diff --git a/docs/sphinx/source/resources/pages/changes.rst b/docs/sphinx/source/resources/pages/changes.rst index 959f6b3a..37c553fc 100644 --- a/docs/sphinx/source/resources/pages/changes.rst +++ b/docs/sphinx/source/resources/pages/changes.rst @@ -11,6 +11,54 @@ Changes
+4.0.8 - Stable +-------------- + +| **sIBL_GUI** 4.0.8 - Stable - Milestone: https://github.com/KelSolaar/sIBL_GUI/issues?milestone=10&page=1&state=closed +| **Umbra** 1.0.9 - Stable - Milestone: https://github.com/KelSolaar/Umbra/issues?milestone=10&state=closed +| **Manager** 2.0.5 - Stable - Milestone: https://github.com/KelSolaar/Manager/issues?milestone=4&state=closed +| **Foundations** 2.1.0 - Stable - Milestone: https://github.com/KelSolaar/Foundations/issues?milestone=8&page=1&state=closed + +- Handled **WindowsError** in **database** component while retrieving stats on a non existing file. +- Handled exception while searching in tags cloud using an invalid regex pattern in **searchDatabase** component. +- Handled potential **IOError** exceptions related to **foundations.common.foundations.common.isBinaryFile** definition usage when accessing a locked file. +- Prevented exception in **sibl_gui.ui.common.getFormattedShotDate** definition. +- Prevented **AttributeError** exception in **sibl_gui.components.core.inspector.inspector.Inspector.__setActiveIblSet** method when no active iblSet is defined. +- Prevented **ValueError** exception in **sibl_gui.components.core.inspector.inspector.Inspector.__drawActiveIblSetOverlay** method when invalid lights colors attributes are used. +- Prevented **IndexError** exception in **inspector** component. +- Prevented exception reports stacking. +- Prevented **AttributeError** exception in **umbra.components.scriptEditor.scriptEditor.ScriptEditor.__editor__modificationChanged** method. +- Prevented files reloading on exit in **scriptEditor** component. +- Fixed long startup delay when no Internet connection is available. +- Fixed **notificationsManager** notifiers insertion order. +- Fixed caching issue in **foundations.parsers.SectionsFileParser.write** method. +- Handled **BadZipfile** exception in **foundations.pkzip.Pkzip.extractZipFile** method. +- Ensured **fileSystemEventsManager** manager doesn't compares integer paths modification times to float ones. +- Ensured **Softimage_Arnold_Lightsmith** Template compatibility with **SItoA 2.8.0** by removing deprecated legacy light filter code. +- Ensured directional light position is correct in **Maya_Arnold_Standard** and **Maya_Arnold_Dome_Light** Templates. +- Ensured Templates are downloaded into **Factory** directory only if writable. +- Ensured Ibl Set icon is properly displayed in **inspector** component plates view. +- Ensured **Softimage_Arnold_*** Templates compatibility with latest **SItoA** build. +- Ensured **notificationsManager** has a maximum number of displayed notifiers at same time. +- Ensured **foundations.parsers.SectionsFileParser.parse** method reads current file content if no content has been previously set. +- Ensured that loggers and their formatters receive unicode data. +- Removed **miCreateOtherOptionsNodesForURG" mel procedure call in "Maya_MR_Standard" Template. +- Removed dependency on **ordereddict** for Python versions that already include it. +- Moved **foundations.common.isBinaryFile** definition into **foundations.io** module. +- Added **foundations.shell.** module. +- Extracted documentation utilities to their own repository. +- Pass various globals variables through arguments in **umbra.engine.Umbra** class. +- Refactored magic methods implementation in various managers. +- Implemented fall-back preferences directory support. +- Implemented **get** method in various managers. +- Implemented **__setitem__** method in various managers. +- Implemented magic methods tests for **foundations.parsers.SectionsFileParser** class. +- Implemented **foundations.parsers.SectionsFileParser.setValue** method. +- Implemented support for **ANSI** escape codes. +- Implemented new documentation theme. +- Reformatted package docstrings. +- Verbosed **PyQt** version on startup. + 4.0.7 - Stable -------------- From 7cdcf659f383f656bff1a9bad90b2a7d4503b9c3 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Wed, 2 Apr 2014 23:14:11 +0200 Subject: [PATCH 50/54] Restore "Crittercism" application id. --- sibl_gui/globals/uiConstants.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sibl_gui/globals/uiConstants.py b/sibl_gui/globals/uiConstants.py index e49b121f..dc784ad1 100644 --- a/sibl_gui/globals/uiConstants.py +++ b/sibl_gui/globals/uiConstants.py @@ -310,7 +310,7 @@ class UiConstants(): thumbnailsCacheDirectory = "thumbnails" """Thumbnails cache directory.""" - crittercismId = "5075c158d5f9b9796b000002" + crittercismId = "51290b3589ea7429250004fe" """ :param crittercismId: Crittercism Id. :type crittercismId: unicode From e54d37791c7f36551958076bcd2f9cf9cf1dbd98 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Wed, 2 Apr 2014 23:27:24 +0200 Subject: [PATCH 51/54] Update documentation / help files. --- CHANGES.rst | 13 +++---------- README.rst | 3 ++- docs/help/sIBL_GUI_Manual.html | 2 +- docs/help/sIBL_GUI_Manual.rst | 2 +- docs/sphinx/source/resources/pages/changes.rst | 15 ++++----------- .../source/resources/pages/installation.rst | 2 +- 6 files changed, 12 insertions(+), 25 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index f3abc421..553a8bc3 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -6,16 +6,6 @@ Changes ======= -.. raw:: html - -
-

Notes:

-
    -
  • The following changes reflects the changes of sIBL_GUI package and also its dependencies. -
    • -
-
- 4.0.8 - Stable -------------- @@ -37,6 +27,7 @@ Changes - Fixed long startup delay when no Internet connection is available. - Fixed **notificationsManager** notifiers insertion order. - Fixed caching issue in **foundations.parsers.SectionsFileParser.write** method. +- Fixed various issues in **Softimage_Arnold_Standard**, **Softimage_Arnold_Dome_Light** and **Softimage_Arnold_Lightsmith** templates to support latest **SItoA** build. - Handled **BadZipfile** exception in **foundations.pkzip.Pkzip.extractZipFile** method. - Ensured **fileSystemEventsManager** manager doesn't compares integer paths modification times to float ones. - Ensured **Softimage_Arnold_Lightsmith** Template compatibility with **SItoA 2.8.0** by removing deprecated legacy light filter code. @@ -47,10 +38,12 @@ Changes - Ensured **notificationsManager** has a maximum number of displayed notifiers at same time. - Ensured **foundations.parsers.SectionsFileParser.parse** method reads current file content if no content has been previously set. - Ensured that loggers and their formatters receive unicode data. +- Ensured directional light position is correct in **Maya_Arnold_Standard** and **Maya_Arnold_Dome_Light** templates. - Removed **miCreateOtherOptionsNodesForURG** mel procedure call in **Maya_MR_Standard** Template. - Removed dependency on **ordereddict** for Python versions that already include it. - Moved **foundations.common.isBinaryFile** definition into **foundations.io** module. - Added **foundations.shell.** module. +- Added Jed Frechette **Blender_Cycles_Standard** template. - Extracted documentation utilities to their own repository. - Pass various globals variables through arguments in **umbra.engine.Umbra** class. - Refactored magic methods implementation in various managers. diff --git a/README.rst b/README.rst index 9ff73d3c..b9ff5484 100644 --- a/README.rst +++ b/README.rst @@ -2,6 +2,7 @@ sIBL_GUI ======== .. image:: https://secure.travis-ci.org/KelSolaar/sIBL_GUI.png?branch=master +.. image:: https://gemnasium.com/KelSolaar/sIBL_GUI.png Introduction ------------ @@ -53,7 +54,7 @@ If you want to support third party images formats through FreeImage, you will ne - **FreeImage_For_sIBL_GUI**: https://github.com/KelSolaar/FreeImage_For_sIBL_GUI -Alternatively, if you want to directly install from `Github `_ source repository:: +You can also directly install from `Github `_ source repository:: git clone git://github.com/KelSolaar/sIBL_GUI.git cd sIBL_GUI diff --git a/docs/help/sIBL_GUI_Manual.html b/docs/help/sIBL_GUI_Manual.html index 0a7eb86d..ff1d9f3a 100644 --- a/docs/help/sIBL_GUI_Manual.html +++ b/docs/help/sIBL_GUI_Manual.html @@ -469,7 +469,7 @@

- Alternatively, if you want to directly install from Github source repository: + You can also directly install from Github source repository: 

 git clone git://github.com/KelSolaar/sIBL_GUI.git
diff --git a/docs/help/sIBL_GUI_Manual.rst b/docs/help/sIBL_GUI_Manual.rst
index 4a5ca48f..a024d72c 100644
--- a/docs/help/sIBL_GUI_Manual.rst
+++ b/docs/help/sIBL_GUI_Manual.rst
@@ -229,7 +229,7 @@ If you want to support third party images formats through FreeImage, you will ne
 
 - **FreeImage_For_sIBL_GUI**: https://github.com/KelSolaar/FreeImage_For_sIBL_GUI
 
-Alternatively, if you want to directly install from `Github `_ source repository::
+You can also directly install from `Github `_ source repository::
 
       git clone git://github.com/KelSolaar/sIBL_GUI.git
       cd sIBL_GUI
diff --git a/docs/sphinx/source/resources/pages/changes.rst b/docs/sphinx/source/resources/pages/changes.rst
index 37c553fc..a3458c49 100644
--- a/docs/sphinx/source/resources/pages/changes.rst
+++ b/docs/sphinx/source/resources/pages/changes.rst
@@ -1,16 +1,6 @@
 Changes
 =======
 
-.. raw:: html
-
-    

-        
Notes:

-        
    
-            
  • The following changes reflects the changes of sIBL_GUI package and also its dependencies.
-            
    • 
-        

-    

-
 4.0.8 - Stable
 --------------
 
@@ -32,6 +22,7 @@ Changes
 -  Fixed long startup delay when no Internet connection is available.
 -  Fixed **notificationsManager** notifiers insertion order.
 -  Fixed caching issue in **foundations.parsers.SectionsFileParser.write** method.
+-  Fixed various issues in **Softimage_Arnold_Standard**, **Softimage_Arnold_Dome_Light** and **Softimage_Arnold_Lightsmith** templates to support latest **SItoA** build.
 -  Handled **BadZipfile** exception in **foundations.pkzip.Pkzip.extractZipFile** method.
 -  Ensured **fileSystemEventsManager** manager doesn't compares integer paths modification times to float ones.
 -  Ensured **Softimage_Arnold_Lightsmith** Template compatibility with **SItoA 2.8.0** by removing deprecated legacy light filter code.
@@ -42,10 +33,12 @@ Changes
 -  Ensured **notificationsManager** has a maximum number of displayed notifiers at same time.
 -  Ensured **foundations.parsers.SectionsFileParser.parse** method reads current file content if no content has been previously set.
 -  Ensured that loggers and their formatters receive unicode data. 
--  Removed **miCreateOtherOptionsNodesForURG" mel procedure call in "Maya_MR_Standard" Template.
+-  Ensured directional light position is correct in **Maya_Arnold_Standard** and **Maya_Arnold_Dome_Light** templates.  
+-  Removed **miCreateOtherOptionsNodesForURG** mel procedure call in **Maya_MR_Standard** Template.
 -  Removed dependency on **ordereddict** for Python versions that already include it.
 -  Moved **foundations.common.isBinaryFile** definition into **foundations.io** module.
 -  Added **foundations.shell.** module.
+-  Added Jed Frechette **Blender_Cycles_Standard** template.
 -  Extracted documentation utilities to their own repository.
 -  Pass various globals variables through arguments in **umbra.engine.Umbra** class.
 -  Refactored magic methods implementation in various managers.
diff --git a/docs/sphinx/source/resources/pages/installation.rst b/docs/sphinx/source/resources/pages/installation.rst
index 467e2ed5..b382cb91 100644
--- a/docs/sphinx/source/resources/pages/installation.rst
+++ b/docs/sphinx/source/resources/pages/installation.rst
@@ -50,7 +50,7 @@ If you want to support third party images formats through FreeImage, you will ne
 
 - **FreeImage_For_sIBL_GUI**: https://github.com/KelSolaar/FreeImage_For_sIBL_GUI
 
-Alternatively, if you want to directly install from `Github `_ source repository::
+You can also directly install from `Github `_ source repository::
 
       git clone git://github.com/KelSolaar/sIBL_GUI.git
       cd sIBL_GUI

From f8bb9ec883a082a0ad5605f7975cd949c05443a3 Mon Sep 17 00:00:00 2001
From: Thomas Mansencal 
Date: Wed, 2 Apr 2014 23:28:04 +0200
Subject: [PATCH 52/54] Update "Pypi" setup file.

---
 setup.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/setup.py b/setup.py
index 7d4c555d..28895d8e 100644
--- a/setup.py
+++ b/setup.py
@@ -92,7 +92,7 @@ def getLongDescription():
 	license="GPLv3",
 	description="sIBL_GUI is an open source lighting assistant making the Image Based Lighting process easier and straight forward through the use of \"Smart Ibl\" files.",
 	long_description=getLongDescription(),
-	install_requires=["SQLAlchemy==0.7.8", "Umbra>=1.0.8", "Counter>=1.0.0"],
+	install_requires=["Counter>=1.0.0", "SQLAlchemy==0.7.8", "Umbra>=1.0.9"],
 	classifiers=["Development Status :: 5 - Production/Stable",
 				"Environment :: Console",
 				"Environment :: MacOS X",

From d6f6a2d55ff41776e8579edf585ae93ccca7644d Mon Sep 17 00:00:00 2001
From: Thomas Mansencal 
Date: Thu, 3 Apr 2014 22:39:24 +0200
Subject: [PATCH 53/54] Update various utilities files.

---
 utilities/actualInstaller/sIBL_GUI.aip |  2 +-
 utilities/darwinBuild.sh               | 60 +++++++++++++-------------
 utilities/gatherFiles.sh               | 32 +++++++-------
 utilities/windowsBuild.sh              | 52 +++++++++++-----------
 4 files changed, 73 insertions(+), 73 deletions(-)

diff --git a/utilities/actualInstaller/sIBL_GUI.aip b/utilities/actualInstaller/sIBL_GUI.aip
index 26be8cb1..4b1f5b10 100644
--- a/utilities/actualInstaller/sIBL_GUI.aip
+++ b/utilities/actualInstaller/sIBL_GUI.aip
@@ -21,7 +21,7 @@ WinVista=1
 Win7=1
 Win8=1
 x64=1
-Admin=1
+Admin=0
 Internet=0
 CloseApp=0
 CloseAppFile=iexplore.exe
diff --git a/utilities/darwinBuild.sh b/utilities/darwinBuild.sh
index 78e6a533..cd9703d8 100755
--- a/utilities/darwinBuild.sh
+++ b/utilities/darwinBuild.sh
@@ -3,20 +3,20 @@ echo ---------------------------------------------------------------------------
 echo sIBL_GUI - Mac Os X - Overall Build
 echo -------------------------------------------------------------------------------
 
-export PYINSTALLER=/Users/kelsolaar/Setup/pyinstaller-2.0/
+export PYINSTALLER_DIRECTORY=/Users/kelsolaar/Documents/Development/ThirdParty/Setup/pyinstaller-2.0/
 
-export PROJECT=$( dirname "${BASH_SOURCE[0]}" )/..
-export MAJOR_VERSION=4
+export PROJECT_DIRECTORY=$( dirname "${BASH_SOURCE[0]}" )/..
+export PROJECT_MAJOR_VERSION=4
 
-export UTILITIES=$PROJECT/utilities
+export UTILITIES_DIRECTORY=$PROJECT_DIRECTORY/utilities
 
-export SOURCE=$PROJECT/
-export RELEASES=$PROJECT/releases/Darwin
-export DISTRIBUTION=$RELEASES/dist
-export BUILD=$RELEASES/build
-export BUNDLE=$DISTRIBUTION/sIBL_GUI\ $MAJOR_VERSION.app
-export DEPENDENCIES=$BUNDLE/Contents/MacOS
-export RESOURCES=$BUNDLE/Contents/Resources
+export SOURCE_DIRECTORY=$PROJECT_DIRECTORY/
+export RELEASES_DIRECTORY=$PROJECT_DIRECTORY/releases/Darwin
+export DISTRIBUTION_DIRECTORY=$RELEASES_DIRECTORY/dist
+export BUILD_DIRECTORY=$RELEASES_DIRECTORY/build
+export BUNDLE_DIRECTORY=$DISTRIBUTION_DIRECTORY/sIBL_GUI\ $PROJECT_MAJOR_VERSION.app
+export DEPENDENCIES_DIRECTORY=$BUNDLE_DIRECTORY/Contents/MacOS
+export RESOURCES_DIRECTORY=$BUNDLE_DIRECTORY/Contents/Resources
 
 IFS=","
 
@@ -24,14 +24,14 @@ IFS=","
 echo -------------------------------------------------------------------------------
 echo Cleanup - Begin
 echo -------------------------------------------------------------------------------
-rm -rf $BUILD $DISTRIBUTION $DEPENDENCIES $BUNDLE
+rm -rf $BUILD_DIRECTORY $DISTRIBUTION_DIRECTORY $DEPENDENCIES_DIRECTORY $BUNDLE_DIRECTORY
 packages="foundations,manager,umbra,sibl_gui"
 types=".pyc,.pyo,.DS_Store,Thumbs.db"
 for package in $packages
 do
 	for type in $types
 	do
-		python $UTILITIES/recursiveRemove.py --input $( $UTILITIES/getPackagePath.py --package $package ) --pattern $type
+		python $UTILITIES_DIRECTORY/recursiveRemove.py --input $( $UTILITIES_DIRECTORY/getPackagePath.py --package $package ) --pattern $type
 	done
 done
 echo -------------------------------------------------------------------------------
@@ -42,9 +42,9 @@ echo ---------------------------------------------------------------------------
 echo -------------------------------------------------------------------------------
 echo Build - Begin
 echo -------------------------------------------------------------------------------
-mv sibl_gui/launcher.py sibl_gui/sIBL_GUI\ $MAJOR_VERSION.py
-python $PYINSTALLER/pyinstaller.py --noconfirm --noconsole -o releases/Darwin --hidden-import=ConfigParser --hidden-import=PyQt.uic --hidden-import=PyQt4 --hidden-import=PyQt4.QtCore --hidden-import=PyQt4.QtGui --hidden-import=PyQt4.QtNetwork --hidden-import=PyQt4.QtWebKit --hidden-import=PyQt4.uic --hidden-import=PyQt4.uic.Compiler --hidden-import=PyQt4.uic.Compiler.PyQt4 --hidden-import=PyQt4.uic.Compiler.compiler --hidden-import=PyQt4.uic.Compiler.indenter --hidden-import=PyQt4.uic.Compiler.logging --hidden-import=PyQt4.uic.Compiler.misc --hidden-import=PyQt4.uic.Compiler.proxy_metaclass --hidden-import=PyQt4.uic.Compiler.qobjectcreator --hidden-import=PyQt4.uic.Compiler.qtproxies --hidden-import=PyQt4.uic.Compiler.re --hidden-import=PyQt4.uic.Compiler.sys --hidden-import=PyQt4.uic.PyQt4 --hidden-import=PyQt4.uic.exceptions --hidden-import=PyQt4.uic.icon_cache --hidden-import=PyQt4.uic.logging --hidden-import=PyQt4.uic.objcreator --hidden-import=PyQt4.uic.os --hidden-import=PyQt4.uic.port_v2 --hidden-import=PyQt4.uic.port_v2.PyQt4 --hidden-import=PyQt4.uic.port_v2.as_string --hidden-import=PyQt4.uic.port_v2.ascii_upper --hidden-import=PyQt4.uic.port_v2.cStringIO --hidden-import=PyQt4.uic.port_v2.load_plugin --hidden-import=PyQt4.uic.port_v2.proxy_base --hidden-import=PyQt4.uic.port_v2.re --hidden-import=PyQt4.uic.port_v2.string --hidden-import=PyQt4.uic.port_v2.string_io --hidden-import=PyQt4.uic.properties --hidden-import=PyQt4.uic.re --hidden-import=PyQt4.uic.sys --hidden-import=PyQt4.uic.uiparser --hidden-import=PyQt4.uic.xml --hidden-import=Queue --hidden-import=SocketServer --hidden-import=StringIO --hidden-import=UserDict --hidden-import=__builtin__ --hidden-import=__future__ --hidden-import=__main__ --hidden-import=_abcoll --hidden-import=_ast --hidden-import=_bisect --hidden-import=_codecs --hidden-import=_collections --hidden-import=_ctypes --hidden-import=_functools --hidden-import=_hashlib --hidden-import=_heapq --hidden-import=_io --hidden-import=_locale --hidden-import=_random --hidden-import=_scproxy --hidden-import=_socket --hidden-import=_sqlite3 --hidden-import=_sre --hidden-import=_ssl --hidden-import=_struct --hidden-import=_virtualenv_distutils --hidden-import=_warnings --hidden-import=_weakref --hidden-import=_weakrefset --hidden-import=abc --hidden-import=array --hidden-import=ast --hidden-import=atexit --hidden-import=base64 --hidden-import=binascii --hidden-import=bisect --hidden-import=cPickle --hidden-import=cStringIO --hidden-import=cgi --hidden-import=code --hidden-import=codecs --hidden-import=codeop --hidden-import=collections --hidden-import=contextlib --hidden-import=copy --hidden-import=copy_reg --hidden-import=counter --hidden-import=ctypes --hidden-import=ctypes._ctypes --hidden-import=ctypes._endian --hidden-import=ctypes.ctypes --hidden-import=ctypes.macholib --hidden-import=ctypes.macholib.dyld --hidden-import=ctypes.macholib.dylib --hidden-import=ctypes.macholib.framework --hidden-import=ctypes.macholib.itertools --hidden-import=ctypes.macholib.os --hidden-import=ctypes.macholib.re --hidden-import=ctypes.os --hidden-import=ctypes.struct --hidden-import=ctypes.sys --hidden-import=ctypes.util --hidden-import=datetime --hidden-import=decimal --hidden-import=decorator --hidden-import=dis --hidden-import=distutils --hidden-import=distutils.debug --hidden-import=distutils.dep_util --hidden-import=distutils.dist --hidden-import=distutils.distutils --hidden-import=distutils.email --hidden-import=distutils.errors --hidden-import=distutils.fancy_getopt --hidden-import=distutils.getopt --hidden-import=distutils.imp --hidden-import=distutils.log --hidden-import=distutils.opcode --hidden-import=distutils.os --hidden-import=distutils.re --hidden-import=distutils.spawn --hidden-import=distutils.stat --hidden-import=distutils.string --hidden-import=distutils.sys --hidden-import=distutils.sysconfig --hidden-import=distutils.text_file --hidden-import=distutils.util --hidden-import=distutils.warnings --hidden-import=email --hidden-import=email.Charset --hidden-import=email.Encoders --hidden-import=email.Errors --hidden-import=email.FeedParser --hidden-import=email.Generator --hidden-import=email.Header --hidden-import=email.Iterators --hidden-import=email.MIMEAudio --hidden-import=email.MIMEBase --hidden-import=email.MIMEImage --hidden-import=email.MIMEMessage --hidden-import=email.MIMEMultipart --hidden-import=email.MIMENonMultipart --hidden-import=email.MIMEText --hidden-import=email.Message --hidden-import=email.Parser --hidden-import=email.Utils --hidden-import=email._parseaddr --hidden-import=email.base64 --hidden-import=email.base64MIME --hidden-import=email.base64mime --hidden-import=email.binascii --hidden-import=email.cStringIO --hidden-import=email.charset --hidden-import=email.codecs --hidden-import=email.email --hidden-import=email.encoders --hidden-import=email.errors --hidden-import=email.feedparser --hidden-import=email.generator --hidden-import=email.header --hidden-import=email.iterators --hidden-import=email.message --hidden-import=email.mime --hidden-import=email.mime.audio --hidden-import=email.mime.base --hidden-import=email.mime.cStringIO --hidden-import=email.mime.email --hidden-import=email.mime.image --hidden-import=email.mime.imghdr --hidden-import=email.mime.message --hidden-import=email.mime.multipart --hidden-import=email.mime.nonmultipart --hidden-import=email.mime.sndhdr --hidden-import=email.mime.text --hidden-import=email.os --hidden-import=email.parser --hidden-import=email.quopri --hidden-import=email.quopriMIME --hidden-import=email.quoprimime --hidden-import=email.random --hidden-import=email.re --hidden-import=email.socket --hidden-import=email.string --hidden-import=email.sys --hidden-import=email.time --hidden-import=email.urllib --hidden-import=email.utils --hidden-import=email.uu --hidden-import=email.warnings --hidden-import=encodings --hidden-import=encodings.__builtin__ --hidden-import=encodings.aliases --hidden-import=encodings.ascii --hidden-import=encodings.codecs --hidden-import=encodings.encodings --hidden-import=encodings.utf_8 --hidden-import=errno --hidden-import=exceptions --hidden-import=fcntl --hidden-import=fnmatch --hidden-import=functools --hidden-import=gc --hidden-import=genericpath --hidden-import=getopt --hidden-import=getpass --hidden-import=gettext --hidden-import=grp --hidden-import=hashlib --hidden-import=heapq --hidden-import=httplib --hidden-import=imghdr --hidden-import=imp --hidden-import=inspect --hidden-import=io --hidden-import=itertools --hidden-import=keyword --hidden-import=linecache --hidden-import=locale --hidden-import=logging --hidden-import=logging.atexit --hidden-import=logging.cStringIO --hidden-import=logging.codecs --hidden-import=logging.os --hidden-import=logging.sys --hidden-import=logging.thread --hidden-import=logging.threading --hidden-import=logging.time --hidden-import=logging.traceback --hidden-import=logging.warnings --hidden-import=logging.weakref --hidden-import=logilab --hidden-import=marshal --hidden-import=math --hidden-import=migrate --hidden-import=migrate.changeset --hidden-import=migrate.changeset.StringIO --hidden-import=migrate.changeset.UserDict --hidden-import=migrate.changeset.ansisql --hidden-import=migrate.changeset.constraint --hidden-import=migrate.changeset.databases --hidden-import=migrate.changeset.databases.UserDict --hidden-import=migrate.changeset.databases.copy --hidden-import=migrate.changeset.databases.firebird --hidden-import=migrate.changeset.databases.migrate --hidden-import=migrate.changeset.databases.mysql --hidden-import=migrate.changeset.databases.oracle --hidden-import=migrate.changeset.databases.postgres --hidden-import=migrate.changeset.databases.sqlalchemy --hidden-import=migrate.changeset.databases.sqlite --hidden-import=migrate.changeset.databases.visitor --hidden-import=migrate.changeset.migrate --hidden-import=migrate.changeset.re --hidden-import=migrate.changeset.schema --hidden-import=migrate.changeset.sqlalchemy --hidden-import=migrate.changeset.warnings --hidden-import=migrate.exceptions --hidden-import=migrate.migrate --hidden-import=migrate.versioning --hidden-import=migrate.versioning.ConfigParser --hidden-import=migrate.versioning.api --hidden-import=migrate.versioning.cfgparse --hidden-import=migrate.versioning.config --hidden-import=migrate.versioning.datetime --hidden-import=migrate.versioning.genmodel --hidden-import=migrate.versioning.inspect --hidden-import=migrate.versioning.logging --hidden-import=migrate.versioning.migrate --hidden-import=migrate.versioning.os --hidden-import=migrate.versioning.pathed --hidden-import=migrate.versioning.pkg_resources --hidden-import=migrate.versioning.re --hidden-import=migrate.versioning.repository --hidden-import=migrate.versioning.schema --hidden-import=migrate.versioning.schemadiff --hidden-import=migrate.versioning.script --hidden-import=migrate.versioning.script.StringIO --hidden-import=migrate.versioning.script.base --hidden-import=migrate.versioning.script.inspect --hidden-import=migrate.versioning.script.logging --hidden-import=migrate.versioning.script.migrate --hidden-import=migrate.versioning.script.py --hidden-import=migrate.versioning.script.shutil --hidden-import=migrate.versioning.script.sql --hidden-import=migrate.versioning.script.warnings --hidden-import=migrate.versioning.shutil --hidden-import=migrate.versioning.sqlalchemy --hidden-import=migrate.versioning.string --hidden-import=migrate.versioning.sys --hidden-import=migrate.versioning.tempita --hidden-import=migrate.versioning.template --hidden-import=migrate.versioning.util --hidden-import=migrate.versioning.util.decorator --hidden-import=migrate.versioning.util.importpath --hidden-import=migrate.versioning.util.keyedinstance --hidden-import=migrate.versioning.util.logging --hidden-import=migrate.versioning.util.migrate --hidden-import=migrate.versioning.util.os --hidden-import=migrate.versioning.util.pkg_resources --hidden-import=migrate.versioning.util.sqlalchemy --hidden-import=migrate.versioning.util.sys --hidden-import=migrate.versioning.util.warnings --hidden-import=migrate.versioning.version --hidden-import=mimetools --hidden-import=new --hidden-import=numbers --hidden-import=opcode --hidden-import=operator --hidden-import=optparse --hidden-import=ordereddict --hidden-import=os --hidden-import=os.path --hidden-import=pickle --hidden-import=pkg_resources --hidden-import=pkgutil --hidden-import=platform --hidden-import=plistlib --hidden-import=posix --hidden-import=posixpath --hidden-import=pwd --hidden-import=pyexpat --hidden-import=pyexpat.errors --hidden-import=pyexpat.model --hidden-import=quopri --hidden-import=random --hidden-import=re --hidden-import=rfc822 --hidden-import=select --hidden-import=sets --hidden-import=shutil --hidden-import=signal --hidden-import=sip --hidden-import=site --hidden-import=sitecustomize --hidden-import=sndhdr --hidden-import=socket --hidden-import=sqlalchemy --hidden-import=sqlalchemy.codecs --hidden-import=sqlalchemy.collections --hidden-import=sqlalchemy.connectors --hidden-import=sqlalchemy.connectors.mxodbc --hidden-import=sqlalchemy.connectors.mysqldb --hidden-import=sqlalchemy.connectors.pyodbc --hidden-import=sqlalchemy.connectors.re --hidden-import=sqlalchemy.connectors.sqlalchemy --hidden-import=sqlalchemy.connectors.sys --hidden-import=sqlalchemy.connectors.urllib --hidden-import=sqlalchemy.connectors.warnings --hidden-import=sqlalchemy.connectors.zxJDBC --hidden-import=sqlalchemy.cprocessors --hidden-import=sqlalchemy.cresultproxy --hidden-import=sqlalchemy.databases --hidden-import=sqlalchemy.databases.sqlalchemy --hidden-import=sqlalchemy.datetime --hidden-import=sqlalchemy.dialects --hidden-import=sqlalchemy.dialects.access --hidden-import=sqlalchemy.dialects.access.base --hidden-import=sqlalchemy.dialects.access.sqlalchemy --hidden-import=sqlalchemy.dialects.drizzle --hidden-import=sqlalchemy.dialects.drizzle.base --hidden-import=sqlalchemy.dialects.drizzle.mysqldb --hidden-import=sqlalchemy.dialects.drizzle.sqlalchemy --hidden-import=sqlalchemy.dialects.firebird --hidden-import=sqlalchemy.dialects.firebird.base --hidden-import=sqlalchemy.dialects.firebird.datetime --hidden-import=sqlalchemy.dialects.firebird.kinterbasdb --hidden-import=sqlalchemy.dialects.firebird.re --hidden-import=sqlalchemy.dialects.firebird.sqlalchemy --hidden-import=sqlalchemy.dialects.informix --hidden-import=sqlalchemy.dialects.informix.base --hidden-import=sqlalchemy.dialects.informix.datetime --hidden-import=sqlalchemy.dialects.informix.informixdb --hidden-import=sqlalchemy.dialects.informix.re --hidden-import=sqlalchemy.dialects.informix.sqlalchemy --hidden-import=sqlalchemy.dialects.maxdb --hidden-import=sqlalchemy.dialects.maxdb.base --hidden-import=sqlalchemy.dialects.maxdb.datetime --hidden-import=sqlalchemy.dialects.maxdb.itertools --hidden-import=sqlalchemy.dialects.maxdb.re --hidden-import=sqlalchemy.dialects.maxdb.sapdb --hidden-import=sqlalchemy.dialects.maxdb.sqlalchemy --hidden-import=sqlalchemy.dialects.mssql --hidden-import=sqlalchemy.dialects.mssql.adodbapi --hidden-import=sqlalchemy.dialects.mssql.base --hidden-import=sqlalchemy.dialects.mssql.datetime --hidden-import=sqlalchemy.dialects.mssql.decimal --hidden-import=sqlalchemy.dialects.mssql.information_schema --hidden-import=sqlalchemy.dialects.mssql.mxodbc --hidden-import=sqlalchemy.dialects.mssql.operator --hidden-import=sqlalchemy.dialects.mssql.pymssql --hidden-import=sqlalchemy.dialects.mssql.pyodbc --hidden-import=sqlalchemy.dialects.mssql.re --hidden-import=sqlalchemy.dialects.mssql.sqlalchemy --hidden-import=sqlalchemy.dialects.mssql.sys --hidden-import=sqlalchemy.dialects.mssql.zxjdbc --hidden-import=sqlalchemy.dialects.mysql --hidden-import=sqlalchemy.dialects.mysql.array --hidden-import=sqlalchemy.dialects.mysql.base --hidden-import=sqlalchemy.dialects.mysql.datetime --hidden-import=sqlalchemy.dialects.mysql.inspect --hidden-import=sqlalchemy.dialects.mysql.mysqlconnector --hidden-import=sqlalchemy.dialects.mysql.mysqldb --hidden-import=sqlalchemy.dialects.mysql.oursql --hidden-import=sqlalchemy.dialects.mysql.pymysql --hidden-import=sqlalchemy.dialects.mysql.pyodbc --hidden-import=sqlalchemy.dialects.mysql.re --hidden-import=sqlalchemy.dialects.mysql.sqlalchemy --hidden-import=sqlalchemy.dialects.mysql.sys --hidden-import=sqlalchemy.dialects.mysql.zxjdbc --hidden-import=sqlalchemy.dialects.oracle --hidden-import=sqlalchemy.dialects.oracle.base --hidden-import=sqlalchemy.dialects.oracle.collections --hidden-import=sqlalchemy.dialects.oracle.cx_oracle --hidden-import=sqlalchemy.dialects.oracle.datetime --hidden-import=sqlalchemy.dialects.oracle.decimal --hidden-import=sqlalchemy.dialects.oracle.random --hidden-import=sqlalchemy.dialects.oracle.re --hidden-import=sqlalchemy.dialects.oracle.sqlalchemy --hidden-import=sqlalchemy.dialects.oracle.zxjdbc --hidden-import=sqlalchemy.dialects.postgresql --hidden-import=sqlalchemy.dialects.postgresql.base --hidden-import=sqlalchemy.dialects.postgresql.logging --hidden-import=sqlalchemy.dialects.postgresql.pg8000 --hidden-import=sqlalchemy.dialects.postgresql.psycopg2 --hidden-import=sqlalchemy.dialects.postgresql.pypostgresql --hidden-import=sqlalchemy.dialects.postgresql.re --hidden-import=sqlalchemy.dialects.postgresql.sqlalchemy --hidden-import=sqlalchemy.dialects.postgresql.uuid --hidden-import=sqlalchemy.dialects.postgresql.zxjdbc --hidden-import=sqlalchemy.dialects.sqlite --hidden-import=sqlalchemy.dialects.sqlite.base --hidden-import=sqlalchemy.dialects.sqlite.datetime --hidden-import=sqlalchemy.dialects.sqlite.os --hidden-import=sqlalchemy.dialects.sqlite.pysqlite --hidden-import=sqlalchemy.dialects.sqlite.re --hidden-import=sqlalchemy.dialects.sqlite.sqlalchemy --hidden-import=sqlalchemy.dialects.sqlite.sqlite3 --hidden-import=sqlalchemy.dialects.sybase --hidden-import=sqlalchemy.dialects.sybase.base --hidden-import=sqlalchemy.dialects.sybase.operator --hidden-import=sqlalchemy.dialects.sybase.pyodbc --hidden-import=sqlalchemy.dialects.sybase.pysybase --hidden-import=sqlalchemy.dialects.sybase.sqlalchemy --hidden-import=sqlalchemy.engine --hidden-import=sqlalchemy.engine.StringIO --hidden-import=sqlalchemy.engine.base --hidden-import=sqlalchemy.engine.codecs --hidden-import=sqlalchemy.engine.collections --hidden-import=sqlalchemy.engine.ddl --hidden-import=sqlalchemy.engine.default --hidden-import=sqlalchemy.engine.inspect --hidden-import=sqlalchemy.engine.itertools --hidden-import=sqlalchemy.engine.operator --hidden-import=sqlalchemy.engine.random --hidden-import=sqlalchemy.engine.re --hidden-import=sqlalchemy.engine.reflection --hidden-import=sqlalchemy.engine.sqlalchemy --hidden-import=sqlalchemy.engine.strategies --hidden-import=sqlalchemy.engine.sys --hidden-import=sqlalchemy.engine.threadlocal --hidden-import=sqlalchemy.engine.url --hidden-import=sqlalchemy.engine.urllib --hidden-import=sqlalchemy.engine.weakref --hidden-import=sqlalchemy.event --hidden-import=sqlalchemy.events --hidden-import=sqlalchemy.exc --hidden-import=sqlalchemy.ext --hidden-import=sqlalchemy.ext.declarative --hidden-import=sqlalchemy.ext.sqlalchemy --hidden-import=sqlalchemy.inspect --hidden-import=sqlalchemy.interfaces --hidden-import=sqlalchemy.log --hidden-import=sqlalchemy.logging --hidden-import=sqlalchemy.orm --hidden-import=sqlalchemy.orm.attributes --hidden-import=sqlalchemy.orm.collections --hidden-import=sqlalchemy.orm.copy --hidden-import=sqlalchemy.orm.dependency --hidden-import=sqlalchemy.orm.deprecated_interfaces --hidden-import=sqlalchemy.orm.descriptor_props --hidden-import=sqlalchemy.orm.evaluator --hidden-import=sqlalchemy.orm.events --hidden-import=sqlalchemy.orm.exc --hidden-import=sqlalchemy.orm.identity --hidden-import=sqlalchemy.orm.inspect --hidden-import=sqlalchemy.orm.instrumentation --hidden-import=sqlalchemy.orm.interfaces --hidden-import=sqlalchemy.orm.itertools --hidden-import=sqlalchemy.orm.mapper --hidden-import=sqlalchemy.orm.operator --hidden-import=sqlalchemy.orm.persistence --hidden-import=sqlalchemy.orm.properties --hidden-import=sqlalchemy.orm.query --hidden-import=sqlalchemy.orm.re --hidden-import=sqlalchemy.orm.scoping --hidden-import=sqlalchemy.orm.session --hidden-import=sqlalchemy.orm.sets --hidden-import=sqlalchemy.orm.sqlalchemy --hidden-import=sqlalchemy.orm.state --hidden-import=sqlalchemy.orm.strategies --hidden-import=sqlalchemy.orm.sync --hidden-import=sqlalchemy.orm.sys --hidden-import=sqlalchemy.orm.types --hidden-import=sqlalchemy.orm.unitofwork --hidden-import=sqlalchemy.orm.util --hidden-import=sqlalchemy.orm.weakref --hidden-import=sqlalchemy.pool --hidden-import=sqlalchemy.processors --hidden-import=sqlalchemy.re --hidden-import=sqlalchemy.schema --hidden-import=sqlalchemy.sql --hidden-import=sqlalchemy.sql.collections --hidden-import=sqlalchemy.sql.compiler --hidden-import=sqlalchemy.sql.decimal --hidden-import=sqlalchemy.sql.expression --hidden-import=sqlalchemy.sql.functions --hidden-import=sqlalchemy.sql.itertools --hidden-import=sqlalchemy.sql.operator --hidden-import=sqlalchemy.sql.operators --hidden-import=sqlalchemy.sql.re --hidden-import=sqlalchemy.sql.sqlalchemy --hidden-import=sqlalchemy.sql.sys --hidden-import=sqlalchemy.sql.util --hidden-import=sqlalchemy.sql.visitors --hidden-import=sqlalchemy.sqlalchemy --hidden-import=sqlalchemy.sys --hidden-import=sqlalchemy.time --hidden-import=sqlalchemy.traceback --hidden-import=sqlalchemy.types --hidden-import=sqlalchemy.util --hidden-import=sqlalchemy.util._collections --hidden-import=sqlalchemy.util.cPickle --hidden-import=sqlalchemy.util.collections --hidden-import=sqlalchemy.util.compat --hidden-import=sqlalchemy.util.contextlib --hidden-import=sqlalchemy.util.decimal --hidden-import=sqlalchemy.util.deprecations --hidden-import=sqlalchemy.util.functools --hidden-import=sqlalchemy.util.hashlib --hidden-import=sqlalchemy.util.inspect --hidden-import=sqlalchemy.util.itertools --hidden-import=sqlalchemy.util.langhelpers --hidden-import=sqlalchemy.util.operator --hidden-import=sqlalchemy.util.queue --hidden-import=sqlalchemy.util.re --hidden-import=sqlalchemy.util.sets --hidden-import=sqlalchemy.util.sqlalchemy --hidden-import=sqlalchemy.util.sys --hidden-import=sqlalchemy.util.threading --hidden-import=sqlalchemy.util.time --hidden-import=sqlalchemy.util.topological --hidden-import=sqlalchemy.util.types --hidden-import=sqlalchemy.util.urlparse --hidden-import=sqlalchemy.util.warnings --hidden-import=sqlalchemy.util.weakref --hidden-import=sqlalchemy.weakref --hidden-import=sqlite3 --hidden-import=sqlite3._sqlite3 --hidden-import=sqlite3.datetime --hidden-import=sqlite3.dbapi2 --hidden-import=sqlite3.time --hidden-import=sre_compile --hidden-import=sre_constants --hidden-import=sre_parse --hidden-import=ssl --hidden-import=stat --hidden-import=string --hidden-import=strop --hidden-import=struct --hidden-import=sys --hidden-import=tempfile --hidden-import=tempita --hidden-import=tempita._looper --hidden-import=tempita.cStringIO --hidden-import=tempita.cgi --hidden-import=tempita.compat3 --hidden-import=tempita.os --hidden-import=tempita.re --hidden-import=tempita.sys --hidden-import=tempita.tempita --hidden-import=tempita.tokenize --hidden-import=tempita.urllib --hidden-import=termios --hidden-import=textwrap --hidden-import=thread --hidden-import=threading --hidden-import=time --hidden-import=token --hidden-import=tokenize --hidden-import=traceback --hidden-import=types --hidden-import=urllib --hidden-import=urllib2 --hidden-import=urlparse --hidden-import=uu --hidden-import=uuid --hidden-import=warnings --hidden-import=weakref --hidden-import=win32com.client --hidden-import=xml --hidden-import=xml.etree --hidden-import=xml.etree.ElementPath --hidden-import=xml.etree.ElementTree --hidden-import=xml.etree.re --hidden-import=xml.etree.sys --hidden-import=xml.etree.warnings --hidden-import=xml.etree.xml --hidden-import=xml.parsers --hidden-import=xml.parsers.expat --hidden-import=xml.parsers.pyexpat --hidden-import=zipfile --hidden-import=zipimport --hidden-import=zlib sibl_gui/sIBL_GUI\ $MAJOR_VERSION.py
-mv sibl_gui/sIBL_GUI\ $MAJOR_VERSION.py sibl_gui/launcher.py
+mv sibl_gui/launcher.py sibl_gui/sIBL_GUI\ $PROJECT_MAJOR_VERSION.py
+python $PYINSTALLER_DIRECTORY/pyinstaller.py --noconfirm --noconsole -o releases/Darwin --hidden-import=ConfigParser --hidden-import=PyQt.uic --hidden-import=PyQt4 --hidden-import=PyQt4.QtCore --hidden-import=PyQt4.QtGui --hidden-import=PyQt4.QtNetwork --hidden-import=PyQt4.QtWebKit --hidden-import=PyQt4.uic --hidden-import=PyQt4.uic.Compiler --hidden-import=PyQt4.uic.Compiler.PyQt4 --hidden-import=PyQt4.uic.Compiler.compiler --hidden-import=PyQt4.uic.Compiler.indenter --hidden-import=PyQt4.uic.Compiler.logging --hidden-import=PyQt4.uic.Compiler.misc --hidden-import=PyQt4.uic.Compiler.proxy_metaclass --hidden-import=PyQt4.uic.Compiler.qobjectcreator --hidden-import=PyQt4.uic.Compiler.qtproxies --hidden-import=PyQt4.uic.Compiler.re --hidden-import=PyQt4.uic.Compiler.sys --hidden-import=PyQt4.uic.PyQt4 --hidden-import=PyQt4.uic.exceptions --hidden-import=PyQt4.uic.icon_cache --hidden-import=PyQt4.uic.logging --hidden-import=PyQt4.uic.objcreator --hidden-import=PyQt4.uic.os --hidden-import=PyQt4.uic.port_v2 --hidden-import=PyQt4.uic.port_v2.PyQt4 --hidden-import=PyQt4.uic.port_v2.as_string --hidden-import=PyQt4.uic.port_v2.ascii_upper --hidden-import=PyQt4.uic.port_v2.cStringIO --hidden-import=PyQt4.uic.port_v2.load_plugin --hidden-import=PyQt4.uic.port_v2.proxy_base --hidden-import=PyQt4.uic.port_v2.re --hidden-import=PyQt4.uic.port_v2.string --hidden-import=PyQt4.uic.port_v2.string_io --hidden-import=PyQt4.uic.properties --hidden-import=PyQt4.uic.re --hidden-import=PyQt4.uic.sys --hidden-import=PyQt4.uic.uiparser --hidden-import=PyQt4.uic.xml --hidden-import=Queue --hidden-import=SocketServer --hidden-import=StringIO --hidden-import=UserDict --hidden-import=__builtin__ --hidden-import=__future__ --hidden-import=__main__ --hidden-import=_abcoll --hidden-import=_ast --hidden-import=_bisect --hidden-import=_codecs --hidden-import=_collections --hidden-import=_ctypes --hidden-import=_functools --hidden-import=_hashlib --hidden-import=_heapq --hidden-import=_io --hidden-import=_locale --hidden-import=_random --hidden-import=_scproxy --hidden-import=_socket --hidden-import=_sqlite3 --hidden-import=_sre --hidden-import=_ssl --hidden-import=_struct --hidden-import=_virtualenv_distutils --hidden-import=_warnings --hidden-import=_weakref --hidden-import=_weakrefset --hidden-import=abc --hidden-import=array --hidden-import=ast --hidden-import=atexit --hidden-import=base64 --hidden-import=binascii --hidden-import=bisect --hidden-import=cPickle --hidden-import=cStringIO --hidden-import=cgi --hidden-import=code --hidden-import=codecs --hidden-import=codeop --hidden-import=collections --hidden-import=contextlib --hidden-import=copy --hidden-import=copy_reg --hidden-import=counter --hidden-import=ctypes --hidden-import=ctypes._ctypes --hidden-import=ctypes._endian --hidden-import=ctypes.ctypes --hidden-import=ctypes.macholib --hidden-import=ctypes.macholib.dyld --hidden-import=ctypes.macholib.dylib --hidden-import=ctypes.macholib.framework --hidden-import=ctypes.macholib.itertools --hidden-import=ctypes.macholib.os --hidden-import=ctypes.macholib.re --hidden-import=ctypes.os --hidden-import=ctypes.struct --hidden-import=ctypes.sys --hidden-import=ctypes.util --hidden-import=datetime --hidden-import=decimal --hidden-import=decorator --hidden-import=dis --hidden-import=distutils --hidden-import=distutils.debug --hidden-import=distutils.dep_util --hidden-import=distutils.dist --hidden-import=distutils.distutils --hidden-import=distutils.email --hidden-import=distutils.errors --hidden-import=distutils.fancy_getopt --hidden-import=distutils.getopt --hidden-import=distutils.imp --hidden-import=distutils.log --hidden-import=distutils.opcode --hidden-import=distutils.os --hidden-import=distutils.re --hidden-import=distutils.spawn --hidden-import=distutils.stat --hidden-import=distutils.string --hidden-import=distutils.sys --hidden-import=distutils.sysconfig --hidden-import=distutils.text_file --hidden-import=distutils.util --hidden-import=distutils.warnings --hidden-import=email --hidden-import=email.Charset --hidden-import=email.Encoders --hidden-import=email.Errors --hidden-import=email.FeedParser --hidden-import=email.Generator --hidden-import=email.Header --hidden-import=email.Iterators --hidden-import=email.MIMEAudio --hidden-import=email.MIMEBase --hidden-import=email.MIMEImage --hidden-import=email.MIMEMessage --hidden-import=email.MIMEMultipart --hidden-import=email.MIMENonMultipart --hidden-import=email.MIMEText --hidden-import=email.Message --hidden-import=email.Parser --hidden-import=email.Utils --hidden-import=email._parseaddr --hidden-import=email.base64 --hidden-import=email.base64MIME --hidden-import=email.base64mime --hidden-import=email.binascii --hidden-import=email.cStringIO --hidden-import=email.charset --hidden-import=email.codecs --hidden-import=email.email --hidden-import=email.encoders --hidden-import=email.errors --hidden-import=email.feedparser --hidden-import=email.generator --hidden-import=email.header --hidden-import=email.iterators --hidden-import=email.message --hidden-import=email.mime --hidden-import=email.mime.audio --hidden-import=email.mime.base --hidden-import=email.mime.cStringIO --hidden-import=email.mime.email --hidden-import=email.mime.image --hidden-import=email.mime.imghdr --hidden-import=email.mime.message --hidden-import=email.mime.multipart --hidden-import=email.mime.nonmultipart --hidden-import=email.mime.sndhdr --hidden-import=email.mime.text --hidden-import=email.os --hidden-import=email.parser --hidden-import=email.quopri --hidden-import=email.quopriMIME --hidden-import=email.quoprimime --hidden-import=email.random --hidden-import=email.re --hidden-import=email.socket --hidden-import=email.string --hidden-import=email.sys --hidden-import=email.time --hidden-import=email.urllib --hidden-import=email.utils --hidden-import=email.uu --hidden-import=email.warnings --hidden-import=encodings --hidden-import=encodings.__builtin__ --hidden-import=encodings.aliases --hidden-import=encodings.ascii --hidden-import=encodings.codecs --hidden-import=encodings.encodings --hidden-import=encodings.utf_8 --hidden-import=errno --hidden-import=exceptions --hidden-import=fcntl --hidden-import=fnmatch --hidden-import=functools --hidden-import=gc --hidden-import=genericpath --hidden-import=getopt --hidden-import=getpass --hidden-import=gettext --hidden-import=grp --hidden-import=hashlib --hidden-import=heapq --hidden-import=httplib --hidden-import=imghdr --hidden-import=imp --hidden-import=inspect --hidden-import=io --hidden-import=itertools --hidden-import=keyword --hidden-import=linecache --hidden-import=locale --hidden-import=logging --hidden-import=logging.atexit --hidden-import=logging.cStringIO --hidden-import=logging.codecs --hidden-import=logging.os --hidden-import=logging.sys --hidden-import=logging.thread --hidden-import=logging.threading --hidden-import=logging.time --hidden-import=logging.traceback --hidden-import=logging.warnings --hidden-import=logging.weakref --hidden-import=logilab --hidden-import=marshal --hidden-import=math --hidden-import=migrate --hidden-import=migrate.changeset --hidden-import=migrate.changeset.StringIO --hidden-import=migrate.changeset.UserDict --hidden-import=migrate.changeset.ansisql --hidden-import=migrate.changeset.constraint --hidden-import=migrate.changeset.databases --hidden-import=migrate.changeset.databases.UserDict --hidden-import=migrate.changeset.databases.copy --hidden-import=migrate.changeset.databases.firebird --hidden-import=migrate.changeset.databases.migrate --hidden-import=migrate.changeset.databases.mysql --hidden-import=migrate.changeset.databases.oracle --hidden-import=migrate.changeset.databases.postgres --hidden-import=migrate.changeset.databases.sqlalchemy --hidden-import=migrate.changeset.databases.sqlite --hidden-import=migrate.changeset.databases.visitor --hidden-import=migrate.changeset.migrate --hidden-import=migrate.changeset.re --hidden-import=migrate.changeset.schema --hidden-import=migrate.changeset.sqlalchemy --hidden-import=migrate.changeset.warnings --hidden-import=migrate.exceptions --hidden-import=migrate.migrate --hidden-import=migrate.versioning --hidden-import=migrate.versioning.ConfigParser --hidden-import=migrate.versioning.api --hidden-import=migrate.versioning.cfgparse --hidden-import=migrate.versioning.config --hidden-import=migrate.versioning.datetime --hidden-import=migrate.versioning.genmodel --hidden-import=migrate.versioning.inspect --hidden-import=migrate.versioning.logging --hidden-import=migrate.versioning.migrate --hidden-import=migrate.versioning.os --hidden-import=migrate.versioning.pathed --hidden-import=migrate.versioning.pkg_resources --hidden-import=migrate.versioning.re --hidden-import=migrate.versioning.repository --hidden-import=migrate.versioning.schema --hidden-import=migrate.versioning.schemadiff --hidden-import=migrate.versioning.script --hidden-import=migrate.versioning.script.StringIO --hidden-import=migrate.versioning.script.base --hidden-import=migrate.versioning.script.inspect --hidden-import=migrate.versioning.script.logging --hidden-import=migrate.versioning.script.migrate --hidden-import=migrate.versioning.script.py --hidden-import=migrate.versioning.script.shutil --hidden-import=migrate.versioning.script.sql --hidden-import=migrate.versioning.script.warnings --hidden-import=migrate.versioning.shutil --hidden-import=migrate.versioning.sqlalchemy --hidden-import=migrate.versioning.string --hidden-import=migrate.versioning.sys --hidden-import=migrate.versioning.tempita --hidden-import=migrate.versioning.template --hidden-import=migrate.versioning.util --hidden-import=migrate.versioning.util.decorator --hidden-import=migrate.versioning.util.importpath --hidden-import=migrate.versioning.util.keyedinstance --hidden-import=migrate.versioning.util.logging --hidden-import=migrate.versioning.util.migrate --hidden-import=migrate.versioning.util.os --hidden-import=migrate.versioning.util.pkg_resources --hidden-import=migrate.versioning.util.sqlalchemy --hidden-import=migrate.versioning.util.sys --hidden-import=migrate.versioning.util.warnings --hidden-import=migrate.versioning.version --hidden-import=mimetools --hidden-import=new --hidden-import=numbers --hidden-import=opcode --hidden-import=operator --hidden-import=optparse --hidden-import=ordereddict --hidden-import=os --hidden-import=os.path --hidden-import=pickle --hidden-import=pkg_resources --hidden-import=pkgutil --hidden-import=platform --hidden-import=plistlib --hidden-import=posix --hidden-import=posixpath --hidden-import=pwd --hidden-import=pyexpat --hidden-import=pyexpat.errors --hidden-import=pyexpat.model --hidden-import=quopri --hidden-import=random --hidden-import=re --hidden-import=rfc822 --hidden-import=select --hidden-import=sets --hidden-import=shutil --hidden-import=signal --hidden-import=sip --hidden-import=site --hidden-import=sitecustomize --hidden-import=sndhdr --hidden-import=socket --hidden-import=sqlalchemy --hidden-import=sqlalchemy.codecs --hidden-import=sqlalchemy.collections --hidden-import=sqlalchemy.connectors --hidden-import=sqlalchemy.connectors.mxodbc --hidden-import=sqlalchemy.connectors.mysqldb --hidden-import=sqlalchemy.connectors.pyodbc --hidden-import=sqlalchemy.connectors.re --hidden-import=sqlalchemy.connectors.sqlalchemy --hidden-import=sqlalchemy.connectors.sys --hidden-import=sqlalchemy.connectors.urllib --hidden-import=sqlalchemy.connectors.warnings --hidden-import=sqlalchemy.connectors.zxJDBC --hidden-import=sqlalchemy.cprocessors --hidden-import=sqlalchemy.cresultproxy --hidden-import=sqlalchemy.databases --hidden-import=sqlalchemy.databases.sqlalchemy --hidden-import=sqlalchemy.datetime --hidden-import=sqlalchemy.dialects --hidden-import=sqlalchemy.dialects.access --hidden-import=sqlalchemy.dialects.access.base --hidden-import=sqlalchemy.dialects.access.sqlalchemy --hidden-import=sqlalchemy.dialects.drizzle --hidden-import=sqlalchemy.dialects.drizzle.base --hidden-import=sqlalchemy.dialects.drizzle.mysqldb --hidden-import=sqlalchemy.dialects.drizzle.sqlalchemy --hidden-import=sqlalchemy.dialects.firebird --hidden-import=sqlalchemy.dialects.firebird.base --hidden-import=sqlalchemy.dialects.firebird.datetime --hidden-import=sqlalchemy.dialects.firebird.kinterbasdb --hidden-import=sqlalchemy.dialects.firebird.re --hidden-import=sqlalchemy.dialects.firebird.sqlalchemy --hidden-import=sqlalchemy.dialects.informix --hidden-import=sqlalchemy.dialects.informix.base --hidden-import=sqlalchemy.dialects.informix.datetime --hidden-import=sqlalchemy.dialects.informix.informixdb --hidden-import=sqlalchemy.dialects.informix.re --hidden-import=sqlalchemy.dialects.informix.sqlalchemy --hidden-import=sqlalchemy.dialects.maxdb --hidden-import=sqlalchemy.dialects.maxdb.base --hidden-import=sqlalchemy.dialects.maxdb.datetime --hidden-import=sqlalchemy.dialects.maxdb.itertools --hidden-import=sqlalchemy.dialects.maxdb.re --hidden-import=sqlalchemy.dialects.maxdb.sapdb --hidden-import=sqlalchemy.dialects.maxdb.sqlalchemy --hidden-import=sqlalchemy.dialects.mssql --hidden-import=sqlalchemy.dialects.mssql.adodbapi --hidden-import=sqlalchemy.dialects.mssql.base --hidden-import=sqlalchemy.dialects.mssql.datetime --hidden-import=sqlalchemy.dialects.mssql.decimal --hidden-import=sqlalchemy.dialects.mssql.information_schema --hidden-import=sqlalchemy.dialects.mssql.mxodbc --hidden-import=sqlalchemy.dialects.mssql.operator --hidden-import=sqlalchemy.dialects.mssql.pymssql --hidden-import=sqlalchemy.dialects.mssql.pyodbc --hidden-import=sqlalchemy.dialects.mssql.re --hidden-import=sqlalchemy.dialects.mssql.sqlalchemy --hidden-import=sqlalchemy.dialects.mssql.sys --hidden-import=sqlalchemy.dialects.mssql.zxjdbc --hidden-import=sqlalchemy.dialects.mysql --hidden-import=sqlalchemy.dialects.mysql.array --hidden-import=sqlalchemy.dialects.mysql.base --hidden-import=sqlalchemy.dialects.mysql.datetime --hidden-import=sqlalchemy.dialects.mysql.inspect --hidden-import=sqlalchemy.dialects.mysql.mysqlconnector --hidden-import=sqlalchemy.dialects.mysql.mysqldb --hidden-import=sqlalchemy.dialects.mysql.oursql --hidden-import=sqlalchemy.dialects.mysql.pymysql --hidden-import=sqlalchemy.dialects.mysql.pyodbc --hidden-import=sqlalchemy.dialects.mysql.re --hidden-import=sqlalchemy.dialects.mysql.sqlalchemy --hidden-import=sqlalchemy.dialects.mysql.sys --hidden-import=sqlalchemy.dialects.mysql.zxjdbc --hidden-import=sqlalchemy.dialects.oracle --hidden-import=sqlalchemy.dialects.oracle.base --hidden-import=sqlalchemy.dialects.oracle.collections --hidden-import=sqlalchemy.dialects.oracle.cx_oracle --hidden-import=sqlalchemy.dialects.oracle.datetime --hidden-import=sqlalchemy.dialects.oracle.decimal --hidden-import=sqlalchemy.dialects.oracle.random --hidden-import=sqlalchemy.dialects.oracle.re --hidden-import=sqlalchemy.dialects.oracle.sqlalchemy --hidden-import=sqlalchemy.dialects.oracle.zxjdbc --hidden-import=sqlalchemy.dialects.postgresql --hidden-import=sqlalchemy.dialects.postgresql.base --hidden-import=sqlalchemy.dialects.postgresql.logging --hidden-import=sqlalchemy.dialects.postgresql.pg8000 --hidden-import=sqlalchemy.dialects.postgresql.psycopg2 --hidden-import=sqlalchemy.dialects.postgresql.pypostgresql --hidden-import=sqlalchemy.dialects.postgresql.re --hidden-import=sqlalchemy.dialects.postgresql.sqlalchemy --hidden-import=sqlalchemy.dialects.postgresql.uuid --hidden-import=sqlalchemy.dialects.postgresql.zxjdbc --hidden-import=sqlalchemy.dialects.sqlite --hidden-import=sqlalchemy.dialects.sqlite.base --hidden-import=sqlalchemy.dialects.sqlite.datetime --hidden-import=sqlalchemy.dialects.sqlite.os --hidden-import=sqlalchemy.dialects.sqlite.pysqlite --hidden-import=sqlalchemy.dialects.sqlite.re --hidden-import=sqlalchemy.dialects.sqlite.sqlalchemy --hidden-import=sqlalchemy.dialects.sqlite.sqlite3 --hidden-import=sqlalchemy.dialects.sybase --hidden-import=sqlalchemy.dialects.sybase.base --hidden-import=sqlalchemy.dialects.sybase.operator --hidden-import=sqlalchemy.dialects.sybase.pyodbc --hidden-import=sqlalchemy.dialects.sybase.pysybase --hidden-import=sqlalchemy.dialects.sybase.sqlalchemy --hidden-import=sqlalchemy.engine --hidden-import=sqlalchemy.engine.StringIO --hidden-import=sqlalchemy.engine.base --hidden-import=sqlalchemy.engine.codecs --hidden-import=sqlalchemy.engine.collections --hidden-import=sqlalchemy.engine.ddl --hidden-import=sqlalchemy.engine.default --hidden-import=sqlalchemy.engine.inspect --hidden-import=sqlalchemy.engine.itertools --hidden-import=sqlalchemy.engine.operator --hidden-import=sqlalchemy.engine.random --hidden-import=sqlalchemy.engine.re --hidden-import=sqlalchemy.engine.reflection --hidden-import=sqlalchemy.engine.sqlalchemy --hidden-import=sqlalchemy.engine.strategies --hidden-import=sqlalchemy.engine.sys --hidden-import=sqlalchemy.engine.threadlocal --hidden-import=sqlalchemy.engine.url --hidden-import=sqlalchemy.engine.urllib --hidden-import=sqlalchemy.engine.weakref --hidden-import=sqlalchemy.event --hidden-import=sqlalchemy.events --hidden-import=sqlalchemy.exc --hidden-import=sqlalchemy.ext --hidden-import=sqlalchemy.ext.declarative --hidden-import=sqlalchemy.ext.sqlalchemy --hidden-import=sqlalchemy.inspect --hidden-import=sqlalchemy.interfaces --hidden-import=sqlalchemy.log --hidden-import=sqlalchemy.logging --hidden-import=sqlalchemy.orm --hidden-import=sqlalchemy.orm.attributes --hidden-import=sqlalchemy.orm.collections --hidden-import=sqlalchemy.orm.copy --hidden-import=sqlalchemy.orm.dependency --hidden-import=sqlalchemy.orm.deprecated_interfaces --hidden-import=sqlalchemy.orm.descriptor_props --hidden-import=sqlalchemy.orm.evaluator --hidden-import=sqlalchemy.orm.events --hidden-import=sqlalchemy.orm.exc --hidden-import=sqlalchemy.orm.identity --hidden-import=sqlalchemy.orm.inspect --hidden-import=sqlalchemy.orm.instrumentation --hidden-import=sqlalchemy.orm.interfaces --hidden-import=sqlalchemy.orm.itertools --hidden-import=sqlalchemy.orm.mapper --hidden-import=sqlalchemy.orm.operator --hidden-import=sqlalchemy.orm.persistence --hidden-import=sqlalchemy.orm.properties --hidden-import=sqlalchemy.orm.query --hidden-import=sqlalchemy.orm.re --hidden-import=sqlalchemy.orm.scoping --hidden-import=sqlalchemy.orm.session --hidden-import=sqlalchemy.orm.sets --hidden-import=sqlalchemy.orm.sqlalchemy --hidden-import=sqlalchemy.orm.state --hidden-import=sqlalchemy.orm.strategies --hidden-import=sqlalchemy.orm.sync --hidden-import=sqlalchemy.orm.sys --hidden-import=sqlalchemy.orm.types --hidden-import=sqlalchemy.orm.unitofwork --hidden-import=sqlalchemy.orm.util --hidden-import=sqlalchemy.orm.weakref --hidden-import=sqlalchemy.pool --hidden-import=sqlalchemy.processors --hidden-import=sqlalchemy.re --hidden-import=sqlalchemy.schema --hidden-import=sqlalchemy.sql --hidden-import=sqlalchemy.sql.collections --hidden-import=sqlalchemy.sql.compiler --hidden-import=sqlalchemy.sql.decimal --hidden-import=sqlalchemy.sql.expression --hidden-import=sqlalchemy.sql.functions --hidden-import=sqlalchemy.sql.itertools --hidden-import=sqlalchemy.sql.operator --hidden-import=sqlalchemy.sql.operators --hidden-import=sqlalchemy.sql.re --hidden-import=sqlalchemy.sql.sqlalchemy --hidden-import=sqlalchemy.sql.sys --hidden-import=sqlalchemy.sql.util --hidden-import=sqlalchemy.sql.visitors --hidden-import=sqlalchemy.sqlalchemy --hidden-import=sqlalchemy.sys --hidden-import=sqlalchemy.time --hidden-import=sqlalchemy.traceback --hidden-import=sqlalchemy.types --hidden-import=sqlalchemy.util --hidden-import=sqlalchemy.util._collections --hidden-import=sqlalchemy.util.cPickle --hidden-import=sqlalchemy.util.collections --hidden-import=sqlalchemy.util.compat --hidden-import=sqlalchemy.util.contextlib --hidden-import=sqlalchemy.util.decimal --hidden-import=sqlalchemy.util.deprecations --hidden-import=sqlalchemy.util.functools --hidden-import=sqlalchemy.util.hashlib --hidden-import=sqlalchemy.util.inspect --hidden-import=sqlalchemy.util.itertools --hidden-import=sqlalchemy.util.langhelpers --hidden-import=sqlalchemy.util.operator --hidden-import=sqlalchemy.util.queue --hidden-import=sqlalchemy.util.re --hidden-import=sqlalchemy.util.sets --hidden-import=sqlalchemy.util.sqlalchemy --hidden-import=sqlalchemy.util.sys --hidden-import=sqlalchemy.util.threading --hidden-import=sqlalchemy.util.time --hidden-import=sqlalchemy.util.topological --hidden-import=sqlalchemy.util.types --hidden-import=sqlalchemy.util.urlparse --hidden-import=sqlalchemy.util.warnings --hidden-import=sqlalchemy.util.weakref --hidden-import=sqlalchemy.weakref --hidden-import=sqlite3 --hidden-import=sqlite3._sqlite3 --hidden-import=sqlite3.datetime --hidden-import=sqlite3.dbapi2 --hidden-import=sqlite3.time --hidden-import=sre_compile --hidden-import=sre_constants --hidden-import=sre_parse --hidden-import=ssl --hidden-import=stat --hidden-import=string --hidden-import=strop --hidden-import=struct --hidden-import=sys --hidden-import=tempfile --hidden-import=tempita --hidden-import=tempita._looper --hidden-import=tempita.cStringIO --hidden-import=tempita.cgi --hidden-import=tempita.compat3 --hidden-import=tempita.os --hidden-import=tempita.re --hidden-import=tempita.sys --hidden-import=tempita.tempita --hidden-import=tempita.tokenize --hidden-import=tempita.urllib --hidden-import=termios --hidden-import=textwrap --hidden-import=thread --hidden-import=threading --hidden-import=time --hidden-import=token --hidden-import=tokenize --hidden-import=traceback --hidden-import=types --hidden-import=urllib --hidden-import=urllib2 --hidden-import=urlparse --hidden-import=uu --hidden-import=uuid --hidden-import=warnings --hidden-import=weakref --hidden-import=win32com.client --hidden-import=xml --hidden-import=xml.etree --hidden-import=xml.etree.ElementPath --hidden-import=xml.etree.ElementTree --hidden-import=xml.etree.re --hidden-import=xml.etree.sys --hidden-import=xml.etree.warnings --hidden-import=xml.etree.xml --hidden-import=xml.parsers --hidden-import=xml.parsers.expat --hidden-import=xml.parsers.pyexpat --hidden-import=zipfile --hidden-import=zipimport --hidden-import=zlib sibl_gui/sIBL_GUI\ $PROJECT_MAJOR_VERSION.py
+mv sibl_gui/sIBL_GUI\ $PROJECT_MAJOR_VERSION.py sibl_gui/launcher.py
 echo -------------------------------------------------------------------------------
 echo Build - End
 echo -------------------------------------------------------------------------------
@@ -56,27 +56,27 @@ echo ---------------------------------------------------------------------------
 packages="foundations,manager,umbra,sibl_gui"
 for package in $packages
 do
-	cp -r $( $UTILITIES/getPackagePath.py --package $package ) $DEPENDENCIES/
+	cp -r $( $UTILITIES_DIRECTORY/getPackagePath.py --package $package ) $DEPENDENCIES_DIRECTORY/
 done
 packages="umbra,sibl_gui"
 extensions="bmp,icns,ico"
 for package in $packages
 do
-	rm -rf $DEPENDENCIES/$package/resources/images/builders
+	rm -rf $DEPENDENCIES_DIRECTORY/$package/resources/images/builders
 
 	for extension in $extensions
 	do
-		rm -f $DEPENDENCIES/$package/resources/images/*.$extension
+		rm -f $DEPENDENCIES_DIRECTORY/$package/resources/images/*.$extension
 	done
 done
-cp $SOURCE/sibl_gui/resources/images/Icon_Light_256.icns $RESOURCES/icon-windowed.icns
-python $UTILITIES/recursiveRemove.py --input $BUNDLE --pattern .pyc
-rm -f $DEPENDENCIES/sibl_gui/libraries/freeImage/resources/*.dll
-rm -f $DEPENDENCIES/sibl_gui/libraries/freeImage/resources/*.so
-rm -rf $DEPENDENCIES/sibl_gui/resources/templates/3dsMax*
-rm -rf $DEPENDENCIES/sibl_gui/resources/templates/Softimage*
-rm -rf $DEPENDENCIES/sibl_gui/resources/templates/XSI*
-rm -rf $DEPENDENCIES/*/tests
+cp $SOURCE_DIRECTORY/sibl_gui/resources/images/Icon_Light_256.icns $RESOURCES_DIRECTORY/icon-windowed.icns
+python $UTILITIES_DIRECTORY/recursiveRemove.py --input $BUNDLE_DIRECTORY --pattern .pyc
+rm -f $DEPENDENCIES_DIRECTORY/sibl_gui/libraries/freeImage/resources/*.dll
+rm -f $DEPENDENCIES_DIRECTORY/sibl_gui/libraries/freeImage/resources/*.so
+rm -rf $DEPENDENCIES_DIRECTORY/sibl_gui/resources/templates/3dsMax*
+rm -rf $DEPENDENCIES_DIRECTORY/sibl_gui/resources/templates/Softimage*
+rm -rf $DEPENDENCIES_DIRECTORY/sibl_gui/resources/templates/XSI*
+rm -rf $DEPENDENCIES_DIRECTORY/*/tests
 echo -------------------------------------------------------------------------------
 echo Release - End
 echo -------------------------------------------------------------------------------
@@ -84,7 +84,7 @@ echo ---------------------------------------------------------------------------
 echo -------------------------------------------------------------------------------
 echo Templates ReStructuredText Files Cleanup - Begin
 echo -------------------------------------------------------------------------------
-python $UTILITIES/recursiveRemove.py --input $BUNDLE/ --pattern .rst
+python $UTILITIES_DIRECTORY/recursiveRemove.py --input $BUNDLE_DIRECTORY/ --pattern .rst
 echo -------------------------------------------------------------------------------
 echo Templates ReStructuredText Files Cleanup - End
 echo -------------------------------------------------------------------------------
@@ -94,8 +94,8 @@ echo ---------------------------------------------------------------------------
 echo Dmg Compilation - Begin
 echo -------------------------------------------------------------------------------
 rm -f ./*.dmg
-dropdmg -g sIBL_GUI -y sIBL_GUI $BUNDLE
-mv $RELEASES/sIBL_GUI\ $MAJOR_VERSION.dmg $RELEASES/sIBL_GUI.dmg
+dropdmg -g sIBL_GUI -y sIBL_GUI $BUNDLE_DIRECTORY
+mv $RELEASES_DIRECTORY/sIBL_GUI\ $PROJECT_MAJOR_VERSION.dmg $RELEASES_DIRECTORY/sIBL_GUI.dmg
 echo -------------------------------------------------------------------------------
 echo Dmg Compilation - End
 echo -------------------------------------------------------------------------------
diff --git a/utilities/gatherFiles.sh b/utilities/gatherFiles.sh
index 8da23d23..842e2cd3 100755
--- a/utilities/gatherFiles.sh
+++ b/utilities/gatherFiles.sh
@@ -3,36 +3,36 @@ echo ---------------------------------------------------------------------------
 echo sIBL_GUI - Files Gathering
 echo -------------------------------------------------------------------------------
 
-export PROJECT=$( dirname "${BASH_SOURCE[0]}" )/..
+export PROJECT_DIRECTORY=$(cd $( dirname "${BASH_SOURCE[0]}" )/..; pwd)
 
-export DOCUMENTATION=$PROJECT/docs/
-export RELEASES=$PROJECT/releases/
-export REPOSITORY=$RELEASES/repository/
-export UTILITIES=$PROJECT/utilities
+export DOCUMENTATION_DIRECTORY=$PROJECT_DIRECTORY/docs/
+export RELEASES_DIRECTORY=$PROJECT_DIRECTORY/releases/
+export REPOSITORY_DIRECTORY=$RELEASES_DIRECTORY/repository/
+export UTILITIES_DIRECTORY=$PROJECT_DIRECTORY/utilities
 
 #! Gathering folder cleanup.
-rm -rf $REPOSITORY
-mkdir -p $REPOSITORY/sIBL_GUI
+rm -rf $REPOSITORY_DIRECTORY
+mkdir -p $REPOSITORY_DIRECTORY/sIBL_GUI
 
 #! Windows gathering.
-cp $RELEASES/windows/sIBL_GUI_Setup.exe $REPOSITORY/sIBL_GUI/sIBL_GUI.exe
+cp $RELEASES_DIRECTORY/windows/sIBL_GUI_Setup.exe $REPOSITORY_DIRECTORY/sIBL_GUI/sIBL_GUI.exe
 
 #! Mac Os X gathering.
-cp $RELEASES/Darwin/sIBL_GUI.dmg $REPOSITORY/sIBL_GUI/sIBL_GUI.dmg
+cp $RELEASES_DIRECTORY/Darwin/sIBL_GUI.dmg $REPOSITORY_DIRECTORY/sIBL_GUI/sIBL_GUI.dmg
 
 #! sIBL_GUI Changes gathering.
-cp -rf $RELEASES/Changes.html $REPOSITORY/sIBL_GUI/
+cp -rf $RELEASES_DIRECTORY/Changes.html $REPOSITORY_DIRECTORY/sIBL_GUI/
 
 #! sIBL_GUI Releases file.
-cp -rf $RELEASES/sIBL_GUI_Releases.rc $REPOSITORY/sIBL_GUI/
+cp -rf $RELEASES_DIRECTORY/sIBL_GUI_Releases.rc $REPOSITORY_DIRECTORY/sIBL_GUI/
 
 #! sIBL_GUI Manual / Help files.
-cp -rf $DOCUMENTATION/help $REPOSITORY/sIBL_GUI/Help
-rm $REPOSITORY/sIBL_GUI/help/sIBL_GUI_Manual.rst
+cp -rf $DOCUMENTATION_DIRECTORY/help $REPOSITORY_DIRECTORY/sIBL_GUI/Help
+rm $REPOSITORY_DIRECTORY/sIBL_GUI/help/sIBL_GUI_Manual.rst
 
 #! sIBL_GUI Api files.
-cp -rf $DOCUMENTATION/sphinx/build/html $REPOSITORY/sIBL_GUI/Api
+cp -rf $DOCUMENTATION_DIRECTORY/sphinx/build/html $REPOSITORY_DIRECTORY/sIBL_GUI/Api
 
 #! sIBL_GUI Donations files.
-cp -rf $DOCUMENTATION/donations $REPOSITORY/sIBL_GUI/Donations
-rm $REPOSITORY/sIBL_GUI/Donations/Make_A_Donation.rst
+cp -rf $DOCUMENTATION_DIRECTORY/donations $REPOSITORY_DIRECTORY/sIBL_GUI/Donations
+rm $REPOSITORY_DIRECTORY/sIBL_GUI/Donations/Make_A_Donation.rst
diff --git a/utilities/windowsBuild.sh b/utilities/windowsBuild.sh
index 96b4ccf3..d3321172 100755
--- a/utilities/windowsBuild.sh
+++ b/utilities/windowsBuild.sh
@@ -3,20 +3,20 @@ echo ---------------------------------------------------------------------------
 echo sIBL_GUI - Windows - Overall Build
 echo -------------------------------------------------------------------------------
 
-export PYINSTALLER=c:/pyinstaller
+export PYINSTALLER_DIRECTORY=c:/pyinstaller
 export PYTHONPATH=$PROJECT
 
-export PROJECT=z:/Documents/Development/sIBL_GUI
-export MAJOR_VERSION=4
+export PROJECT_DIRECTORY=z:/Documents/Development/sIBL_GUI
+export PROJECT_MAJOR_VERSION=4
 
-export UTILITIES=$PROJECT/utilities
+export UTILITIES_DIRECTORY=$PROJECT_DIRECTORY/utilities
 
-export SOURCE=$PROJECT
-export RELEASES=$PROJECT/releases/Windows
-export DISTRIBUTION=$RELEASES/dist
-export BUILD=$RELEASES/build
-export BUNDLE=$RELEASES/sIBL_GUI\ $MAJOR_VERSION
-export DEPENDENCIES=$BUNDLE
+export SOURCE_DIRECTORY=$PROJECT_DIRECTORY
+export RELEASES_DIRECTORY=$PROJECT_DIRECTORY/releases/Windows
+export DISTRIBUTION_DIRECTORY=$RELEASES_DIRECTORY/dist
+export BUILD_DIRECTORY=$RELEASES_DIRECTORY/build
+export BUNDLE_DIRECTORY=$RELEASES_DIRECTORY/sIBL_GUI\ $PROJECT_MAJOR_VERSION
+export DEPENDENCIES_DIRECTORY=$BUNDLE_DIRECTORY
 
 IFS=","
 
@@ -24,14 +24,14 @@ IFS=","
 echo -------------------------------------------------------------------------------
 echo Cleanup - Begin
 echo -------------------------------------------------------------------------------
-rm -rf $BUILD $DISTRIBUTION $DEPENDENCIES $BUNDLE
+rm -rf $BUILD_DIRECTORY $DISTRIBUTION_DIRECTORY $DEPENDENCIES_DIRECTORY $BUNDLE_DIRECTORY
 packages="foundations,manager,umbra,sibl_gui"
 types=".pyc,.pyo,.DS_Store,Thumbs.db"
 for package in $packages
 do
 	for type in $types
 	do
-		python $UTILITIES/recursiveRemove.py --input $( $UTILITIES/getPackagePath.py --package $package ) --pattern $type
+		python $UTILITIES_DIRECTORY/recursiveRemove.py --input $( $UTILITIES_DIRECTORY/getPackagePath.py --package $package ) --pattern $type
 	done
 done
 echo -------------------------------------------------------------------------------
@@ -43,8 +43,8 @@ echo ---------------------------------------------------------------------------
 echo Build - Begin
 echo -------------------------------------------------------------------------------
 #! python $PYINSTALLER/Makespec.py --noconsole --icon "$SOURCE/sibl_gui/resources/images/Icon_Light.ico" $SOURCE/sIBL_GUI.py -o $RELEASES
-cp $UTILITIES/windowsSetup.py $RELEASES/sIBL_GUI.spec
-python $PYINSTALLER/Build.py $RELEASES/sIBL_GUI.spec
+cp $UTILITIES_DIRECTORY/windowsSetup.py $RELEASES_DIRECTORY/sIBL_GUI.spec
+python $PYINSTALLER_DIRECTORY/Build.py $RELEASES_DIRECTORY/sIBL_GUI.spec
 echo -------------------------------------------------------------------------------
 echo Build - End
 echo -------------------------------------------------------------------------------
@@ -53,25 +53,25 @@ echo ---------------------------------------------------------------------------
 echo -------------------------------------------------------------------------------
 echo Release - Begin
 echo -------------------------------------------------------------------------------
-cp -r $DISTRIBUTION/sIBL_GUI $BUNDLE
+cp -r $DISTRIBUTION_DIRECTORY/sIBL_GUI $BUNDLE_DIRECTORY
 for package in $packages
 do
-	cp -rL $( cygpath --unix $( $UTILITIES/getPackagePath.py --package $package ) ) $DEPENDENCIES/$package
+	cp -rL $( cygpath --unix $( $UTILITIES_DIRECTORY/getPackagePath.py --package $package ) ) $DEPENDENCIES_DIRECTORY/$package
 done
 packages="umbra,sibl_gui"
 extensions="bmp,icns,ico"
 for package in $packages
 do
-	rm -rf $DEPENDENCIES/$package/resources/images/builders
+	rm -rf $DEPENDENCIES_DIRECTORY/$package/resources/images/builders
 
 	for extension in $extensions
 	do
-		rm -f $DEPENDENCIES/$package/resources/images/*.$extension
+		rm -f $DEPENDENCIES_DIRECTORY/$package/resources/images/*.$extension
 	done
 done
-rm -f $DEPENDENCIES/sibl_gui/libraries/freeImage/resources/*.dylib
-rm -f $DEPENDENCIES/sibl_gui/libraries/freeImage/resources/*.so
-rm -rf $DEPENDENCIES/*/tests
+rm -f $DEPENDENCIES_DIRECTORY/sibl_gui/libraries/freeImage/resources/*.dylib
+rm -f $DEPENDENCIES_DIRECTORY/sibl_gui/libraries/freeImage/resources/*.so
+rm -rf $DEPENDENCIES_DIRECTORY/*/tests
 echo -------------------------------------------------------------------------------
 echo Release - End
 echo -------------------------------------------------------------------------------
@@ -79,7 +79,7 @@ echo ---------------------------------------------------------------------------
 echo -------------------------------------------------------------------------------
 echo Templates Textile Files Cleanup - Begin
 echo -------------------------------------------------------------------------------
-python $UTILITIES/recursiveRemove.py --input $DEPENDENCIES/sibl_gui/resources/templates/ --pattern .rst
+python $UTILITIES_DIRECTORY/recursiveRemove.py --input $DEPENDENCIES_DIRECTORY/sibl_gui/resources/templates/ --pattern .rst
 echo -------------------------------------------------------------------------------
 echo Templates Textile Files Cleanup - End
 echo -------------------------------------------------------------------------------
@@ -87,11 +87,11 @@ echo ---------------------------------------------------------------------------
 echo -------------------------------------------------------------------------------
 echo Console Build - Begin
 echo -------------------------------------------------------------------------------
-rm -rf $BUILD $DISTRIBUTION
+rm -rf $BUILD_DIRECTORY $DISTRIBUTION_DIRECTORY
 export CONSOLE_BUILD=True
-python $PYINSTALLER/Build.py $RELEASES/sIBL_GUI.spec
-cp -r $DISTRIBUTION/sIBL_GUI/sIBL_GUI.exe $BUNDLE/sIBL_GUI\ $MAJOR_VERSION\ -\ Console.exe
-cp -r $DISTRIBUTION/sIBL_GUI/sIBL_GUI.exe.manifest $BUNDLE/sIBL_GUI\ $MAJOR_VERSION\ -\ Console.exe.manifest
+python $PYINSTALLER_DIRECTORY/Build.py $RELEASES_DIRECTORY/sIBL_GUI.spec
+cp -r $DISTRIBUTION_DIRECTORY/sIBL_GUI/sIBL_GUI.exe $BUNDLE_DIRECTORY/sIBL_GUI\ $PROJECT_MAJOR_VERSION\ -\ Console.exe
+cp -r $DISTRIBUTION_DIRECTORY/sIBL_GUI/sIBL_GUI.exe.manifest $BUNDLE_DIRECTORY/sIBL_GUI\ $PROJECT_MAJOR_VERSION\ -\ Console.exe.manifest
 echo -------------------------------------------------------------------------------
 echo Console Build - End
 echo -------------------------------------------------------------------------------

From 4c9c064077ea2caac9bc8edbe34aecce89314938 Mon Sep 17 00:00:00 2001
From: Thomas Mansencal 
Date: Thu, 3 Apr 2014 22:40:23 +0200
Subject: [PATCH 54/54] Update "sibl_gui.tests.testsInternational" module.

---
 sibl_gui/tests/testsInternational.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/sibl_gui/tests/testsInternational.py b/sibl_gui/tests/testsInternational.py
index 03753fba..17ad5623 100644
--- a/sibl_gui/tests/testsInternational.py
+++ b/sibl_gui/tests/testsInternational.py
@@ -63,7 +63,7 @@ def testsInternational():
 	"""
 
 	userApplicationDirectory = tempfile.mkdtemp(prefix=USER_APPLICATION_DIRECTORY_PREFIX)
-	command = [os.path.join(sibl_gui.__path__[0], "../bin/sIBL_GUI"),
+	command = [os.path.join(sibl_gui.__path__[0], "..", "bin", "sIBL_GUI"),
  			"-u", userApplicationDirectory,
 			"-x", unicode(INTERNATIONAL_TEST_SCRIPT_FILE)]
 	if subprocess.check_call(command) == 0: