Step.h

/***************************************************************************
 *   Copyright (C) 2008 by Daniel Calviño Sánchez <danxuliu@gmail.com>     *
 *   Copyright (C) 2009 by Daniel Calviño Sánchez <danxuliu@gmail.com>     *
 *   Copyright (C) 2010 by Daniel Calviño Sánchez <danxuliu@gmail.com>     *
 *   Copyright (C) 2011 by Daniel Calviño Sánchez <danxuliu@gmail.com>     *
 *   Copyright (C) 2012 by Daniel Calviño Sánchez <danxuliu@gmail.com>     *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program 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 General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; If not, see <http://www.gnu.org/licenses/>.  *
 ***************************************************************************/

#ifndef KTUTORIAL_STEP_H
#define KTUTORIAL_STEP_H

#include <QtCore/QObject>

#include "ktutorial_export.h"

namespace ktutorial {
class Option;
class WaitFor;
}

namespace ktutorial {

class KTUTORIAL_EXPORT Step: public QObject {
Q_OBJECT
public:

    explicit Step(const QString& id);

    virtual ~Step();

    QString id() const;

    QList<Option*> options() const;

    QString text() const;

    Q_INVOKABLE void setText(const QString& text);

    bool isActive() const;

    void setActive(bool active);

    Q_INVOKABLE void addOption(Option* option, QObject* receiver,
                               const QString& slot);

    Q_INVOKABLE void addOption(Option* option, const QString& nextStepId);

    Q_INVOKABLE void addWaitFor(WaitFor* waitFor, QObject* receiver,
                                const QString& slot);

    Q_INVOKABLE void addWaitFor(WaitFor* waitFor, const QString& nextStepId);

    Q_INVOKABLE void removeOption(Option* option);

    Q_INVOKABLE void removeWaitFor(WaitFor* waitFor);

Q_SIGNALS:

    void nextStepRequested(const QString& nextStepId);

protected:

    virtual void setup();

    virtual void tearDown();

    virtual void connectWaitFor(WaitFor* waitFor, QObject* receiver,
                                const QString& slot);

    virtual void disconnectWaitFor(WaitFor* waitFor);

private:

    class StepPrivate* d;

    void setupWrapper();

    void tearDownWrapper();

    bool addOption(Option* option);

    bool addWaitFor(WaitFor* waitFor);

private Q_SLOTS:

    void requestNextStepForWaitFor(WaitFor* waitFor);

};

}

#endif