File indexing completed on 2025-02-02 04:56:52

 /***************************************************************************
  * SPDX-FileCopyrightText: 2022 S. MANKOWSKI stephane@mankowski.fr
  * SPDX-FileCopyrightText: 2022 G. DE BURE support@mankowski.fr
  * SPDX-License-Identifier: GPL-3.0-or-later
  ***************************************************************************/
 #ifndef SKGADVICEPLUGIN_H
 #define SKGADVICEPLUGIN_H
 /** @file
  * A plugin to advice.
  *
  * @author Stephane MANKOWSKI
  */
 #include <qvariant.h>
 
 #include "skginterfaceplugin.h"
 
 
 /**
  * A plugin to advice
  */
 class SKGAdvicePlugin : public SKGInterfacePlugin
 {
     Q_OBJECT
     Q_INTERFACES(SKGInterfacePlugin)
 
 public:
     /**
      * Default Constructor
      */
     explicit SKGAdvicePlugin(QWidget* iWidget, QObject* iParent, const QVariantList& iArg);
 
     /**
      * Default Destructor
      */
     ~SKGAdvicePlugin() override;
 
     /**
      * Called to initialise the plugin
      * @param iDocument the main document
      * @return true if the plugin is compatible with the document
      */
     bool setupActions(SKGDocument* iDocument) override;
 
     /**
      * The number of dashboard widgets of the plugin.
      * @return The number of dashboard widgets of the plugin
      */
     int getNbDashboardWidgets() override;
 
     /**
      * Get a dashboard widget title of the plugin.
      * @param iIndex the index of the widget
      * @return The title
      */
     QString getDashboardWidgetTitle(int iIndex) override;
 
     /**
      * Get a dashboard widget of the plugin.
      * @param iIndex the index of the widget
      * @return The dashboard widget of the plugin
      */
     SKGBoardWidget* getDashboardWidget(int iIndex) override;
 
     /**
      * The title of the plugin.
      * @return The title of the plugin
      */
     QString title() const override;
 
     /**
      * The icon of the plugin.
      * @return The icon of the plugin
      */
     QString icon() const override;
 
     /**
      * The toolTip of the plugin.
      * @return The toolTip of the plugin
      */
     QString toolTip() const override;
 
     /**
      * The tips list of the plugin.
      * @return The tips list of the plugin
      */
     QStringList tips() const override;
 
     /**
      * Must be implemented to set the position of the plugin.
      * @return integer value between 0 and 999 (default = 999)
      */
     int getOrder() const override;
 
 private Q_SLOTS:
 
 private:
     Q_DISABLE_COPY(SKGAdvicePlugin)
 
     SKGDocument* currentDocument;
 };
 
 #endif  // SKGADVICEPLUGIN_H