Add ActionsWidget and ActionsFilterModel for action management

Introduces ActionsWidget and ActionsFilterModel to provide a categorized, searchable UI for managing actions. Updates CMakeLists.txt to include new sources and integrates ActionsWidget into ExampleActionsPlugin. The new components support recursive filtering and dynamic detail views for actions.

Author: ThomasKroes

ExampleActions/CMakeLists.txt

@@ -40,6 +40,10 @@ add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/../Common ${CMAKE_CURRENT_BINARY_DI
 set(PLUGIN_SOURCES
     src/ExampleActionsPlugin.h
     src/ExampleActionsPlugin.cpp
+	src/ActionsWidget.h
+	src/ActionsWidget.cpp
+	src/ActionsFilterModel.h
+	src/ActionsFilterModel.cpp
     PluginInfo.json
 )
 

ExampleActions/src/ActionsFilterModel.cpp

@@ -0,0 +1,53 @@
+#include "ActionsFilterModel.h"
+
+ActionsFilterModel::ActionsFilterModel(QObject* parent) :
+    QSortFilterProxyModel(parent)
+{
+}
+
+void ActionsFilterModel::setSearchRoles(QVector<int> roles)
+{
+	searchRoles = std::move(roles);
+}
+
+bool ActionsFilterModel::filterAcceptsRow(int sourceRow, const QModelIndex& sourceParent) const
+{
+    const QModelIndex idx = sourceModel()->index(sourceRow, 0, sourceParent);
+
+    if (!idx.isValid())
+        return false;
+
+    if (rowMatches(idx))
+        return true;
+
+    const auto childCount = sourceModel()->rowCount(idx);
+
+    for (int i = 0; i < childCount; ++i)
+    {
+        if (filterAcceptsRow(i, idx))
+            return true;
+    }
+
+    return false;
+}
+
+bool ActionsFilterModel::rowMatches(const QModelIndex& idx) const
+{
+    const auto re = filterRegularExpression();
+    if (!re.isValid() || re.pattern().isEmpty())
+        return true;
+
+    // Always include DisplayRole at minimum
+    const QString display = sourceModel()->data(idx, Qt::DisplayRole).toString();
+    if (display.contains(re))
+        return true;
+
+    for (int r : searchRoles) {
+        const auto string = sourceModel()->data(idx, r).toString();
+
+    	if (!string.isEmpty() && string.contains(re))
+            return true;
+    }
+
+    return false;
+}

ExampleActions/src/ActionsFilterModel.h

@@ -0,0 +1,47 @@
+#pragma once
+
+#include <QSortFilterProxyModel>
+#include <QVector>
+
+/**
+ * A QSortFilterProxyModel that filters recursively through all child items.
+ * 
+ * @author Thomas Kroes
+*/
+class ActionsFilterModel final : public QSortFilterProxyModel
+{
+    Q_OBJECT
+public:
+
+    /**
+     * Construct with optional parent.
+     * @param parent The parent QObject.
+     */
+    explicit ActionsFilterModel(QObject* parent = nullptr);
+
+    // Optional: include tooltips and ids in matching.
+    void setSearchRoles(QVector<int> roles);
+
+protected:
+
+    /**
+     * Reimplemented to filter recursively.
+     * @param sourceRow The row in the source model.
+     * @param sourceParent The parent index in the source model.
+     * @return True if the row should be included in the filtered model.
+     */
+    bool filterAcceptsRow(int sourceRow, const QModelIndex& sourceParent) const override;
+
+private:
+
+    /**
+     * Check if a row matches the current filter.
+     * @param idx The index of the row to check.
+     * @return True if the row matches the filter, false otherwise.
+     */
+    bool rowMatches(const QModelIndex& idx) const;
+
+
+private:
+    QVector<int> searchRoles;       /** The roles to search in. */
+};

ExampleActions/src/ActionsWidget.cpp

@@ -0,0 +1,138 @@
+#include "ActionsWidget.h"
+
+ActionsWidget::ActionsWidget(QWidget* parent):
+	QWidget(parent),
+    _model(this),
+	_proxy(this),
+	_splitter(Qt::Horizontal, this)
+{
+	_proxy.setSourceModel(&_model);
+	_proxy.setFilterCaseSensitivity(Qt::CaseInsensitive);
+	_proxy.setSearchRoles({Qt::ToolTipRole, Roles::ActionId});
+
+    _mainLayout.addWidget(&_splitter);
+
+    setLayout(&_mainLayout);
+
+    _leftPanelWidget.setLayout(&_leftPanelLayout);
+    _rightPanelWidget.setLayout(&_rightPanelLayout);
+
+    _splitter.addWidget(&_leftPanelWidget);
+    _splitter.addWidget(&_rightPanelWidget);
+
+    _splitter.setStretchFactor(0, 0);
+    _splitter.setStretchFactor(1, 1);
+
+    _splitter.setSizes({ 320, 680 });
+
+    _leftPanelLayout.addWidget(&_search);
+    _leftPanelLayout.addWidget(&_tree);
+
+    _rightPanelLayout.addWidget(&_detailsArea);
+
+	_search.setPlaceholderText("Search actions");
+
+	_tree.setModel(&_proxy);
+	_tree.setHeaderHidden(true);
+	_tree.setUniformRowHeights(true);
+	_tree.setEditTriggers(QAbstractItemView::NoEditTriggers);
+	_tree.setSelectionMode(QAbstractItemView::SingleSelection);
+	_tree.setSelectionBehavior(QAbstractItemView::SelectRows);
+	_tree.header()->setStretchLastSection(true);
+	
+	_detailsLayout.setContentsMargins(0, 0, 0, 0);
+
+	_detailsArea.setWidgetResizable(true);
+	_detailsArea.setWidget(&_detailsHost);
+
+	connect(&_search, &QLineEdit::textChanged, this, [this](const QString& text) {
+		_proxy.setFilterRegularExpression(QRegularExpression(QRegularExpression::escape(text), QRegularExpression::CaseInsensitiveOption));
+
+		// UX: when searching, expand all; when empty, collapse to top-level
+		if (!text.isEmpty())
+			_tree.expandAll();
+		else
+			_tree.collapseAll();
+	});
+
+	connect(_tree.selectionModel(), &QItemSelectionModel::currentChanged, this, &ActionsWidget::onCurrentChanged);
+}
+
+void ActionsWidget::addAction(const QString& category, const QString& text, const QString& actionId, Factory factory, const QIcon& icon, const QString& toolTip)
+{
+	const auto cat = category.trimmed().isEmpty() ? QStringLiteral("Uncategorized") : category.trimmed();
+
+	auto categoryItem = ensureCategory(cat);
+
+	auto actionItem = new QStandardItem(icon, text);
+
+	actionItem->setToolTip(toolTip);
+	actionItem->setData(ActionNode, Roles::NodeType);
+	actionItem->setData(actionId, Roles::ActionId);
+
+	categoryItem->appendRow(actionItem);
+
+	_factories.insert(actionId, std::move(factory));
+}
+
+void ActionsWidget::onCurrentChanged(const QModelIndex& current, const QModelIndex& previous)
+{
+	clearDetails();
+
+	if (!current.isValid())
+		return;
+
+	const auto sourceIndex = _proxy.mapToSource(current);
+
+    auto item = _model.itemFromIndex(sourceIndex);
+
+	if (!item)
+		return;
+
+	const auto type = item->data(Roles::NodeType).toInt();
+
+	if (type != ActionNode)
+		return; // category selected: leave details empty (or show placeholder)
+
+	const auto actionId = item->data(Roles::ActionId).toString();
+
+	auto it = _factories.find(actionId);
+
+	if (it == _factories.end())
+		return;
+
+	auto actionWidget = it.value()(&_detailsHost);
+
+	if (!actionWidget)
+		return;
+
+	_detailsLayout.addWidget(actionWidget);
+	_detailsLayout.addStretch(1);
+}
+
+QStandardItem* ActionsWidget::ensureCategory(const QString& category)
+{
+	if (auto it = _categories.find(category); it != _categories.end())
+		return it.value();
+
+	auto catItem = new QStandardItem(category);
+
+	catItem->setData(CategoryNode, Roles::NodeType);
+	catItem->setSelectable(true);
+
+	_model.appendRow(catItem);
+	_categories.insert(category, catItem);
+
+	return catItem;
+}
+
+void ActionsWidget::clearDetails()
+{
+	while (auto child = _detailsLayout.takeAt(0))
+	{
+		if (auto actionWidget = child->widget())
+			actionWidget->deleteLater();
+
+		delete child;
+	}
+}

ExampleActions/src/ActionsWidget.h

@@ -0,0 +1,89 @@
+#pragma once
+
+#include "ActionsFilterModel.h"
+
+#include <QApplication>
+#include <QHash>
+#include <QHeaderView>
+#include <QLineEdit>
+#include <QScrollArea>
+#include <QSplitter>
+#include <QStandardItemModel>
+#include <QTreeView>
+#include <QVBoxLayout>
+#include <QWidget>
+
+#include <functional>
+
+/* Custom roles for action items */
+namespace Roles {
+    static constexpr int NodeType = Qt::UserRole + 1;  // int
+    static constexpr int ActionId = Qt::UserRole + 2;  // QString
+}
+
+/* Node types for items in the model */
+enum NodeType { CategoryNode = 0, ActionNode = 1 };
+
+/* Factory function type for creating detail widgets */
+using Factory = std::function<QWidget*(QWidget* parent)>;
+
+class ActionsWidget final : public QWidget
+{
+    Q_OBJECT
+public:
+
+    /**
+     * Construct with optional parent.
+     * @param parent The parent QWidget.
+     */
+    explicit ActionsWidget(QWidget* parent = nullptr);
+
+    /**
+     * Add an action to the widget.
+     * @param category The category of the action.
+     * @param text The display text of the action.
+     * @param actionId The unique identifier of the action.
+     * @param factory The factory function to create the detail widget.
+     * @param icon The optional icon for the action.
+     * @param toolTip The optional tooltip for the action.
+     */
+    void addAction(const QString& category, const QString& text, const QString& actionId, Factory factory, const QIcon& icon = {}, const QString& toolTip = {});
+
+private slots:
+
+    /**
+     * Slot called when the current selection changes in the tree view.
+     * @param current The new current index.
+     * @param previous The previous current index (unused).
+     */
+    void onCurrentChanged(const QModelIndex& current, const QModelIndex& previous);
+
+private:
+
+    /*
+     * Ensure that a category item exists in the model
+     * @param category The category name
+     * @return The QStandardItem representing the category
+     */
+    QStandardItem* ensureCategory(const QString& category);
+
+    /** Clear the details area  */
+    void clearDetails();
+
+private:
+    QStandardItemModel              _model;             /** The underlying model */
+    ActionsFilterModel              _proxy;             /** The filter proxy model */
+    QVBoxLayout                     _mainLayout;        /** The main layout */
+    QSplitter                       _splitter;          /** The main splitter */
+    QWidget                         _leftPanelWidget;   /** The left panel widget */
+    QVBoxLayout                     _leftPanelLayout;   /** The left panel layout */
+    QWidget                         _rightPanelWidget;  /** The right panel widget */
+    QVBoxLayout                     _rightPanelLayout;  /** The right panel layout */
+    QLineEdit                       _search;            /** The search box */
+    QTreeView                       _tree;              /** The tree view */
+    QScrollArea                     _detailsArea;       /** The details scroll area */
+    QWidget                         _detailsHost;       /** The details host widget */
+    QVBoxLayout                     _detailsLayout;     /** The details layout */
+    QHash<QString, QStandardItem*>  _categories;        /** The category items */
+    QHash<QString, Factory>         _factories;         /** The action detail widget factories */
+};

ExampleActions/src/ExampleActionsPlugin.cpp

@@ -1,4 +1,5 @@
 #include "ExampleActionsPlugin.h"
+#include "ActionsWidget.h"
 
 #include "../Common/common.h"
 
@@ -15,10 +16,12 @@ ExampleActionsPlugin::ExampleActionsPlugin(const PluginFactory* factory) :
 
 void ExampleActionsPlugin::init()
 {
-    // Create layout
     auto layout = new QVBoxLayout();
 
     layout->setContentsMargins(0, 0, 0, 0);
+    layout->addWidget(new ActionsWidget());
+
+    getWidget().setLayout(layout);
 }
 
 ExampleActionsPluginFactory::ExampleActionsPluginFactory()