lesson.h

Go to the documentation of this file.

/***************************************************************************

    Copyright 2008 Avgoustinos Kadis <avgoustinos.kadis@kdemail.net>

 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef SCRIPTINGSCRIPTOBJECTLESSON_H
#define SCRIPTINGSCRIPTOBJECTLESSON_H

#include <keduvoclesson.h>
#include "container.h"

#include <QObject>
#include <QStringList>

#include <KSharedPtr>

namespace Scripting
{

class Expression;

class Lesson : public Container
{
    Q_OBJECT
public:

    Lesson(KEduVocLesson * lesson);

    Lesson(KEduVocContainer * container);

    Lesson(const QString& name);

    ~Lesson();

public slots:
    QVariantList entries(bool recursive = false) const;

    void setEntries(QVariantList entries);

    QObject * entry(int row, bool recursive = false);

    int entryCount(bool recursive = false);

    QObject* newEntry();

    QObject* newEntry(QStringList translations);

    void appendEntry(Expression * entry);

    void appendNewEntry(QStringList translations);

    void insertEntry(int index, Expression * entry);

    void removeEntry(QObject * entry);

    void clearEntries();

    // @note this one doesn't work with the previous one (python doesn't know which one to call)
    /*
     * Creates and returns a new Expression Object
     * @param expression
     * @return A new Expression object
     */
//             QObject* newEntry ( const QString & expression );


    //child lesson public functions (just to change the names from "Container" to "Lesson")
    void appendChildLesson(Lesson *child) {
        appendChildContainer(child);
    }
    void insertChildLesson(int row, Lesson *child) {
        insertChildContainer(row, child);
    }
    /*
     * Delete child lesson of the specified @p row
     */
//             void deleteChildLesson ( int row ) { deleteChildContainer ( row ); }
    void removeChildLesson(int row) {
        removeChildContainer(row);
    }
    QObject *childLesson(int row) {
        return new Lesson(m_lesson->childContainer(row));
    }

    QObject *childLesson(const QString& name) {
        return new Lesson(m_lesson->childContainer(name));
    }

    QVariantList childLessons(bool recursive = false);

    QObject * findChildLesson(const QString& name);

    int childLessonCount() const {
        return childContainerCount();
    }

private:
    KEduVocLesson* m_lesson;
};

}

#endif