Source code for sibl_gui.components.core.templatesOutliner.models

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

"""
**models.py**

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

**Description:**
	This module defines the :class:`sibl_gui.components.core.templatesOutliner.templatesOutliner.TemplatesOutliner`
	Component Interface class Models.

**Others:**

"""

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

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

LOGGER = foundations.verbose.installLogger()

#**********************************************************************************************************************
#***	Module classes and definitions.
#**********************************************************************************************************************
[docs]class TemplatesModel(sibl_gui.ui.models.GraphModel): """ This class defines the Model used the by :class:`sibl_gui.components.core.templatesOutliner.templatesOutliner.TemplatesOutliner` Component Interface class. """ def __init__(self, parent=None, rootNode=None, horizontalHeaders=None, verticalHeaders=None): """ .. Sphinx: Statements updated for auto-documentation purpose. :param parent: Object parent. ( QObject ) :param rootNode: Root node. ( AbstractCompositeNode ) :param horizontalHeaders: Headers. ( OrderedDict ) :param verticalHeaders: Headers. ( OrderedDict ) """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) sibl_gui.ui.models.GraphModel.__init__(self, parent, rootNode, horizontalHeaders, verticalHeaders) #****************************************************************************************************************** #*** Class methods. #******************************************************************************************************************
[docs] def initializeModel(self, rootNode): """ This method initializes the Model using given root node. :param rootNode: Graph root node. ( DefaultNode ) :return: Method success ( Boolean ) """ LOGGER.debug("> Initializing model with '{0}' root node.".format(rootNode)) self.beginResetModel() self.rootNode = rootNode self.enableModelTriggers(True) self.endResetModel() return True