cnQPushButton.py

# -*- coding: UTF-8 -*-

'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
'                                                                         '
' Copyright 2018-2024 Gauthier Brière (gauthier.briere "at" gmail.com)    '
'                                                                         '
' This file is part of cn5X++                                             '
'                                                                         '
' cn5X++ is free software: you can redistribute it and/or modify it       '
'  under the terms of the GNU General Public License as published by      '
' the Free Software Foundation, either version 3 of the License, or       '
' (at your option) any later version.                                     '
'                                                                         '
' cn5X++ is distributed in the hope that it will be useful, but           '
' WITHOUT ANY WARRANTY; without even the implied warranty of              '
' MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the           '
' GNU General Public License for more details.                            '
'                                                                         '
' You should have received a copy of the GNU General Public License       '
' along with this program.  If not, see <http://www.gnu.org/licenses/>.   '
'                                                                         '
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

import sys, os
from PyQt6 import QtCore, QtGui, QtWidgets
from PyQt6.QtCore import Qt, pyqtSignal, QEvent, QResource, QSize


class cnQPushButton(QtWidgets.QPushButton):
  '''
  QPushButton avec gestion d'images en fonction de l'etat
  '''

  keyPressed       = pyqtSignal(QtGui.QKeyEvent)
  mousePress       = pyqtSignal(QtWidgets.QPushButton, QtGui.QMouseEvent)
  mouseRelease     = pyqtSignal(QtWidgets.QPushButton, QtGui.QMouseEvent)
  mouseDoubleClick = pyqtSignal(QtGui.QMouseEvent)

  def __init__(self, parent=None):
    super(cnQPushButton, self).__init__(parent=parent)
    self.installEventFilter(self)
    self.__myName = ""
    self.__mouseIsDown = False
    self.__buttonStatus = False

    # Chemin des images dans le fichier de resources
    self.__imagePath = os.path.join(os.path.dirname(__file__), "images/")

    self.icon = QtGui.QIcon()
    self.iconDown = QtGui.QIcon()
    self.iconLight = QtGui.QIcon()
    self.__imagesOk = False

  def eventFilter(self, object, event):
    '''
    On utilise eventFilter() pour "trapper" un evennement unique au plus tot apres la creation
    du controle car le nom n'est pas definit lors de l'appel d'__init() et je n'ai pas reussi
    a recuperer le signal objectNameChanged.
    '''
    if event.type() == QEvent.Type.DynamicPropertyChange:
      self.__myName = object.objectName()
      pictureBaseName = self.__imagePath + self.__myName.split("_")[0]

      if QResource(pictureBaseName + ".svg").isValid():
        self.icon.addPixmap     (QtGui.QPixmap(pictureBaseName + ".svg"),       QtGui.QIcon.Mode.Normal, QtGui.QIcon.State.On)
        if QResource(pictureBaseName + "_down.svg").isValid():
          self.iconDown.addPixmap (QtGui.QPixmap(pictureBaseName + "_down.svg"),  QtGui.QIcon.Mode.Normal, QtGui.QIcon.State.On)
        else:
          self.iconDown.addPixmap (QtGui.QPixmap(pictureBaseName + ".svg"),  QtGui.QIcon.Mode.Normal, QtGui.QIcon.State.On)
        if QResource(pictureBaseName + "_light.svg").isValid():
          self.iconLight.addPixmap(QtGui.QPixmap(pictureBaseName + "_light.svg"), QtGui.QIcon.Mode.Normal, QtGui.QIcon.State.On)
        else:
          self.iconLight.addPixmap (QtGui.QPixmap(pictureBaseName + ".svg"),  QtGui.QIcon.Mode.Normal, QtGui.QIcon.State.On)
        self.__imagesOk = True

    if event.type() == QEvent.Type.EnabledChange:
      if self.__imagesOk:
        if self.isEnabled():
          if self.__buttonStatus:
            self.setIcon(self.iconLight)
          else:
            self.setIcon(self.icon)
        else:
          self.setIcon(self.icon)

    if event.type() == QEvent.Type.Resize:
      self.setIconSize(QSize(self.size().width()-2, self.size().height()-2))
    
    return False


  def changeIcon(self, icon):
    newIcon = QtGui.QIcon()
    newIcon.addPixmap(QtGui.QPixmap(icon), QtGui.QIcon.Mode.Normal, QtGui.QIcon.State.On)
    self.setIcon(newIcon)


  def mousePressEvent(self, e):
    super(cnQPushButton, self).mousePressEvent(e)
    if e.button() == Qt.MouseButton.LeftButton:
      self.__mouseIsDown = True
      if self.__imagesOk:
        self.setIcon(self.iconDown)
      self.mousePress.emit(self, e)

  def mouseReleaseEvent(self, e):
    if e.button() == Qt.MouseButton.LeftButton:
      self.__mouseIsDown = False
      if self.isCheckable():
        self.__buttonStatus = True
      if self.__imagesOk:
        if self.isEnabled():
          if self.__buttonStatus:
            self.setIcon(self.iconLight)
          else:
            self.setIcon(self.icon)
        else:
          self.setIcon(self.icon)
      self.mouseRelease.emit(self, e)
    super(cnQPushButton, self).mouseReleaseEvent(e)

  def setButtonStatus(self, value: bool):
    self.__buttonStatus = value
    if not self.__mouseIsDown:
      if self.__imagesOk:
        if self.isEnabled():
          if self.__buttonStatus:
            self.setIcon(self.iconLight)
          else:
            self.setIcon(self.icon)
        else:
          self.setIcon(self.icon)

  def isMouseDown(self):
    return self.__mouseIsDown

  def getButtonStatus(self):
    return self.__buttonStatus

  def name(self):
    return self.__myName

  def mouseDoubleClickEvent(self, e):
    super(cnQPushButton, self).mouseDoubleClickEvent(e)
    self.mouseDoubleClick.emit(e)

  def keyPressEvent(self, e):
    super(cnQPushButton, self).keyPressEvent(e)
    self.keyPressed.emit(e)