kindred/create
1
1
Fork 0
Code Issues 44 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity

Addon Manager: Refactor buttons above detail view

Browse Source
This commit is contained in:
Chris Hennes
2024-02-04 16:01:36 -06:00
parent e76c22d77c
commit 2e81663cc4
3 changed files with 164 additions and 122 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
src/Mod/AddonManager/Widgets/CMakeLists.txt
View File

@@ -1,5 +1,6 @@
SET(AddonManagerWidget_SRCS
__init__.py
addonmanager_widget_addon_buttons.py
addonmanager_widget_filter_selector.py
addonmanager_widget_global_buttons.py
addonmanager_widget_progress_bar.py

115
src/Mod/AddonManager/Widgets/addonmanager_widget_addon_buttons.py Normal file
View File

@@ -0,0 +1,115 @@
# SPDX-License-Identifier: LGPL-2.1-or-later
# ***************************************************************************
# * *
# * Copyright (c) 2024 FreeCAD Project Association *
# * *
# * This file is part of FreeCAD. *
# * *
# * FreeCAD is free software: you can redistribute it and/or modify it *
# * under the terms of the GNU Lesser General Public License as *
# * published by the Free Software Foundation, either version 2.1 of the *
# * License, or (at your option) any later version. *
# * *
# * FreeCAD 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 *
# * Lesser General Public License for more details. *
# * *
# * You should have received a copy of the GNU Lesser General Public *
# * License along with FreeCAD. If not, see *
# * <https://www.gnu.org/licenses/>. *
# * *
# ***************************************************************************
""" Defines a QWidget-derived class for displaying the single-addon buttons. """
from enum import Enum, auto
try:
import FreeCAD
translate = FreeCAD.Qt.translate
except ImportError:
FreeCAD = None
def translate(_: str, text: str):
return text
# Get whatever version of PySide we can
try:
import PySide # Use the FreeCAD wrapper
except ImportError:
try:
import PySide6 # Outside FreeCAD, try Qt6 first
PySide = PySide6
except ImportError:
import PySide2 # Fall back to Qt5 (if this fails, Python will kill this module's import)
PySide = PySide2
from PySide import QtCore, QtGui, QtWidgets
class ButtonBarDisplayMode(Enum):
TextOnly = auto()
IconsOnly = auto()
TextAndIcons = auto()
class WidgetAddonButtons(QtWidgets.QWidget):
def __init__(self, parent: QtWidgets.QWidget = None):
super().__init__(parent)
self.display_mode = ButtonBarDisplayMode.TextAndIcons
self._setup_ui()
self._set_icons()
self.retranslateUi(None)
def set_display_mode(self, mode: ButtonBarDisplayMode):
"""NOTE: Not really implemented yet -- TODO: Implement this functionality"""
if mode == self.display_mode:
return
self._setup_ui()
self._set_icons()
self.retranslateUi(None)
def _setup_ui(self):
self.horizontal_layout = QtWidgets.QHBoxLayout()
self.horizontal_layout.setContentsMargins(0, 0, 0, 0)
self.back_button = QtWidgets.QToolButton(self)
self.install_button = QtWidgets.QPushButton(self)
self.uninstall_button = QtWidgets.QPushButton(self)
self.enable_button = QtWidgets.QPushButton(self)
self.disable_button = QtWidgets.QPushButton(self)
self.update_button = QtWidgets.QPushButton(self)
self.run_macro_button = QtWidgets.QPushButton(self)
self.change_branch_button = QtWidgets.QPushButton(self)
self.check_for_update_button = QtWidgets.QPushButton(self)
self.horizontal_layout.addWidget(self.back_button)
self.horizontal_layout.addStretch()
self.horizontal_layout.addWidget(self.check_for_update_button)
self.horizontal_layout.addWidget(self.install_button)
self.horizontal_layout.addWidget(self.uninstall_button)
self.horizontal_layout.addWidget(self.enable_button)
self.horizontal_layout.addWidget(self.disable_button)
self.horizontal_layout.addWidget(self.update_button)
self.horizontal_layout.addWidget(self.run_macro_button)
self.horizontal_layout.addWidget(self.change_branch_button)
self.setLayout(self.horizontal_layout)
def _set_icons(self):
self.back_button.setIcon(
QtGui.QIcon.fromTheme("back", QtGui.QIcon(":/icons/button_left.svg"))
)
def retranslateUi(self, _):
self.check_for_update_button.setText(translate("AddonsInstaller", "Check for update"))
self.install_button.setText(translate("AddonsInstaller", "Install"))
self.uninstall_button.setText(translate("AddonsInstaller", "Uninstall"))
self.disable_button.setText(translate("AddonsInstaller", "Disable"))
self.enable_button.setText(translate("AddonsInstaller", "Enable"))
self.update_button.setText(translate("AddonsInstaller", "Update"))
self.run_macro_button.setText(translate("AddonsInstaller", "Run"))
self.change_branch_button.setText(translate("AddonsInstaller", "Change branch..."))
self.back_button.setToolTip(translate("AddonsInstaller", "Return to package list"))

170
src/Mod/AddonManager/package_details.py
View File

@@ -41,6 +41,7 @@ from addonmanager_readme_viewer import ReadmeViewer
from addonmanager_git import GitManager, NoGitFound
from Addon import Addon
from change_branch import ChangeBranchDialog
from Widgets.addonmanager_widget_addon_buttons import WidgetAddonButtons
translate = fci.translate
@@ -70,15 +71,17 @@ class PackageDetails(QtWidgets.QWidget):
except NoGitFound:
self.git_manager = None
self.ui.buttonBack.clicked.connect(self.back.emit)
self.ui.buttonExecute.clicked.connect(lambda: self.execute.emit(self.repo))
self.ui.buttonInstall.clicked.connect(lambda: self.install.emit(self.repo))
self.ui.buttonUninstall.clicked.connect(lambda: self.uninstall.emit(self.repo))
self.ui.buttonUpdate.clicked.connect(lambda: self.update.emit(self.repo))
self.ui.buttonCheckForUpdate.clicked.connect(lambda: self.check_for_update.emit(self.repo))
self.ui.buttonChangeBranch.clicked.connect(self.change_branch_clicked)
self.ui.buttonEnable.clicked.connect(self.enable_clicked)
self.ui.buttonDisable.clicked.connect(self.disable_clicked)
self.ui.button_bar.back_button.clicked.connect(self.back.emit)
self.ui.button_bar.run_macro_button.clicked.connect(lambda: self.execute.emit(self.repo))
self.ui.button_bar.install_button.clicked.connect(lambda: self.install.emit(self.repo))
self.ui.button_bar.uninstall_button.clicked.connect(lambda: self.uninstall.emit(self.repo))
self.ui.button_bar.update_button.clicked.connect(lambda: self.update.emit(self.repo))
self.ui.button_bar.check_for_update_button.clicked.connect(
lambda: self.check_for_update.emit(self.repo)
)
self.ui.button_bar.change_branch_button.clicked.connect(self.change_branch_clicked)
self.ui.button_bar.enable_button.clicked.connect(self.enable_clicked)
self.ui.button_bar.disable_button.clicked.connect(self.disable_clicked)
def show_repo(self, repo: Addon, reload: bool = False) -> None:
"""The main entry point for this class, shows the package details and related buttons
@@ -97,13 +100,13 @@ class PackageDetails(QtWidgets.QWidget):
if repo.repo_type == Addon.Kind.MACRO:
self.show_macro(repo)
self.ui.buttonExecute.show()
self.ui.button_bar.run_macro_button.show()
elif repo.repo_type == Addon.Kind.WORKBENCH:
self.show_workbench(repo)
self.ui.buttonExecute.hide()
self.ui.button_bar.run_macro_button.hide()
elif repo.repo_type == Addon.Kind.PACKAGE:
self.show_package(repo)
self.ui.buttonExecute.hide()
self.ui.button_bar.run_macro_button.hide()
if repo.status() == Addon.Status.UNCHECKED:
if not self.status_update_thread:
@@ -264,35 +267,35 @@ class PackageDetails(QtWidgets.QWidget):
self.ui.labelInstallationLocation.hide()
if status == Addon.Status.NOT_INSTALLED:
self.ui.buttonInstall.show()
self.ui.buttonUninstall.hide()
self.ui.buttonUpdate.hide()
self.ui.buttonCheckForUpdate.hide()
self.ui.button_bar.install_button.show()
self.ui.button_bar.uninstall_button.hide()
self.ui.button_bar.update_button.hide()
self.ui.button_bar.check_for_update_button.hide()
elif status == Addon.Status.NO_UPDATE_AVAILABLE:
self.ui.buttonInstall.hide()
self.ui.buttonUninstall.show()
self.ui.buttonUpdate.hide()
self.ui.buttonCheckForUpdate.hide()
self.ui.button_bar.install_button.hide()
self.ui.button_bar.uninstall_button.show()
self.ui.button_bar.update_button.hide()
self.ui.button_bar.check_for_update_button.hide()
elif status == Addon.Status.UPDATE_AVAILABLE:
self.ui.buttonInstall.hide()
self.ui.buttonUninstall.show()
self.ui.buttonUpdate.show()
self.ui.buttonCheckForUpdate.hide()
self.ui.button_bar.install_button.hide()
self.ui.button_bar.uninstall_button.show()
self.ui.button_bar.update_button.show()
self.ui.button_bar.check_for_update_button.hide()
elif status == Addon.Status.UNCHECKED:
self.ui.buttonInstall.hide()
self.ui.buttonUninstall.show()
self.ui.buttonUpdate.hide()
self.ui.buttonCheckForUpdate.show()
self.ui.button_bar.install_button.hide()
self.ui.button_bar.uninstall_button.show()
self.ui.button_bar.update_button.hide()
self.ui.button_bar.check_for_update_button.show()
elif status == Addon.Status.PENDING_RESTART:
self.ui.buttonInstall.hide()
self.ui.buttonUninstall.show()
self.ui.buttonUpdate.hide()
self.ui.buttonCheckForUpdate.hide()
self.ui.button_bar.install_button.hide()
self.ui.button_bar.uninstall_button.show()
self.ui.button_bar.update_button.hide()
self.ui.button_bar.check_for_update_button.hide()
elif status == Addon.Status.CANNOT_CHECK:
self.ui.buttonInstall.hide()
self.ui.buttonUninstall.show()
self.ui.buttonUpdate.show()
self.ui.buttonCheckForUpdate.hide()
self.ui.button_bar.install_button.hide()
self.ui.button_bar.uninstall_button.show()
self.ui.button_bar.update_button.show()
self.ui.button_bar.check_for_update_button.hide()
required_version = self.requires_newer_freecad()
if repo.obsolete:
@@ -355,7 +358,7 @@ class PackageDetails(QtWidgets.QWidget):
"""The change branch button is only available for installed Addons that have a .git directory
and in runs where the git is available."""
self.ui.buttonChangeBranch.hide()
self.ui.button_bar.change_branch_button.hide()
pref = fci.ParamGet("User parameter:BaseApp/Preferences/Addons")
show_switcher = pref.GetBool("ShowBranchSwitcher", False)
@@ -382,19 +385,19 @@ class PackageDetails(QtWidgets.QWidget):
# If all four above checks passed, then it's possible for us to switch
# branches, if there are any besides the one we are on: show the button
self.ui.buttonChangeBranch.show()
self.ui.button_bar.change_branch_button.show()
def set_disable_button_state(self):
"""Set up the enable/disable button based on the enabled/disabled state of the addon"""
self.ui.buttonEnable.hide()
self.ui.buttonDisable.hide()
self.ui.button_bar.enable_button.hide()
self.ui.button_bar.disable_button.hide()
status = self.repo.status()
if status != Addon.Status.NOT_INSTALLED:
disabled = self.repo.is_disabled()
if disabled:
self.ui.buttonEnable.show()
self.ui.button_bar.enable_button.show()
else:
self.ui.buttonDisable.show()
self.ui.button_bar.disable_button.show()
def show_workbench(self, repo: Addon) -> None:
"""loads information of a given workbench"""
@@ -511,59 +514,9 @@ class Ui_PackageDetails(object):
self.verticalLayout_2.setObjectName("verticalLayout_2")
self.layoutDetailsBackButton = QtWidgets.QHBoxLayout()
self.layoutDetailsBackButton.setObjectName("layoutDetailsBackButton")
self.buttonBack = QtWidgets.QToolButton(PackageDetails)
self.buttonBack.setObjectName("buttonBack")
self.buttonBack.setIcon(
QtGui.QIcon.fromTheme("back", QtGui.QIcon(":/icons/button_left.svg"))
)
self.layoutDetailsBackButton.addWidget(self.buttonBack)
self.horizontalSpacer = QtWidgets.QSpacerItem(
40, 20, QtWidgets.QSizePolicy.Expanding, QtWidgets.QSizePolicy.Minimum
)
self.layoutDetailsBackButton.addItem(self.horizontalSpacer)
self.buttonInstall = QtWidgets.QPushButton(PackageDetails)
self.buttonInstall.setObjectName("buttonInstall")
self.layoutDetailsBackButton.addWidget(self.buttonInstall)
self.buttonUninstall = QtWidgets.QPushButton(PackageDetails)
self.buttonUninstall.setObjectName("buttonUninstall")
self.layoutDetailsBackButton.addWidget(self.buttonUninstall)
self.buttonUpdate = QtWidgets.QPushButton(PackageDetails)
self.buttonUpdate.setObjectName("buttonUpdate")
self.layoutDetailsBackButton.addWidget(self.buttonUpdate)
self.buttonCheckForUpdate = QtWidgets.QPushButton(PackageDetails)
self.buttonCheckForUpdate.setObjectName("buttonCheckForUpdate")
self.layoutDetailsBackButton.addWidget(self.buttonCheckForUpdate)
self.buttonChangeBranch = QtWidgets.QPushButton(PackageDetails)
self.buttonChangeBranch.setObjectName("buttonChangeBranch")
self.layoutDetailsBackButton.addWidget(self.buttonChangeBranch)
self.buttonExecute = QtWidgets.QPushButton(PackageDetails)
self.buttonExecute.setObjectName("buttonExecute")
self.layoutDetailsBackButton.addWidget(self.buttonExecute)
self.buttonDisable = QtWidgets.QPushButton(PackageDetails)
self.buttonDisable.setObjectName("buttonDisable")
self.layoutDetailsBackButton.addWidget(self.buttonDisable)
self.buttonEnable = QtWidgets.QPushButton(PackageDetails)
self.buttonEnable.setObjectName("buttonEnable")
self.layoutDetailsBackButton.addWidget(self.buttonEnable)
self.button_bar = WidgetAddonButtons(PackageDetails)
self.layoutDetailsBackButton.addWidget(self.button_bar)
self.verticalLayout_2.addLayout(self.layoutDetailsBackButton)
@@ -601,33 +554,6 @@ class Ui_PackageDetails(object):
# setupUi
def retranslateUi(self, _):
self.buttonBack.setText("")
self.buttonInstall.setText(
QtCore.QCoreApplication.translate("AddonsInstaller", "Install", None)
)
self.buttonUninstall.setText(
QtCore.QCoreApplication.translate("AddonsInstaller", "Uninstall", None)
)
self.buttonUpdate.setText(
QtCore.QCoreApplication.translate("AddonsInstaller", "Update", None)
)
self.buttonCheckForUpdate.setText(
QtCore.QCoreApplication.translate("AddonsInstaller", "Check for Update", None)
)
self.buttonExecute.setText(
QtCore.QCoreApplication.translate("AddonsInstaller", "Run Macro", None)
)
self.buttonChangeBranch.setText(
QtCore.QCoreApplication.translate("AddonsInstaller", "Change Branch", None)
)
self.buttonEnable.setText(
QtCore.QCoreApplication.translate("AddonsInstaller", "Enable", None)
)
self.buttonDisable.setText(
QtCore.QCoreApplication.translate("AddonsInstaller", "Disable", None)
)
self.buttonBack.setToolTip(
QtCore.QCoreApplication.translate("AddonsInstaller", "Return to package list", None)
)
pass
# retranslateUi