kemoticonstheme.h

Go to the documentation of this file.

/**********************************************************************************
 *   Copyright (C) 2008 by Carlo Segato <brandon.ml@gmail.com>                    *
 *   Copyright (c) 2002-2003 by Stefan Gehn            <metz@gehn.net>            *
 *   Kopete    (c) 2002-2008 by the Kopete developers  <kopete-devel@kde.org>     *
 *   Copyright (c) 2005      by Engin AYDOGAN          <engin@bzzzt.biz>          *
 *                                                                                *
 *   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_THEME_H
#define KEMOTICONS_THEME_H

#include "kemoticonsprovider.h"

#include <QtCore/QSharedDataPointer>

class QString;

class KEMOTICONS_EXPORT KEmoticonsTheme
{
public:

    enum ParseModeEnum {
        DefaultParse = 0x0,      
        StrictParse = 0x1,       
        RelaxedParse = 0x2,      
        SkipHTML = 0x4           
    };

    Q_DECLARE_FLAGS(ParseMode, ParseModeEnum)

    
    enum TokenType {
        Undefined, 
        Image,     
        Text       
    };

    struct Token {
        Token() : type(Undefined) {}
        Token(TokenType t, const QString &m) : type(t), text(m) {}
        Token(TokenType t, const QString &m, const QString &p, const QString &html)
                : type(t), text(m), picPath(p), picHTMLCode(html) {}
        TokenType   type; 
        QString     text; 
        QString     picPath; 
        QString     picHTMLCode; 
    };

    KEmoticonsTheme();

    KEmoticonsTheme(const KEmoticonsTheme &ket);

    KEmoticonsTheme(KEmoticonsProvider *p);

    ~KEmoticonsTheme();

    QString parseEmoticons(const QString &text, ParseMode mode = DefaultParse, const QStringList &exclude = QStringList()) const;

    QList<Token> tokenize(const QString &message, ParseMode mode = DefaultParse) const;

    bool loadTheme(const QString &path);

    bool removeEmoticon(const QString &emo);

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

    void save();

    QString themeName() const;

    void setThemeName(const QString &name);

    QString themePath() const;

    QString fileName() const;

    QHash<QString, QStringList> emoticonsMap() const;

    void createNew();

    bool isNull() const;

    KEmoticonsTheme& operator=(const KEmoticonsTheme &ket);
private:
    class KEmoticonsThemeData;
    QSharedDataPointer<KEmoticonsThemeData> d;
};

Q_DECLARE_OPERATORS_FOR_FLAGS(KEmoticonsTheme::ParseMode)

#endif /* KEMOTICONS_THEME_H */

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