Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Minor improvements to GUI system #1690

Merged
merged 11 commits into from
Jun 9, 2023
Merged

Minor improvements to GUI system #1690

Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
10ee9f9
Improve layout and formatting of `concept.rst` for GUI system docs
eschan145 Apr 4, 2023
b034b12
Fix typo of "a" to "an" and "effecting" to "affecting"
eschan145 Apr 5, 2023
b14866e
Apply suggestions to `concept.rst` by pushfoo
eschan145 Apr 5, 2023
1247831
Documentation improvements to GUI text widgets
eschan145 Apr 7, 2023
f3ed9b3
Minor formatting fixes
eschan145 Apr 7, 2023
5f5f00f
Fixes for `arcade.text`
eschan145 Apr 8, 2023
14ffe0a
Small commit checks and fixes
eschan145 Apr 19, 2023
32d2719
Update arcade/gui/widgets/text.py
eruvanos May 9, 2023
c626854
Merge branch 'pythonarcade:development' into widget_revamp
eschan145 May 16, 2023
66d7123
Merge branch 'development' into widget_revamp
eruvanos May 30, 2023
8b4b705
Update text.py
einarf Jun 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
218 changes: 139 additions & 79 deletions arcade/gui/widgets/text.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,37 +20,51 @@
from arcade.gui.surface import Surface
from arcade.gui.widgets import UIWidget, Rect
from arcade.gui.widgets.layout import UIAnchorLayout
from arcade.types import RGBA255, Color, RGBOrA255
from arcade.types import RGBA255, Color, RGBOrA255, RGB



class UILabel(UIWidget):
"""A simple text label. Also supports multiline text.
In case you want to scroll text use a :class:`UITextArea`
By default a :class:`UILabel` will fit its initial content,
if the text changed use :meth:`UILabel.fit_content` to adjust the size.

:param float x: x coordinate of bottom left
:param float y: y coordinate of bottom left
:param float width: width of widget. Defaults to text width if not specified.
:param float height: height of widget. Defaults to text height if not specified.
:param str text: text of the label.
:param font_name: a list of fonts to use. Program will start at the beginning of the list
and keep trying to load fonts until success.
:param float font_size: size of font.
:param RGBA255 text_color: Color of font.
:param bool bold: Bold font style.
:param bool italic: Italic font style.
"""A simple text label. This widget is meant to display user instructions or
information. This label supports multiline text.

If you want to make a scrollable viewing text box, use a
:py:class:`~arcade.gui.UITextArea`.

By default, a label will fit its initial content. If the text is changed use
:py:meth:`~arcade.gui.UILabel.fit_content` to adjust the size.

:param float x: x position (default anchor is bottom-left).
:param float y: y position (default anchor is bottom-left).
:param float width: Width of the label. Defaults to text width if not
specified. See
:py:meth:`~pyglet.text.layout.TextLayout.content_width`.
:param float height: Height of the label. Defaults to text height if not
specified. See
:py:meth:`~pyglet.text.layout.TextLayout.content_height`.
:param str text: Text displayed on the label.
:param font_name: A list of fonts to use. Arcade will start at the beginning
of the tuple and keep trying to load fonts until success.
:param float font_size: Font size of font.
:param RGBA255 text_color: Color of the text.
:param bool bold: If enabled, the label's text will be in a **bold** style.
:param bool italic: If enabled, the label's text will be in an *italic*
style.
:param bool stretch: Stretch font style.
:param str align: Horizontal alignment of text on a line, only applies if a width is supplied.
One of ``"left"``, ``"center"`` or ``"right"``.
:param float dpi: Resolution of the fonts in this layout. Defaults to 96.
:param bool multiline: if multiline is true, a \\n will start a new line.
A UITextWidget with multiline of true is the same thing as UITextArea.

:param size_hint: Tuple of floats (0.0-1.0), how much space of the parent should be requested
:param size_hint_min: min width and height in pixel
:param size_hint_max: max width and height in pixel
:param style: Not used.
:param str align: Horizontal alignment of text on a line. This only applies
if a width is supplied. Valid options include ``"left"``,
``"center"`` or ``"right"``.
:param float dpi: Resolution of the fonts in the layout. Defaults to 96.
:param bool multiline: If enabled, a ``\\n`` will start a new line. A
:py:class:`~arcade.gui.UITextWidget` with
``multiline`` of True is the same thing as
a :py:class:`~arcade.gui.UITextArea`.
:param size_hint: A tuple of floats between 0 and 1 defining the amount of
space of the parent should be requested.
:param size_hint_min: Minimum size hint width and height in pixel.
:param size_hint_max: Maximum size hint width and height in pixel.
:param style: Not used. Labels will have no need for a style; they are too
simple (just a text display).
"""

def __init__(
Expand All @@ -72,7 +86,7 @@ def __init__(
size_hint_max=None,
**kwargs,
):
# Use Arcade wrapper of pyglet.Label for text rendering
# Use Arcade Text wrapper of pyglet.Label for text rendering
self.label = arcade.Text(
start_x=0,
start_y=0,
Expand All @@ -84,10 +98,11 @@ def __init__(
bold=bold,
italic=italic,
align=align,
anchor_y="bottom", # position text bottom left, to fit into scissor box
multiline=multiline,
anchor_y="bottom", # Position text bottom left to fit into scissor
multiline=multiline, # area
**kwargs,
)

super().__init__(
x=x,
y=y,
Expand All @@ -99,9 +114,9 @@ def __init__(
**kwargs,
)

# set label size, if the width or height was given
# because border and padding can only be applied later, we can avoid `fit_content()`
# and set with and height separately
# Set the label size. If the width or height was given because border
# and padding can only be applied later, we can avoid ``fit_content``
# and set with and height separately.
if width:
self.label.width = int(width)
if height:
Expand All @@ -111,7 +126,7 @@ def __init__(

def fit_content(self):
"""
Sets the width and height of this UIWidget to contain the whole text.
Set the width and height of the label to contain the whole text.
"""
base_width = self._padding_left + self._padding_right + 2 * self._border_width
base_height = self._padding_top + self._padding_bottom + 2 * self._border_width
Expand Down Expand Up @@ -150,16 +165,21 @@ def do_render(self, surface: Surface):
class UITextWidget(UIAnchorLayout):
"""
Adds the ability to add text to a widget.
The text can be placed within the widget using UIAnchorLayout parameters with `place_text()`.

The text can be placed within the widget using
:py:class:`~arcade.gui.UIAnchorLayout` parameters with
:py:meth:`~arcade.gui.UITextWidget.place_text`.
"""

def __init__(self, text: str = "", multiline: bool = False, **kwargs):
super().__init__(text=text, **kwargs)

self._label = UILabel(
text=text,
multiline=multiline,
width=1000 if multiline else None
) # width 1000 try to prevent line wrap if multiline is enabled

self.add(self._label)
self.ui_label.fit_content()

Expand All @@ -172,7 +192,8 @@ def place_text(self,
align_y: float = 0,
**kwargs):
"""
This allows to place widgets text within the widget using UIAnchorLayout parameters.
Place widget's text within the widget using
:py:class:`~arcade.gui.UIAnchorLayout` parameters.
"""
self.remove(self._label)
self.add(
Expand All @@ -186,6 +207,10 @@ def place_text(self,

@property
def text(self):
"""
Text of the widget. Modifying this repeatedly will cause significant
lag; calculating glyph position is very expensive.
"""
return self._label.text

@text.setter
Expand All @@ -196,6 +221,13 @@ def text(self, value):

@property
def multiline(self):
"""
Get or set the multiline mode.

Newline characters (``"\\n"``) will only be honored when this is set to ``True``.
If you want a scrollable text widget, please use :py:class:`~arcade.gui.UITextArea`
instead.
"""
return self.label.multiline

@multiline.setter
Expand All @@ -206,6 +238,9 @@ def multiline(self, value):

@property
def ui_label(self) -> UILabel:
"""
Internal py:class:`~arcade.gui.UILabel` used for rendering the text.
"""
return self._label

@property
Expand All @@ -215,24 +250,39 @@ def label(self) -> arcade.Text:

class UIInputText(UIWidget):
"""
An input field the user can type text into.

:param float x: x coordinate of bottom left
:param float y: y coordinate of bottom left
:param width: width of widget
:param height: height of widget
:param text: Text to show
:param font_name: string or tuple of font names, to load
:param font_size: size of the text
:param text_color: color of the text
:param multiline: support for multiline
:param size_hint: Tuple of floats (0.0-1.0), how much space of the parent should be requested
:param size_hint_min: min width and height in pixel
:param size_hint_max: max width and height in pixel
:param style: not used
An input field the user can type text into. This is useful in returning
string input from the user. A caret is displayed, which the user can move
around with a mouse or keyboard.

A mouse drag selects text, a mouse press moves the caret, and keys can move
around the caret. Arcade confirms that the field is active before allowing
users to type, so it is okay to have multiple of these.

:param float x: x position (default anchor is bottom-left).
:param float y: y position (default anchor is bottom-left).
:param width: Width of the text field.
:param height: Height of the text field.
:param text: Initial text displayed. This can be modified later
programmatically or by the user's interaction with the caret.
:param font_name: A list of fonts to use. Arcade will start at the beginning
of the tuple and keep trying to load fonts until success.
:param font_size: Font size of font.
:param text_color: Color of the text.
:param multiline: If enabled, a ``\\n`` will start a new line. A
:py:class:`~arcade.gui.UITextWidget` ``multiline`` of
True is the same thing as
a :py:class:`~arcade.gui.UITextArea`.
:param caret_color: RGB color of the caret.
:param size_hint: A tuple of floats between 0 and 1 defining the amount of
space of the parent should be requested.
:param size_hint_min: Minimum size hint width and height in pixel.
:param size_hint_max: Maximum size hint width and height in pixel.
:param style: Style has not been implemented for this widget, however it
will be added in the near future.
"""

# move layout one pixel into the scissor box, so the caret is also shown at position 0
# Move layout one pixel into the scissor box so the caret is also shown at
# position 0.
LAYOUT_OFFSET = 1

def __init__(
Expand All @@ -246,6 +296,7 @@ def __init__(
font_size: float = 12,
text_color: RGBOrA255 = (0, 0, 0, 255),
multiline=False,
caret_color: RGB = (0, 0, 0),
size_hint=None,
size_hint_min=None,
size_hint_max=None,
Expand Down Expand Up @@ -276,13 +327,15 @@ def __init__(
self.doc, width - self.LAYOUT_OFFSET, height, multiline=multiline
)
self.layout.x += self.LAYOUT_OFFSET
self.caret = Caret(self.layout, color=(0, 0, 0))
self.caret = Caret(self.layout, color=caret_color)
self.caret.visible = False

self._blink_state = self._get_caret_blink_state()

def _get_caret_blink_state(self):
return self.caret.visible and self._active and self.caret._blink_visible
"""Check whether or not the caret is currently blinking or not."""
return self.caret.visible and self._active and \
self.caret._blink_visible

def on_update(self, dt):
# Only trigger render if blinking state changed
Expand All @@ -292,7 +345,7 @@ def on_update(self, dt):
self.trigger_full_render()

def on_event(self, event: UIEvent) -> Optional[bool]:
# if not active, check to activate, return
# If not active, check to activate, return
if not self._active and isinstance(event, UIMousePressEvent):
if self.rect.collide_with_point(event.x, event.y):
self._active = True
Expand All @@ -301,7 +354,7 @@ def on_event(self, event: UIEvent) -> Optional[bool]:
self.caret.position = len(self.doc.text)
return EVENT_UNHANDLED

# if active check to deactivate
# If active check to deactivate
if self._active and isinstance(event, UIMousePressEvent):
if self.rect.collide_with_point(event.x, event.y):
x, y = event.x - self.x - self.LAYOUT_OFFSET, event.y - self.y
Expand All @@ -312,7 +365,7 @@ def on_event(self, event: UIEvent) -> Optional[bool]:
self.caret.on_deactivate()
return EVENT_UNHANDLED

# if active pass all non press events to caret
# If active pass all non press events to caret
if self._active:
# Act on events if active
if isinstance(event, UITextEvent):
Expand All @@ -325,17 +378,20 @@ def on_event(self, event: UIEvent) -> Optional[bool]:
self.caret.on_text_motion_select(event.selection)
self.trigger_full_render()

if isinstance(event, UIMouseEvent) and self.rect.collide_with_point(
if isinstance(event, UIMouseEvent) and \
self.rect.collide_with_point(
event.x, event.y
):
x, y = event.x - self.x - self.LAYOUT_OFFSET, event.y - self.y
if isinstance(event, UIMouseDragEvent):
self.caret.on_mouse_drag(
x, y, event.dx, event.dy, event.buttons, event.modifiers
x, y, event.dx, event.dy,
event.buttons, event.modifiers
)
self.trigger_full_render()
elif isinstance(event, UIMouseScrollEvent):
self.caret.on_mouse_scroll(x, y, event.scroll_x, event.scroll_y)
self.caret.on_mouse_scroll(
x, y, event.scroll_x, event.scroll_y)
self.trigger_full_render()

if super().on_event(event):
Expand Down Expand Up @@ -372,23 +428,26 @@ def do_render(self, surface: Surface):

class UITextArea(UIWidget):
"""
A text area for scrollable text.


:param float x: x coordinate of bottom left
:param float y: y coordinate of bottom left
:param width: width of widget
:param height: height of widget
:param text: Text to show
:param font_name: string or tuple of font names, to load
:param font_size: size of the text
:param text_color: color of the text
:param multiline: support for multiline
:param scroll_speed: speed of scrolling
:param size_hint: Tuple of floats (0.0-1.0), how much space of the parent should be requested
:param size_hint_min: min width and height in pixel
:param size_hint_max: max width and height in pixel
:param style: not used
A text area that allows users to view large documents of text by scrolling
the mouse.

:param float x: x position (default anchor is bottom-left).
:param float y: y position (default anchor is bottom-left).
:param width: Width of the text area.
:param height: Height of the text area.
:param text: Initial text displayed.
:param font_name: A list of fonts to use. Arcade will start at the beginning
of the tuple and keep trying to load fonts until success.
:param font_size: Font size of font.
:param text_color: Color of the text.
:param multiline: If enabled, a ``\\n`` will start a new line.
:param scroll_speed: Speed of mouse scrolling.
:param size_hint: A tuple of floats between 0 and 1 defining the amount of
space of the parent should be requested.
:param size_hint_min: Minimum size hint width and height in pixel.
:param size_hint_max: Maximum size hint width and height in pixel.
:param style: Style has not been implemented for this widget, however it
will be added in the near future.
"""

def __init__(
Expand Down Expand Up @@ -421,7 +480,8 @@ def __init__(

# Set how fast the mouse scroll wheel will scroll text in the pane.
# Measured in pixels per 'click'
self.scroll_speed = scroll_speed if scroll_speed is not None else font_size
self.scroll_speed = scroll_speed if scroll_speed is not None \
else font_size

self.doc: AbstractDocument = pyglet.text.decode_text(text)
self.doc.set_style(
Expand All @@ -445,7 +505,7 @@ def __init__(

def fit_content(self):
"""
Sets the width and height of this UIWidget to contain the whole text.
Set the width and height of the text area to contain the whole text.
"""
self.rect = Rect(
self.x,
Expand Down