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

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

"""
**views.py**

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

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

**Others:**

"""

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

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

#**********************************************************************************************************************
#***	Internal imports.
#**********************************************************************************************************************
import foundations.exceptions
import foundations.verbose
import sibl_gui.components.core.database.operations
import sibl_gui.ui.views
import umbra.exceptions

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

LOGGER = foundations.verbose.installLogger()

#**********************************************************************************************************************
#***	Module classes and definitions.
#**********************************************************************************************************************
[docs]class IblSetsCollections_QTreeView(sibl_gui.ui.views.Abstract_QTreeView): """ Defines the view for Database Collections. """ def __init__(self, parent, model=None, readOnly=False, message=None): """ Initializes the class. :param parent: Object parent. :type parent: QObject :param model: Model. :type model: QObject :param readOnly: View is read only. :type readOnly: bool :param message: View default message when Model is empty. :type message: unicode """ 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.__container = parent self.__treeViewIndentation = 15 IblSetsCollections_QTreeView.__initializeUi(self) #****************************************************************************************************************** #*** Attributes properties. #****************************************************************************************************************** @property def container(self): """ Property for **self.__container** attribute. :return: self.__container. :rtype: QObject """ return self.__container @container.setter # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def container(self, value): """ Setter for **self.__container** attribute. :param value: Attribute value. :type value: QObject """ raise foundations.exceptions.ProgrammingError( "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "container")) @container.deleter # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def container(self): """ Deleter for **self.__container** attribute. """ raise foundations.exceptions.ProgrammingError( "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "container"))
@property def treeViewIndentation(self): """ Property for **self.__treeViewIndentation** attribute. :return: self.__treeViewIndentation. :rtype: int """ return self.__treeViewIndentation @treeViewIndentation.setter # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError) def treeViewIndentation(self, value): """ Setter for **self.__treeViewIndentation** attribute. :param value: Attribute value. :type value: int """ raise foundations.exceptions.ProgrammingError( "{0} | '{1}' attribute is read only!".format(self.__class__.__name__, "treeViewIndentation")) @treeViewIndentation.deleter # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def treeViewIndentation(self): """ Deleter for **self.__treeViewIndentation** attribute. """ raise foundations.exceptions.ProgrammingError( "{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "treeViewIndentation")) #****************************************************************************************************************** #*** Class methods. #******************************************************************************************************************
[docs] def dragEnterEvent(self, event): """ Reimplements the :meth:`sibl_gui.ui.views.Abstract_QTreeView.dragEnterEvent` method. :param event: QEvent. :type event: QEvent """ if event.mimeData().hasFormat("application/x-umbragraphmodeldatalist"): LOGGER.debug("> '{0}' drag event type accepted!".format("application/x-umbragraphmodeldatalist")) event.accept() else: event.ignore()
[docs] def dragMoveEvent(self, event): """ Reimplements the :meth:`sibl_gui.ui.views.Abstract_QTreeView.dragMoveEvent` method. :param event: QEvent. :type event: QEvent """ pass # Oncilla: Statement commented by auto-documentation process: # Oncilla: Statement commented by auto-documentation process: @foundations.exceptions.handleExceptions(umbra.exceptions.notifyExceptionHandler, # Oncilla: Statement commented by auto-documentation process: foundations.exceptions.DirectoryExistsError, # Oncilla: Statement commented by auto-documentation process: foundations.exceptions.UserError)
[docs] def dropEvent(self, event): """ Reimplements the :meth:`sibl_gui.ui.views.Abstract_QTreeView.dropEvent` method. :param event: QEvent. :type event: QEvent """ if not self.readOnly: indexAt = self.indexAt(event.pos()) collectionNode = self.model().getNode(indexAt) if not collectionNode: return if collectionNode.name in (self.__container.overallCollection, "InvisibleRootNode"): return LOGGER.debug("> Item at drop position: '{0}'.".format(collectionNode)) databaseSession = sibl_gui.components.core.database.operations.getSession() nodes = pickle.loads(event.mimeData().data("application/x-umbragraphmodeldatalist")) for node in nodes: if node.family != "IblSet": continue node._AbstractDatabaseNode__databaseItem = databaseSession.merge(node.databaseItem) if collectionNode.databaseItem.id != node.databaseItem.collection: LOGGER.info("> Moving '{0}' Ibl Set to '{1}' Collection.".format(node.databaseItem.title, collectionNode.databaseItem.name)) node.databaseItem.collection = collectionNode.databaseItem.id if sibl_gui.components.core.database.operations.commit(): self.__container.refreshNodes.emit() else: raise foundations.exceptions.UserError("{0} | Cannot perform action, View has been set read only!".format( self.__class__.__name__))
def __initializeUi(self): """ Initializes the Widget ui. """ self.setAutoScroll(True) self.setSelectionMode(QAbstractItemView.ExtendedSelection) self.setIndentation(self.__treeViewIndentation) self.setDragDropMode(QAbstractItemView.DropOnly) self.setSortingEnabled(True) self.sortByColumn(0, Qt.AscendingOrder) self.__setDefaultUiState() # Signals / Slots. self.model().modelReset.connect(self.__setDefaultUiState) def __setDefaultUiState(self): """ 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)
[docs] def storeModelSelection(self): """ Stores the Model selection. :return: Method success. :rtype: bool """ LOGGER.debug("> Storing Model selection!") self.modelSelection = {"Overall" : [], "Collections" : []} for node in self.getSelectedNodes(): if node.name == self.__container.overallCollection: self.modelSelection["Overall"].append(node.name) elif node.family == "Collection": self.modelSelection["Collections"].append(node.id.value) return True
[docs] def restoreModelSelection(self): """ Restores the Model selection. :return: Method success. :rtype: bool """ LOGGER.debug("> Restoring Model selection!") if not self.modelSelection: return False selection = self.modelSelection.get("Overall", None) or self.modelSelection.get("Collections", None) if not selection: return False indexes = [] for node in foundations.walkers.nodesWalker(self.model().rootNode): if node.family == "Collection": self.modelSelection.get("Collections", None) and \ node.id.value in self.modelSelection["Collections"] and indexes.append(self.model().getNodeIndex(node)) else: self.modelSelection.get("Overall", None) and \ node.name in self.modelSelection["Overall"] and indexes.append(self.model().getNodeIndex(node)) return self.selectIndexes(indexes)