Source code for sibl_gui.components.core.iblSetsOutliner.views

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

"""
**views.py**

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

**Description:**
	This module defines the :class:`sibl_gui.components.core.iblSetsOutliner.iblSetsOutliner.IblSetsOutliner`
	Component Interface class Views.

**Others:**

"""

#**********************************************************************************************************************
#***	External imports.
#**********************************************************************************************************************
from PyQt4.QtCore import QSize
from PyQt4.QtCore import Qt
from PyQt4.QtGui import QAbstractItemView
from PyQt4.QtGui import QListView

#**********************************************************************************************************************
#***	Internal imports.
#**********************************************************************************************************************
import foundations.exceptions
import foundations.verbose
import sibl_gui.ui.views

#**********************************************************************************************************************
#***	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", "Thumbnails_QListView", "Columns_QListView", "Details_QTreeView"]

LOGGER = foundations.verbose.installLogger()

#**********************************************************************************************************************
#***	Module classes and definitions.
#**********************************************************************************************************************
[docs]class Thumbnails_QListView(sibl_gui.ui.views.Abstract_QListView): """ This class is used to display Database Ibl Sets as thumbnails. """ def __init__(self, parent, model=None, readOnly=False, message=None): """ .. Sphinx: Statements updated for auto-documentation purpose. :param parent: Object parent. ( QObject ) :param model: Model. ( QObject ) :param readOnly: View is read only. ( Boolean ) :param message: View default message when Model is empty. ( String ) """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) sibl_gui.ui.views.Abstract_QListView.__init__(self, parent, model, readOnly, message) # --- Setting class attributes. --- self.__listViewSpacing = 24 self.__listViewMargin = 32 self.__listViewIconSize = 128 Thumbnails_QListView.__initializeUi(self) #****************************************************************************************************************** #*** Attributes properties. #****************************************************************************************************************** @property def listViewSpacing(self): """ This method is the property for **self.__listViewSpacing** attribute. :return: self.__listViewSpacing. ( Integer ) """ return self.__listViewSpacing @listViewSpacing.setter #*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(AssertionError) def listViewSpacing(self, value): """ This method is the setter method for **self.__listViewSpacing** attribute. :param value: Attribute value. ( Integer ) """ if value is not None: assert type(value) is int, "'{0}' attribute: '{1}' type is not 'int'!".format("listViewSpacing", value) assert value > 0, "'{0}' attribute: '{1}' need to be exactly positive!".format("listViewSpacing", value) self.__listViewSpacing = value @listViewSpacing.deleter #*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def listViewSpacing(self): """ This method is the deleter method for **self.__listViewSpacing** attribute. """ raise foundations.exceptions.ProgrammingError( "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "listViewSpacing"))
@property def listViewMargin(self): """ This method is the property for **self.__listViewMargin** attribute. :return: self.__listViewMargin. ( Integer ) """ return self.__listViewMargin @listViewMargin.setter #*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(AssertionError) def listViewMargin(self, value): """ This method is the setter method for **self.__listViewMargin** attribute. :param value: Attribute value. ( Integer ) """ if value is not None: assert type(value) is int, "'{0}' attribute: '{1}' type is not 'int'!".format("listViewMargin", value) assert value > 0, "'{0}' attribute: '{1}' need to be exactly positive!".format("listViewMargin", value) self.__listViewMargin = value @listViewMargin.deleter #*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def listViewMargin(self): """ This method is the deleter method for **self.__listViewMargin** attribute. """ raise foundations.exceptions.ProgrammingError( "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "listViewMargin"))
@property def listViewIconSize(self): """ This method is the property for **self.__listViewIconSize** attribute. :return: self.__listViewIconSize. ( Integer ) """ return self.__listViewIconSize @listViewIconSize.setter #*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(AssertionError) def listViewIconSize(self, value): """ This method is the setter method for **self.__listViewIconSize** attribute. :param value: Attribute value. ( Integer ) """ if value is not None: assert type(value) is int, "'{0}' attribute: '{1}' type is not 'int'!".format("listViewIconSize", value) assert value > 0, "'{0}' attribute: '{1}' need to be exactly positive!".format("listViewIconSize", value) self.__listViewIconSize = value @listViewIconSize.deleter #*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def listViewIconSize(self): """ This method is the deleter method for **self.__listViewIconSize** attribute. """ raise foundations.exceptions.ProgrammingError( "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "listViewIconSize")) #****************************************************************************************************************** #*** Class methods. #******************************************************************************************************************
def __initializeUi(self): """ This method initializes the Widget ui. """ self.setAutoScroll(True) self.setResizeMode(QListView.Adjust) self.setSelectionMode(QAbstractItemView.ExtendedSelection) self.setViewMode(QListView.IconMode) # Previous statement sets the dragDropMode to "QAbstractItemView.DragDrop". self.setDragDropMode(QAbstractItemView.DragOnly) self.__setDefaultUiState() # Signals / Slots. self.model().modelReset.connect(self.__setDefaultUiState) def __setDefaultUiState(self): """ This method sets the Widget default ui state. """ LOGGER.debug("> Setting default View state!") self.setIconSize(QSize(self.__listViewIconSize, self.__listViewIconSize)) self.setGridSize(QSize(self.__listViewIconSize + self.__listViewSpacing, self.__listViewIconSize + self.__listViewMargin))
[docs]class Columns_QListView(sibl_gui.ui.views.Abstract_QListView): """ This class is used to display Database Ibl Sets in columns. """ def __init__(self, parent, model=None, readOnly=False, message=None): """ .. Sphinx: Statements updated for auto-documentation purpose. :param parent: Object parent. ( QObject ) :param model: Model. ( QObject ) :param readOnly: View is read only. ( Boolean ) :param message: View default message when Model is empty. ( String ) """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) sibl_gui.ui.views.Abstract_QListView.__init__(self, parent, model, readOnly, message) Columns_QListView.__initializeUi(self) #****************************************************************************************************************** #*** Class methods. #****************************************************************************************************************** def __initializeUi(self): """ This method initializes the Widget ui. """ self.setAutoScroll(True) self.setResizeMode(QListView.Adjust) self.setSelectionMode(QAbstractItemView.ExtendedSelection) self.setDragDropMode(QAbstractItemView.DragOnly) self.__setDefaultUiState() # Signals / Slots. self.model().modelReset.connect(self.__setDefaultUiState) def __setDefaultUiState(self): """ This method sets the Widget default ui state. """ LOGGER.debug("> Setting default View state!")
[docs]class Details_QTreeView(sibl_gui.ui.views.Abstract_QTreeView): """ This class is used to display Database Ibl Sets columns. """ def __init__(self, parent, model=None, readOnly=False, message=None): """ .. Sphinx: Statements updated for auto-documentation purpose. :param parent: Object parent. ( QObject ) :param model: Model. ( QObject ) :param readOnly: View is read only. ( Boolean ) :param message: View default message when Model is empty. ( String ) """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) sibl_gui.ui.views.Abstract_QTreeView.__init__(self, parent, model, readOnly, message) # --- Setting class attributes. --- self.__treeViewIndentation = 15 Details_QTreeView.__initializeUi(self) #****************************************************************************************************************** #*** Attributes properties. #****************************************************************************************************************** @property def treeViewIndentation(self): """ This method is the property for **self.__treeViewIndentation** attribute. :return: self.__treeViewIndentation. ( Integer ) """ return self.__treeViewIndentation @treeViewIndentation.setter #*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def treeViewIndentation(self, value): """ This method is the setter method for **self.__treeViewIndentation** attribute. :param value: Attribute value. ( Integer ) """ raise foundations.exceptions.ProgrammingError( "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "treeViewIndentation")) @treeViewIndentation.deleter #*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def treeViewIndentation(self): """ This method is the deleter method for **self.__treeViewIndentation** attribute. """ raise foundations.exceptions.ProgrammingError( "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "treeViewIndentation")) #****************************************************************************************************************** #*** Class methods. #******************************************************************************************************************
def __initializeUi(self): """ This method initializes the Widget ui. """ self.setAutoScroll(True) self.setSelectionMode(QAbstractItemView.ExtendedSelection) self.setIndentation(self.__treeViewIndentation) self.setRootIsDecorated(False) self.setDragDropMode(QAbstractItemView.DragOnly) self.setSortingEnabled(True) self.sortByColumn(0, Qt.AscendingOrder) self.__setDefaultUiState() # Signals / Slots. self.model().modelReset.connect(self.__setDefaultUiState) def __setDefaultUiState(self): """ This method sets the Widget default ui state. """ LOGGER.debug("> Setting default View state!") if not self.model(): return self.expandAll() for column in range(len(self.model().horizontalHeaders)): self.resizeColumnToContents(column)