KUIT Namespace Reference

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

Enumerations
enum	VisualFormat { UndefinedFormat = 0, PlainText = 10, RichText = 20, TermText = 30 }
enum	TagClass { PhraseTag = 0, StructTag = 1 }

Functions
KUITSetup &	setupForCatalog (const QString &domain)

Detailed Description

Global constants and functions related to KUIT markup.

Typedef Documentation

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

Functions accepted by tag formatting functions.

Parameters

tagName	the wrapping tag name
attributes	the attribute name-value pairs in the tag
text	the wrapped text
tagPath	the ordered list of ancestor tag names, parent first
format	the target visual format

Returns

formatted text

Enumeration Type Documentation

enum KUIT::VisualFormat

Visual formats into which KUIT markup can be resolved.

Enumerator:

UndefinedFormat	Visual format not defined. This value can be explicitly set (e.g. through KLocalizedString::withFormat) to indicate that the format should be decided by another mechanism (e.g. context UI marker).
PlainText	Plain text.
RichText	Qt rich text (HTML subset).
TermText	Terminal escape sequences.

enum KUIT::TagClass

Classification of KUIT tags.

Enumerator:

PhraseTag	Tags wrapping text inserted into running text.
StructTag	Tags spliting text into paragraph-level blocks.

Function Documentation

KUITSetup& KUIT::setupForCatalog

(

const QString &

domain

)

Get hold of the KUIT setup object for given catalog.

Parameters

domain

the canonical name of the catalog

Returns

pointer to KUIT setup object