kuitmarkup.h

/*  This file is part of the KDE libraries
    Copyright (C) 2012 Chusslove Illich <caslav.ilic@gmx.net>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 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
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#ifndef KUITMARKUP_H
#define KUITMARKUP_H

#include <ki18n_export.h>

#include <QtCore/QString>
#include <QtCore/QStringList>
#include <QtCore/QHash>

class KUITSetup;

namespace KUIT
{
    enum VisualFormat {
        UndefinedFormat = 0,
        PlainText = 10,
        RichText = 20,
        TermText = 30
    };

    enum TagClass {
        PhraseTag = 0,
        StructTag = 1,
    };

    typedef QString (*TagFormatter)(const QString &tagName,
                                    const QHash &attributes,
                                    const QString &text,
                                    const QStringList &tagPath,
                                    KUIT::VisualFormat format);

    KUITSetup &setupForDomain(const QString &domain);
}


class KUITSetupPrivate;
class KLocalizedString;

class KI18N_EXPORT KUITSetup
{
    friend KUIT::setupForDomain;

public:

    ~KUITSetup();

    void setTagPattern(const QString &tagName,
                       const QStringList &attrNames,
                       KUIT::VisualFormat format,
                       const KLocalizedString &pattern);

    void setTagPattern(const QString &tagName,
                       const QStringList &attrNames,
                       KUIT::VisualFormat format,
                       const KUIT::TagFormatter formatter);

    void setTagClass(const QString &tagName, KUIT::TagClass aClass);

    void setFormatForMarker(const QString &marker, KUIT::VisualFormat format);

private:

    KUITSetup(const QString &domain);
    KUITSetup(const KUITSetup &);

    const KUITSetupPrivate *d;
};

#endif // KUITMARKUP_H