Skip to content

OpenToonz - An open-source full-featured 2D animation creation software

C

feat(shortcuts): add dynamic commands in configure shortcuts and workaround for tree persistence

Ahl76ddea8f599f18
diff --git a/toonz/sources/toonz/shortcutpopup.cpp b/toonz/sources/toonz/shortcutpopup.cpp
index 535b24828..f2494bf32 100644
--- a/toonz/sources/toonz/shortcutpopup.cpp
+++ b/toonz/sources/toonz/shortcutpopup.cpp
@@ -7,6 +7,7 @@
#include "tapp.h"
#include "tenv.h"
#include "tsystem.h"
+#include "toolpresetcommandmanager.h"
#include "toonz/toonzfolders.h"
// TnzQt includes
@@ -27,7 +28,14 @@
#include <QPushButton>
#include <QPainter>
#include <QAction>
+#include <QMap>
#include <QKeyEvent>
+
+//=============================================================================
+// Static instance pointer for ShortcutPopup
+//=============================================================================
+
+ShortcutPopup *ShortcutPopup::s_instance = nullptr;
#include <QMainWindow>
#include <QLabel>
#include <QLineEdit>
@@ -35,6 +43,7 @@
#include <QApplication>
#include <QTextStream>
#include <QGroupBox>
+#include <QSignalBlocker>
// STD includes
#include <vector>
@@ -225,7 +234,8 @@ void ShortcutViewer::leaveEvent(QEvent *event) { update(); }
// ShortcutTree
//-----------------------------------------------------------------------------
-ShortcutTree::ShortcutTree(QWidget *parent) : QTreeWidget(parent) {
+ShortcutTree::ShortcutTree(QWidget *parent)
+ : QTreeWidget(parent) {
setObjectName("ShortcutTree");
setIndentation(14);
setAlternatingRowColors(true);
@@ -254,6 +264,8 @@ ShortcutTree::ShortcutTree(QWidget *parent) : QTreeWidget(parent) {
addFolder(tr("Render"), MenuRenderCommandType, menuCommandFolder);
addFolder(tr("View"), MenuViewCommandType, menuCommandFolder);
addFolder(tr("Windows"), MenuWindowsCommandType, menuCommandFolder);
+ QTreeWidgetItem *windowsFolder = m_subFolders.back();
+ addFolder(tr("Custom Panels"), CustomPanelCommandType, windowsFolder);
addFolder(tr("Help"), MenuHelpCommandType, menuCommandFolder);
addFolder(tr("Right-click Menu Commands"), RightClickMenuCommandType);
@@ -262,18 +274,31 @@ ShortcutTree::ShortcutTree(QWidget *parent) : QTreeWidget(parent) {
addFolder(tr("Tools"), ToolCommandType);
addFolder(tr("Tool Modifiers"), ToolModifierCommandType);
+ QTreeWidgetItem *toolModifiersFolder = m_folders.back();
+ addFolder(tr("Brush Presets"), BrushPresetCommandType, toolModifiersFolder);
+ addFolder(tr("Brush Sizes"), BrushSizeCommandType, toolModifiersFolder);
addFolder(tr("Stop Motion"), StopMotionCommandType);
addFolder(tr("Visualization"), ZoomCommandType);
addFolder(tr("Misc"), MiscCommandType);
addFolder(tr("RGBA Channels"), RGBACommandType);
sortItems(0, Qt::AscendingOrder);
+
+ restoreExpandedState();
connect(
this, SIGNAL(currentItemChanged(QTreeWidgetItem *, QTreeWidgetItem *)),
this, SLOT(onCurrentItemChanged(QTreeWidgetItem *, QTreeWidgetItem *)));
connect(this, SIGNAL(clicked(const QModelIndex &)), this,
SLOT(onItemClicked(const QModelIndex &)));
+ connect(this, SIGNAL(itemCollapsed(QTreeWidgetItem *)), this,
+ SLOT(onItemCollapsed(QTreeWidgetItem *)));
+ connect(this, &QTreeWidget::itemExpanded, [this](QTreeWidgetItem *) {
+ if (m_lastSearchTerm.isEmpty()) saveExpandedState();
+ });
+ connect(this, &QTreeWidget::itemCollapsed, [this](QTreeWidgetItem *) {
+ if (m_lastSearchTerm.isEmpty()) saveExpandedState();
+ });
}
//-----------------------------------------------------------------------------
@@ -282,6 +307,174 @@ ShortcutTree::~ShortcutTree() {}
//-----------------------------------------------------------------------------
+void ShortcutTree::saveExpandedState() {
+ QSettings settings;
+ QStringList expandedFolders = collectExpandedState();
+
+ settings.setValue("ShortcutPopup/expandedFolders", expandedFolders);
+ settings.setValue("ShortcutPopup/expandedStateSaved", true);
+}
+
+//-----------------------------------------------------------------------------
+
+void ShortcutTree::restoreExpandedState() {
+ QSettings settings;
+ bool hasSavedState = settings.contains("ShortcutPopup/expandedStateSaved");
+ QStringList expandedFolders =
+ settings.value("ShortcutPopup/expandedFolders").toStringList();
+ QSignalBlocker blocker(this);
+ applyExpandedState(expandedFolders, !hasSavedState);
+}
+
+//-----------------------------------------------------------------------------
+
+QStringList ShortcutTree::collectExpandedState() const {
+ QStringList expandedFolders;
+
+ // Save expanded state for all folders
+ for (QTreeWidgetItem* folder : m_folders) {
+ if (folder && folder->isExpanded()) {
+ expandedFolders.append(folder->text(0));
+ }
+ }
+
+ // Save expanded state for all subfolders (with parent path)
+ for (QTreeWidgetItem* subfolder : m_subFolders) {
+ if (subfolder && subfolder->isExpanded() && subfolder->parent()) {
+ QString path = subfolder->parent()->text(0) + "/" + subfolder->text(0);
+ expandedFolders.append(path);
+ }
+ }
+
+ return expandedFolders;
+}
+
+//-----------------------------------------------------------------------------
+
+void ShortcutTree::applyExpandedState(const QStringList &expandedFolders,
+ bool useDefaultIfEmpty) {
+ // Restore state for top-level folders
+ for (QTreeWidgetItem* folder : m_folders) {
+ if (folder) {
+ QString folderName = folder->text(0);
+ if (!expandedFolders.isEmpty()) {
+ folder->setExpanded(expandedFolders.contains(folderName));
+ } else if (useDefaultIfEmpty) {
+ folder->setExpanded(folderName == tr("Menu Commands"));
+ }
+ }
+ }
+
+ // Restore state for subfolders
+ for (QTreeWidgetItem* subfolder : m_subFolders) {
+ if (subfolder && subfolder->parent()) {
+ QString path = subfolder->parent()->text(0) + "/" + subfolder->text(0);
+ if (!expandedFolders.isEmpty()) {
+ subfolder->setExpanded(expandedFolders.contains(path));
+ } else if (useDefaultIfEmpty) {
+ subfolder->setExpanded(false);
+ }
+ }
+ }
+}
+
+//-----------------------------------------------------------------------------
+
+void ShortcutTree::refreshTree() {
+ // === STEP 1: Save expansion state before clearing ===
+ QMap<QString, bool> expandedState;
+
+ // Save state for top-level folders
+ for (QTreeWidgetItem* folder : m_folders) {
+ if (folder) {
+ expandedState[folder->text(0)] = folder->isExpanded();
+ }
+ }
+
+ // Save state for sub-folders
+ for (QTreeWidgetItem* subfolder : m_subFolders) {
+ if (subfolder && subfolder->parent()) {
+ QString fullPath = subfolder->parent()->text(0) + "/" + subfolder->text(0);
+ expandedState[fullPath] = subfolder->isExpanded();
+ }
+ }
+
+ // === STEP 2: Clear and rebuild ===
+ m_items.clear();
+ m_folders.clear();
+ m_subFolders.clear();
+ clear();
+
+ // Rebuild the tree structure
+ QTreeWidgetItem *menuCommandFolder = new QTreeWidgetItem(this);
+ menuCommandFolder->setText(0, tr("Menu Commands"));
+ m_folders.push_back(menuCommandFolder);
+
+ addFolder(tr("Fill"), FillCommandType);
+ addFolder(tr("File"), MenuFileCommandType, menuCommandFolder);
+ addFolder(tr("Edit"), MenuEditCommandType, menuCommandFolder);
+ addFolder(tr("Scan & Cleanup"), MenuScanCleanupCommandType,
+ menuCommandFolder);
+ addFolder(tr("Level"), MenuLevelCommandType, menuCommandFolder);
+ addFolder(tr("Xsheet"), MenuXsheetCommandType, menuCommandFolder);
+ addFolder(tr("Cells"), MenuCellsCommandType, menuCommandFolder);
+ addFolder(tr("Play"), MenuPlayCommandType, menuCommandFolder);
+ addFolder(tr("Render"), MenuRenderCommandType, menuCommandFolder);
+ addFolder(tr("View"), MenuViewCommandType, menuCommandFolder);
+ addFolder(tr("Windows"), MenuWindowsCommandType, menuCommandFolder);
+ QTreeWidgetItem *windowsFolder = m_subFolders.back();
+ addFolder(tr("Custom Panels"), CustomPanelCommandType, windowsFolder);
+ addFolder(tr("Help"), MenuHelpCommandType, menuCommandFolder);
+
+ addFolder(tr("Right-click Menu Commands"), RightClickMenuCommandType);
+ QTreeWidgetItem *rcmSubFolder = m_folders.back();
+ addFolder(tr("Cell Mark"), CellMarkCommandType, rcmSubFolder);
+
+ addFolder(tr("Tools"), ToolCommandType);
+ addFolder(tr("Tool Modifiers"), ToolModifierCommandType);
+ QTreeWidgetItem *toolModifiersFolder = m_folders.back();
+ addFolder(tr("Brush Presets"), BrushPresetCommandType, toolModifiersFolder);
+ addFolder(tr("Brush Sizes"), BrushSizeCommandType, toolModifiersFolder);
+ addFolder(tr("Stop Motion"), StopMotionCommandType);
+ addFolder(tr("Visualization"), ZoomCommandType);
+ addFolder(tr("Misc"), MiscCommandType);
+ addFolder(tr("RGBA Channels"), RGBACommandType);
+
+ sortItems(0, Qt::AscendingOrder);
+
+ // === STEP 3: Restore expansion state ===
+ // Restore state for top-level folders (only if state exists)
+ for (QTreeWidgetItem* folder : m_folders) {
+ if (folder) {
+ QString folderName = folder->text(0);
+ if (expandedState.contains(folderName)) {
+ folder->setExpanded(expandedState[folderName]);
+ }
+ // No default behavior - keep folders collapsed if no state exists
+ }
+ }
+
+ // Restore state for sub-folders (only if state exists)
+ for (QTreeWidgetItem* subfolder : m_subFolders) {
+ if (subfolder && subfolder->parent()) {
+ QString fullPath = subfolder->parent()->text(0) + "/" + subfolder->text(0);
+ if (expandedState.contains(fullPath)) {
+ subfolder->setExpanded(expandedState[fullPath]);
+ }
+ // No default behavior - keep folders collapsed if no state exists
+ }
+ }
+
+ // === STEP 4: Restore search filter if one was active ===
+ if (!m_lastSearchTerm.isEmpty()) {
+ searchItems(m_lastSearchTerm);
+ }
+
+ update();
+}
+
+//-----------------------------------------------------------------------------
+
void ShortcutTree::addFolder(const QString &title, int commandType,
QTreeWidgetItem *parentFolder) {
QTreeWidgetItem *folder;
@@ -306,24 +499,77 @@ void ShortcutTree::addFolder(const QString &title, int commandType,
//-----------------------------------------------------------------------------
void ShortcutTree::searchItems(const QString &searchWord) {
+ m_lastSearchTerm = searchWord;
+
if (searchWord.isEmpty()) {
+ // Reset: show all items
for (int i = 0; i < (int)m_items.size(); i++) m_items[i]->setHidden(false);
for (int f = 0; f < m_subFolders.size(); f++) {
m_subFolders[f]->setHidden(false);
- m_subFolders[f]->setExpanded(false);
+ m_subFolders[f]->setExpanded(false); // Close all subfolders
}
for (int f = 0; f < m_folders.size(); f++) {
m_folders[f]->setHidden(false);
- m_folders[f]->setExpanded(f == 0);
+ // Open only "Menu Commands"
+ m_folders[f]->setExpanded(m_folders[f]->text(0) == tr("Menu Commands"));
}
+
+ // Clear user collapse tracking
+ m_userCollapsedDuringSearch.clear();
+
show();
emit searched(true);
update();
return;
}
+
+ // Starting a new search: clear user collapse tracking
+ if (m_lastSearchTerm.isEmpty()) {
+ m_userCollapsedDuringSearch.clear();
+ }
- QList<QTreeWidgetItem *> foundItems =
- findItems(searchWord, Qt::MatchContains | Qt::MatchRecursive, 0);
+ // Multi-word search: split search term by spaces and match all words
+ QStringList searchWords = searchWord.split(' ', Qt::SkipEmptyParts);
+ QList<QTreeWidgetItem *> foundItems;
+
+ if (searchWords.isEmpty()) {
+ // No valid search words after splitting
+ hide();
+ emit searched(false);
+ update();
+ return;
+ }
+
+ // Find items that contain ALL search words (case-insensitive)
+ // Search in item name AND parent folder names
+ for (int i = 0; i < (int)m_items.size(); i++) {
+ QTreeWidgetItem *item = m_items[i];
+ QString itemText = item->text(0); // Get item name
+
+ // Build full search text: item name + parent folder name + grandparent folder name
+ QString fullSearchText = itemText;
+ QTreeWidgetItem *parent = item->parent();
+ if (parent) {
+ fullSearchText += " " + parent->text(0);
+ QTreeWidgetItem *grandparent = parent->parent();
+ if (grandparent) {
+ fullSearchText += " " + grandparent->text(0);
+ }
+ }
+
+ bool matchesAllWords = true;
+ for (const QString &word : searchWords) {
+ if (!fullSearchText.contains(word, Qt::CaseInsensitive)) {
+ matchesAllWords = false;
+ break;
+ }
+ }
+
+ if (matchesAllWords) {
+ foundItems.append(item);
+ }
+ }
+
if (foundItems.isEmpty()) {
hide();
emit searched(false);
@@ -336,7 +582,7 @@ void ShortcutTree::searchItems(const QString &searchWord) {
m_items[i]->setHidden(!foundItems.contains(m_items[i]));
// hide folders which does not contain matched items
- // show and expand folders containing matched items
+ // show AND expand folders containing matched items (unless user manually closed them)
bool found;
for (int f = 0; f < m_subFolders.size(); f++) {
QTreeWidgetItem *sf = m_subFolders.at(f);
@@ -348,7 +594,14 @@ void ShortcutTree::searchItems(const QString &searchWord) {
}
}
sf->setHidden(!found);
- sf->setExpanded(found);
+
+ // Expand only if: has results AND user hasn't manually closed it
+ if (found) {
+ QString path = sf->parent() ? sf->parent()->text(0) + "/" + sf->text(0) : sf->text(0);
+ if (!m_userCollapsedDuringSearch.contains(path)) {
+ sf->setExpanded(true);
+ }
+ }
}
for (int f = 0; f < m_folders.size(); f++) {
QTreeWidgetItem *fol = m_folders.at(f);
@@ -360,7 +613,14 @@ void ShortcutTree::searchItems(const QString &searchWord) {
}
}
fol->setHidden(!found);
- fol->setExpanded(found);
+
+ // Expand only if: has results AND user hasn't manually closed it
+ if (found) {
+ QString folderName = fol->text(0);
+ if (!m_userCollapsedDuringSearch.contains(folderName)) {
+ fol->setExpanded(true);
+ }
+ }
}
show();
@@ -389,12 +649,31 @@ void ShortcutTree::onItemClicked(const QModelIndex &index) {
isExpanded(index) ? collapse(index) : expand(index);
}
+//-----------------------------------------------------------------------------
+
+void ShortcutTree::onItemCollapsed(QTreeWidgetItem *item) {
+ // If search is active and user manually collapses a folder, remember it
+ if (!m_lastSearchTerm.isEmpty()) {
+ // Determine the path for this item
+ QString path;
+ if (item->parent()) {
+ path = item->parent()->text(0) + "/" + item->text(0);
+ } else {
+ path = item->text(0);
+ }
+ m_userCollapsedDuringSearch.insert(path);
+ }
+}
+
//=============================================================================
// ShortcutPopup
//-----------------------------------------------------------------------------
ShortcutPopup::ShortcutPopup()
: Dialog(TApp::instance()->getMainWindow(), false, false, "Shortcut") {
+ // Register this instance
+ s_instance = this;
+
setWindowTitle(tr("Configure Shortcuts"));
m_presetChoiceCB = new QComboBox(this);
buildPresets();
@@ -428,7 +707,7 @@ ShortcutPopup::ShortcutPopup()
new QLabel(tr("Couldn't find any matching command."), this);
noSearchResultLabel->setHidden(true);
- QLineEdit *searchEdit = new QLineEdit(this);
+ m_searchEdit = new QLineEdit(this);
m_topLayout->setContentsMargins(5, 5, 5, 5);
m_topLayout->setSpacing(8);
@@ -438,7 +717,7 @@ ShortcutPopup::ShortcutPopup()
searchLay->setSpacing(5);
{
searchLay->addWidget(new QLabel(tr("Search:"), this), 0);
- searchLay->addWidget(searchEdit);
+ searchLay->addWidget(m_searchEdit);
}
m_topLayout->addLayout(searchLay, 0);
@@ -495,7 +774,7 @@ ShortcutPopup::ShortcutPopup()
connect(m_list, SIGNAL(searched(bool)), noSearchResultLabel,
SLOT(setHidden(bool)));
- connect(searchEdit, SIGNAL(textChanged(const QString &)), this,
+ connect(m_searchEdit, SIGNAL(textChanged(const QString &)), this,
SLOT(onSearchTextChanged(const QString &)));
connect(m_presetChoiceCB, SIGNAL(currentIndexChanged(int)),
SLOT(onPresetChanged()));
@@ -509,7 +788,27 @@ ShortcutPopup::ShortcutPopup()
//-----------------------------------------------------------------------------
-ShortcutPopup::~ShortcutPopup() {}
+ShortcutPopup::~ShortcutPopup() {
+ // Save tree expansion state before closing
+ if (m_list) {
+ m_list->saveExpandedState();
+ }
+
+ // Unregister this instance
+ if (s_instance == this) {
+ s_instance = nullptr;
+ }
+}
+
+//-----------------------------------------------------------------------------
+
+void ShortcutPopup::refreshIfOpen() {
+ // If the popup is currently open, refresh its tree to show new commands
+ if (s_instance && s_instance->m_list) {
+ s_instance->m_list->refreshTree();
+ }
+ // Note: The tree preserves expansion state and search filter automatically
+}
//-----------------------------------------------------------------------------
@@ -802,7 +1101,64 @@ void ShortcutPopup::onSavePreset() {
//-----------------------------------------------------------------------------
-void ShortcutPopup::showEvent(QShowEvent *se) { getCurrentPresetPref(); }
+void ShortcutPopup::showEvent(QShowEvent *se) {
+ getCurrentPresetPref();
+
+ // Refresh brush preset and size commands to ensure they're up-to-date
+ ToolPresetCommandManager::instance()->refreshPresetCommands();
+ ToolPresetCommandManager::instance()->refreshSizeCommands();
+
+ // Restore search term from QSettings
+ QSettings settings;
+ QString lastSearchTerm = settings.value("ShortcutPopup/searchText", "").toString();
+
+ // Step 1: Restore search text in the field WITHOUT triggering searchItems
+ {
+ QSignalBlocker blocker(m_searchEdit);
+ m_searchEdit->setText(lastSearchTerm);
+ }
+
+ // Step 2: Restore folder expansion state from QSettings
+ m_list->restoreExpandedState();
+
+ // Step 3: If there was a search, apply filtering WITHOUT changing expansion
+ if (!lastSearchTerm.isEmpty()) {
+ // Save current expansion state before filtering
+ QStringList expandedBeforeFilter;
+ for (int i = 0; i < m_list->topLevelItemCount(); i++) {
+ QTreeWidgetItem* item = m_list->topLevelItem(i);
+ if (item && item->isExpanded()) {
+ expandedBeforeFilter.append(item->text(0));
+ }
+ }
+
+ // Apply search filter (this will change expansion)
+ m_list->searchItems(lastSearchTerm);
+
+ // Restore the expansion state we had before filtering
+ for (int i = 0; i < m_list->topLevelItemCount(); i++) {
+ QTreeWidgetItem* item = m_list->topLevelItem(i);
+ if (item) {
+ item->setExpanded(expandedBeforeFilter.contains(item->text(0)));
+ }
+ }
+ }
+}
+
+//-----------------------------------------------------------------------------
+
+void ShortcutPopup::hideEvent(QHideEvent *he) {
+ // Save tree expansion state when hiding the popup
+ if (m_list) {
+ m_list->saveExpandedState();
+ }
+
+ // Save search text to QSettings
+ QSettings settings;
+ settings.setValue("ShortcutPopup/searchText", m_searchEdit->text());
+
+ DVGui::Dialog::hideEvent(he);
+}
//-----------------------------------------------------------------------------
diff --git a/toonz/sources/toonz/shortcutpopup.h b/toonz/sources/toonz/shortcutpopup.h
index 29fce429f..1342240e3 100644
--- a/toonz/sources/toonz/shortcutpopup.h
+++ b/toonz/sources/toonz/shortcutpopup.h
@@ -58,25 +58,33 @@ class ShortcutTree final : public QTreeWidget {
std::vector<ShortcutItem *> m_items;
std::vector<QTreeWidgetItem *> m_folders;
std::vector<QTreeWidgetItem *> m_subFolders;
+ QString m_lastSearchTerm;
+ QSet<QString> m_userCollapsedDuringSearch; // Track folders user manually closed during search
public:
ShortcutTree(QWidget *parent = 0);
~ShortcutTree();
void searchItems(const QString &searchWord = QString());
+ void refreshTree(); // Rebuild the entire tree from CommandManager
+ void saveExpandedState(); // Save expansion state to QSettings
+ void restoreExpandedState(); // Restore expansion state from QSettings
protected:
// aggiunge un blocco di QAction. commandType e' un
// CommandType::MenubarCommandType
void addFolder(const QString &title, int commandType,
QTreeWidgetItem *folder = 0);
+ QStringList collectExpandedState() const;
+ void applyExpandedState(const QStringList &expandedFolders,
+ bool useDefaultIfEmpty);
public slots:
void onCurrentItemChanged(QTreeWidgetItem *current,
QTreeWidgetItem *previous);
void onShortcutChanged();
-
void onItemClicked(const QModelIndex &);
+ void onItemCollapsed(QTreeWidgetItem *item);
signals:
void actionSelected(QAction *);
@@ -91,10 +99,15 @@ signals:
class ShortcutPopup final : public DVGui::Dialog {
Q_OBJECT
+
+ // Static instance pointer to allow refresh from external code
+ static ShortcutPopup *s_instance;
+
QPushButton *m_removeBtn;
ShortcutViewer *m_sViewer;
ShortcutTree *m_list;
QComboBox *m_presetChoiceCB;
+ QLineEdit *m_searchEdit; // Store search field to preserve state
DVGui::Dialog *m_dialog;
GenericLoadFilePopup *m_loadShortcutsPopup;
GenericSaveFilePopup *m_saveShortcutsPopup;
@@ -108,6 +121,9 @@ class ShortcutPopup final : public DVGui::Dialog {
public:
ShortcutPopup();
~ShortcutPopup();
+
+ // Static method to refresh the popup if it's currently open
+ static void refreshIfOpen();
private:
void setPresetShortcuts(TFilePath fp);
@@ -117,6 +133,7 @@ private:
void importPreset();
void buildPresets();
void showEvent(QShowEvent *se) override;
+ void hideEvent(QHideEvent *he) override;
void setCurrentPresetPref(QString preset);
void getCurrentPresetPref();