Spaces:
Sleeping
Sleeping
File size: 32,351 Bytes
2d876d1 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 |
"""
Collection of reusable components for building full screen applications.
All of these widgets implement the ``__pt_container__`` method, which makes
them usable in any situation where we are expecting a `prompt_toolkit`
container object.
.. warning::
At this point, the API for these widgets is considered unstable, and can
potentially change between minor releases (we try not too, but no
guarantees are made yet). The public API in
`prompt_toolkit.shortcuts.dialogs` on the other hand is considered stable.
"""
from __future__ import annotations
from functools import partial
from typing import Callable, Generic, Sequence, TypeVar
from prompt_toolkit.application.current import get_app
from prompt_toolkit.auto_suggest import AutoSuggest, DynamicAutoSuggest
from prompt_toolkit.buffer import Buffer, BufferAcceptHandler
from prompt_toolkit.completion import Completer, DynamicCompleter
from prompt_toolkit.document import Document
from prompt_toolkit.filters import (
Condition,
FilterOrBool,
has_focus,
is_done,
is_true,
to_filter,
)
from prompt_toolkit.formatted_text import (
AnyFormattedText,
StyleAndTextTuples,
Template,
to_formatted_text,
)
from prompt_toolkit.formatted_text.utils import fragment_list_to_text
from prompt_toolkit.history import History
from prompt_toolkit.key_binding.key_bindings import KeyBindings
from prompt_toolkit.key_binding.key_processor import KeyPressEvent
from prompt_toolkit.keys import Keys
from prompt_toolkit.layout.containers import (
AnyContainer,
ConditionalContainer,
Container,
DynamicContainer,
Float,
FloatContainer,
HSplit,
VSplit,
Window,
WindowAlign,
)
from prompt_toolkit.layout.controls import (
BufferControl,
FormattedTextControl,
GetLinePrefixCallable,
)
from prompt_toolkit.layout.dimension import AnyDimension
from prompt_toolkit.layout.dimension import Dimension as D
from prompt_toolkit.layout.margins import (
ConditionalMargin,
NumberedMargin,
ScrollbarMargin,
)
from prompt_toolkit.layout.processors import (
AppendAutoSuggestion,
BeforeInput,
ConditionalProcessor,
PasswordProcessor,
Processor,
)
from prompt_toolkit.lexers import DynamicLexer, Lexer
from prompt_toolkit.mouse_events import MouseEvent, MouseEventType
from prompt_toolkit.utils import get_cwidth
from prompt_toolkit.validation import DynamicValidator, Validator
from .toolbars import SearchToolbar
__all__ = [
"TextArea",
"Label",
"Button",
"Frame",
"Shadow",
"Box",
"VerticalLine",
"HorizontalLine",
"RadioList",
"CheckboxList",
"Checkbox", # backward compatibility
"ProgressBar",
]
E = KeyPressEvent
class Border:
"Box drawing characters. (Thin)"
HORIZONTAL = "\u2500"
VERTICAL = "\u2502"
TOP_LEFT = "\u250c"
TOP_RIGHT = "\u2510"
BOTTOM_LEFT = "\u2514"
BOTTOM_RIGHT = "\u2518"
class TextArea:
"""
A simple input field.
This is a higher level abstraction on top of several other classes with
sane defaults.
This widget does have the most common options, but it does not intend to
cover every single use case. For more configurations options, you can
always build a text area manually, using a
:class:`~prompt_toolkit.buffer.Buffer`,
:class:`~prompt_toolkit.layout.BufferControl` and
:class:`~prompt_toolkit.layout.Window`.
Buffer attributes:
:param text: The initial text.
:param multiline: If True, allow multiline input.
:param completer: :class:`~prompt_toolkit.completion.Completer` instance
for auto completion.
:param complete_while_typing: Boolean.
:param accept_handler: Called when `Enter` is pressed (This should be a
callable that takes a buffer as input).
:param history: :class:`~prompt_toolkit.history.History` instance.
:param auto_suggest: :class:`~prompt_toolkit.auto_suggest.AutoSuggest`
instance for input suggestions.
BufferControl attributes:
:param password: When `True`, display using asterisks.
:param focusable: When `True`, allow this widget to receive the focus.
:param focus_on_click: When `True`, focus after mouse click.
:param input_processors: `None` or a list of
:class:`~prompt_toolkit.layout.Processor` objects.
:param validator: `None` or a :class:`~prompt_toolkit.validation.Validator`
object.
Window attributes:
:param lexer: :class:`~prompt_toolkit.lexers.Lexer` instance for syntax
highlighting.
:param wrap_lines: When `True`, don't scroll horizontally, but wrap lines.
:param width: Window width. (:class:`~prompt_toolkit.layout.Dimension` object.)
:param height: Window height. (:class:`~prompt_toolkit.layout.Dimension` object.)
:param scrollbar: When `True`, display a scroll bar.
:param style: A style string.
:param dont_extend_width: When `True`, don't take up more width then the
preferred width reported by the control.
:param dont_extend_height: When `True`, don't take up more width then the
preferred height reported by the control.
:param get_line_prefix: None or a callable that returns formatted text to
be inserted before a line. It takes a line number (int) and a
wrap_count and returns formatted text. This can be used for
implementation of line continuations, things like Vim "breakindent" and
so on.
Other attributes:
:param search_field: An optional `SearchToolbar` object.
"""
def __init__(
self,
text: str = "",
multiline: FilterOrBool = True,
password: FilterOrBool = False,
lexer: Lexer | None = None,
auto_suggest: AutoSuggest | None = None,
completer: Completer | None = None,
complete_while_typing: FilterOrBool = True,
validator: Validator | None = None,
accept_handler: BufferAcceptHandler | None = None,
history: History | None = None,
focusable: FilterOrBool = True,
focus_on_click: FilterOrBool = False,
wrap_lines: FilterOrBool = True,
read_only: FilterOrBool = False,
width: AnyDimension = None,
height: AnyDimension = None,
dont_extend_height: FilterOrBool = False,
dont_extend_width: FilterOrBool = False,
line_numbers: bool = False,
get_line_prefix: GetLinePrefixCallable | None = None,
scrollbar: bool = False,
style: str = "",
search_field: SearchToolbar | None = None,
preview_search: FilterOrBool = True,
prompt: AnyFormattedText = "",
input_processors: list[Processor] | None = None,
name: str = "",
) -> None:
if search_field is None:
search_control = None
elif isinstance(search_field, SearchToolbar):
search_control = search_field.control
if input_processors is None:
input_processors = []
# Writeable attributes.
self.completer = completer
self.complete_while_typing = complete_while_typing
self.lexer = lexer
self.auto_suggest = auto_suggest
self.read_only = read_only
self.wrap_lines = wrap_lines
self.validator = validator
self.buffer = Buffer(
document=Document(text, 0),
multiline=multiline,
read_only=Condition(lambda: is_true(self.read_only)),
completer=DynamicCompleter(lambda: self.completer),
complete_while_typing=Condition(
lambda: is_true(self.complete_while_typing)
),
validator=DynamicValidator(lambda: self.validator),
auto_suggest=DynamicAutoSuggest(lambda: self.auto_suggest),
accept_handler=accept_handler,
history=history,
name=name,
)
self.control = BufferControl(
buffer=self.buffer,
lexer=DynamicLexer(lambda: self.lexer),
input_processors=[
ConditionalProcessor(
AppendAutoSuggestion(), has_focus(self.buffer) & ~is_done
),
ConditionalProcessor(
processor=PasswordProcessor(), filter=to_filter(password)
),
BeforeInput(prompt, style="class:text-area.prompt"),
]
+ input_processors,
search_buffer_control=search_control,
preview_search=preview_search,
focusable=focusable,
focus_on_click=focus_on_click,
)
if multiline:
if scrollbar:
right_margins = [ScrollbarMargin(display_arrows=True)]
else:
right_margins = []
if line_numbers:
left_margins = [NumberedMargin()]
else:
left_margins = []
else:
height = D.exact(1)
left_margins = []
right_margins = []
style = "class:text-area " + style
# If no height was given, guarantee height of at least 1.
if height is None:
height = D(min=1)
self.window = Window(
height=height,
width=width,
dont_extend_height=dont_extend_height,
dont_extend_width=dont_extend_width,
content=self.control,
style=style,
wrap_lines=Condition(lambda: is_true(self.wrap_lines)),
left_margins=left_margins,
right_margins=right_margins,
get_line_prefix=get_line_prefix,
)
@property
def text(self) -> str:
"""
The `Buffer` text.
"""
return self.buffer.text
@text.setter
def text(self, value: str) -> None:
self.document = Document(value, 0)
@property
def document(self) -> Document:
"""
The `Buffer` document (text + cursor position).
"""
return self.buffer.document
@document.setter
def document(self, value: Document) -> None:
self.buffer.set_document(value, bypass_readonly=True)
@property
def accept_handler(self) -> BufferAcceptHandler | None:
"""
The accept handler. Called when the user accepts the input.
"""
return self.buffer.accept_handler
@accept_handler.setter
def accept_handler(self, value: BufferAcceptHandler) -> None:
self.buffer.accept_handler = value
def __pt_container__(self) -> Container:
return self.window
class Label:
"""
Widget that displays the given text. It is not editable or focusable.
:param text: Text to display. Can be multiline. All value types accepted by
:class:`prompt_toolkit.layout.FormattedTextControl` are allowed,
including a callable.
:param style: A style string.
:param width: When given, use this width, rather than calculating it from
the text size.
:param dont_extend_width: When `True`, don't take up more width than
preferred, i.e. the length of the longest line of
the text, or value of `width` parameter, if
given. `True` by default
:param dont_extend_height: When `True`, don't take up more width than the
preferred height, i.e. the number of lines of
the text. `False` by default.
"""
def __init__(
self,
text: AnyFormattedText,
style: str = "",
width: AnyDimension = None,
dont_extend_height: bool = True,
dont_extend_width: bool = False,
align: WindowAlign | Callable[[], WindowAlign] = WindowAlign.LEFT,
# There is no cursor navigation in a label, so it makes sense to always
# wrap lines by default.
wrap_lines: FilterOrBool = True,
) -> None:
self.text = text
def get_width() -> AnyDimension:
if width is None:
text_fragments = to_formatted_text(self.text)
text = fragment_list_to_text(text_fragments)
if text:
longest_line = max(get_cwidth(line) for line in text.splitlines())
else:
return D(preferred=0)
return D(preferred=longest_line)
else:
return width
self.formatted_text_control = FormattedTextControl(text=lambda: self.text)
self.window = Window(
content=self.formatted_text_control,
width=get_width,
height=D(min=1),
style="class:label " + style,
dont_extend_height=dont_extend_height,
dont_extend_width=dont_extend_width,
align=align,
wrap_lines=wrap_lines,
)
def __pt_container__(self) -> Container:
return self.window
class Button:
"""
Clickable button.
:param text: The caption for the button.
:param handler: `None` or callable. Called when the button is clicked. No
parameters are passed to this callable. Use for instance Python's
`functools.partial` to pass parameters to this callable if needed.
:param width: Width of the button.
"""
def __init__(
self,
text: str,
handler: Callable[[], None] | None = None,
width: int = 12,
left_symbol: str = "<",
right_symbol: str = ">",
) -> None:
self.text = text
self.left_symbol = left_symbol
self.right_symbol = right_symbol
self.handler = handler
self.width = width
self.control = FormattedTextControl(
self._get_text_fragments,
key_bindings=self._get_key_bindings(),
focusable=True,
)
def get_style() -> str:
if get_app().layout.has_focus(self):
return "class:button.focused"
else:
return "class:button"
# Note: `dont_extend_width` is False, because we want to allow buttons
# to take more space if the parent container provides more space.
# Otherwise, we will also truncate the text.
# Probably we need a better way here to adjust to width of the
# button to the text.
self.window = Window(
self.control,
align=WindowAlign.CENTER,
height=1,
width=width,
style=get_style,
dont_extend_width=False,
dont_extend_height=True,
)
def _get_text_fragments(self) -> StyleAndTextTuples:
width = self.width - (
get_cwidth(self.left_symbol) + get_cwidth(self.right_symbol)
)
text = (f"{{:^{width}}}").format(self.text)
def handler(mouse_event: MouseEvent) -> None:
if (
self.handler is not None
and mouse_event.event_type == MouseEventType.MOUSE_UP
):
self.handler()
return [
("class:button.arrow", self.left_symbol, handler),
("[SetCursorPosition]", ""),
("class:button.text", text, handler),
("class:button.arrow", self.right_symbol, handler),
]
def _get_key_bindings(self) -> KeyBindings:
"Key bindings for the Button."
kb = KeyBindings()
@kb.add(" ")
@kb.add("enter")
def _(event: E) -> None:
if self.handler is not None:
self.handler()
return kb
def __pt_container__(self) -> Container:
return self.window
class Frame:
"""
Draw a border around any container, optionally with a title text.
Changing the title and body of the frame is possible at runtime by
assigning to the `body` and `title` attributes of this class.
:param body: Another container object.
:param title: Text to be displayed in the top of the frame (can be formatted text).
:param style: Style string to be applied to this widget.
"""
def __init__(
self,
body: AnyContainer,
title: AnyFormattedText = "",
style: str = "",
width: AnyDimension = None,
height: AnyDimension = None,
key_bindings: KeyBindings | None = None,
modal: bool = False,
) -> None:
self.title = title
self.body = body
fill = partial(Window, style="class:frame.border")
style = "class:frame " + style
top_row_with_title = VSplit(
[
fill(width=1, height=1, char=Border.TOP_LEFT),
fill(char=Border.HORIZONTAL),
fill(width=1, height=1, char="|"),
# Notice: we use `Template` here, because `self.title` can be an
# `HTML` object for instance.
Label(
lambda: Template(" {} ").format(self.title),
style="class:frame.label",
dont_extend_width=True,
),
fill(width=1, height=1, char="|"),
fill(char=Border.HORIZONTAL),
fill(width=1, height=1, char=Border.TOP_RIGHT),
],
height=1,
)
top_row_without_title = VSplit(
[
fill(width=1, height=1, char=Border.TOP_LEFT),
fill(char=Border.HORIZONTAL),
fill(width=1, height=1, char=Border.TOP_RIGHT),
],
height=1,
)
@Condition
def has_title() -> bool:
return bool(self.title)
self.container = HSplit(
[
ConditionalContainer(content=top_row_with_title, filter=has_title),
ConditionalContainer(content=top_row_without_title, filter=~has_title),
VSplit(
[
fill(width=1, char=Border.VERTICAL),
DynamicContainer(lambda: self.body),
fill(width=1, char=Border.VERTICAL),
# Padding is required to make sure that if the content is
# too small, the right frame border is still aligned.
],
padding=0,
),
VSplit(
[
fill(width=1, height=1, char=Border.BOTTOM_LEFT),
fill(char=Border.HORIZONTAL),
fill(width=1, height=1, char=Border.BOTTOM_RIGHT),
],
# specifying height here will increase the rendering speed.
height=1,
),
],
width=width,
height=height,
style=style,
key_bindings=key_bindings,
modal=modal,
)
def __pt_container__(self) -> Container:
return self.container
class Shadow:
"""
Draw a shadow underneath/behind this container.
(This applies `class:shadow` the the cells under the shadow. The Style
should define the colors for the shadow.)
:param body: Another container object.
"""
def __init__(self, body: AnyContainer) -> None:
self.container = FloatContainer(
content=body,
floats=[
Float(
bottom=-1,
height=1,
left=1,
right=-1,
transparent=True,
content=Window(style="class:shadow"),
),
Float(
bottom=-1,
top=1,
width=1,
right=-1,
transparent=True,
content=Window(style="class:shadow"),
),
],
)
def __pt_container__(self) -> Container:
return self.container
class Box:
"""
Add padding around a container.
This also makes sure that the parent can provide more space than required by
the child. This is very useful when wrapping a small element with a fixed
size into a ``VSplit`` or ``HSplit`` object. The ``HSplit`` and ``VSplit``
try to make sure to adapt respectively the width and height, possibly
shrinking other elements. Wrapping something in a ``Box`` makes it flexible.
:param body: Another container object.
:param padding: The margin to be used around the body. This can be
overridden by `padding_left`, padding_right`, `padding_top` and
`padding_bottom`.
:param style: A style string.
:param char: Character to be used for filling the space around the body.
(This is supposed to be a character with a terminal width of 1.)
"""
def __init__(
self,
body: AnyContainer,
padding: AnyDimension = None,
padding_left: AnyDimension = None,
padding_right: AnyDimension = None,
padding_top: AnyDimension = None,
padding_bottom: AnyDimension = None,
width: AnyDimension = None,
height: AnyDimension = None,
style: str = "",
char: None | str | Callable[[], str] = None,
modal: bool = False,
key_bindings: KeyBindings | None = None,
) -> None:
self.padding = padding
self.padding_left = padding_left
self.padding_right = padding_right
self.padding_top = padding_top
self.padding_bottom = padding_bottom
self.body = body
def left() -> AnyDimension:
if self.padding_left is None:
return self.padding
return self.padding_left
def right() -> AnyDimension:
if self.padding_right is None:
return self.padding
return self.padding_right
def top() -> AnyDimension:
if self.padding_top is None:
return self.padding
return self.padding_top
def bottom() -> AnyDimension:
if self.padding_bottom is None:
return self.padding
return self.padding_bottom
self.container = HSplit(
[
Window(height=top, char=char),
VSplit(
[
Window(width=left, char=char),
body,
Window(width=right, char=char),
]
),
Window(height=bottom, char=char),
],
width=width,
height=height,
style=style,
modal=modal,
key_bindings=None,
)
def __pt_container__(self) -> Container:
return self.container
_T = TypeVar("_T")
class _DialogList(Generic[_T]):
"""
Common code for `RadioList` and `CheckboxList`.
"""
open_character: str = ""
close_character: str = ""
container_style: str = ""
default_style: str = ""
selected_style: str = ""
checked_style: str = ""
multiple_selection: bool = False
show_scrollbar: bool = True
def __init__(
self,
values: Sequence[tuple[_T, AnyFormattedText]],
default_values: Sequence[_T] | None = None,
) -> None:
assert len(values) > 0
default_values = default_values or []
self.values = values
# current_values will be used in multiple_selection,
# current_value will be used otherwise.
keys: list[_T] = [value for (value, _) in values]
self.current_values: list[_T] = [
value for value in default_values if value in keys
]
self.current_value: _T = (
default_values[0]
if len(default_values) and default_values[0] in keys
else values[0][0]
)
# Cursor index: take first selected item or first item otherwise.
if len(self.current_values) > 0:
self._selected_index = keys.index(self.current_values[0])
else:
self._selected_index = 0
# Key bindings.
kb = KeyBindings()
@kb.add("up")
def _up(event: E) -> None:
self._selected_index = max(0, self._selected_index - 1)
@kb.add("down")
def _down(event: E) -> None:
self._selected_index = min(len(self.values) - 1, self._selected_index + 1)
@kb.add("pageup")
def _pageup(event: E) -> None:
w = event.app.layout.current_window
if w.render_info:
self._selected_index = max(
0, self._selected_index - len(w.render_info.displayed_lines)
)
@kb.add("pagedown")
def _pagedown(event: E) -> None:
w = event.app.layout.current_window
if w.render_info:
self._selected_index = min(
len(self.values) - 1,
self._selected_index + len(w.render_info.displayed_lines),
)
@kb.add("enter")
@kb.add(" ")
def _click(event: E) -> None:
self._handle_enter()
@kb.add(Keys.Any)
def _find(event: E) -> None:
# We first check values after the selected value, then all values.
values = list(self.values)
for value in values[self._selected_index + 1 :] + values:
text = fragment_list_to_text(to_formatted_text(value[1])).lower()
if text.startswith(event.data.lower()):
self._selected_index = self.values.index(value)
return
# Control and window.
self.control = FormattedTextControl(
self._get_text_fragments, key_bindings=kb, focusable=True
)
self.window = Window(
content=self.control,
style=self.container_style,
right_margins=[
ConditionalMargin(
margin=ScrollbarMargin(display_arrows=True),
filter=Condition(lambda: self.show_scrollbar),
),
],
dont_extend_height=True,
)
def _handle_enter(self) -> None:
if self.multiple_selection:
val = self.values[self._selected_index][0]
if val in self.current_values:
self.current_values.remove(val)
else:
self.current_values.append(val)
else:
self.current_value = self.values[self._selected_index][0]
def _get_text_fragments(self) -> StyleAndTextTuples:
def mouse_handler(mouse_event: MouseEvent) -> None:
"""
Set `_selected_index` and `current_value` according to the y
position of the mouse click event.
"""
if mouse_event.event_type == MouseEventType.MOUSE_UP:
self._selected_index = mouse_event.position.y
self._handle_enter()
result: StyleAndTextTuples = []
for i, value in enumerate(self.values):
if self.multiple_selection:
checked = value[0] in self.current_values
else:
checked = value[0] == self.current_value
selected = i == self._selected_index
style = ""
if checked:
style += " " + self.checked_style
if selected:
style += " " + self.selected_style
result.append((style, self.open_character))
if selected:
result.append(("[SetCursorPosition]", ""))
if checked:
result.append((style, "*"))
else:
result.append((style, " "))
result.append((style, self.close_character))
result.append((self.default_style, " "))
result.extend(to_formatted_text(value[1], style=self.default_style))
result.append(("", "\n"))
# Add mouse handler to all fragments.
for i in range(len(result)):
result[i] = (result[i][0], result[i][1], mouse_handler)
result.pop() # Remove last newline.
return result
def __pt_container__(self) -> Container:
return self.window
class RadioList(_DialogList[_T]):
"""
List of radio buttons. Only one can be checked at the same time.
:param values: List of (value, label) tuples.
"""
open_character = "("
close_character = ")"
container_style = "class:radio-list"
default_style = "class:radio"
selected_style = "class:radio-selected"
checked_style = "class:radio-checked"
multiple_selection = False
def __init__(
self,
values: Sequence[tuple[_T, AnyFormattedText]],
default: _T | None = None,
) -> None:
if default is None:
default_values = None
else:
default_values = [default]
super().__init__(values, default_values=default_values)
class CheckboxList(_DialogList[_T]):
"""
List of checkbox buttons. Several can be checked at the same time.
:param values: List of (value, label) tuples.
"""
open_character = "["
close_character = "]"
container_style = "class:checkbox-list"
default_style = "class:checkbox"
selected_style = "class:checkbox-selected"
checked_style = "class:checkbox-checked"
multiple_selection = True
class Checkbox(CheckboxList[str]):
"""Backward compatibility util: creates a 1-sized CheckboxList
:param text: the text
"""
show_scrollbar = False
def __init__(self, text: AnyFormattedText = "", checked: bool = False) -> None:
values = [("value", text)]
super().__init__(values=values)
self.checked = checked
@property
def checked(self) -> bool:
return "value" in self.current_values
@checked.setter
def checked(self, value: bool) -> None:
if value:
self.current_values = ["value"]
else:
self.current_values = []
class VerticalLine:
"""
A simple vertical line with a width of 1.
"""
def __init__(self) -> None:
self.window = Window(
char=Border.VERTICAL, style="class:line,vertical-line", width=1
)
def __pt_container__(self) -> Container:
return self.window
class HorizontalLine:
"""
A simple horizontal line with a height of 1.
"""
def __init__(self) -> None:
self.window = Window(
char=Border.HORIZONTAL, style="class:line,horizontal-line", height=1
)
def __pt_container__(self) -> Container:
return self.window
class ProgressBar:
def __init__(self) -> None:
self._percentage = 60
self.label = Label("60%")
self.container = FloatContainer(
content=Window(height=1),
floats=[
# We first draw the label, then the actual progress bar. Right
# now, this is the only way to have the colors of the progress
# bar appear on top of the label. The problem is that our label
# can't be part of any `Window` below.
Float(content=self.label, top=0, bottom=0),
Float(
left=0,
top=0,
right=0,
bottom=0,
content=VSplit(
[
Window(
style="class:progress-bar.used",
width=lambda: D(weight=int(self._percentage)),
),
Window(
style="class:progress-bar",
width=lambda: D(weight=int(100 - self._percentage)),
),
]
),
),
],
)
@property
def percentage(self) -> int:
return self._percentage
@percentage.setter
def percentage(self, value: int) -> None:
self._percentage = value
self.label.text = f"{value}%"
def __pt_container__(self) -> Container:
return self.container
|