KI18n 5.109.0
Typedefs | Enumerations | Functions
Kuit Namespace Reference

Global constants and functions related to KUIT markup. More...

Typedefs

typedef QString(* TagFormatter) (const QStringList &languages, const QString &tagName, const QHash< QString, QString > &attributes, const QString &text, const QStringList &tagPath, Kuit::VisualFormat format)
 Functions accepted by tag formatting functions.
 

Enumerations

enum  TagClass { PhraseTag = 0 , StructTag = 1 }
 Classification of KUIT tags. More...
 
enum  VisualFormat { UndefinedFormat = 0 , PlainText = 10 , RichText = 20 , TermText = 30 }
 Visual formats into which KUIT markup can be resolved. More...
 

Functions

KuitSetupsetupForDomain (const char *domain)
 Get hold of the KUIT setup object for a given domain.
 
KuitSetupsetupForDomain (const QByteArray &domain)
 

Detailed Description

Global constants and functions related to KUIT markup.

Typedef Documentation

◆ TagFormatter

typedef QString(* Kuit::TagFormatter) (const QStringList &languages, const QString &tagName, const QHash< QString, QString > &attributes, const QString &text, const QStringList &tagPath, Kuit::VisualFormat format)

Functions accepted by tag formatting functions.

Parameters
languagesthe target languages (by decreasing priority)
tagNamethe wrapping tag name
attributesthe attribute name-value pairs in the tag
textthe wrapped text
tagPaththe ordered list of ancestor tag names, parent first
formatthe target visual format
Returns
formatted text

Enumeration Type Documentation

◆ TagClass

Classification of KUIT tags.

Enumerator
PhraseTag 

Tags wrapping text inserted into running text.

StructTag 

Tags splitting text into paragraph-level blocks.

◆ 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.

Function Documentation

◆ setupForDomain()

KuitSetup & Kuit::setupForDomain ( const char *  domain)

Get hold of the KUIT setup object for a given domain.

Parameters
domainthe translation domain
Returns
pointer to KUIT setup object