Repository URL to install this package:
|
Version:
0.28.0.dev4273 ▾
|
from typing import Any, Optional
from flet.core.badge import BadgeValue
from flet.core.control import Control, OptionalNumber
from flet.core.ref import Ref
from flet.core.types import OptionalControlEventCallable
class Semantics(Control):
"""
A control that annotates the control tree with a description of the meaning of the widgets.
Used by accessibility tools, search engines, and other semantic analysis software to determine the meaning of the application.
-----
Online docs: https://flet.dev/docs/controls/semantics
"""
def __init__(
self,
content: Optional[Control] = None,
label: Optional[str] = None,
expanded: Optional[bool] = None,
hidden: Optional[bool] = None,
selected: Optional[bool] = None,
button: Optional[bool] = None,
obscured: Optional[bool] = None,
multiline: Optional[bool] = None,
focusable: Optional[bool] = None,
read_only: Optional[bool] = None,
focus: Optional[bool] = None,
slider: Optional[bool] = None,
tooltip: Optional[str] = None,
badge: Optional[BadgeValue] = None,
toggled: Optional[bool] = None,
max_value_length: OptionalNumber = None,
checked: Optional[bool] = None,
value: Optional[str] = None,
increased_value: Optional[str] = None,
decreased_value: Optional[str] = None,
hint_text: Optional[str] = None,
on_tap_hint_text: Optional[str] = None,
current_value_length: Optional[int] = None,
heading_level: Optional[int] = None,
exclude_semantics: Optional[bool] = None,
mixed: Optional[bool] = None,
on_long_press_hint_text: Optional[str] = None,
container: Optional[bool] = None,
live_region: Optional[bool] = None,
textfield: Optional[bool] = None,
link: Optional[bool] = None,
header: Optional[bool] = None,
image: Optional[bool] = None,
on_tap: OptionalControlEventCallable = None,
on_double_tap: OptionalControlEventCallable = None,
on_increase: OptionalControlEventCallable = None,
on_decrease: OptionalControlEventCallable = None,
on_dismiss: OptionalControlEventCallable = None,
on_scroll_left: OptionalControlEventCallable = None,
on_scroll_right: OptionalControlEventCallable = None,
on_scroll_up: OptionalControlEventCallable = None,
on_scroll_down: OptionalControlEventCallable = None,
on_copy: OptionalControlEventCallable = None,
on_cut: OptionalControlEventCallable = None,
on_paste: OptionalControlEventCallable = None,
on_long_press: OptionalControlEventCallable = None,
on_move_cursor_forward_by_character: OptionalControlEventCallable = None,
on_move_cursor_backward_by_character: OptionalControlEventCallable = None,
on_did_gain_accessibility_focus: OptionalControlEventCallable = None,
on_did_lose_accessibility_focus: OptionalControlEventCallable = None,
on_set_text: OptionalControlEventCallable = None,
#
# Control
#
ref: Optional[Ref] = None,
visible: Optional[bool] = None,
disabled: Optional[bool] = None,
data: Any = None,
):
Control.__init__(
self,
ref=ref,
visible=visible,
disabled=disabled,
data=data,
badge=badge,
)
self.content = content
self.label = label
self.expanded = expanded
self.hidden = hidden
self.selected = selected
self.button = button
self.obscured = obscured
self.multiline = multiline
self.focusable = focusable
self.read_only = read_only
self.focus = focus
self.slider = slider
self.tooltip = tooltip
self.toggled = toggled
self.max_value_length = max_value_length
self.checked = checked
self.value = value
self.increased_value = increased_value
self.decreased_value = decreased_value
self.hint_text = hint_text
self.on_tap_hint_text = on_tap_hint_text
self.on_long_press_hint_text = on_long_press_hint_text
self.container = container
self.live_region = live_region
self.textfield = textfield
self.link = link
self.header = header
self.image = image
self.on_tap = on_tap
self.on_double_tap = on_double_tap
self.on_increase = on_increase
self.on_decrease = on_decrease
self.on_dismiss = on_dismiss
self.on_scroll_left = on_scroll_left
self.on_scroll_right = on_scroll_right
self.on_scroll_up = on_scroll_up
self.on_scroll_down = on_scroll_down
self.on_copy = on_copy
self.on_cut = on_cut
self.on_paste = on_paste
self.on_long_press = on_long_press
self.on_move_cursor_forward_by_character = on_move_cursor_forward_by_character
self.on_move_cursor_backward_by_character = on_move_cursor_backward_by_character
self.on_did_gain_accessibility_focus = on_did_gain_accessibility_focus
self.on_did_lose_accessibility_focus = on_did_lose_accessibility_focus
self.current_value_length = current_value_length
self.heading_level = heading_level
self.exclude_semantics = exclude_semantics
self.mixed = mixed
self.on_set_text = on_set_text
def _get_control_name(self):
return "semantics"
def _get_children(self):
children = []
if self.__content is not None:
self.__content._set_attr_internal("n", "content")
children.append(self.__content)
return children
# label
@property
def label(self) -> Optional[str]:
return self._get_attr("label")
@label.setter
def label(self, value: Optional[str]):
self._set_attr("label", value)
# content
@property
def content(self) -> Optional[Control]:
return self.__content
@content.setter
def content(self, value: Optional[Control]):
self.__content = value
# expanded
@property
def expanded(self) -> Optional[bool]:
return self._get_attr("expanded", data_type="bool")
@expanded.setter
def expanded(self, value: Optional[bool]):
self._set_attr("expanded", value)
# hidden
@property
def hidden(self):
return self._get_attr("hidden")
@hidden.setter
def hidden(self, value: Optional[bool]):
self._set_attr("hidden", value)
# textfield
@property
def textfield(self) -> Optional[bool]:
return self._get_attr("textfield", data_type="bool")
@textfield.setter
def textfield(self, value: Optional[bool]):
self._set_attr("textfield", value)
# link
@property
def link(self) -> Optional[bool]:
return self._get_attr("link", data_type="bool")
@link.setter
def link(self, value: Optional[bool]):
self._set_attr("link", value)
# image
@property
def image(self) -> Optional[bool]:
return self._get_attr("image", data_type="bool")
@image.setter
def image(self, value: Optional[bool]):
self._set_attr("image", value)
# header
@property
def header(self) -> Optional[bool]:
return self._get_attr("header", data_type="bool")
@header.setter
def header(self, value: Optional[bool]):
self._set_attr("header", value)
# selected
@property
def selected(self) -> Optional[bool]:
return self._get_attr("selected", data_type="bool")
@selected.setter
def selected(self, value: Optional[bool]):
self._set_attr("selected", value)
# button
@property
def button(self) -> Optional[bool]:
return self._get_attr("button", data_type="bool")
@button.setter
def button(self, value: Optional[bool]):
self._set_attr("button", value)
# obscured
@property
def obscured(self) -> Optional[bool]:
return self._get_attr("obscured", data_type="bool")
@obscured.setter
def obscured(self, value: Optional[bool]):
self._set_attr("obscured", value)
# multiline
@property
def multiline(self) -> Optional[bool]:
return self._get_attr("multiline", data_type="bool")
@multiline.setter
def multiline(self, value: Optional[bool]):
self._set_attr("multiline", value)
# focusable
@property
def focusable(self) -> Optional[bool]:
return self._get_attr("focusable", data_type="bool")
@focusable.setter
def focusable(self, value: Optional[bool]):
self._set_attr("focusable", value)
# read_only
@property
def read_only(self) -> Optional[bool]:
return self._get_attr("readOnly", data_type="bool")
@read_only.setter
def read_only(self, value: Optional[bool]):
self._set_attr("readOnly", value)
# focused
@property
def focused(self) -> Optional[bool]:
return self._get_attr("focused", data_type="bool")
@focused.setter
def focused(self, value: Optional[bool]):
self._set_attr("focused", value)
# mixed
@property
def mixed(self) -> Optional[bool]:
return self._get_attr("mixed", data_type="bool")
@mixed.setter
def mixed(self, value: Optional[bool]):
self._set_attr("mixed", value)
# exclude_semantics
@property
def exclude_semantics(self) -> bool:
return self._get_attr("excludeSemantics", data_type="bool", def_value=False)
@exclude_semantics.setter
def exclude_semantics(self, value: Optional[bool]):
self._set_attr("excludeSemantics", value)
# heading_level
@property
def heading_level(self) -> Optional[int]:
return self._get_attr("headingLevel", data_type="int")
@heading_level.setter
def heading_level(self, value: Optional[int]):
self._set_attr("headingLevel", value)
# current_value_length
@property
def current_value_length(self) -> Optional[int]:
return self._get_attr("currentValueLength", data_type="int")
@current_value_length.setter
def current_value_length(self, value: Optional[int]):
self._set_attr("currentValueLength", value)
# slider
@property
def slider(self) -> Optional[bool]:
return self._get_attr("slider", data_type="bool")
@slider.setter
def slider(self, value: Optional[bool]):
self._set_attr("slider", value)
# tooltip
@property
def tooltip(self) -> Optional[str]:
return self._get_attr("tooltip")
@tooltip.setter
def tooltip(self, value: Optional[str]):
self._set_attr("tooltip", value)
# toggled
@property
def toggled(self) -> Optional[bool]:
return self._get_attr("toggled", data_type="bool")
@toggled.setter
def toggled(self, value: Optional[bool]):
self._set_attr("toggled", value)
# max_value_length
@property
def max_value_length(self) -> OptionalNumber:
return self._get_attr("maxValueLength")
@max_value_length.setter
def max_value_length(self, value: OptionalNumber):
self._set_attr("maxValueLength", value)
# checked
@property
def checked(self) -> Optional[bool]:
return self._get_attr("checked", data_type="bool")
@checked.setter
def checked(self, value: Optional[bool]):
self._set_attr("checked", value)
# value
@property
def value(self) -> Optional[str]:
return self._get_attr("value")
@value.setter
def value(self, value: Optional[str]):
self._set_attr("value", value)
# increased_value
@property
def increased_value(self) -> Optional[str]:
return self._get_attr("increasedValue")
@increased_value.setter
def increased_value(self, value: Optional[str]):
self._set_attr("increasedValue", value)
# decreased_value
@property
def decreased_value(self) -> Optional[str]:
return self._get_attr("decreasedValue")
@decreased_value.setter
def decreased_value(self, value: Optional[str]):
self._set_attr("decreasedValue", value)
# hint_text
@property
def hint_text(self) -> Optional[str]:
return self._get_attr("hintText")
@hint_text.setter
def hint_text(self, value: Optional[str]):
self._set_attr("hintText", value)
# on_long_press_hint_text
@property
def on_long_press_hint_text(self):
return self._get_attr("onLongPressHintText")
@on_long_press_hint_text.setter
def on_long_press_hint_text(self, value: Optional[bool]):
self._set_attr("onLongPressHintText", value)
# on_tap_hint_text
@property
def on_tap_hint_text(self):
return self._get_attr("onTapHintText")
@on_tap_hint_text.setter
def on_tap_hint_text(self, value: Optional[bool]):
self._set_attr("onTapHintText", value)
# container
@property
def container(self) -> Optional[bool]:
return self._get_attr("container", data_type="bool")
@container.setter
def container(self, value: Optional[bool]):
self._set_attr("container", value)
# live_region
@property
def live_region(self) -> Optional[bool]:
return self._get_attr("liveRegion", data_type="bool")
@live_region.setter
def live_region(self, value: Optional[bool]):
self._set_attr("liveRegion", value)
# on_tap
@property
def on_tap(self) -> OptionalControlEventCallable:
return self._get_event_handler("tap")
@on_tap.setter
def on_tap(self, handler: OptionalControlEventCallable):
self._add_event_handler("tap", handler)
self._set_attr("onTap", True if handler is not None else None)
# on_double_tap
@property
def on_double_tap(self) -> OptionalControlEventCallable:
return self._get_event_handler("double_tap")
@on_double_tap.setter
def on_double_tap(self, handler: OptionalControlEventCallable):
self._add_event_handler("double_tap", handler)
self._set_attr("onDoubleTap", True if handler is not None else None)
# on_increase
@property
def on_increase(self) -> OptionalControlEventCallable:
return self._get_event_handler("increase")
@on_increase.setter
def on_increase(self, handler: OptionalControlEventCallable):
self._add_event_handler("increase", handler)
self._set_attr("onIncrease", True if handler is not None else None)
# on_decrease
@property
def on_decrease(self) -> OptionalControlEventCallable:
return self._get_event_handler("decrease")
@on_decrease.setter
def on_decrease(self, handler: OptionalControlEventCallable):
self._add_event_handler("decrease", handler)
self._set_attr("onDecrease", True if handler is not None else None)
# on_dismiss
@property
def on_dismiss(self) -> OptionalControlEventCallable:
return self._get_event_handler("dismiss")
@on_dismiss.setter
def on_dismiss(self, handler: OptionalControlEventCallable):
self._add_event_handler("dismiss", handler)
self._set_attr("onDismiss", True if handler is not None else None)
# on_scroll_left
@property
def on_scroll_left(self) -> OptionalControlEventCallable:
return self._get_event_handler("scroll_left")
@on_scroll_left.setter
def on_scroll_left(self, handler: OptionalControlEventCallable):
self._add_event_handler("scroll_left", handler)
self._set_attr("onScrollLeft", True if handler is not None else None)
# on_scroll_right
@property
def on_scroll_right(self) -> OptionalControlEventCallable:
return self._get_event_handler("scroll_right")
@on_scroll_right.setter
def on_scroll_right(self, handler: OptionalControlEventCallable):
self._add_event_handler("scroll_right", handler)
self._set_attr("onScrollRight", True if handler is not None else None)
# on_scroll_up
@property
def on_scroll_up(self) -> OptionalControlEventCallable:
return self._get_event_handler("scroll_up")
@on_scroll_up.setter
def on_scroll_up(self, handler: OptionalControlEventCallable):
self._add_event_handler("scroll_up", handler)
self._set_attr("onScrollUp", True if handler is not None else None)
# on_scroll_down
@property
def on_scroll_down(self) -> OptionalControlEventCallable:
return self._get_event_handler("scroll_down")
@on_scroll_down.setter
def on_scroll_down(self, handler: OptionalControlEventCallable):
self._add_event_handler("scroll_down", handler)
self._set_attr("onScrollDown", True if handler is not None else None)
# on_copy
@property
def on_copy(self) -> OptionalControlEventCallable:
return self._get_event_handler("copy")
@on_copy.setter
def on_copy(self, handler: OptionalControlEventCallable):
self._add_event_handler("copy", handler)
self._set_attr("onCopy", True if handler is not None else None)
# on_cut
@property
def on_cut(self) -> OptionalControlEventCallable:
return self._get_event_handler("cut")
@on_cut.setter
def on_cut(self, handler: OptionalControlEventCallable):
self._add_event_handler("cut", handler)
self._set_attr("onCut", True if handler is not None else None)
# on_paste
@property
def on_paste(self) -> OptionalControlEventCallable:
return self._get_event_handler("paste")
@on_paste.setter
def on_paste(self, handler: OptionalControlEventCallable):
self._add_event_handler("paste", handler)
self._set_attr("onPaste", True if handler is not None else None)
# on_long_press
@property
def on_long_press(self) -> OptionalControlEventCallable:
return self._get_event_handler("long_press")
@on_long_press.setter
def on_long_press(self, handler: OptionalControlEventCallable):
self._add_event_handler("long_press", handler)
self._set_attr("onLongPress", True if handler is not None else None)
# on_move_cursor_forward_by_character
@property
def on_move_cursor_forward_by_character(
self,
) -> OptionalControlEventCallable:
return self._get_event_handler("move_cursor_forward_by_character")
@on_move_cursor_forward_by_character.setter
def on_move_cursor_forward_by_character(
self, handler: OptionalControlEventCallable
):
self._add_event_handler("move_cursor_forward_by_character", handler)
self._set_attr(
"onMoveCursorForwardByCharacter", True if handler is not None else None
)
# on_move_cursor_backward_by_character
@property
def on_move_cursor_backward_by_character(
self,
) -> OptionalControlEventCallable:
return self._get_event_handler("move_cursor_backward_by_character")
@on_move_cursor_backward_by_character.setter
def on_move_cursor_backward_by_character(
self, handler: OptionalControlEventCallable
):
self._add_event_handler("move_cursor_backward_by_character", handler)
self._set_attr(
"onMoveCursorBackwardByCharacter", True if handler is not None else None
)
# on_did_gain_accessibility_focus
@property
def on_did_gain_accessibility_focus(
self,
) -> OptionalControlEventCallable:
return self._get_event_handler("did_gain_accessibility_focus")
@on_did_gain_accessibility_focus.setter
def on_did_gain_accessibility_focus(self, handler: OptionalControlEventCallable):
self._add_event_handler("did_gain_accessibility_focus", handler)
self._set_attr(
"onDidGainAccessibilityFocus", True if handler is not None else None
)
# on_did_lose_accessibility_focus
@property
def on_did_lose_accessibility_focus(
self,
) -> OptionalControlEventCallable:
return self._get_event_handler("did_lose_accessibility_focus")
@on_did_lose_accessibility_focus.setter
def on_did_lose_accessibility_focus(self, handler: OptionalControlEventCallable):
self._add_event_handler("did_lose_accessibility_focus", handler)
self._set_attr(
"onDidLoseAccessibilityFocus", True if handler is not None else None
)
# on_set_text
@property
def on_set_text(
self,
) -> OptionalControlEventCallable:
return self._get_event_handler("set_text")
@on_set_text.setter
def on_set_text(self, handler: OptionalControlEventCallable):
self._add_event_handler("set_text", handler)
self._set_attr("setText", True if handler is not None else None)