118 lines
3.7 KiB
Python
118 lines
3.7 KiB
Python
"""
|
|
This module contains the panel API.
|
|
"""
|
|
import logging
|
|
from pyqode.core.api.mode import Mode
|
|
from pyqode.qt import QtWidgets, QtGui
|
|
|
|
|
|
def _logger():
|
|
""" Returns module's logger """
|
|
return logging.getLogger(__name__)
|
|
|
|
|
|
class Panel(QtWidgets.QWidget, Mode):
|
|
"""
|
|
Base class for editor panels.
|
|
|
|
A panel is a mode and a QWidget.
|
|
|
|
.. note:: Use enabled to disable panel actions and setVisible to change the
|
|
visibility of the panel.
|
|
"""
|
|
class Position(object):
|
|
"""
|
|
Enumerates the possible panel positions
|
|
"""
|
|
#: Top margin
|
|
TOP = 0
|
|
#: Left margin
|
|
LEFT = 1
|
|
#: Right margin
|
|
RIGHT = 2
|
|
#: Bottom margin
|
|
BOTTOM = 3
|
|
|
|
@classmethod
|
|
def iterable(cls):
|
|
""" Returns possible positions as an iterable (list) """
|
|
return [cls.TOP, cls.LEFT, cls.RIGHT, cls.BOTTOM]
|
|
|
|
@property
|
|
def scrollable(self):
|
|
"""
|
|
A scrollable panel will follow the editor's scroll-bars. Left and right
|
|
panels follow the vertical scrollbar. Top and bottom panels follow the
|
|
horizontal scrollbar.
|
|
|
|
:type: bool
|
|
"""
|
|
return self._scrollable
|
|
|
|
@scrollable.setter
|
|
def scrollable(self, value):
|
|
self._scrollable = value
|
|
|
|
def __init__(self, dynamic=False):
|
|
Mode.__init__(self)
|
|
QtWidgets.QWidget.__init__(self)
|
|
#: Specifies whether the panel is dynamic. A dynamic panel is a panel
|
|
#: that will be shown/hidden depending on the context.
|
|
#: Dynamic panel should not appear in any GUI menu (e.g. no display
|
|
#: in the panels menu of the notepad example).
|
|
self.dynamic = dynamic
|
|
#: Panel order into the zone it is installed to. This value is
|
|
#: automatically set when installing the panel but it can be changed
|
|
#: later (negative values can also be used).
|
|
self.order_in_zone = -1
|
|
self._scrollable = False
|
|
self._background_brush = None
|
|
self._foreground_pen = None
|
|
#: Position in the editor (top, left, right, bottom)
|
|
self.position = -1
|
|
|
|
def on_install(self, editor):
|
|
"""
|
|
Extends :meth:`pyqode.core.api.Mode.on_install` method to set the
|
|
editor instance as the parent widget.
|
|
|
|
.. warning:: Don't forget to call **super** if you override this
|
|
method!
|
|
|
|
:param editor: editor instance
|
|
:type editor: pyqode.core.api.CodeEdit
|
|
"""
|
|
Mode.on_install(self, editor)
|
|
self.setParent(editor)
|
|
self.setPalette(QtWidgets.QApplication.instance().palette())
|
|
self.setFont(QtWidgets.QApplication.instance().font())
|
|
self.editor.panels.refresh()
|
|
self._background_brush = QtGui.QBrush(QtGui.QColor(
|
|
self.palette().window().color()))
|
|
self._foreground_pen = QtGui.QPen(QtGui.QColor(
|
|
self.palette().windowText().color()))
|
|
|
|
def paintEvent(self, event):
|
|
# Fills the panel background using QPalette
|
|
if self.isVisible():
|
|
# fill background
|
|
self._background_brush = QtGui.QBrush(QtGui.QColor(
|
|
self.palette().window().color()))
|
|
self._foreground_pen = QtGui.QPen(QtGui.QColor(
|
|
self.palette().windowText().color()))
|
|
painter = QtGui.QPainter(self)
|
|
painter.fillRect(event.rect(), self._background_brush)
|
|
|
|
def setVisible(self, visible):
|
|
"""
|
|
Shows/Hides the panel
|
|
|
|
Automatically call CodeEdit.refresh_panels.
|
|
|
|
:param visible: Visible state
|
|
"""
|
|
_logger().debug('%s visibility changed', self.name)
|
|
super(Panel, self).setVisible(visible)
|
|
if self.editor:
|
|
self.editor.panels.refresh()
|