Source code for ccpn.ui.gui.widgets.Frame

"""

This module implemented a Frame and a ScrollableFrame

Frame(parent=None, showBorder=False, fShape=None, fShadow=None, **kwds)
  NB: Until now: fShape and fShadow do not seem to alter the appearance on OSX
  
ScrollableFrame(parent=None, showBorder=False, fShape=None, fShadow=None,
                minimumSizes=(50,50), scrollBarPolicies=('asNeeded','asNeeded'), **kwds)

  From: http://pyqt.sourceforge.net/Docs/PyQt5/qframe.html#details

  The QFrame class is the base class of widgets that can have a frame. More...

  Inherits QWidget.

  Inherited by QAbstractScrollArea, QLabel, QLCDNumber, QSplitter, QStackedWidget and QToolBox.

  Types

  enum Shadow { Plain, Raised, Sunken }
  enum Shape { NoFrame, Box, Panel, WinPanel, ..., StyledPanel }
  enum StyleMask { Shadow_Mask, Shape_Mask }
  Methods

  __init__ (self, QWidget parent = None, Qt.WindowFlags flags = 0)
  changeEvent (self, QEvent)
  drawFrame (self, QPainter)
  bool event (self, QEvent e)
  QRect frameRect (self)
  Shadow frameShadow (self)
  Shape frameShape (self)
  int frameStyle (self)
  int frameWidth (self)
  int lineWidth (self)
  int midLineWidth (self)
  paintEvent (self, QPaintEvent)
  setFrameRect (self, QRect)
  setFrameShadow (self, Shadow)
  setFrameShape (self, Shape)
  setFrameStyle (self, int)
  setLineWidth (self, int)
  setMidLineWidth (self, int)
  QSize sizeHint (self)

"""
#=========================================================================================
# Licence, Reference and Credits
#=========================================================================================
__copyright__ = "Copyright (C) CCPN project (http://www.ccpn.ac.uk) 2014 - 2020"
__credits__ = ("Ed Brooksbank, Luca Mureddu, Timothy J Ragan & Geerten W Vuister")
__licence__ = ("CCPN licence. See http://www.ccpn.ac.uk/v3-software/downloads/license")
__reference__ = ("Skinner, S.P., Fogh, R.H., Boucher, W., Ragan, T.J., Mureddu, L.G., & Vuister, G.W.",
                 "CcpNmr AnalysisAssign: a flexible platform for integrated NMR analysis",
                 "J.Biomol.Nmr (2016), 66, 111-124, http://doi.org/10.1007/s10858-016-0060-y")
#=========================================================================================
# Last code modification
#=========================================================================================
__modifiedBy__ = "$modifiedBy: Ed Brooksbank $"
__dateModified__ = "$dateModified: 2020-09-22 09:32:50 +0100 (Tue, September 22, 2020) $"
__version__ = "$Revision: 3.0.1 $"
#=========================================================================================
# Created
#=========================================================================================
__author__ = "$Author: Geerten Vuister $"
__date__ = "$Date: 2017-04-07 10:28:41 +0000 (Fri, April 07, 2017) $"
#=========================================================================================
# Start of code
#=========================================================================================

from PyQt5 import QtGui, QtWidgets, QtCore
from ccpn.ui.gui.widgets.Base import Base
from ccpn.ui.gui.widgets.ScrollArea import ScrollArea
from ccpn.ui.gui.widgets.ScrollBarVisibilityWatcher import ScrollBarVisibilityWatcher
from ccpn.ui.gui.widgets.Widget import Widget
from ccpn.ui.gui.widgets.Font import setWidgetFont, getFont
from ccpn.ui.gui.guiSettings import CCPNGLWIDGET_HEXFOREGROUND, CCPNGLWIDGET_HEXBACKGROUND, CCPNGLWIDGET_HEXHIGHLIGHT, \
    getColours, BORDERNOFOCUS_COLOUR


[docs]class Frame(QtWidgets.QFrame, Base):
    FRAME_DICT = {
        # Shadow
        'plain'      : QtWidgets.QFrame.Plain,
        'raised'     : QtWidgets.QFrame.Raised,
        'sunken'     : QtWidgets.QFrame.Sunken,
        # Shapes
        'noFrame'    : QtWidgets.QFrame.NoFrame,
        'box'        : QtWidgets.QFrame.Box,
        'panel'      : QtWidgets.QFrame.Panel,
        'styledPanel': QtWidgets.QFrame.StyledPanel,
        'hLine'      : QtWidgets.QFrame.HLine,
        'vLine'      : QtWidgets.QFrame.VLine,
        }

    def __init__(self, parent=None, showBorder=False, fShape=None, fShadow=None,
                 setLayout=False, **kwds):
        """
        Initialise a Frame with optional border and layout

        :param fShape:   frame shape options: noFrame, box, styledPanel, hLine, vLine
        :param fShadow:  frame shadow options: plain, raised, sunken

        """

        super().__init__(parent)
        Base._init(self, setLayout=setLayout, **kwds)

        self._thisparent = parent

        #TODO: replace with proper stylesheet routines once implemented
        styleSheet = ''
        if 'bgColor' in kwds:
            #rgb = QtGui.QColor(kwds["bgColor"]).getRgb()[:3]
            styleSheet += "background-color: rgb(%d, %d, %d); " % kwds["bgColor"]
            del (kwds['bgColor'])
        if 'fgColor' in kwds:
            styleSheet += "foreground-color: rgb(%d, %d, %d); " % kwds["fgColor"]
            del (kwds['fgColor'])
        if showBorder:
            styleSheet += "border: 1px solid %s; " % BORDERNOFOCUS_COLOUR
        else:
            styleSheet += "border: 0px; "
        if len(styleSheet) > 0:
            #print('>>', styleSheet)
            self.setStyleSheet('QFrame {' + styleSheet + '}')

        self.setContentsMargins(0, 0, 0, 0)

        # define frame styles
        if fShape or fShadow:
            """
            Define frame properties:
            """
            #TODO:GEERTEN: routine is called but appears not to change much in the appearance on OSX
            shape = self.FRAME_DICT.get(fShape, QtWidgets.QFrame.NoFrame)
            shadow = self.FRAME_DICT.get(fShadow, 0)
            #print('>>', shape, shadow)
            #print('Frame.framestyle>', shape | shadow)
            #self.setFrameStyle(shape | shadow)
            self.setFrameShape(shape)
            self.setFrameShadow(shadow)
            #self.setLineWidth(3)
            self.setMidLineWidth(3)


[docs]class ScrollableFrame(Frame):
    """A scrollable frame
    """

    def __init__(self, parent=None,
                 setLayout=False, showBorder=False, fShape=None, fShadow=None,
                 minimumSizes=(50, 50), scrollBarPolicies=('asNeeded', 'asNeeded'),
                 margins=(0, 0, 0, 0), **kwds):

        # define a scroll area; check kwds if these apply to grid
        kw1 = {}
        for key in 'grid gridSpan stretch hAlign vAlign'.split():
            if key in kwds:
                kw1[key] = kwds[key]
                del (kwds[key])
        kw1['setLayout'] = True  ## always assure a layout for the scrollarea

        # initialise the frame
        super().__init__(parent=parent, setLayout=setLayout,
                         showBorder=showBorder, fShape=fShape, fShadow=fShadow,
                         **kwds
                         )

        # make a new scrollArea
        self._scrollArea = ScrollArea(parent=parent,
                                      scrollBarPolicies=scrollBarPolicies, minimumSizes=minimumSizes,
                                      **kw1
                                      )
        self._scrollArea.setWidget(self)
        self._scrollArea.setWidgetResizable(True)
        self._scrollArea.setStyleSheet('ScrollArea { border: 0px; background: transparent; }')

        # configure the scroll area to allow all available space without margins
        self.setContentsMargins(*margins)
        self.setScrollBarPolicies(scrollBarPolicies)
        self.setAutoFillBackground(False)
        self.setSizePolicy(QtWidgets.QSizePolicy.MinimumExpanding, QtWidgets.QSizePolicy.MinimumExpanding)

        # align items to the top of the frame
        self.getLayout().setAlignment(QtCore.Qt.AlignTop)

[docs]    def setScrollBarPolicies(self, scrollBarPolicies=('asNeeded', 'asNeeded')):
        """Set the scrollbar policy: always, never, asNeeded
        """
        self._scrollArea.setScrollBarPolicies(scrollBarPolicies)

    @property
    def scrollArea(self):
        """Return the scrollbar widget; for external usage
        """
        return self._scrollArea

[docs]    def insertCornerWidget(self):
        """Insert a corner widget into the target widget with the correct borders
        """
        self._cornerDisplay = ScrollBarVisibilityWatcher(self._scrollArea)


[docs]class OpenGLOverlayFrame(Frame):
    AUTOFILLBACKGROUND = False

    def __init__(self, parent=None, showBorder=False, fShape=None, fShadow=None,
                 setLayout=False, backgroundColour=None, **kwds):
        super(OpenGLOverlayFrame, self).__init__(parent=parent, showBorder=showBorder, fShape=fShape, fShadow=fShadow,
                                                 setLayout=setLayout, **kwds)

        self._backgroundColour = backgroundColour
        self.getLayout().setSpacing(0)

[docs]    def paintEvent(self, ev):
        """Paint the region of the frame to the desired background colour, required when overlaying a GL widget
        """
        if self._backgroundColour is not None:
            painter = QtGui.QPainter(self)
            painter.setCompositionMode(painter.CompositionMode_SourceOver)
            painter.fillRect(self.rect(), QtGui.QColor(*self._backgroundColour))
            painter.end()
        super().paintEvent(ev)

    def _setMaskToChildren(self):
        """Set the mouse mask to only the children of the frame - required to make sections transparent
        """
        self.adjustSize()
        self._setMask()

    def _setMask(self):
        region = QtGui.QRegion(self.frameGeometry())
        region -= QtGui.QRegion(self.geometry())
        region += self.childrenRegion()
        self.setMask(region)

[docs]    def resizeEvent(self, ev) -> None:
        """Resize event to handle resizing of frames that overlay the OpenGL frame
        """
        # not happy as I think is creating duplicate events
        super().resizeEvent(ev)
        self._resizeFrames()

    def _resize(self):
        """Resize event to handle resizing of frames that overlay the OpenGL frame
        """
        self.parent()._resize()

    def _resizeFrames(self):
        glFrames = self.findChildren(OpenGLOverlayFrame)
        if glFrames:
            for glF in glFrames:
                glF._resizeFrames()
            self._setMaskToChildren()

    def _resizeMasks(self):
        glFrames = self.findChildren(OpenGLOverlayFrame)
        if glFrames:
            for glF in glFrames:
                glF._resizeMasks()
            self._setMask()

    def _setStyle(self, sl, foregroundColour=CCPNGLWIDGET_HEXFOREGROUND, backgroundColour=CCPNGLWIDGET_HEXBACKGROUND):

        # from ccpn.framework.Application import getApplication
        # textFontLarge = getApplication()._fontSettings.textFontLarge
        textFontLarge = getFont(size='MEDIUM')

        if self._backgroundColour is not None or self.AUTOFILLBACKGROUND:
            sl.setStyleSheet('QLabel {'
                             'padding: 0; '
                             'margin: 0px 0px 0px 0px;'
                             'color: %s;'
                             'background-color: %s;'
                             'border: 0 px;'
                             'font-family: %s;'
                             'font-size: %dpx;'
                             'qproperty-alignment: AlignLeft;'
                             '}' % (getColours()[foregroundColour],
                                    getColours()[backgroundColour],
                                    textFontLarge.fontName,
                                    textFontLarge.pointSize()))
        else:
            sl.setStyleSheet('QLabel {'
                             'padding: 0; '
                             'margin: 0px 0px 0px 0px;'
                             'color: %s;'
                             'border: 0 px;'
                             'font-family: %s;'
                             'font-size: %dpx;'
                             'qproperty-alignment: AlignLeft;'
                             '}' % (getColours()[foregroundColour],
                                    textFontLarge.fontName,
                                    textFontLarge.pointSize()))

        sl.setSizePolicy(QtWidgets.QSizePolicy.Minimum, QtWidgets.QSizePolicy.Minimum)

    def _updateColourThemeStyle(self, sl,
                                foregroundColour=CCPNGLWIDGET_HEXFOREGROUND, backgroundColour=CCPNGLWIDGET_HEXBACKGROUND,
                                highlightColour=CCPNGLWIDGET_HEXHIGHLIGHT):
        """Update the background colour when changing colour themes, keeping the same foreground highlighting
        """
        # from ccpn.framework.Application import getApplication
        # textFontLarge = getApplication()._fontSettings.textFontLarge
        textFontLarge = getFont(size='MEDIUM')

        sl.setStyleSheet('QLabel {'
                         'padding: 0; '
                         'margin: 0px 0px 0px 0px;'
                         'color: %s;'
                         'background-color: %s;'
                         'border: 0 px;'
                         'font-family: %s;'
                         'font-size: %dpx;'
                         'qproperty-alignment: AlignLeft;'
                         '}' % (getColours()[highlightColour if sl.highlighted else foregroundColour],
                                getColours()[backgroundColour],
                                textFontLarge.fontName,
                                textFontLarge.pointSize()))

        sl.update()

[docs]    def resetColourTheme(self):
        """Reset the colour theme
        """
        myItems = self.findChildren(QtWidgets.QLabel)
        for item in myItems:
            # resetBackground
            try:
                self._updateColourThemeStyle(item)
            except Exception as es:

                # just in case I've missed subclassing the above method
                pass


[docs]class ScrollOpenGLOverlayFrame(OpenGLOverlayFrame):
    """
    A scrollable frame
    """

    def __init__(self, parent=None,
                 setLayout=False, showBorder=False, fShape=None, fShadow=None,
                 minimumSizes=(50, 50), scrollBarPolicies=('asNeeded', 'asNeeded'),
                 margins=(0, 0, 0, 0), **kwds):

        # define a scroll area; check kwds if these apply to grid
        kw1 = {}
        for key in 'grid gridSpan stretch hAlign vAlign'.split():
            if key in kwds:
                kw1[key] = kwds[key]
                del (kwds[key])
        kw1['setLayout'] = True  ## always assure a layout for the scrollarea

        # initialise the frame
        super().__init__(parent=parent, setLayout=setLayout,
                         showBorder=showBorder, fShape=fShape, fShadow=fShadow,
                         **kwds
                         )

        # make a new scrollArea
        self._scrollArea = ScrollArea(parent=parent,
                                      scrollBarPolicies=scrollBarPolicies, minimumSizes=minimumSizes,
                                      **kw1
                                      )
        self._scrollArea.setWidget(self)
        self._scrollArea.setWidgetResizable(True)
        self._scrollArea.setStyleSheet('ScrollArea { border: 0px; background: transparent; }')

        # configure the scroll area to allow all available space without margins
        self.setContentsMargins(*margins)
        self.setScrollBarPolicies(scrollBarPolicies)
        self.setAutoFillBackground(False)
        self.setSizePolicy(QtWidgets.QSizePolicy.MinimumExpanding, QtWidgets.QSizePolicy.MinimumExpanding)

        # align items to the top of the frame
        self.getLayout().setAlignment(QtCore.Qt.AlignTop)

[docs]    def setScrollBarPolicies(self, scrollBarPolicies=('asNeeded', 'asNeeded')):
        """Set the scrollbar policy: always, never, asNeeded
        """
        self._scrollArea.setScrollBarPolicies(scrollBarPolicies)

    @property
    def scrollArea(self):
        """Return the scrollbar widget; for external usage
        """
        return self._scrollArea


if __name__ == '__main__':
    from ccpn.ui.gui.widgets.Application import TestApplication
    from ccpn.ui.gui.widgets.BasePopup import BasePopup
    from ccpn.ui.gui.widgets.Label import Label


    class TestPopup(BasePopup):
        def body(self, parent):
            widget = Widget(parent, setLayout=True)
            policyDict = dict(
                    hAlign='c',
                    stretch=(1, 0),
                    #hPolicy = 'center',
                    #vPolicy = 'center'
                    )

            #TODO: find the cause of the empty space between the widgets
            #frame3 = ScrollableFrame(parent=parent, showBorder=True, bgColor=(255, 0, 255), grid=(2,0))
            frame1 = Frame(parent=widget, setLayout=True, grid=(0, 0), showBorder=False, bgColor=(255, 255, 0), **policyDict)
            label1 = Label(parent=frame1, grid=(0, 0), text="FRAME-1", bold=True, textColour='black', textSize='32')

            frame2 = Frame(parent=widget, setLayout=True, grid=(1, 0), showBorder=True, bgColor=(255, 0, 0),
                           fShape='styledPanel', fShadow='raised', **policyDict)
            label2 = Label(parent=frame2, grid=(0, 0), text="FRAME-2", bold=True, textColour='black', textSize='32')

            #     scroll4 = ScrollableFrame2(parent=widget, grid=(2,0), setLayout=True)
            scroll4 = ScrollArea(scrollBarPolicies=('always', 'always'))
            print(scroll4)
            label4 = Label(
                    text="ScrollableFrame", bold=True, textColour='black', textSize='32',
                    **policyDict,
                    )
            scroll4.setWidget(label4)
            widget.getLayout().addWidget(scroll4, 2, 0)


    app = TestApplication()
    popup = TestPopup(title='Test Frame')
    popup.resize(200, 400)
    app.start()