1
0
Fork 0
mirror of synced 2024-06-02 18:54:41 +12:00
Rare/rare/utils/extra_widgets.py

501 lines
17 KiB
Python

import os
from logging import getLogger
from typing import Callable, Tuple
from PyQt5.QtCore import (
Qt,
QCoreApplication,
QRect,
QSize,
QPoint,
pyqtSignal,
QFileInfo,
)
from PyQt5.QtGui import QMovie, QPixmap, QFontMetrics, QImage
from PyQt5.QtWidgets import (
QStyle,
QSizePolicy,
QLabel,
QFileDialog,
QHBoxLayout,
QWidget,
QPushButton,
QStyleOptionTab,
QStylePainter,
QTabBar,
QLineEdit,
QToolButton,
QTabWidget,
QCompleter,
QFileSystemModel,
QStyledItemDelegate,
QFileIconProvider,
QVBoxLayout,
QScrollArea,
)
from rare.utils.paths import tmp_dir
from rare.utils.qt_requests import QtRequestManager
from rare.utils.misc import icon as qta_icon
logger = getLogger("ExtraWidgets")
class IndicatorReasons:
dir_not_empty = QCoreApplication.translate("IndicatorReasons", "Directory is not empty")
wrong_format = QCoreApplication.translate("IndicatorReasons", "Given text has wrong format")
game_not_installed = QCoreApplication.translate(
"IndicatorReasons", "Game is not installed or does not exist"
)
dir_not_exist = QCoreApplication.translate("IndicatorReasons", "Directory does not exist")
file_not_exist = QCoreApplication.translate("IndicatorReasons", "File does not exist")
wrong_path = QCoreApplication.translate("IndicatorReasons", "Wrong Directory")
class IndicatorLineEdit(QWidget):
textChanged = pyqtSignal(str)
is_valid = False
reasons = IndicatorReasons()
def __init__(
self,
text: str = "",
placeholder: str = "",
completer: QCompleter = None,
edit_func: Callable[[str], Tuple[bool, str, str]] = None,
save_func: Callable[[str], None] = None,
horiz_policy: QSizePolicy = QSizePolicy.Expanding,
parent=None,
):
super(IndicatorLineEdit, self).__init__(parent=parent)
self.setObjectName(type(self).__name__)
layout = QHBoxLayout(self)
layout.setObjectName(f"{self.objectName()}Layout")
layout.setContentsMargins(0, 0, 0, 0)
# Add line_edit
self.line_edit = QLineEdit(self)
self.line_edit.setObjectName(f"{type(self).__name__}Edit")
self.line_edit.setPlaceholderText(placeholder)
self.line_edit.setSizePolicy(horiz_policy, QSizePolicy.Fixed)
# Add hint_label to line_edit
self.line_edit.setLayout(QHBoxLayout())
self.hint_label = QLabel()
self.hint_label.setObjectName(f"{type(self).__name__}Label")
self.hint_label.setAlignment(Qt.AlignRight | Qt.AlignVCenter)
self.line_edit.layout().setContentsMargins(0, 0, 10, 0)
self.line_edit.layout().addWidget(self.hint_label)
# Add completer
if completer is not None:
completer.popup().setItemDelegate(QStyledItemDelegate(self))
completer.popup().setAlternatingRowColors(True)
self.line_edit.setCompleter(completer)
layout.addWidget(self.line_edit)
if edit_func is not None:
self.indicator_label = QLabel()
self.indicator_label.setPixmap(qta_icon("ei.info-circle", color="gray").pixmap(16, 16))
self.indicator_label.setSizePolicy(QSizePolicy.Fixed, QSizePolicy.Fixed)
layout.addWidget(self.indicator_label)
if not placeholder:
_translate = QCoreApplication.translate
self.line_edit.setPlaceholderText(_translate(self.__class__.__name__, "Default"))
self.edit_func = edit_func
self.save_func = save_func
self.line_edit.textChanged.connect(self.__edit)
if self.edit_func is None:
self.line_edit.textChanged.connect(self.__save)
# lk: this can be placed here to trigger __edit
# lk: it going to save the input again if it is valid which
# lk: is ok to do given the checks don't misbehave (they shouldn't)
# lk: however it is going to edit any "understood" bad input to good input
# lk: and we might not want that (but the validity check reports on the edited string)
# lk: it is also going to trigger this widget's textChanged signal but that gets lost
if text:
self.line_edit.setText(text)
def text(self) -> str:
return self.line_edit.text()
def setText(self, text: str):
self.line_edit.setText(text)
def setHintText(self, text: str):
self.hint_label.setFrameRect(self.line_edit.rect())
self.hint_label.setText(text)
def __indicator(self, res, reason=None):
color = "green" if res else "red"
self.indicator_label.setPixmap(qta_icon("ei.info-circle", color=color).pixmap(16, 16))
if reason:
self.indicator_label.setToolTip(reason)
else:
self.indicator_label.setToolTip("")
def __edit(self, text):
if self.edit_func is not None:
self.line_edit.blockSignals(True)
self.is_valid, text, reason = self.edit_func(text)
if text != self.line_edit.text():
self.line_edit.setText(text)
self.line_edit.blockSignals(False)
self.__indicator(self.is_valid, reason)
if self.is_valid:
self.__save(text)
self.textChanged.emit(text)
def __save(self, text):
if self.save_func is not None:
self.save_func(text)
class PathEditIconProvider(QFileIconProvider):
icons = [
("mdi.file-cancel", "fa.file-excel-o"), # Unknown
("mdi.desktop-classic", "fa.desktop"), # Computer
("mdi.desktop-mac", "fa.desktop"), # Desktop
("mdi.trash-can", "fa.trash"), # Trashcan
("mdi.server-network", "fa.server"), # Network
("mdi.harddisk", "fa.desktop"), # Drive
("mdi.folder", "fa.folder"), # Folder
("mdi.file", "fa.file"), # File
("mdi.cog", "fa.cog"), # Executable
]
def __init__(self):
super(PathEditIconProvider, self).__init__()
self.icon_types = dict()
for idx, (icn, fallback) in enumerate(self.icons):
self.icon_types.update({idx - 1: qta_icon(icn, fallback, color="#eeeeee")})
def icon(self, info_type):
if isinstance(info_type, QFileInfo):
if info_type.isRoot():
return self.icon_types[4]
if info_type.isDir():
return self.icon_types[5]
if info_type.isFile():
return self.icon_types[6]
if info_type.isExecutable():
return self.icon_types[7]
return self.icon_types[-1]
return self.icon_types[int(info_type)]
class PathEdit(IndicatorLineEdit):
completer = QCompleter()
compl_model = QFileSystemModel()
def __init__(
self,
path: str = "",
file_type: QFileDialog.FileType = QFileDialog.AnyFile,
type_filter: str = "",
name_filter: str = "",
placeholder: str = "",
edit_func: Callable[[str], Tuple[bool, str, str]] = None,
save_func: Callable[[str], None] = None,
horiz_policy: QSizePolicy = QSizePolicy.Expanding,
parent=None,
):
try:
self.compl_model.setOptions(
QFileSystemModel.DontWatchForChanges
| QFileSystemModel.DontResolveSymlinks
| QFileSystemModel.DontUseCustomDirectoryIcons
)
except AttributeError as e: # Error on Ubuntu
logger.warning(e)
self.compl_model.setIconProvider(PathEditIconProvider())
self.compl_model.setRootPath(path)
self.completer.setModel(self.compl_model)
edit_func = self.__wrap_edit_function(edit_func)
super(PathEdit, self).__init__(
text=path,
placeholder=placeholder,
completer=self.completer,
edit_func=edit_func,
save_func=save_func,
horiz_policy=horiz_policy,
parent=parent,
)
self.setObjectName(type(self).__name__)
self.line_edit.setMinimumSize(QSize(250, 0))
self.path_select = QToolButton(self)
self.path_select.setObjectName(f"{type(self).__name__}Button")
layout = self.layout()
layout.addWidget(self.path_select)
_translate = QCoreApplication.translate
self.path_select.setText(_translate("PathEdit", "Browse..."))
self.type_filter = type_filter
self.name_filter = name_filter
self.file_type = file_type
self.path_select.clicked.connect(self.__set_path)
def __set_path(self):
dlg_path = self.line_edit.text()
if not dlg_path:
dlg_path = os.path.expanduser("~/")
dlg = QFileDialog(self, self.tr("Choose path"), dlg_path)
dlg.setFileMode(self.file_type)
if self.type_filter:
dlg.setFilter([self.type_filter])
if self.name_filter:
dlg.setNameFilter(self.name_filter)
if dlg.exec_():
names = dlg.selectedFiles()
self.line_edit.setText(names[0])
self.compl_model.setRootPath(names[0])
def __wrap_edit_function(self, edit_function: Callable[[str], Tuple[bool, str, str]]):
if edit_function:
return lambda text: edit_function(os.path.expanduser(text)
if text.startswith("~") else text)
else:
return edit_function
class SideTabBar(QTabBar):
def __init__(self, parent=None):
super(SideTabBar, self).__init__(parent=parent)
self.setObjectName("SideTabBar")
self.fm = QFontMetrics(self.font())
def tabSizeHint(self, index):
# width = QTabBar.tabSizeHint(self, index).width()
return QSize(200, self.fm.height() + 18)
def paintEvent(self, event):
painter = QStylePainter(self)
opt = QStyleOptionTab()
for i in range(self.count()):
self.initStyleOption(opt, i)
painter.drawControl(QStyle.CE_TabBarTabShape, opt)
painter.save()
s = opt.rect.size()
s.transpose()
r = QRect(QPoint(), s)
r.moveCenter(opt.rect.center())
opt.rect = r
c = self.tabRect(i).center()
painter.translate(c)
painter.rotate(90)
painter.translate(-c)
painter.drawControl(QStyle.CE_TabBarTabLabel, opt)
painter.restore()
class SideTabContainer(QWidget):
def __init__(self, widget: QWidget, title: str = str(), parent: QWidget = None):
super(SideTabContainer, self).__init__(parent=parent)
self.title = QLabel(self)
self.setTitle(title)
self.scroll = QScrollArea(self)
self.scroll.setWidgetResizable(True)
self.scroll.setSizeAdjustPolicy(QScrollArea.AdjustToContents)
self.scroll.setHorizontalScrollBarPolicy(Qt.ScrollBarAlwaysOff)
self.scroll.setFrameStyle(QScrollArea.NoFrame)
if widget.layout():
widget.layout().setAlignment(Qt.AlignTop)
widget.layout().setContentsMargins(0, 0, 9, 0)
widget.title = self.title
widget.title.setTitle = self.setTitle
self.scroll.setMinimumWidth(
widget.sizeHint().width()
+ self.scroll.verticalScrollBar().sizeHint().width()
)
self.scroll.setWidget(widget)
layout = QVBoxLayout()
layout.addWidget(self.title)
layout.addWidget(self.scroll)
self.setLayout(layout)
def setTitle(self, text: str) -> None:
self.title.setText(f"<h2>{text}</h2>")
self.title.setVisible(bool(text))
class SideTabWidget(QTabWidget):
back_clicked = pyqtSignal()
def __init__(self, show_back: bool = False, parent=None):
super(SideTabWidget, self).__init__(parent=parent)
self.setTabBar(SideTabBar())
self.setDocumentMode(True)
self.setTabPosition(QTabWidget.West)
if show_back:
super(SideTabWidget, self).addTab(
QWidget(), qta_icon("mdi.keyboard-backspace", "ei.backward"), self.tr("Back")
)
self.tabBarClicked.connect(self.back_func)
def back_func(self, tab):
# shortcut for tab == 0
if not tab:
self.back_clicked.emit()
def addTab(self, widget: QWidget, a1: str, title: str = str()) -> int:
container = SideTabContainer(widget, title, parent=self)
return super(SideTabWidget, self).addTab(container, a1)
class WaitingSpinner(QLabel):
def __init__(self):
super(WaitingSpinner, self).__init__()
self.setStyleSheet(
"""
margin-left: auto;
margin-right: auto;
"""
)
self.movie = QMovie(":/images/loader.gif")
self.setMovie(self.movie)
self.movie.start()
class SelectViewWidget(QWidget):
toggled = pyqtSignal()
def __init__(self, icon_view: bool):
super(SelectViewWidget, self).__init__()
self.icon_view = icon_view
self.setStyleSheet("""QPushButton{border: none; background-color: transparent}""")
self.icon_button = QPushButton()
self.list_button = QPushButton()
if icon_view:
self.icon_button.setIcon(
qta_icon("mdi.view-grid-outline", "ei.th-large", color="orange")
)
self.list_button.setIcon(qta_icon("fa5s.list", "ei.th-list"))
else:
self.icon_button.setIcon(qta_icon("mdi.view-grid-outline", "ei.th-large"))
self.list_button.setIcon(qta_icon("fa5s.list", "ei.th-list", color="orange"))
self.icon_button.clicked.connect(self.icon)
self.list_button.clicked.connect(self.list)
layout = QHBoxLayout()
layout.setContentsMargins(0, 0, 0, 0)
layout.addWidget(self.icon_button)
layout.addWidget(self.list_button)
self.setLayout(layout)
def isChecked(self):
return self.icon_view
def icon(self):
self.icon_button.setIcon(
qta_icon("mdi.view-grid-outline", "ei.th-large", color="orange")
)
self.list_button.setIcon(qta_icon("fa5s.list", "ei.th-list"))
self.icon_view = False
self.toggled.emit()
def list(self):
self.icon_button.setIcon(qta_icon("mdi.view-grid-outline", "ei.th-large"))
self.list_button.setIcon(qta_icon("fa5s.list", "ei.th-list", color="orange"))
self.icon_view = True
self.toggled.emit()
class ImageLabel(QLabel):
image = None
img_size = None
name = str()
def __init__(self):
super(ImageLabel, self).__init__()
self.path = tmp_dir
self.manager = QtRequestManager("bytes")
def update_image(self, url, name="", size: tuple = (240, 320)):
self.setFixedSize(*size)
self.img_size = size
self.name = name
for c in r'<>?":|\/* ':
self.name = self.name.replace(c, "")
if self.img_size[0] > self.img_size[1]:
name_extension = "wide"
else:
name_extension = "tall"
self.name = f"{self.name}_{name_extension}.png"
if not os.path.exists(os.path.join(self.path, self.name)):
self.manager.get(url, self.image_ready)
# self.request.finished.connect(self.image_ready)
else:
self.show_image()
def image_ready(self, data):
try:
self.setPixmap(QPixmap())
except Exception:
logger.warning("C++ object already removed, when image ready")
return
image = QImage()
image.loadFromData(data)
image = image.scaled(
*self.img_size[:2],
Qt.KeepAspectRatio,
transformMode=Qt.SmoothTransformation,
)
image.save(os.path.join(self.path, self.name))
pixmap = QPixmap().fromImage(image)
self.setPixmap(pixmap)
def show_image(self):
self.image = QPixmap(os.path.join(self.path, self.name)).scaled(
*self.img_size, transformMode=Qt.SmoothTransformation
)
self.setPixmap(self.image)
class ButtonLineEdit(QLineEdit):
buttonClicked = pyqtSignal()
def __init__(self, icon_name, placeholder_text: str, parent=None):
super(ButtonLineEdit, self).__init__(parent)
self.button = QToolButton(self)
self.button.setIcon(qta_icon(icon_name, color="white"))
self.button.setStyleSheet("border: 0px; padding: 0px;")
self.button.setCursor(Qt.ArrowCursor)
self.button.clicked.connect(self.buttonClicked.emit)
self.setPlaceholderText(placeholder_text)
frameWidth = self.style().pixelMetric(QStyle.PM_DefaultFrameWidth)
buttonSize = self.button.sizeHint()
self.setStyleSheet(
"QLineEdit {padding-right: %dpx; }" % (buttonSize.width() + frameWidth + 1)
)
self.setMinimumSize(
max(self.minimumSizeHint().width(), buttonSize.width() + frameWidth * 2 + 2),
max(
self.minimumSizeHint().height(),
buttonSize.height() + frameWidth * 2 + 2,
),
)
def resizeEvent(self, event):
buttonSize = self.button.sizeHint()
frameWidth = self.style().pixelMetric(QStyle.PM_DefaultFrameWidth)
self.button.move(
self.rect().right() - frameWidth - buttonSize.width(),
(self.rect().bottom() - buttonSize.height() + 1) // 2,
)
super(ButtonLineEdit, self).resizeEvent(event)