kuitmarkup.h

/*  This file is part of the KDE libraries
    Copyright (C) 2013 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 <QString>
#include <QStringList>
#include <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 QStringList &languages,
                               const QString &tagName,
                               const QHash<QString, QString> &attributes,
                               const QString &text,
                               const QStringList &tagPath,
                               Kuit::VisualFormat format);

KuitSetup &setupForDomain(const char *domain);

KuitSetup &setupForDomain(const QByteArray& domain);
}

class KLocalizedString;
class KuitSetupPrivate;
class KuitFormatterPrivate;

class KI18N_EXPORT KuitSetup
{
    friend KuitSetup &Kuit::setupForDomain(const QByteArray& domain);
    friend class KuitFormatterPrivate;

public:

    ~KuitSetup();

    void setTagPattern(const QString &tagName,
                       const QStringList &attribNames,
                       Kuit::VisualFormat format,
                       const KLocalizedString &pattern,
                       Kuit::TagFormatter formatter = nullptr,
                       int leadingNewlines = 0);

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

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

private:

    KuitSetup(const QByteArray &domain);
    Q_DISABLE_COPY(KuitSetup)

    KuitSetupPrivate *const d;
};

#endif // KUITMARKUP_H