iassistant.h

Go to the documentation of this file.

/*
   Copyright 2009 David Nolden <[email protected]>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.

   This library 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/

#ifndef KDEVPLATFORM_IASSISTANT_H
#define KDEVPLATFORM_IASSISTANT_H

#include <QIcon>
#include <QExplicitlySharedDataPointer>
#include "interfacesexport.h"
#include <util/ksharedobject.h>

class QAction;

namespace KDevelop {

class KDEVPLATFORMINTERFACES_EXPORT IAssistantAction : public QObject, public KSharedObject
{
    Q_OBJECT
public:
    IAssistantAction();

    using Ptr = QExplicitlySharedDataPointer<IAssistantAction>;

    ~IAssistantAction() override;

    virtual QAction* toQAction(QObject* parent = nullptr) const;

    virtual QString description() const = 0;
    virtual QString toolTip() const;
    virtual QIcon icon() const;

public Q_SLOTS:
    virtual void execute() = 0;

Q_SIGNALS:
    void executed(IAssistantAction* action);
};

class KDEVPLATFORMINTERFACES_EXPORT AssistantLabelAction : public IAssistantAction
{
    Q_OBJECT
public:
    explicit AssistantLabelAction(const QString& description);
    QString description() const override;
    void execute() override;
    QAction* toQAction(QObject* parent = nullptr) const override;

private:
    QString m_description;
};

class KDEVPLATFORMINTERFACES_EXPORT IAssistant : public QObject, public KSharedObject
{
    Q_OBJECT
public:
    IAssistant();
    ~IAssistant() override;

    using Ptr = QExplicitlySharedDataPointer<IAssistant>;

    QList<IAssistantAction::Ptr> actions() const;

    virtual void createActions();

    virtual void addAction(const IAssistantAction::Ptr& action);

    virtual void clearActions();

    virtual QIcon icon() const;

    virtual QString title() const;
public Q_SLOTS:
    virtual void doHide();
Q_SIGNALS:
    void hide();
    void actionsChanged();
private:
    QList<IAssistantAction::Ptr> m_actions;
};

}

#endif // KDEVPLATFORM_IASSISTANT_H