Source code for sibl_gui.components.core.inspector.nodes
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
**nodes.py**
**Platform:**
Windows, Linux, Mac Os X.
**Description:**
This module defines the :class:`sibl_gui.components.core.inspector.inspector.Inspector`
Component Interface class nodes.
**Others:**
"""
#**********************************************************************************************************************
#*** Future imports.
#**********************************************************************************************************************
from __future__ import unicode_literals
#**********************************************************************************************************************
#*** External imports.
#**********************************************************************************************************************
from PyQt4.QtCore import Qt
#**********************************************************************************************************************
#*** Internal imports.
#**********************************************************************************************************************
import foundations.exceptions
import foundations.verbose
import sibl_gui.ui.nodes
#**********************************************************************************************************************
#*** 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__ = ["LOGGER", "PlatesNode"]
LOGGER = foundations.verbose.installLogger()
#**********************************************************************************************************************
#*** Module classes and definitions.
#**********************************************************************************************************************
[docs]class PlatesNode(sibl_gui.ui.nodes.GraphModelNode):
"""
This class factory defines :class:`sibl_gui.components.core.inspector.inspector.Inspector`
Component Interface class Model Plates node.
"""
__family = "Plate"
"""Node family. ( String )"""
def __init__(self,
plate,
name=None,
parent=None,
children=None,
roles=None,
nodeFlags=int(Qt.ItemIsSelectable | Qt.ItemIsEnabled),
attributesFlags=int(Qt.ItemIsSelectable | Qt.ItemIsEnabled),
iconSize=None,
iconPlaceholder=None,
**kwargs):
"""
.. Sphinx: Statements updated for auto-documentation purpose.
: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. ( \*\* )
"""
LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__))
sibl_gui.ui.nodes.GraphModelNode.__init__(self,
name,
parent,
children,
roles,
nodeFlags,
iconSize,
iconPlaceholder,
**kwargs)
# --- Setting class attributes. ---
self.__plate = plate
self.__toolTipText = """
<p><b>{0}</b></p>
"""
PlatesNode.__initializeNode(self, attributesFlags)
#******************************************************************************************************************
#*** Attributes properties.
#******************************************************************************************************************
@property
def plate(self):
"""
This method is the property for **self.__plate** attribute.
:return: self.__plate. ( Plate )
"""
return self.__plate
@plate.setter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
def plate(self, value):
"""
This method is the setter method for **self.__plate** attribute.
:param value: Attribute value. ( Plate )
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "plate"))
@plate.deleter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def plate(self):
"""
This method is the deleter method for **self.__plate** attribute.
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "plate"))
@property
def toolTipText(self):
"""
This method is the property for **self.__toolTipText** attribute.
:return: self.__toolTipText. ( String )
"""
return self.__toolTipText
@toolTipText.setter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
def toolTipText(self, value):
"""
This method is the setter method for **self.__toolTipText** attribute.
:param value: Attribute value. ( String )
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "toolTipText"))
@toolTipText.deleter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def toolTipText(self):
"""
This method is the deleter method for **self.__toolTipText** attribute.
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "plate"))
#******************************************************************************************************************
#*** Class methods.
#******************************************************************************************************************
def __initializeNode(self, attributesFlags=int(Qt.ItemIsSelectable | Qt.ItemIsEnabled)):
"""
This method initializes the node.
:param attributesFlags: Attributes flags. ( Integer )
"""
self.roles.update({Qt.ToolTipRole : self.__toolTipText.format(self.name)})