Prima::Drawable::Markup - allow markup in widgets
use Prima qw(Application Buttons); use Prima::Drawable::Markup q(M); my $m = Prima::MainWindow->new; $m-> insert( Button => text => Prima::Drawable::Markup->new(markup => "B<Bold> bU<u>tton"), hotKey => 'u', pack => {}, ); $m->insert( Button => pack => {}, text => M "I<Italic> button" ); $m->insert( Button => pack => {}, text => \ "Not an Q<I<italic>> button" ); run Prima;
Prima::Drawable::Markup adds the ability to recognize POD-like markup to Prima widgets. Supported markup sequences are B (bold text), I (italic text), U (underlined text), F (change font), S (change font size), C (change foreground color), G (change background color), M (move pointer), W (disable wrapping), and P (picture).
Prima::Drawable::Markup
B
I
U
F
S
C
G
M
W
P
The F sequence is used as follows: n|text, where n is a 0-based index into the fontPalette.
n|text
n
fontPalette
The S sequence is used as follows: n|text, where n is the number of points relative to the current font size. The font size may optionally be preceded by + or -.
+
-
The C and G sequences are used as follows: c|text, where c is either: a color in any form accepted by Prima, including the cl constants (Black Blue Green Cyan Red Magenta Brown LightGray DarkGray LightBlue LightGreen LightCyan LightRed LightMagenta Yellow White Gray). Or, a 0-based index into the colorPalette. Also, default can be used to set the color that the canvas originally had. For G a special value off can be used to turn off the background color and set it as transparent.
c|text
c
cl
Black
Blue
Green
Cyan
Red
Magenta
Brown
LightGray
DarkGray
LightBlue
LightGreen
LightCyan
LightRed
LightMagenta
Yellow
White
Gray
colorPalette
default
off
The M command has three parameters, comma-separated: X, Y, and flags. X and Y are coordinates of how much to move the current pointer. By default X and are in pixels, and do not extend block width. flags is a set of characters, where each is:
flags
m - set units to font height p - set units to points x - also extend the block width
The text inside the W sequence will not be wrapped during text_wrap calls.
text_wrap
The text inside the Q sequence will not be treated as markup.
Q
The P sequence is used as follows:P<n>, where n is a 0-based index into the picturePalette.
P<n>
picturePalette
The URL sequence parsing results in making 1) text of color linkColor, and 2) wrapping the text with OP_LINK commands in the block, that do nothing by default but could be used by whoever uses the block. See Prima::Widget::Link for more and Prima::Label as an example.
text
linkColor
OP_LINK
The methods text_out and get_text_width are affected by Prima::Drawable::Markup. text_out will write formatted text to the canvas, and get_text_width will return the width of the formatted text. NOTE: These methods do not save the state between calls, so your markup cannot span lines (since each line is drawn or measured with a separate call).
text_out
get_text_width
The module can export a single method M which is a shortcut over the creation of a new markup object with default color, font, and image palettes. These can be accessed directly as @COLORS, @FONTS, @IMAGES correspondingly.
@COLORS, @FONTS, @IMAGES
The following properties are used:
Gets or sets the color palette to be used for C sequences within this widget. Each element of the array should be a cl:: constant.
cl::
Gets or sets the font palette to be used for F sequences within this widget. Each element of the array should be a hashref suitable for setting a font.
Gets or sets the picture palette to be used for P sequences within this widget. Each element of the array should be a Prima::Image descendant.
Prima::Image
Prima::Drawable::TextBlock, examples/markup.pl
Copyright 2003 Teo Sankaro
You may redistribute and/or modify this module under the same terms as Perl itself. (Although a credit would be nice.)
This module is based on work by Teo Sankaro, <teo_sankaro@hotmail.com>.
To install Prima, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Prima
CPAN shell
perl -MCPAN -e shell install Prima
For more information on module installation, please visit the detailed CPAN module installation guide.