HotPlugActionExtension.h

Go to the documentation of this file.

/*****************************************************************************
 * $CAMITK_LICENCE_BEGIN$
 *
 * CamiTK - Computer Assisted Medical Intervention ToolKit
 * (c) 2001-2025 Univ. Grenoble Alpes, CNRS, Grenoble INP - UGA, TIMC, 38000 Grenoble, France
 *
 * Visit http://camitk.imag.fr for more information
 *
 * This file is part of CamiTK.
 *
 * CamiTK is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * CamiTK is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with CamiTK.  If not, see <http://www.gnu.org/licenses/>.
 *
 * $CAMITK_LICENCE_END$
 ****************************************************************************/
 
#ifndef __HOTPLUG_ACTION_EXTENSION__
#define __HOTPLUG_ACTION_EXTENSION__
 
#include "ActionExtension.h"
 
class VariantDataModel;
 
namespace camitk {
 
class HotPlugAction;

class CAMITK_API HotPlugActionExtension : public ActionExtension {
    Q_OBJECT
 
protected:
    HotPlugActionExtension(const QString& camitkFilePath);
 
public:
    static HotPlugActionExtension* newHotPlugActionExtension(const QString& camitkFilePath, bool forceVerifyOrRebuild);

    ~HotPlugActionExtension() override;

    virtual QString getName() const override;

    virtual QString getDescription() const override;

    virtual QString getProgrammingLanguage() const = 0;

    virtual void init() override;

    virtual bool initActions(int progressMinimum = 0, int progressMaximum = 100) = 0;

    virtual int declaredActionCount() const;

    // used to get the state of init at any time.
    // For instance this is used to show a specific icon beside the registered extension name
    // Dev menu in imp for instance uses it to show a QStyle::SP_DialogApplyButton (a tick mark)
    // when all actions are correctly loaded, and QStyle::SP_DialogCancelButton (a noway sign)
    // when some actions failed
    bool isSuccessfullyLoaded();
 
protected:
    QString name;

    QString description;

    bool successfullyLoaded;
};
 
} // namespace camitk
 
#endif // __HOTPLUG_ACTION_EXTENSION__