Source code for sibl_gui.components.core.collectionsOutliner.nodes

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

"""
**nodes.py**

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

**Description:**
	Defines the :class:`sibl_gui.components.core.collectionsOutliner.collectionsOutliner.CollectionsOutliner`
	Component Interface class nodes.

**Others:**

"""

#**********************************************************************************************************************
#***	Future imports.
#**********************************************************************************************************************
from __future__ import unicode_literals

#**********************************************************************************************************************
#***	External imports.
#**********************************************************************************************************************
from PyQt4.QtCore import Qt

#**********************************************************************************************************************
#***	Internal imports.
#**********************************************************************************************************************
import foundations.verbose
import sibl_gui.ui.nodes

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

LOGGER = foundations.verbose.installLogger()

#**********************************************************************************************************************
#***	Module classes and definitions.
#**********************************************************************************************************************
[docs]class OverallCollectionNode(sibl_gui.ui.nodes.GraphModelNode): """ Defines :class:`sibl_gui.components.core.collectionsOutliner.collectionsOutliner.CollectionsOutliner` Component Interface class Model **Overall** collection node. """ __family = "OverallCollection" def __init__(self, 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): """ Initializes the class. :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__)) sibl_gui.ui.nodes.GraphModelNode.__init__(self, name, parent, children, roles, nodeFlags, iconSize, iconPlaceholder, **kwargs) OverallCollectionNode.__initializeNode(self, attributesFlags) #****************************************************************************************************************** #*** Class methods. #****************************************************************************************************************** def __initializeNode(self, attributesFlags=int(Qt.ItemIsSelectable | Qt.ItemIsEnabled)): """ Initializes the node. :param attributesFlags: Attributes flags. :type attributesFlags: int """ self["count"] = sibl_gui.ui.nodes.GraphModelAttribute(name="count", value=sum(node["count"].value for node in self.children), flags=int(Qt.ItemIsSelectable | Qt.ItemIsEnabled)) self["comment"] = sibl_gui.ui.nodes.GraphModelAttribute(name="comment", flags=int(Qt.ItemIsSelectable | Qt.ItemIsEnabled))
[docs] def updateNode(self): """ Updates the node. :return: Method success. :rtype: bool """ return self.updateNodeAttributes()
[docs] def updateNodeAttributes(self): """ Updates the Node attributes. :return: Method success. :rtype: bool """ self.count.value = self.count.roles[Qt.DisplayRole] = sum(node.count.value for node in self.children)