Class cocos.text.PygletRichLabel

pyglet.text.layout.TextLayout --+    
                                |    
        pyglet.text.DocumentLabel --+
                                    |
                                   PygletRichLabel

This is not a CocosNode - let instantiation be handled by RichLabel

Helper class for RichLabel

Methods

  __init__(self, text='', font_name=None, font_size=None, bold=False, italic=False, color=None, x=0, y=0, width=None, height=None, anchor_x='left', anchor_y='baseline', halign='left', multiline=False, dpi=None, batch=None, group=None)
Create a rich text label.
Inherited from pyglet.text.DocumentLabel: get_style, set_style Inherited from pyglet.text.layout.TextLayout: begin_update, delete, draw, end_update, on_delete_text, on_insert_text, on_style_text

Properties

Inherited from pyglet.text.DocumentLabel: bold, color, font_name, font_size, italic, text Inherited from pyglet.text.layout.TextLayout: anchor_x, anchor_y, content_valign, document, dpi, height, multiline, width, x, y

Instance Variables

Inherited from pyglet.text.layout.TextLayout: background_group, content_height, content_width, foreground_decoration_group, foreground_group, top_group

Method Details

__init__

(Constructor) __init__(self, text='', font_name=None, font_size=None, bold=False, italic=False, color=None, x=0, y=0, width=None, height=None, anchor_x='left', anchor_y='baseline', halign='left', multiline=False, dpi=None, batch=None, group=None)
Create a rich text label.
Parameters:
text : str
Pyglet attributed (rich) text to display.
font_name : str or list
Font family name(s). If more than one name is given, the first matching name is used.
font_size : float
Font size, in points.
bold : bool
Bold font style.
italic : bool
Italic font style.
color : (int, int, int, int) or None
Font colour, as RGBA components in range [0, 255]. None to use font colors defined by text attributes.
x : int
X coordinate of the label.
y : int
Y coordinate of the label.
width : int
Width of the label in pixels, or None
height : int
Height of the label in pixels, or None
anchor_x : str
Anchor point of the X coordinate: one of "left", "center" or "right".
anchor_y : str
Anchor point of the Y coordinate: one of "bottom", "baseline", "center" or "top".
halign : str
Horizontal alignment of text on a line, only applies if a width is supplied. One of "left", "center" or "right".
multiline : bool
If True, the label will be word-wrapped and accept newline characters. You must also set the width of the label.
dpi : float
Resolution of the fonts in this layout. Defaults to 96.
batch : Batch
Optional graphics batch to add the label to.
group : Group
Optional graphics group to use.
Overrides:
pyglet.text.DocumentLabel.__init__