#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
**preferencesManager.py**
**Platform:**
Windows, Linux, Mac Os X.
**Description:**
This module defines the :class:`PreferencesManager` Component Interface class.
**Others:**
"""
#**********************************************************************************************************************
#*** External imports.
#**********************************************************************************************************************
import logging
import os
from PyQt4.QtCore import QStringList
from PyQt4.QtCore import Qt
#**********************************************************************************************************************
#*** Internal imports.
#**********************************************************************************************************************
import foundations.common
import foundations.core as core
import foundations.exceptions
import foundations.strings as strings
from manager.qwidgetComponent import QWidgetComponentFactory
from umbra.globals.constants import Constants
from umbra.globals.runtimeGlobals import RuntimeGlobals
#**********************************************************************************************************************
#*** Module attributes.
#**********************************************************************************************************************
__author__ = "Thomas Mansencal"
__copyright__ = "Copyright (C) 2008 - 2012 - Thomas Mansencal"
__license__ = "GPL V3.0 - http://www.gnu.org/licenses/"
__maintainer__ = "Thomas Mansencal"
__email__ = "thomas.mansencal@gmail.com"
__status__ = "Production"
__all__ = ["LOGGER", "COMPONENT_UI_FILE", "PreferencesManager"]
LOGGER = logging.getLogger(Constants.logger)
COMPONENT_UI_FILE = os.path.join(os.path.dirname(__file__), "ui", "Preferences_Manager.ui")
#**********************************************************************************************************************
#*** Module classes and definitions.
#**********************************************************************************************************************
[docs]class PreferencesManager(QWidgetComponentFactory(uiFile=COMPONENT_UI_FILE)):
"""
| This class is the :mod:`umbra.components.factory.preferencesManager.preferencesManager` Component Interface class.
| It exposes Application preferences inside
a dedicated `QDockWidget <http://doc.qt.nokia.com/qdockwidget.html>`_ window.
"""
#*** Sphinx: Decorator commented for auto-documentation purpose. @core.executionTrace
def __init__(self, parent=None, name=None, *args, **kwargs):
"""
.. Sphinx: Statements updated for auto-documentation purpose.
:param parent: Object parent. ( QObject )
:param name: Component name. ( String )
:param \*args: Arguments. ( \* )
:param \*\*kwargs: Keywords arguments. ( \*\* )
"""
LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__))
super(PreferencesManager, self).__init__(parent, name, *args, **kwargs)
# --- Setting class attributes. ---
self.deactivatable = False
self.__dockArea = 2
self.__engine = None
self.__settings = None
#******************************************************************************************************************
#*** Attributes properties.
#******************************************************************************************************************
@property
def dockArea(self):
"""
This method is the property for **self.__dockArea** attribute.
:return: self.__dockArea. ( Integer )
"""
return self.__dockArea
@dockArea.setter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.exceptionsHandler(None, False, foundations.exceptions.ProgrammingError)
def dockArea(self, value):
"""
This method is the setter method for **self.__dockArea** attribute.
:param value: Attribute value. ( Integer )
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "dockArea"))
@dockArea.deleter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.exceptionsHandler(None, False, foundations.exceptions.ProgrammingError)
[docs] def dockArea(self):
"""
This method is the deleter method for **self.__dockArea** attribute.
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "dockArea"))
@property
def engine(self):
"""
This method is the property for **self.__engine** attribute.
:return: self.__engine. ( QObject )
"""
return self.__engine
@engine.setter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.exceptionsHandler(None, False, foundations.exceptions.ProgrammingError)
def engine(self, value):
"""
This method is the setter method for **self.__engine** attribute.
:param value: Attribute value. ( QObject )
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "engine"))
@engine.deleter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.exceptionsHandler(None, False, foundations.exceptions.ProgrammingError)
[docs] def engine(self):
"""
This method is the deleter method for **self.__engine** attribute.
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "engine"))
@property
def settings(self):
"""
This method is the property for **self.__settings** attribute.
:return: self.__settings. ( QSettings )
"""
return self.__settings
@settings.setter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.exceptionsHandler(None, False, foundations.exceptions.ProgrammingError)
def settings(self, value):
"""
This method is the setter method for **self.__settings** attribute.
:param value: Attribute value. ( QSettings )
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "settings"))
@settings.deleter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.exceptionsHandler(None, False, foundations.exceptions.ProgrammingError)
[docs] def settings(self):
"""
This method is the deleter method for **self.__settings** attribute.
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "settings"))
#******************************************************************************************************************
#*** Class methods.
#******************************************************************************************************************
#*** Sphinx: Decorator commented for auto-documentation purpose. @core.executionTrace
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.exceptionsHandler(None, False, Exception)
[docs] def activate(self, engine):
"""
This method activates the Component.
:param engine: Engine to attach the Component to. ( QObject )
:return: Method success. ( Boolean )
"""
LOGGER.debug("> Activating '{0}' Component.".format(self.__class__.__name__))
self.__engine = engine
self.__settings = self.__engine.settings
self.activated = True
return True
#*** Sphinx: Decorator commented for auto-documentation purpose. @core.executionTrace
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.exceptionsHandler(None, False, foundations.exceptions.ProgrammingError)
[docs] def deactivate(self):
"""
This method deactivates the Component.
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' Component cannot be deactivated!".format(self.__class__.__name__, self.__name))
#*** Sphinx: Decorator commented for auto-documentation purpose. @core.executionTrace
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.exceptionsHandler(None, False, Exception)
[docs] def initializeUi(self):
"""
This method initializes the Component ui.
:return: Method success. ( Boolean )
"""
LOGGER.debug("> Initializing '{0}' Component ui.".format(self.__class__.__name__))
self.__Logging_Formatters_comboBox_setUi()
self.__Verbose_Level_comboBox_setUi()
self.__Restore_Geometry_On_Layout_Change_checkBox_setUi()
# Signals / Slots.
self.__engine.verbosityLevelChanged.connect(self.__engine__verbosityLevelChanged)
self.Logging_Formatters_comboBox.activated.connect(self.__Logging_Formatters_comboBox__activated)
self.Verbose_Level_comboBox.activated.connect(self.__Verbose_Level_comboBox__activated)
self.Restore_Geometry_On_Layout_Change_checkBox.stateChanged.connect(
self.__Restore_Geometry_On_Layout_Change_checkBox__stateChanged)
self.initializedUi = True
return True
#*** Sphinx: Decorator commented for auto-documentation purpose. @core.executionTrace
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.exceptionsHandler(None, False, foundations.exceptions.ProgrammingError)
[docs] def uninitializeUi(self):
"""
This method uninitializes the Component ui.
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' Component ui cannot be uninitialized!".format(self.__class__.__name__, self.name))
#*** Sphinx: Decorator commented for auto-documentation purpose. @core.executionTrace
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.exceptionsHandler(None, False, Exception)
def __engine__verbosityLevelChanged(self, verbosityLevel):
"""
This method is triggered when the engine verbosity level has changed.
:param verbosityLevel: Current verbosity level. ( Integer )
"""
self.Verbose_Level_comboBox.setCurrentIndex(verbosityLevel)
#*** Sphinx: Decorator commented for auto-documentation purpose. @core.executionTrace
def __Logging_Formatters_comboBox_setUi(self):
"""
This method fills **Logging_Formatter_comboBox** Widget.
"""
self.Logging_Formatters_comboBox.clear()
LOGGER.debug("> Available logging formatters: '{0}'.".format(", ".join(RuntimeGlobals.loggingFormatters)))
self.Logging_Formatters_comboBox.insertItems(0, QStringList(RuntimeGlobals.loggingFormatters.keys()))
loggingFormatter = self.__settings.getKey("Settings", "loggingFormatter").toString()
self.__engine.loggingActiveFormatter = loggingFormatter and loggingFormatter or Constants.loggingDefaultFormatter
self.Logging_Formatters_comboBox.setCurrentIndex(self.Logging_Formatters_comboBox.findText(
self.__engine.loggingActiveFormatter, Qt.MatchExactly))
#*** Sphinx: Decorator commented for auto-documentation purpose. @core.executionTrace
def __Logging_Formatters_comboBox__activated(self, index):
"""
This method is triggered when the **Logging_Formatter_comboBox** Widget is activated.
:param index: ComboBox activated item index. ( Integer )
"""
formatter = strings.encode(self.Logging_Formatters_comboBox.currentText())
LOGGER.debug("> Setting logging formatter: '{0}'.".format(formatter))
RuntimeGlobals.loggingActiveFormatter = formatter
self.setLoggingFormatter()
self.__settings.setKey("Settings", "loggingFormatter", self.Logging_Formatters_comboBox.currentText())
#*** Sphinx: Decorator commented for auto-documentation purpose. @core.executionTrace
def __Verbose_Level_comboBox_setUi(self):
"""
This method fills **Verbose_Level_ComboBox** Widget.
"""
self.Verbose_Level_comboBox.clear()
LOGGER.debug("> Available verbose levels: '{0}'.".format(Constants.verbosityLabels))
self.Verbose_Level_comboBox.insertItems(0, QStringList (Constants.verbosityLabels))
self.__engine.verbosityLevel = foundations.common.getFirstItem(
self.__settings.getKey("Settings", "verbosityLevel").toInt())
self.Verbose_Level_comboBox.setCurrentIndex(self.__engine.verbosityLevel)
#*** Sphinx: Decorator commented for auto-documentation purpose. @core.executionTrace
def __Verbose_Level_comboBox__activated(self, index):
"""
This method is triggered when the **Verbose_Level_ComboBox** Widget is triggered.
:param index: ComboBox activated item index. ( Integer )
"""
LOGGER.debug("> Setting verbose level: '{0}'.".format(self.Verbose_Level_comboBox.currentText()))
self.__engine.verbosityLevel = index
core.setVerbosityLevel(index)
self.__settings.setKey("Settings", "verbosityLevel", index)
#*** Sphinx: Decorator commented for auto-documentation purpose. @core.executionTrace
def __Restore_Geometry_On_Layout_Change_checkBox_setUi(self):
"""
This method sets the **Restore_Geometry_On_Layout_Change_checkBox** Widget.
"""
# Adding settings key if it doesn't exists.
self.__settings.getKey("Settings", "restoreGeometryOnLayoutChange").isNull() and \
self.__settings.setKey("Settings", "restoreGeometryOnLayoutChange", Qt.Unchecked)
restoreGeometryOnLayoutChange = foundations.common.getFirstItem(
self.__settings.getKey("Settings", "restoreGeometryOnLayoutChange").toInt())
LOGGER.debug("> Setting '{0}' with value '{1}'.".format("Restore_Geometry_On_Layout_Change_checkBox",
restoreGeometryOnLayoutChange))
self.Restore_Geometry_On_Layout_Change_checkBox.setCheckState(restoreGeometryOnLayoutChange)
self.__engine.layoutsManager.restoreGeometryOnLayoutChange = restoreGeometryOnLayoutChange and True or False
#*** Sphinx: Decorator commented for auto-documentation purpose. @core.executionTrace
def __Restore_Geometry_On_Layout_Change_checkBox__stateChanged(self, state):
"""
This method is triggered when **Restore_Geometry_On_Layout_Change_checkBox** Widget state changes.
:param state: Checkbox state. ( Integer )
"""
LOGGER.debug("> 'Restore Geometry On Layout Change' state: '{0}'.".format(state))
self.__settings.setKey("Settings", "restoreGeometryOnLayoutChange", state)
self.__engine.layoutsManager.restoreGeometryOnLayoutChange = state and True or False
#*** Sphinx: Decorator commented for auto-documentation purpose. @core.executionTrace
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.exceptionsHandler(None, False, Exception)