Source code for umbra.ui.widgets.variable_QPushButton

#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""
**variable_QPushButton.py**

**Platform:**
	Windows, Linux, Mac Os X.

**Description:**
	This module defines the :class:`Variable_QPushButton` class.

**Others:**

"""

#**********************************************************************************************************************
#***	External imports.
#**********************************************************************************************************************
from PyQt4.QtGui import QColor
from PyQt4.QtGui import QPalette
from PyQt4.QtGui import QPushButton

#**********************************************************************************************************************
#***	Internal imports.
#**********************************************************************************************************************
import foundations.common
import foundations.exceptions
import foundations.verbose

#**********************************************************************************************************************
#***	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", "Variable_QPushButton"]

LOGGER = foundations.verbose.installLogger()

#**********************************************************************************************************************
#***	Module classes and definitions.
#**********************************************************************************************************************
[docs]class Variable_QPushButton(QPushButton): """ This class is a `QPushButton <http://doc.qt.nokia.com/qpushbutton.html>`_ subclass providing a button with different colors and labels depending on its clicked state. """ def __init__(self, parent=None, state=True, colors=(QColor(240, 240, 240), QColor(160, 160, 160)), labels=("Yes", "No")): """ .. Sphinx: Statements updated for auto-documentation purpose. :param parent: Widget parent. ( QObject ) :param state: Current button state. ( Boolean ) :param colors: Button colors. ( Tuple ) :param labels: Button texts. ( Tuple ) """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) QPushButton.__init__(self, parent) # --- Setting class attributes. --- self.__state = None self.state = state self.__colors = None self.colors = colors self.__labels = None self.labels = labels # Initializing the button self.setCheckable(True) if self.__state: self.__setTrueState() else: self.__setFalseState() # Signals / Slots. self.clicked.connect(self.__variable_QPushButton__clicked) #****************************************************************************************************************** #*** Attributes properties. #****************************************************************************************************************** @property def state(self): """ This method is the property for **self.__state** attribute. :return: self.__state. ( Boolean ) """ return self.__state @state.setter #*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(AssertionError) def state(self, value): """ This method is the setter method for **self.__state** attribute. :param value: Attribute value. ( Boolean ) """ if value is not None: assert type(value) is bool, "'{0}' attribute: '{1}' type is not 'bool'!".format("state", value) self.__state = value @state.deleter #*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def state(self): """ This method is the deleter method for **self.__state** attribute. """ raise foundations.exceptions.ProgrammingError( "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "state"))
@property def colors(self): """ This method is the property for **self.__colors** attribute. :return: self.__colors. ( Tuple ) """ return self.__colors @colors.setter #*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(AssertionError) def colors(self, value): """ This method is the setter method for **self.__colors** attribute. :param value: Attribute value. ( Tuple ) """ if value is not None: assert type(value) is tuple, "'{0}' attribute: '{1}' type is not 'tuple'!".format("colors", value) assert len(value) == 2, "'{0}' attribute: '{1}' length should be '2'!".format("colors", value) for index in range(len(value)): assert type(value[index]) is QColor, "'{0}' attribute element '{1}': '{2}' type is not 'QColor'!".format( "colors", index, value) self.__colors = value @colors.deleter #*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def colors(self): """ This method is the deleter method for **self.__colors** attribute. """ raise foundations.exceptions.ProgrammingError( "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "colors"))
@property def labels(self): """ This method is the property for **self.__labels** attribute. :return: self.__labels. ( Tuple ) """ return self.__labels @labels.setter #*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(AssertionError) def labels(self, value): """ This method is the setter method for **self.__labels** attribute. :param value: Attribute value. ( Tuple ) """ if value is not None: assert type(value) is tuple, "'{0}' attribute: '{1}' type is not 'tuple'!".format("labels", value) assert len(value) == 2, "'{0}' attribute: '{1}' length should be '2'!".format("labels", value) for index in range(len(value)): assert type(value[index]) in (str, unicode), \ "'{0}' attribute element '{1}': '{2}' type is not 'str' or 'unicode'!".format("labels", index, value) self.__labels = value @labels.deleter #*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def labels(self): """ This method is the deleter method for **self.__labels** attribute. """ raise foundations.exceptions.ProgrammingError( "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "labels")) #****************************************************************************************************************** #*** Class methods. #******************************************************************************************************************
def __variable_QPushButton__clicked(self, checked): """ This method is triggered when a **Variable_QPushButton** Widget is clicked. :param checked: Checked state. ( Boolean ) """ if self.__state: self.__setFalseState() else: self.__setTrueState() def __setTrueState(self): """ This method sets the variable button true state. """ LOGGER.debug("> Setting variable QPushButton() to 'True' state.") self.__state = True palette = QPalette() palette.setColor(QPalette.Button, foundations.common.getFirstItem(self.__colors)) self.setPalette(palette) self.setChecked(True) self.setText(foundations.common.getFirstItem(self.__labels)) def __setFalseState(self): """ This method sets the variable QPushButton true state. """ LOGGER.debug("> Setting variable QPushButton() to 'False' state.") self.__state = False palette = QPalette() palette.setColor(QPalette.Button, self.__colors[1]) self.setPalette(palette) self.setChecked(False) self.setText(self.__labels[1]) #********************************************************************************************************************** #*** Sphinx: Statements updated for auto-documentation purpose. #**********************************************************************************************************************