Kuit Namespace Reference

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

Enumerations
enum	Cue {   UndefinedCue , ButtonCue , InmenuCue , IntoolbarCue ,   WindowCue , MenuCue , TabCue , GroupCue ,   ColumnCue , RowCue , SliderCue , SpinboxCue ,   ListboxCue , TextboxCue , ChooserCue , CheckCue ,   RadioCue , InlistboxCue , IntableCue , InrangeCue ,   IntextCue , ValuesuffixCue , TooltipCue , WhatsthisCue ,   PlaceholderCue , StatusCue , ProgressCue , TipofthedayCue ,   UsagetipCue , CreditCue , ShellCue }
enum	Role {   UndefinedRole , ActionRole , TitleRole , OptionRole ,   LabelRole , ItemRole , InfoRole }
enum	TagClass { PhraseTag = 0 , StructTag = 1 }
enum	VisualFormat { UndefinedFormat = 0 , PlainText = 10 , RichText = 20 , TermText = 30 }

Functions
KI18N_EXPORT KuitSetup &	setupForDomain (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

languages	the target languages (by decreasing priority)
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

Definition at line 75 of file kuitsetup.h.

Enumeration Type Documentation

Cue

enum Kuit::Cue

Definition at line 125 of file kuitsetup.cpp.

Role

enum Kuit::Role

Definition at line 115 of file kuitsetup.cpp.

TagClass

enum Kuit::TagClass

Classification of KUIT tags.

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

Definition at line 53 of file kuitsetup.h.

VisualFormat

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.

Definition at line 27 of file kuitsetup.h.

Function Documentation

setupForDomain()

KuitSetup & Kuit::setupForDomain

(

const QByteArray &

domain

)

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

Parameters

domain

the translation domain

Returns

pointer to KUIT setup object

Definition at line 509 of file kuitsetup.cpp.