Source code for umbra.components.factory.scriptEditor.views

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

"""
**views.py**

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

**Description:**
	Defines the :class:`umbra.components.factory.scriptEditor.scriptEditor.ScriptEditor`
	Component Interface class Views.

**Others:**

"""

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

#**********************************************************************************************************************
#***	External imports.
#**********************************************************************************************************************
from PyQt4.QtCore import QEvent
from PyQt4.QtCore import pyqtSignal
from PyQt4.QtGui import QAbstractItemView
from PyQt4.QtGui import QTabWidget

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

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

LOGGER = foundations.verbose.installLogger()

#**********************************************************************************************************************
#***	Module classes and definitions.
#**********************************************************************************************************************
[docs]class SearchResults_QTreeView(umbra.ui.views.Abstract_QTreeView): """ Defines the view for Database Ibl Sets columns. """ def __init__(self, parent, model=None, readOnly=False, message=None): """ Initializes the class. :param parent: Object parent. :type parent: 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__)) umbra.ui.views.Abstract_QTreeView.__init__(self, parent, readOnly, message) # --- Setting class attributes. --- self.setModel(model) self.__treeViewIndentation = 15 SearchResults_QTreeView.__initializeUi(self) #****************************************************************************************************************** #*** Attributes properties. #****************************************************************************************************************** @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. #******************************************************************************************************************
def __initializeUi(self): """ Initializes the Widget ui. """ self.setAutoScroll(True) self.setSelectionMode(QAbstractItemView.ExtendedSelection) self.setIndentation(self.__treeViewIndentation) self.setDragDropMode(QAbstractItemView.DragOnly) self.setHeaderHidden(True) self.__setDefaultUiState() # Signals / Slots. self.model().modelReset.connect(self.__setDefaultUiState) def __setDefaultUiState(self, *args): """ Sets the Widget default ui state. :param \*args: Arguments. :type \*args: \* """ 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]class ScriptEditor_QTabWidget(QTabWidget): """ | Defines a `QTabWidget <http://doc.qt.nokia.com/qtabwidget.html>`_ subclass used to display :class:`umbra.components.factory.scriptEditor.scriptEditor.ScriptEditor` editors. | It provides support for drag'n'drop by reimplementing relevant methods. """ # Custom signals definitions. contentDropped = pyqtSignal(QEvent) """ This signal is emited by the :class:`ScriptEditor_QTabWidget` class when it receives dropped content. ( pyqtSignal ) :return: Event. :rtype: QEvent """ def __init__(self, parent): """ Initializes the class. :param parent: Parent object. :type parent: QObject """ LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__)) QTabWidget.__init__(self, parent) self.setAcceptDrops(True) # --- Setting class attributes. --- self.__container = parent #****************************************************************************************************************** #*** 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")) #****************************************************************************************************************** #*** Class methods. #******************************************************************************************************************
[docs] def dragEnterEvent(self, event): """ Reimplements the :meth:`QTabWidget.dragEnterEvent` method. :param event: QEvent. :type event: QEvent """ LOGGER.debug("> '{0}' widget drag enter event accepted!".format(self.__class__.__name__)) event.accept()
[docs] def dragMoveEvent(self, event): """ Reimplements the :meth:`QTabWidget.dragMoveEvent` method. :param event: QEvent. :type event: QEvent """ LOGGER.debug("> '{0}' widget drag move event accepted!".format(self.__class__.__name__)) event.accept()
[docs] def dropEvent(self, event): """ Reimplements the :meth:`QTabWidget.dropEvent` method. :param event: QEvent. :type event: QEvent """ LOGGER.debug("> '{0}' widget drop event accepted!".format(self.__class__.__name__)) self.contentDropped.emit(event)