kemoticonsprovider.h

Go to the documentation of this file.

/**********************************************************************************
 *   Copyright (C) 2008 by Carlo Segato <brandon.ml@gmail.com>                    *
 *                                                                                *
 *   This library is free software; you can redistribute it and/or                *
 *   modify it under the terms of the GNU Lesser General Public                   *
 *   License as published by the Free Software Foundation; either                 *
 *   version 2.1 of the License, or (at your option) any later version.           *
 *                                                                                *
 *   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            *
 *   Lesser General Public License for more details.                              *
 *                                                                                *
 *   You should have received a copy of the GNU Lesser General Public             *
 *   License along with this library.  If not, see <http://www.gnu.org/licenses/>.*
 *                                                                                *
 **********************************************************************************/

#ifndef KEMOTICONS_PROVIDER_H
#define KEMOTICONS_PROVIDER_H

#include "kemoticons_export.h"
#include <QtCore/QObject>
#include <QtCore/QVariant>
#include <QtCore/QStringList>
#include <QtCore/QPair>

class QString;
class KEmoticonsProviderPrivate;
struct Emoticon;

class KEMOTICONS_EXPORT KEmoticonsProvider : public QObject
{
    Q_OBJECT
public:
    struct Emoticon
    {
        Emoticon(){}
        /* sort by longest to shortest matchText */
        bool operator < (const Emoticon &e) const { return matchText.length() > e.matchText.length(); }
        QString matchText;
        QString matchTextEscaped;
        QString picPath;
        QString picHTMLCode;
    };

    enum AddEmoticonOption {
        DoNotCopy, 
        Copy 
    };

    explicit KEmoticonsProvider(QObject *parent = 0);

    virtual ~KEmoticonsProvider();

    virtual bool loadTheme(const QString &path);

    virtual bool removeEmoticon(const QString &emo);

    virtual bool addEmoticon(const QString &emo, const QString &text, AddEmoticonOption option = DoNotCopy);

    virtual void save();

    QString themeName() const;

    void setThemeName(const QString &name);

    QString themePath() const;

    QString fileName() const;

    QHash<QString, QStringList> emoticonsMap() const;

    QHash<QChar, QList<Emoticon> > emoticonsIndex() const;

    virtual void createNew();

protected:
    void clearEmoticonsMap();

    void addEmoticonsMap(QString key, QStringList value);

    void removeEmoticonsMap(QString key);

    void addEmoticonIndex(const QString &path, const QStringList &emoList);

    void removeEmoticonIndex(const QString &path, const QStringList &emoList);

    KEmoticonsProviderPrivate * const d;
};

#endif /* KEMOTICONS_PROVIDER_H */

// kate: space-indent on; indent-width 4; replace-tabs on;