SelectionZoneAction.h
63 lines
| 1.9 KiB
| text/x-c
|
CLexer
r1111 | #ifndef SCIQLOP_SELECTIONZONEACTION_H | |||
#define SCIQLOP_SELECTIONZONEACTION_H | ||||
#include <Common/spimpl.h> | ||||
#include <QLoggingCategory> | ||||
#include <QObject> | ||||
#include <functional> | ||||
class VisualizationSelectionZoneItem; | ||||
Q_DECLARE_LOGGING_CATEGORY(LOG_SelectionZoneAction) | ||||
/** | ||||
* @brief The SelectionZoneAction class represents an action on a selection zone in the | ||||
* visualization. | ||||
* | ||||
* The action is a function that will be executed when the slot execute() is called. | ||||
*/ | ||||
class SelectionZoneAction : public QObject { | ||||
Q_OBJECT | ||||
public: | ||||
/// Signature of the function associated to the action | ||||
using ExecuteFunction | ||||
= std::function<void(const QVector<VisualizationSelectionZoneItem *> &item)>; | ||||
r1115 | using EnableFunction | |||
= std::function<bool(const QVector<VisualizationSelectionZoneItem *> &item)>; | ||||
r1111 | /** | |||
* @param name the name of the action, displayed to the user | ||||
* @param fun the function that will be called when the action is executed | ||||
* @sa execute() | ||||
*/ | ||||
explicit SelectionZoneAction(const QString &name, ExecuteFunction fun); | ||||
r1115 | /// Sets the function which determine if the action should be enabled or disabled | |||
void setEnableFunction(EnableFunction fun); | ||||
r1117 | /// Sets the shortcut displayed by the action. | |||
/// Note: The shortcut is only displayed and not active because it is not permanently stored | ||||
void setDisplayedShortcut(const QKeySequence &shortcut); | ||||
QKeySequence displayedShortcut() const; | ||||
r1111 | /// The name of the action | |||
QString name() const noexcept; | ||||
public slots: | ||||
/// Executes the action | ||||
void execute(const QVector<VisualizationSelectionZoneItem *> &item); | ||||
r1115 | /// Returns true if the action is enabled | |||
bool isEnabled(const QVector<VisualizationSelectionZoneItem *> &item); | ||||
r1111 | private: | |||
class SelectionZoneActionPrivate; | ||||
spimpl::unique_impl_ptr<SelectionZoneActionPrivate> impl; | ||||
}; | ||||
#endif // SCIQLOP_SELECTIONZONEACTION_H | ||||