src/eric7/Preferences/ConfigurationPages/ConfigurationPageBase.py

# -*- coding: utf-8 -*-

# Copyright (c) 2006 - 2024 Detlev Offenbach <detlev@die-offenbachs.de>
#

"""
Module implementing the base class for all configuration pages.
"""

from PyQt6.QtCore import pyqtSignal, pyqtSlot
from PyQt6.QtGui import QColor, QIcon, QPixmap
from PyQt6.QtWidgets import QColorDialog, QDialog, QFontDialog, QWidget


class ConfigurationPageBase(QWidget):
    """
    Class implementing the base class for all configuration pages.

    @signal colourChanged(str, QColor) To inform about a new colour selection
    """

    colourChanged = pyqtSignal(str, QColor)

    def __init__(self):
        """
        Constructor
        """
        super().__init__()

        self.__coloursDict = {}

    def polishPage(self):
        """
        Public slot to perform some polishing actions.
        """
        pass

    def saveState(self):
        """
        Public method to save the current state of the widget.
        """
        pass

    def setState(self, state):
        """
        Public method to set the state of the widget.

        @param state state data generated by saveState
        @type list
        """
        pass

    def initColour(self, colourKey, button, prefMethod, byName=False, hasAlpha=False):
        """
        Public method to initialize a colour selection button.

        @param colourKey key of the colour resource
        @type string
        @param button reference to a button to show the colour on
        @type QPushButton
        @param prefMethod preferences method to get the colour
        @type function
        @param byName flag indicating to retrieve/save by colour name
        @type bool
        @param hasAlpha flag indicating to allow alpha channel
        @type bool
        """
        colour = QColor(prefMethod(colourKey))
        size = button.size()
        pm = QPixmap(size.width() // 2, size.height() // 2)
        pm.fill(colour)
        button.setIconSize(pm.size())
        button.setIcon(QIcon(pm))
        button.setProperty("colorKey", colourKey)
        button.setProperty("hasAlpha", hasAlpha)
        button.clicked.connect(lambda: self.__selectColourSlot(button))
        self.__coloursDict[colourKey] = [colour, byName]
        self.colourChanged.emit(colourKey, colour)

    @pyqtSlot()
    def __selectColourSlot(self, button):
        """
        Private slot to select a color.

        @param button reference to the button been pressed
        @type QPushButton
        """
        colorKey = button.property("colorKey")
        hasAlpha = button.property("hasAlpha")

        colDlg = QColorDialog(parent=self)
        if hasAlpha:
            colDlg.setOptions(QColorDialog.ColorDialogOption.ShowAlphaChannel)
        # Set current color last to avoid conflicts with alpha channel
        colDlg.setCurrentColor(self.__coloursDict[colorKey][0])
        colDlg.currentColorChanged.connect(
            lambda col: self.colourChanged.emit(colorKey, col)
        )
        colDlg.exec()

        if colDlg.result() == QDialog.DialogCode.Accepted:
            colour = colDlg.selectedColor()
            size = button.iconSize()
            pm = QPixmap(size.width(), size.height())
            pm.fill(colour)
            button.setIcon(QIcon(pm))
            self.__coloursDict[colorKey][0] = colour

        # Update color selection
        self.colourChanged.emit(colorKey, self.__coloursDict[colorKey][0])

    def saveColours(self, prefMethod):
        """
        Public method to save the colour selections.

        @param prefMethod preferences method to set the colour
        @type function
        """
        for key in self.__coloursDict:
            if self.__coloursDict[key][1]:
                prefMethod(key, self.__coloursDict[key][0].name())
            else:
                prefMethod(key, self.__coloursDict[key][0])

    def selectFont(self, fontSample, fontVar, showFontInfo=False, options=None):
        """
        Public method used by the font selection buttons.

        @param fontSample reference to the font sample widget
        @type QLineEdit
        @param fontVar reference to the variable containing the font
        @type QFont
        @param showFontInfo flag indicating to show some font info
            as the sample
        @type bool
        @param options options for the font dialog
        @type QFontDialog.FontDialogOption
        @return selected font
        @rtype QFont
        """
        if options is None:
            options = QFontDialog.FontDialogOption(0)
        font, ok = QFontDialog.getFont(fontVar, self, "", options)
        if ok:
            fontSample.setFont(font)
            if showFontInfo:
                fontSample.setText("{0} {1}".format(font.family(), font.pointSize()))
        else:
            font = fontVar
        return font  # __IGNORE_WARNING_M834__