GIT_REPOSITORIES/LPP/Users/mperrinel/SCIQLOP-Initialisation Files · core/include/DataSource/DataSourceItemAction.h

Merge branch 'feature/DownloadWhenTolIsOutsideCache' into develop

perrinel - - Load All Authors

File last commit:

r400:fc95d1db826f


                r405:632636b095ab

Download file

             DataSourceItemAction.h
        
                    50 lines
            
             | 1.2 KiB
            
                | text/x-c
            
             |
                CLexer
            
             / core / include / DataSource / DataSourceItemAction.h
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      #ifndef SCIQLOP_DATASOURCEITEMACTION_H

      #define SCIQLOP_DATASOURCEITEMACTION_H

      #include <Common/spimpl.h>

      #include <QLoggingCategory>

      #include <QObject>

      #include <functional>

      Q_DECLARE_LOGGING_CATEGORY(LOG_DataSourceItemAction)

      class DataSourceItem;

      /**

       * @brief The DataSourceItemAction class represents an action on a data source item.

       *

       * An action is a function that will be executed when the slot execute() is called.

       */

      class DataSourceItemAction : public QObject {

          Q_OBJECT

      public:

          /// Signature of the function associated to the action

          using ExecuteFunction = std::function<void(DataSourceItem &dataSourceItem)>;

          /**

           * Ctor

           * @param name the name of the action

           * @param fun the function that will be called when the action is executed

           * @sa execute()

           */

          explicit DataSourceItemAction(const QString &name, ExecuteFunction fun);

          QString name() const noexcept;

          /// Sets the data source item concerned by the action

          void setDataSourceItem(DataSourceItem *dataSourceItem) noexcept;

      public slots:

          /// Executes the action

          void execute();

      private:

          class DataSourceItemActionPrivate;

          spimpl::unique_impl_ptr<DataSourceItemActionPrivate> impl;

      };

      #endif // SCIQLOP_DATASOURCEITEMACTION_H

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

				#ifndef SCIQLOP_DATASOURCEITEMACTION_H
				#define SCIQLOP_DATASOURCEITEMACTION_H

				#include <Common/spimpl.h>

				#include <QLoggingCategory>
				#include <QObject>

				#include <functional>

				Q_DECLARE_LOGGING_CATEGORY(LOG_DataSourceItemAction)

				class DataSourceItem;

				/**
				* @brief The DataSourceItemAction class represents an action on a data source item.
				*
				* An action is a function that will be executed when the slot execute() is called.
				*/
				class DataSourceItemAction : public QObject {

				Q_OBJECT

				public:
				/// Signature of the function associated to the action
				using ExecuteFunction = std::function<void(DataSourceItem &dataSourceItem)>;

				/**
				* Ctor
				* @param name the name of the action
				* @param fun the function that will be called when the action is executed
				* @sa execute()
				*/
				explicit DataSourceItemAction(const QString &name, ExecuteFunction fun);

				QString name() const noexcept;

				/// Sets the data source item concerned by the action
				void setDataSourceItem(DataSourceItem *dataSourceItem) noexcept;

				public slots:
				/// Executes the action
				void execute();

				private:
				class DataSourceItemActionPrivate;
				spimpl::unique_impl_ptr<DataSourceItemActionPrivate> impl;
				};

				#endif // SCIQLOP_DATASOURCEITEMACTION_H