This is the pango-markup Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:30:36 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
pango-markupA small library to generate pango-style text markup.
Yukari Hafner <shinmera@tymoon.eu>
Yukari Hafner <shinmera@tymoon.eu>
(GIT https://github.com/Shinmera/pango-markup.git)
zlib
1.0.0
documentation-utils (system).
package.lisp (file).
pango.lisp (file).
documentation.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
pango-markup/pango-markup.asdpango-markup/package.lisppango-markup/pango.lisppango-markup/documentation.lisppango-markup/pango.lisppackage.lisp (file).
pango-markup (system).
background (reader method).
(setf background) (writer method).
closing-tag (method).
escape-char (function).
fallback (reader method).
(setf fallback) (writer method).
family (reader method).
(setf family) (writer method).
features (reader method).
(setf features) (writer method).
font (reader method).
(setf font) (writer method).
font (class).
foreground (reader method).
(setf foreground) (writer method).
gravity (reader method).
(setf gravity) (writer method).
language (reader method).
(setf language) (writer method).
letter-spacing (reader method).
(setf letter-spacing) (writer method).
markup (class).
markup-regions (function).
opening-tag (method).
rise (reader method).
(setf rise) (writer method).
shared-initialize (method).
size (reader method).
(setf size) (writer method).
stretch (reader method).
(setf stretch) (writer method).
strikethrough (reader method).
(setf strikethrough) (writer method).
style (reader method).
(setf style) (writer method).
underline (reader method).
(setf underline) (writer method).
variant (reader method).
(setf variant) (writer method).
weight (reader method).
(setf weight) (writer method).
enlist (function).
format-color (method).
format-color (method).
format-color (method).
format-escape (method).
format-escape (method).
format-escape (method).
null-if (function).
tag (method).
pango-markup/documentation.lisppango.lisp (file).
pango-markup (system).
Packages are listed by definition order.
pango-markuporg.shirakumo.pango-markup
common-lisp.
background (generic reader).
(setf background) (generic writer).
closing-tag (generic function).
escape-char (function).
fallback (generic reader).
(setf fallback) (generic writer).
family (generic reader).
(setf family) (generic writer).
features (generic reader).
(setf features) (generic writer).
font (generic reader).
(setf font) (generic writer).
font (class).
foreground (generic reader).
(setf foreground) (generic writer).
gravity (generic reader).
(setf gravity) (generic writer).
language (generic reader).
(setf language) (generic writer).
letter-spacing (generic reader).
(setf letter-spacing) (generic writer).
markup (class).
markup-regions (function).
opening-tag (generic function).
rise (generic reader).
(setf rise) (generic writer).
size (generic reader).
(setf size) (generic writer).
stretch (generic reader).
(setf stretch) (generic writer).
strikethrough (generic reader).
(setf strikethrough) (generic writer).
style (generic reader).
(setf style) (generic writer).
underline (generic reader).
(setf underline) (generic writer).
variant (generic reader).
(setf variant) (generic writer).
weight (generic reader).
(setf weight) (generic writer).
enlist (function).
format-color (generic function).
format-escape (generic function).
null-if (function).
tag (generic function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Escapes the given char if necessary and writes it to stream.
This makes the following substitutions:
< ::= <
> ::= >
& ::= &
’ ::= '
Any other character is written verbatim to the stream.
Marks up the given text using the list of markup regions.
Each entry in the region list should be of the following form:
REGION ::= (START END . MARKUP)
START — An integer describing the index in the text at which
the markup should start applying.
END — An integer describing the index up until which the markup
should apply.
MARKUP — Either a list of MARKUP initargs, or a MARKUP instance.
For instance, the following invocation:
(markup-regions "1 22 333"
’((0 1 :color red)
(5 8 :font (:family "monospace"))))
Produces the following result:
<span color=’red’>1</span> 22 <span font_family=’monospace’>333</span>
Note that while it is allowed to nest markup regions, this function
makes no attempt at detecting and warning about invalid region
combinations such as ((1 3 ..) (2 4 ..)).
See MARKUP
See FONT
Accesses the background colour of the markup region.
A colour can either be the name of a colour as a string, an encoded
RGB integer, or a list of R, G, B, and optional A elements with each
element being an integer between 0 and 255.
See MARKUP
Returns the closing tag that ends the marked up text region.
You should be able to splice this tag after the text region you wish
to mark up.
Note that the text between the opening-tag and the closing-tag should
be properly entity-escaped using ESCAPE-CHAR.
See ESCAPE-CHAR
See OPENING-TAG
See MARKUP
Accesses whether fallback font glyphs should be enabled.
This defaults to true and should not need to be changed.
See MARKUP
Accesses the font family name.
The font family should be a string describing the name of the family of
font that should be used.
See FONT
Accesses the font’s list of feature settings.
This should be a list of strings describing the desired OpenType
features, in the same syntax as CSS uses.
See FONT
Accesses the font properties of the markup region.
This should be set to an instance of FONT.
When supplied as an initarg, the font may also be a list of initargs
to use to construct a FONT instance.
See FONT
See MARKUP
Accesses the foreground text colour of the markup region.
A colour can either be the name of a colour as a string, an encoded
RGB integer, or a list of R, G, B, and optional A elements with each
element being an integer between 0 and 255.
See MARKUP
Accesses the alignment gravity of the markup region.
If set should be either a gravity mode, or a list of gravity mode and
gravity hint.
The gravity mode can be one of: :south :east :north :west :auto
The gravity hint can be one of: :natural :strong :line
See MARKUP
Accesses the language of the markup region.
The value should be a two or three letter ISO language code.
See MARKUP
Accesses the inter-letter spacing of the markup region.
The value should be a float describing the spacing in points.
See MARKUP
Returns the opening tag that describes all the markup options.
You should be able to splice this tag before the text region you wish
to mark up with the given options. The end of the region to be marked
should be followed by the CLOSING-TAG.
Note that the text between the opening-tag and the closing-tag should
be properly entity-escaped using ESCAPE-CHAR.
See ESCAPE-CHAR
See CLOSING-TAG
See MARKUP
cons)) ¶Accesses the vertical displacement of the markup region.
This displacement can be positive or negative, and must be in pango
units.
See MARKUP
Accesses the size of the font.
The value can either be a float describing the size in points, or one
of the following size units:
Absolute: :xx-small :x-small :small :medium :large :x-large :xx-large
Relative: :smaller :larger
See FONT
Accesses the font’s stretch factor.
Can be one of the following:
:ultra-condensed :extra-condensed :condensed :semi-condensed :normal :semi-expanded :expanded :extra-expanded :ultra-expanded
See FONT
Accesses the strikethrough options of the markup region.
Can be either T or a list of T and the strikethrough colour.
A colour can either be the name of a colour as a string, an encoded
RGB integer, or a list of R, G, B, and optional A elements with each
element being an integer between 0 and 255.
See MARKUP
Accesses the font’s style variant.
Can be one of the following:
:normal :oblique :italic
See FONT
Accesses the underline options of the markup region.
If set should be either an underline mode, or a list of underline mode
and underline colour. The underline mode should be one of
:none T :single :double :low :error
Where T is synonymous with :single
The colour can either be the name of a colour as a string, an encoded
RGB integer, or a list of R, G, B, and optional A elements with each
element being an integer between 0 and 255.
See MARKUP
Accesses the font’s variant.
Can be one of the following:
:normal :small-caps
See FONT
Accesses the font’s weight or boldness.
Can be either a numeric weight, or one of the following:
:ultra-light :light :normal :bold :ultra-bold :heavy
See FONT
This class represents all possible font features that can be used within a markup block.
Any font property that is not a boolean can also be NIL, in which case
the value is not changed and instead inherited from the surrounding
context.
See FAMILY
See SIZE
See STYLE
See WEIGHT
See VARIANT
See STRETCH
See FEATURES
| Initarg | Value |
|---|---|
:family | nil |
:size | nil |
:style | nil |
:weight | nil |
:variant | nil |
:stretch | nil |
:features | nil |
(or null string)
:family
(or null real (member :xx-small :x-small :small :medium :large :x-larg :xx-large :smaller :larger))
:size
size.
(or null (member :normal :oblique :italic))
:style
(or null real (member :ultra-light :light :normal :bold :ultra-bold :heavy))
:weight
(or null (member :normal :small-caps))
:variant
(or null (member :ultra-condensed :extra-condensed :condensed :semi-condensed :normal :semi-expanded :expanded :extra-expanded :ultra-expanded))
:stretch
:features
This class represents markup information for a region of text.
Any markup property that is not a boolean can also be NIL, in which
case the value is not changed and instead inherited from the
surrounding context.
See FONT
See FOREGROUND
See BACKGROUND
See UNDERLINE
See RISE
See STRIKETHROUGH
See FALLBACK
See LANGUAGE
See LETTER-SPACING
See GRAVITY
See TAG
See MARKUP-REGIONS
(setf background).
background.
(setf fallback).
fallback.
(setf font).
font.
(setf foreground).
foreground.
(setf gravity).
gravity.
(setf language).
language.
(setf letter-spacing).
letter-spacing.
(setf rise).
rise.
shared-initialize.
(setf strikethrough).
strikethrough.
tag.
(setf underline).
underline.
| Initarg | Value |
|---|---|
:font | nil |
:foreground | nil |
:background | nil |
:underline | nil |
:rise | nil |
:strikethrough | nil |
:fallback | t |
:language | nil |
:letter-spacing | nil |
:gravity | nil |
:color, :foreground
:background
:underline
:strike, :strikethrough
:fallback
:lang, :language
:spacing, :letter-spacing
:gravity
| Jump to: | (
B C E F G L M N O R S T U V W |
|---|
| Jump to: | (
B C E F G L M N O R S T U V W |
|---|
| Jump to: | B F G L R S U V W |
|---|
| Jump to: | B F G L R S U V W |
|---|
| Jump to: | C D F M P S |
|---|
| Jump to: | C D F M P S |
|---|