Files
qelectrotech-source-mirror/sources/qetmainwindow.cpp
T
ispyisail 5275fb44fe Add configurable shortcuts: ShortcutManager registry + Shortcuts config page (#574)
Implements the first pillar of #574: a "Shortcuts" preferences page letting
users rebind, search and reset every keyboard shortcut in the app.

What it does
- New ShortcutManager singleton: every one of the ~95 setShortcut()/
  setShortcuts() call sites across qet.cpp, qetmainwindow.cpp,
  elementspanelwidget.cpp, autonumberingdockwidget.cpp, richtexteditor.cpp,
  qetdiagrameditor.cpp, qettemplateeditor.cpp and qetelementeditor.cpp now
  calls registerAction(target, id, category, default_sequence) instead,
  which applies the user's saved override (or the default) and remembers
  the target for later editing.
- New ShortcutsConfigPage, added to the existing "Configurer QElectroTech"
  dialog: a filterable table of every registered shortcut, grouped by
  category, each with a QKeySequenceEdit and a per-row reset button, plus a
  "reset all" button. Bindings are only persisted (via
  ShortcutManager::setSequence()) when the dialog is accepted.
- Conflict detection: rows whose currently-edited sequence collides with
  another row are highlighted with a tooltip naming the conflicting action.
- Overrides are stored under a "shortcuts/" QSettings group, one key per
  id, keyed to match the id (not persisted at all when equal to the
  hardcoded default), so a future QET version can safely raise a default
  for anyone who never customized it.

Design notes
- Targets are handled generically via QObject rather than QAction, since one
  call site (autonumberingdockwidget's "Configurer" button) is a
  QPushButton, not a QAction. Both declare an identical "shortcut"
  QKeySequence Q_PROPERTY, so registerAction() reads/writes it through the
  property system instead of needing a separate code path.
- Several live targets can share one id at once -- QET allows multiple
  windows of the same kind (diagram editor, element editor...) open
  simultaneously, each constructing its own QAction with the same id.
  setSequence() updates every live target for that id in one call, so a
  rebind takes effect in all open windows immediately, without restart.
- A shortcut's description is captured from its target's text() the first
  time that id is registered, then cached -- so the config page stays
  correct even after the owning window is closed. One consequence: a
  shortcut belonging to an on-demand window (element editor, title block
  editor, rich text editor) only appears in the list once that window has
  been opened at least once in the current session, since nothing has
  registered its id yet otherwise.

Testing
Full CMake build (qmake CONFIG+=no_kf5, Qt 5.15) compiles clean with zero
errors and zero new warnings. Verified end-to-end in a real running session
(Xvfb + xdotool):
- The Shortcuts page appears in Configure QElectroTech with the right icon,
  lists every always-registered shortcut with correct category/action name/
  current binding.
- The filter box correctly narrows the list, and correctly returns nothing
  for an action whose owning window hasn't been constructed yet this
  session (confirming the on-demand-registration behavior above is working
  as designed, not silently broken).
- Conflict detection correctly flagged a real pre-existing same-key overlap
  between "Supprimer" (delete selection, Del) and "Supprimer ce folio"
  (delete diagram from panel, Del) -- both highlighted with explanatory
  tooltips.
- Rebound "Manuel en ligne" to Ctrl+Shift+M, clicked OK: persisted under
  [shortcuts] in QElectroTech.conf, and the Aide menu's entry showed the new
  binding immediately, no restart needed.
- Reopened the dialog: the rebind was still shown. Clicked its per-row
  reset button, then OK: the settings key was removed entirely (not stored
  as "F1"), correctly falling back to the hardcoded default.

Retrofitting the Tab/Shift+Tab, select-all (#585) and Ctrl+G jump-to-element
(#586) shortcuts through this registry is left for a follow-up once those
PRs land, to avoid re-merging still-open branches into this one.

Developed with assistance from Claude (Anthropic).
2026-08-01 01:35:51 +12:00

289 lines
9.4 KiB
C++

/*
Copyright 2006-2026 The QElectroTech Team
This file is part of QElectroTech.
QElectroTech 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 2 of the License, or
(at your option) any later version.
QElectroTech 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 QElectroTech. If not, see <http://www.gnu.org/licenses/>.
*/
#include <QAction>
#include <QWhatsThis>
#include <QMenu>
#include <QMenuBar>
#include <QDragEnterEvent>
#include <QDesktopServices>
#include "qetmainwindow.h"
#include "qeticons.h"
#include "shortcutmanager.h"
#include "qetapp.h"
#include "qetdiagrameditor.h"
#include "projectview.h"
/**
Constructor
*/
QETMainWindow::QETMainWindow(QWidget *widget, Qt::WindowFlags flags) :
QMainWindow(widget, flags),
display_toolbars_(nullptr),
first_activation_(true)
{
initCommonActions();
initCommonMenus();
setAcceptDrops(true);
}
/**
Destructor
*/
QETMainWindow::~QETMainWindow()
{
}
/**
Initialize common actions.
*/
void QETMainWindow::initCommonActions()
{
QETApp *qet_app = QETApp::instance();
configure_action_ = new QAction(QET::Icons::Configure, tr("&Configurer QElectroTech"), this);
configure_action_ -> setStatusTip(tr("Permet de régler différents paramètres de QElectroTech", "status bar tip"));
connect(configure_action_, &QAction::triggered, [qet_app]()
{
qet_app->configureQET();
#if TODO_LIST
# pragma message("@TODO we use reloadOldElementPanel only to keep up to ")
# pragma message("datethe string of the folio in the old element panel.")
# pragma message("then,if user change the option")
# pragma message(" 'Use labels of folio instead of their ID' the string")
# pragma message(" of folio in the old element panel is up to date")
#endif
//TODO we use reloadOldElementPanel only to keep up to date the string of the folio in the old element panel.
//then, if user change the option "Use labels of folio instead of their ID" the string of folio in the old element panel is up to date
for (QETDiagramEditor *qde : qet_app->diagramEditors())
{
qde->reloadOldElementPanel();
for (ProjectView *pv : qde->openedProjects())
{
pv->updateAllTabsTitle();
}
}
});
fullscreen_action_ = new QAction(this);
updateFullScreenAction();
connect(fullscreen_action_, SIGNAL(triggered()), this, SLOT(toggleFullScreen()));
whatsthis_action_ = QWhatsThis::createAction(this);
about_qet_ = new QAction(QET::Icons::QETLogo, tr("À &propos de QElectroTech"), this);
about_qet_ -> setStatusTip(tr("Affiche des informations sur QElectroTech", "status bar tip"));
connect(about_qet_, SIGNAL(triggered()), qet_app, SLOT(aboutQET()));
manual_online_ = new QAction(QET::Icons::QETManual, tr("Manuel en ligne"), this);
manual_online_ -> setStatusTip(tr("Lance le navigateur par défaut vers le manuel en ligne de QElectroTech", "status bar tip"));
connect(manual_online_, &QAction::triggered, [](bool) {
QString link = "https://download.qelectrotech.org/qet/manual_0.7/build/index.html";
QDesktopServices::openUrl(QUrl(link));
});
ShortcutManager::instance().registerAction(manual_online_, "mainwindow.manual_online", tr("Général"), Qt::Key_F1);
youtube_ = new QAction(QET::Icons::QETVideo, tr("Chaine Youtube"), this);
youtube_ -> setStatusTip(tr("Lance le navigateur par défaut vers la chaine Youtube de QElectroTech", "status bar tip"));
connect(youtube_, &QAction::triggered, [](bool) {
QString link = "https://www.youtube.com/user/scorpio8101/videos";
QDesktopServices::openUrl(QUrl(link));
});
upgrade_ = new QAction(QET::Icons::QETDownload, tr("Télécharger une nouvelle version (dev)"), this);
upgrade_ -> setStatusTip(tr("Lance le navigateur par défaut vers le dépot Nightly en ligne de QElectroTech", "status bar tip"));
upgrade_M = new QAction(QET::Icons::QETDownload, tr("Télécharger une nouvelle version (dev)"), this);
upgrade_M -> setStatusTip(tr("Lance le navigateur par défaut vers le dépot Nightly en ligne de QElectroTech", "status bar tip"));
connect(upgrade_, &QAction::triggered, [](bool) {
QString link = "https://qelectrotech.org/download_windows.php";
QDesktopServices::openUrl(QUrl(link));
});
connect(upgrade_M, &QAction::triggered, [](bool) {
QString link = "https://qelectrotech.org/download_mac.php";
QDesktopServices::openUrl(QUrl(link));
});
donate_ = new QAction(QET::Icons::QETDonate, tr("Soutenir le projet par un don"), this);
donate_ -> setStatusTip(tr("Soutenir le projet QElectroTech par un don", "status bar tip"));
connect(donate_, &QAction::triggered, [](bool) {
QString link = "https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=ZZHC9D7C3MDPC";
QDesktopServices::openUrl(QUrl(link));
});
about_qt_ = new QAction(QET::Icons::QtLogo, tr("À propos de &Qt"), this);
about_qt_ -> setStatusTip(tr("Affiche des informations sur la bibliothèque Qt", "status bar tip"));
connect(about_qt_, SIGNAL(triggered()), qApp, SLOT(aboutQt()));
}
/**
Initialize common menus.
*/
void QETMainWindow::initCommonMenus()
{
settings_menu_ = new QMenu(tr("&Configuration", "window menu"), this);
settings_menu_ -> addAction(fullscreen_action_);
settings_menu_ -> addAction(configure_action_);
connect(settings_menu_, SIGNAL(aboutToShow()), this, SLOT(checkToolbarsmenu()));
help_menu_ = new QMenu(tr("&Aide", "window menu"), this);
help_menu_ -> addAction(whatsthis_action_);
help_menu_ -> addSeparator();
help_menu_ -> addAction(manual_online_);
help_menu_ -> addAction(youtube_);
help_menu_ -> addAction(upgrade_);
help_menu_ -> addAction(upgrade_M);
help_menu_ -> addAction(donate_);
help_menu_ -> addAction(about_qt_);
help_menu_ -> addAction(about_qet_);
#ifdef Q_OS_WIN32
upgrade_ -> setVisible(true);
#else
upgrade_ -> setVisible(false);
#endif
#ifdef Q_OS_MACOS
upgrade_M -> setVisible(true);
#else
upgrade_M -> setVisible(false);
#endif
insertMenu(nullptr, settings_menu_);
insertMenu(nullptr, help_menu_);
}
/**
Add \a menu before \a before. Unless \a customize is false, this method also
enables some common settings on the inserted menu.
*/
void QETMainWindow::insertMenu(QMenu *before, QMenu *menu, bool customize) {
if (!menu) return;
QAction *before_action = actionForMenu(before);
QAction *menu_action = menuBar() -> insertMenu(before_action, menu);
menu_actions_.insert(menu, menu_action);
if (customize) {
menu -> setTearOffEnabled(true);
}
}
/**
@return the action returned when inserting \a menu
*/
QAction *QETMainWindow::actionForMenu(QMenu *menu) {
return(menu_actions_.value(menu, nullptr));
}
/**
Toggle the window from/to full screen.
*/
void QETMainWindow::toggleFullScreen()
{
setWindowState(windowState() ^ Qt::WindowFullScreen);
}
/**
Update the look of the full screen action according to the current state of
the window.
*/
void QETMainWindow::updateFullScreenAction()
{
if (windowState() & Qt::WindowFullScreen) {
fullscreen_action_ -> setText(tr("Sortir du &mode plein écran"));
fullscreen_action_ -> setIcon(QET::Icons::FullScreenExit);
fullscreen_action_ -> setStatusTip(tr("Affiche QElectroTech en mode fenêtré", "status bar tip"));
} else {
fullscreen_action_ -> setText(tr("Passer en &mode plein écran"));
fullscreen_action_ -> setIcon(QET::Icons::FullScreenEnter);
fullscreen_action_ -> setStatusTip(tr("Affiche QElectroTech en mode plein écran", "status bar tip"));
}
ShortcutManager::instance().registerAction(fullscreen_action_, "mainwindow.fullscreen", tr("Général"), Qt::CTRL | Qt::SHIFT | Qt::Key_F);
}
/**
Check whether a sub menu dedicated to docks and toolbars can be inserted on
top of the settings menu.
*/
void QETMainWindow::checkToolbarsmenu()
{
if (display_toolbars_) return;
display_toolbars_ = createPopupMenu();
if (display_toolbars_) {
display_toolbars_ -> setTearOffEnabled(true);
display_toolbars_ -> setTitle(tr("Afficher", "menu entry"));
display_toolbars_ -> setIcon(QET::Icons::ConfigureToolbars);
settings_menu_ -> insertMenu(fullscreen_action_, display_toolbars_);
}
}
/**
Handle the \a e event.
*/
bool QETMainWindow::event(QEvent *e) {
if (e -> type() == QEvent::WindowStateChange) {
updateFullScreenAction();
} else if (first_activation_ && e -> type() == QEvent::WindowActivate) {
firstActivation(e);
first_activation_ = false;
}
return(QMainWindow::event(e));
}
/**
Base implementation of firstActivation (does nothing).
*/
void QETMainWindow::firstActivation(QEvent *) {
}
/**
Accept or refuse drag'n drop events depending on the dropped mime type;
especially, accepts only URLs to local files that we could open.
@param e le QDragEnterEvent correspondant au drag'n drop tente
*/
void QETMainWindow::dragEnterEvent(QDragEnterEvent *e) {
if (e -> mimeData() -> hasUrls()) {
if (QETApp::handledFiles(e -> mimeData() -> urls()).count()) {
e -> acceptProposedAction();
}
}
}
/**
Handle drops accepted on main windows; more specifically, open dropped files
as long as they are handled by QElectrotech.
@param e the QDropEvent describing the current drag'n drop
*/
void QETMainWindow::dropEvent(QDropEvent *e) {
if (e -> mimeData() -> hasUrls()) {
QStringList filepaths = QETApp::handledFiles(e -> mimeData() -> urls());
if (filepaths.count()) {
QETApp::instance() -> openFiles(QETArguments(filepaths));
}
}
}