KTutorial.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_KTUTORIAL_H
#define KTUTORIAL_KTUTORIAL_H

#include <QtGui/QWidget>

#include "ktutorial_export.h"

#include "ObjectFinder.h"

class KXmlGuiWindow;

namespace ktutorial {
class KTutorialCustomization;
class Tutorial;
}

namespace ktutorial {

class KTUTORIAL_EXPORT KTutorial: public QObject {
Q_OBJECT
public:

    static KTutorial* self();

    virtual ~KTutorial();

    bool registerWaitForMetaObject(const QMetaObject& waitForMetaObject,
                                   const QString& typeName = QString());

    void setup(KXmlGuiWindow* window);

    void setup(KTutorialCustomization* ktutorialCustomization);

    bool registerTutorial(Tutorial* tutorial);

    QWidget* mainApplicationWindow() const;

    template <typename T>
    T findObject(const QString& name) const {
        return objectFinder()->findObject<T>(name, mainApplicationWindow());
    }

private:

    static KTutorial* sSelf;

    class KTutorialPrivate* d;

    KTutorial();

    ObjectFinder* objectFinder() const;

};

}

#endif