\
jG d Z ddlZddlZddlmZmZmZ G d de Z G d d Z
ddZ dd Z dd
Z
d Zd Z G d
dej Z G d de Z G d de ZdS )a Text formatting, layout and display.
This module provides classes for loading styled documents from text files,
HTML files and a pyglet-specific markup format. Documents can be styled with
multiple fonts, colours, styles, text sizes, margins, paragraph alignments,
and so on.
Using the layout classes, documents can be laid out on a single line or
word-wrapped to fit a rectangle. A layout can then be efficiently drawn in
a window or updated incrementally (for example, to support interactive text
editing).
The label classes provide a simple interface for the common case where an
application simply needs to display some text in a window.
A plain text label can be created with::
label = pyglet.text.Label('Hello, world',
font_name='Times New Roman',
font_size=36,
x=10, y=10)
Alternatively, a styled text label using HTML can be created with::
label = pyglet.text.HTMLLabel('Hello, world',
x=10, y=10)
Either label can then be drawn at any time with::
label.draw()
For details on the subset of HTML supported, see `pyglet.text.formats.html`.
Refer to the Programming Guide for advanced usage of the document and layout
classes, including interactive editing, embedding objects within documents and
creating scrollable layouts.
.. versionadded:: 1.1
N)layoutdocumentcaretc e Zd ZdZdS )DocumentDecodeExceptionz)An error occurred decoding document text.N)__name__
__module__ __qualname____doc__ N/DATA/AppData/hermes/venv/lib/python3.11/site-packages/pyglet/text/__init__.pyr r R s 33Dr
r c e Zd ZdZddZdS )DocumentDecoderz Abstract document decoder.
Nc t d )aM Decode document text.
:Parameters:
`text` : str
Text to decode
`location` : `Location`
Location to use as base path for additional resources
referenced within the document (for example, HTML images).
:rtype: `AbstractDocument`
abstract)NotImplementedError)selftextlocations r decodezDocumentDecoder.decode[ s "*---r
N)r r r
r r r r
r r r W s2 . . . . . .r
r c d |=t j | \ }}| dv rd}nd}|dk rddlm} | S |dk rddlm} | S |dk rdd lm } |
S t d
|z ) a Get a document decoder for the given filename and MIME type.
If `mimetype` is omitted it is guessed from the filename extension.
The following MIME types are supported:
``text/plain``
Plain text
``text/html``
HTML 4 Transitional
``text/vnd.pyglet-attributed``
Attributed text; see `pyglet.text.formats.attributed`
`DocumentDecodeException` is raised if another MIME type is given.
:Parameters:
`filename` : str
Filename to guess the MIME type from. If a MIME type is given,
the filename is ignored.
`mimetype` : str
MIME type to lookup, or ``None`` to guess the type from the
filename.
:rtype: `DocumentDecoder`
N)z.htmz.htmlz.xhtml text/html
text/plainr ) plaintext)htmltext/vnd.pyglet-attributed)
attributedzUnknown format "%s") ospathsplitextlowerpyglet.text.formatsr PlainTextDecoderr HTMLDecoderr AttributedTextDecoderr )filenamemimetype_extr r r s r get_decoderr, j s 4 !!(++3 99;;5 5 5"HH#H< 111111))+++ [ ,,,,,, !!! 1 1 1222222//111%&;h&FGGGr
c t | | }|s>- 2 22s AA
Ac N t dd }| | | S )a< Create a document directly from some HTML formatted text.
:Parameters:
`text` : str
HTML data to decode.
`location` : str
Location giving the base path for additional resources
referenced from the document (e.g., images).
:rtype: `FormattedDocument`
Nr r, r )r r r7 s r decode_htmlr= s' $ ,,G >>$ ) ))r
c L t dd }| | S )zCreate a document directly from some attributed text.
See `pyglet.text.formats.attributed` for a description of attributed text.
:Parameters:
`text` : str
Attributed text to decode.
:rtype: `FormattedDocument`
Nr r< r r7 s r decode_attributedr@ s& $ <==G >>$ r
c L t dd }| | S )zCreate a document directly from some plain text.
:Parameters:
`text` : str
Plain text to initialise the document with.
:rtype: `UnformattedDocument`
Nr r< r? s r decode_textrB s% $ --G >>$ r
c e Zd ZdZ d fd Zed Zej d Zed
Zej d Zed Z e j d
Z ed Z
e
j d Z
ed Z e j d Z ed Z e j d Z ed Z
e
j d Z
d Zd Z xZS )
DocumentLabelz~Base label class.
A label is a layout that exposes convenience methods for manipulating the
associated document.
Nr leftbaselineFc t t | ||||| |
| || _ || _ || _ || _ | dS )a Create a label for a given document.
:Parameters:
`document` : `AbstractDocument`
Document to attach to the layout.
`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"``.
`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` : `~pyglet.graphics.Batch`
Optional graphics batch to add the label to.
`group` : `~pyglet.graphics.Group`
Optional graphics group to use.
)widthheight multilinedpibatchgroupN)superrD __init___x_y _anchor_x _anchor_y_update)
r r xyrH rI anchor_xanchor_yrJ rK rL rM __class__s
r rO zDocumentLabel.__init__ sp D mT""++H276?035 , O O O
!! r
c | j j S )z3The text of the label.
:type: str
r r r s r r zDocumentLabel.text s }!!r
c || j _ d S r r[ r r s r r zDocumentLabel.text s !
r
c 6 | j d S )zText color.
Color is a 4-tuple of RGBA components, each in range [0, 255].
:type: (int, int, int, int)
colorr get_styler\ s r r` zDocumentLabel.color# s }&&w///r
c p | j dt | j j d|i d S )Nr r` r set_stylelenr )r r` s r r` zDocumentLabel.color- s?
3t}'9#:#:!(% 0 2 2 2 2 2r
c | j d S )a Blend opacity.
This property sets the alpha component of the colour of the label's
vertices. With the default blend mode, this allows the layout to be
drawn with fractional opacity, blending with the background.
An opacity of 255 (the default) has no effect. An opacity of 128 will
make the label appear semi-translucent.
:type: int
)r` r\ s r opacityzDocumentLabel.opacity2 s z!} r
c || j d k r;t t t g | j d d |R | _ d S d S )Nrh )r` listmapint)r alphas r ri zDocumentLabel.opacityA sP DJqM ! ! c#'?BQB '?'?'? @ @AADJJJ " !r
c 6 | j d S )zFont family name.
The font name, as passed to :py:func:`pyglet.font.load`. A list of names can
optionally be given: the first matching font will be used.
:type: str or list
font_namera r\ s r rp zDocumentLabel.font_nameF s }&&{333r
c p | j dt | j j d|i d S )Nr rp rd )r rp s r rp zDocumentLabel.font_nameQ ?
3t}'9#:#:!,i 8 : : : : :r
c 6 | j d S )z4Font size, in points.
:type: float
font_sizera r\ s r rt zDocumentLabel.font_sizeV s }&&{333r
c p | j dt | j j d|i d S )Nr rt rd )r rt s r rt zDocumentLabel.font_size^ rr r
c 6 | j d S )z.Bold font style.
:type: bool
boldra r\ s r rw zDocumentLabel.boldc s }&&v...r
c p | j dt | j j d|i d S )Nr rw rd )r rw s r rw zDocumentLabel.boldk s>
3t}'9#:#:!' 0 0 0 0 0r
c 6 | j d S )z0Italic font style.
:type: bool
italicra r\ s r rz zDocumentLabel.italicp s }&&x000r
c p | j dt | j j d|i d S )Nr rz rd )r rz s r rz zDocumentLabel.italicx s?
3t}'9#:#:!)6 2 4 4 4 4 4r
c h | j |dt | j j S )ap Get a document style value by name.
If the document has more than one value of the named style,
`pyglet.text.document.STYLE_INDETERMINATE` is returned.
:Parameters:
`name` : str
Style name to query. See documentation for
`pyglet.text.layout` for known style names.
:rtype: object
r )r get_style_rangerf r )r names r rb zDocumentLabel.get_style} s+ },,T1c$-:L6M6MNNNr
c p | j dt | j j ||i dS )a2 Set a document style value by name over the whole document.
:Parameters:
`name` : str
Name of the style to set. See documentation for
`pyglet.text.layout` for known style names.
`value` : object
Value of the style.
r Nrd )r r~ values r re zDocumentLabel.set_style s5
3t}'9#:#:T5MJJJJJr
) Nr r NNrE rF FNNN)r r r
r rO propertyr setterr` ri rp rt rw rz rb re
__classcell__rY s @r rD rD s
!%.2+5>B+ + + + + +Z " " X"
[" " [" 0 0 X0 \2 2 \2 X
^B B ^B 4 4 X4 : : : 4 4 X4 : : : / / X/
[0 0 [0 1 1 X1 ]4 4 ]4
O
O
O K K K K K K Kr
rD c 2 e Zd ZdZ d
fd Z xZS ) LabelzPlain text label.
NF r r r r rE rF c
t | }t t | ||| |
| | |
|||| | j dt
| j j |||||||d dS )a Create a plain text label.
:Parameters:
`text` : str
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/str
Bold font style.
`italic` : bool/str
Italic font style.
`stretch` : bool/str
Stretch font style.
`color` : (int, int, int, int)
Font colour, as RGBA components in range [0, 255].
`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"``.
`align` : 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` : `~pyglet.graphics.Batch`
Optional graphics batch to add the label to.
`group` : `~pyglet.graphics.Group`
Optional graphics group to use.
r )rp rt rw rz stretchr` alignN)rB rN r rO r re rf r )r r rp rt rw rz r r` rU rV rH rI rW rX r rJ rK rL rM r rY s r rO zLabel.__init__ s l t$$
eT##HaE6$,h$-sE5 B B B
3t}'9#:#:"" =
=
r
)r NNFFFr r r NNrE rF rE FNNN)r r r
r rO r r s @r r r sh SX+.2+5 >B
C C C C C C C C C C r
r c b e Zd ZdZ d fd Zed Zej d
Z xZS ) HTMLLabelz}HTML formatted text label.
A subset of HTML 4.01 is supported. See `pyglet.text.formats.html` for
details.
r Nr rE rF Fc
|| _ || _ t || }
t t | |
||||||| |
| | dS )at Create a label with an HTML string.
:Parameters:
`text` : str
HTML formatted text to display.
`location` : `Location`
Location object for loading images referred to in the
document. By default, the working directory is used.
`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"``.
`multiline` : bool
If True, the label will be word-wrapped and render paragraph
and line breaks. You must also set the width of the label.
`dpi` : float
Resolution of the fonts in this layout. Defaults to 96.
`batch` : `~pyglet.graphics.Batch`
Optional graphics batch to add the label to.
`group` : `~pyglet.graphics.Group`
Optional graphics group to use.
N)_text _locationr= rN r rO )r r r rU rV rH rI rW rX rJ rK rL rM r rY s r rO zHTMLLabel.__init__ sl J
! tX..
i ''!Qv(0((13u F F F F Fr
c | j S )z>HTML formatted text of the label.
:type: str
)r r\ s r r zHTMLLabel.text s zr
c H || _ t || j | _ d S r )r r= r r r^ s r r zHTMLLabel.text s
#D$.99
r
) r Nr r NNrE rF FNNN) r r r
r rO r r r r r s @r r r s *..2+5>B*F *F *F *F *F *FX X
[: : [: : : : :r
r r )NN)r os.pathr r2 pyglet.textr r r Exceptionr r r, r: r= r@ rB
TextLayoutrD r r r r
r r s H& &P
/ / / / / / / / / / i
. . . . . . . .&+H +H +H +H\ 3 3 3 3>
*
*
*
*
tK tK tK tK tKF% tK tK tKnG G G G G M G G G T>: >: >: >: >:
>: >: >: >: >:r