Sets the layout text and attribute list from marked-up text. This will replace
the current text and attribute list. It is the same as playout:SetMarkupWithAccel(),
but the markup text isn't scanned for accelerators.
The Pango markup language allows you to apply text formatting using XML tags.
The most common tag in the Pango markup language is the <span> tag. It allows
you to apply formatting to a range of characters. The <span> tag supports
the following attributes:
font
-
font_desc
-
A font description string, such as "Sans Italic 12". See pango.FontDescription() for a description
of the format of the string representation. Note that any other span attributes will override this
description. So if you have "Sans Italic" and also a style="normal" attribute, you will get
Sans normal, not italic.
font_family
-
face
-
A font family name.
font_size
-
size
-
Font size in 1024ths of a point, or in points (e.g. "12.5pt"), or one of the absolute sizes "xx-small",
"x-small", "small", "medium", "large", "x-large", "xx-large", or a percentage (e.g. "200%"), or one of
the relative sizes "smaller" or "larger". If you want to specify a absolute size, it"s usually easier
to take advantage of the ability to specify a partial font description using "font"; you can use font="12.5"
rather than size="12800" or size="12.5pt".
font_style
-
style
-
One of "normal", "oblique", "italic".
font_weight
-
weight
-
One of "ultralight", "light", "normal", "bold", "ultrabold", "heavy", or a numeric weight.
font_variant
-
variant
-
One of "normal", "small-caps", "all-small-caps", "petite-caps", "all-petite-caps", "unicase", "title-caps".
font_stretch
-
stretch
-
One of "ultracondensed", "extracondensed", "condensed", "semicondensed", "normal", "semiexpanded",
"expanded", "extraexpanded", "ultraexpanded".
font_features
-
A comma-separated list of OpenType font feature settings, in the same syntax as accepted by CSS.
E.g: font_features='dlig=1, -kern, afrc on'.
foreground
-
fgcolor
-
color
-
An RGB color specification such as "#00FF00" or a color name such as "red". An RGBA color
specification such as "#00FF007F" will be interpreted as specifying both a foreground color and foreground
alpha.
background
-
bgcolor
-
An RGB color specification such as "#00FF00" or a color name such as "red". An RGBA color specification
such as "#00FF007F" will be interpreted as specifying both a background color and background alpha.
alpha
-
fgalpha
-
An alpha value for the foreground color, either a plain integer between 1 and 65536 or a percentage value like "50%".
background_alpha
-
bgalpha
-
An alpha value for the background color, either a plain integer between 1 and 65536 or a percentage value like "50%".
underline
-
One of "none", "single", "double", "low", "error".
underline_color
-
The color of underlines; an RGB color specification such as "#00FF00" or a color name such as "red".
overline
-
One of "none" or "single".
overline_color
-
The color of overlines; an RGB color specification such as "#00FF00" or a color name such as "red".
rise
-
Vertical displacement, in Pango units or in points (e.g. "5pt"). Can be negative for subscript, positive for superscript.
baseline_shift
-
Vertical displacement. In contrast to rise, baseline_shift attributes are cumulative. The value can be a length
in Pango units or in points (e.g. "5pt"), or "superscript" or "subscript".
font_scale
-
Font size change. The possible values are "superscript", "subscript" or "small-caps". This is similar to the
font_size values "smaller" or "larger", but uses font metrics to find the new size.
strikethrough
-
"true" or "false" whether to strike through the text.
strikethrough_color
-
The color of strikethrough lines; an RGB color specification such as "#00FF00" or a color name such as "red".
fallback
-
"true" or "false" whether to enable fallback. If disabled, then characters will only be used from the closest matching
font on the system. No fallback will be done to other fonts on the system that might contain the characters in the text.
Fallback is enabled by default. Most applications should not disable fallback.
lang
-
A language code, indicating the text language.
letter_spacing
-
Inter-letter spacing in 1024ths of a point.
gravity
-
One of "south", "east", "north", "west", "auto".
gravity_hint
-
One of "natural", "strong", "line".
show
-
Specifies what special characters to show visibly. The value can be "none" or a combination of "spaces", "line-breaks"
and "ignorables", combined with "|".
insert_hyphens
-
"true" or "false" to indicate whether hyphens should be inserted when breaking lines in the middle of words.
allow_breaks
-
"true" or "false" to indicate whether breaking lines is allowed.
line_height
-
Overrides the line height. The value can be either a factor (< 1024) that is used to scale up the logical extents of
runs or an absolute value (in 1024th of a point).
text_transform
-
Specifies how characters are transformed during shaping. The values can be "none", "lowercase", "uppercase" or "capitalize".
segment
-
Overrides word or sentence boundaries. The value can be "word" or "sentence", to indicate that the span should be treated
as a single word or sentence. Overlapping segments will be split to allow this, and line breaks will be adjusted accordingly.
Besides the <span> tag, the Pango markup language also supports the following
convenience tags:
<b>
-
Bold
<big>
-
Makes font relatively larger, equivalent to
<span size="larger">
<i>
-
Italic
<s>
-
Strikethrough
<sub>
-
Subscript
<sup>
-
Superscript
<small>
-
Makes font relatively smaller, equivalent to
<span size="smaller">
<tt>
-
Monospace font
<u>
-
Underline
Here's an example of marked-up text:
| | <span foreground="blue" size="x-large">Blue text</span> is <i>cool</i>.
|
Note that you can also use XML features such as numeric character entities, e.g. you can
use © for the copyright character etc.