parley.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 SCRIPTOBJECTPARLEY_H
#define SCRIPTOBJECTPARLEY_H

#include "document.h"

#include <QObject>
#include <KAction>
#include <KDebug>

#include <keduvocdeclension.h>

#include <KStandardDirs>

namespace Editor {
    class EditorWindow;
}
class Translator;

namespace Scripting
{


    class Parley : public QObject
    {
            Q_OBJECT
            Q_PROPERTY ( QObject * document READ getDocument )
            Q_PROPERTY ( QObject * doc READ getDocument )
            Q_PROPERTY ( QObject * activeLesson READ activeLesson )

//             Q_ENUMS ( Number Case Person Gender Definiteness )
            Q_ENUMS ( Flags )

        public:

            enum Flags
            {
                // This is used for both empty flags and to denote no flags of the correct type were set.
                NoInformation = 0x0,

                // Gender
                Masculine = 0x1,
                Feminine = 0x2,
                Neuter = 0x4,

                // Plurality
                Singular = 0x10,
                Dual = 0x20,
                Plural = 0x40,

                // Part of Speech
                Verb = 0x100,
                Noun = 0x200,
                Pronoun = 0x400,
                Adjective = 0x800,
                Adverb = 0x1000,
                Article = 0x2000,
                Conjunction = 0x4000,

                // Person
                First = 0x10000,
                Second = 0x20000,
                Third = 0x40000,

                // Declension Case
                Nominative = 0x80000,
                Genitive = 0x100000,
                Dative = 0x200000,
                Accusative = 0x400000,
                Ablative = 0x800000,
                Locative = 0x1000000,
                Vocative = 0x2000000,

                // Other assorted flags
                Definite = 0x4000000, // The article is definite
                Indefinite = 0x8000000, // The article is indefinite
                Regular = 0x10000000,
                Irregular = 0x20000000
            };

            Parley ( Editor::EditorWindow * editor );

            ~Parley();

            /*
             * Emits translateWord signal so the script function connected to it translate the @p word
             * @param word Word to translate
             * @param fromLanguage The language of @p word to translate from
             * @param toLanguage The language you want to translate to
             */
            void callTranslateWord ( const QString & word,const QString& fromLanguage,const QString& toLanguage );

            //sets the translator object
//             void setTranslator ( Translator* translator ) { m_translator = translator; }
            Translator * translator() { return m_translator; }

            //Returns the active document
            QObject* getDocument() { return m_doc; }

            //Returns the active lesson
            QObject* activeLesson();

        public Q_SLOTS:

            QStringList dataDirs()
            {
                return KGlobal::dirs()->findDirs ( "data","parley" );
            }

            QStringList pluginDirs()
            {
                return KGlobal::dirs()->findDirs ( "data","parley/plugins" );
            }

            QVariantList selectedEntries();

            QVariantList selectedTranslations();

            void addTranslation ( QString word,QString fromLanguage,QString toLanguage, QString translation );
            QStringList locales();

            QString localeName ( QString locale );

            /*
             * Open the Parley Document @p file
             * Usage:
             * @code
             * import Parley
             * Parley.open("Vocab/MyVocab.kvtml")
             * @endcode
             * @param file Parley Document file path (ex. /home/kde-user/MyVocab.kvtml)
             */
            void open ( QString filename );

            QObject * newDocument() { return new Document(); }

            QObject * newAction ( const QString & name, const QString & text = QString() );

        Q_SIGNALS:
            void translateWord ( const QString & word,const QString& fromLanguage,const QString& toLanguage );
            /* Emits when the translation of a word is finished (from all the scripts) [not to be used by scripts] */
            void translationFinished ( const QString & word,const QString& fromLanguage,const QString& toLanguage );
            /* Emits when the translation of a word starts [not to be used by scripts] */
            void translationStarted ( const QString & word,const QString& fromLanguage,const QString& toLanguage );

        private:
            Translator* m_translator;
            Document* m_doc;
            Editor::EditorWindow * m_editor;
    };

}
#endif