action.h

Go to the documentation of this file.

#pragma once
 
#include <QAction>
 
namespace Gui
{
 
    /// \brief Small wrapper around QAction
    ///
    /// A tiny wrapper class around QAction that simply provides constructor
    /// arguments to add on-click functionality and keyboard shortcuts.
    class Action : public QAction
    {
      public:
        /// \brief Constructs the Action widget.
        /// \param parent The parent of the Action widget.
        /// \param label The label to be displayed in the action.
        /// \param onClick A function to call when the action is clicked.
        /// \param shortcut A keyboard shortcut to activate the action.
        ///
        /// Typical usage:
        /// \code{.cpp}
        /// Action* openAction = new Action(
        ///     parent, QString::fromUtf8("Open..."),
        ///     []() {
        ///         QString fileName = QFileDialog::getOpenFileName(
        ///             nullptr, QString::fromUtf8("Open Image"),
        ///             QDir::currentPath(),
        ///             QString::fromUtf8("Image Files (*.png *.jpg *.bmp)"));
        ///         qInfo() << "File: " << fileName;
        ///     },
        ///     QKeySequence::Open);
        /// \endcode
        Action(QWidget* parent, const QString& label, void (*onClick)(void),
               const QKeySequence& shortcut = QKeySequence::UnknownKey);
    };
 
} // namespace Gui