flet 0.70.0.dev5623__py3-none-any.whl → 0.70.0.dev5771__py3-none-any.whl

flet/controls/cupertino/cupertino_textfield.py

@@ -36,8 +36,7 @@ class CupertinoTextField(TextField):
 
     placeholder_style: Optional[TextStyle] = None
     """
-    The [`TextStyle`][flet.TextStyle] to use for
-    [`placeholder_text`][flet.CupertinoTextField.placeholder_text].
+    The [`TextStyle`][flet.] to use for [`placeholder_text`][(c).].
     """
 
     gradient: Optional[Gradient] = None
@@ -47,36 +46,37 @@ class CupertinoTextField(TextField):
 
     blend_mode: Optional[BlendMode] = None
     """
-    The blend mode applied to the [`bgcolor`][flet.CupertinoTextField.bgcolor] or
-    [`gradient`][flet.CupertinoTextField.gradient] background.
+    The blend mode applied to the [`bgcolor`][(c).] or [`gradient`][(c).] background.
     """
 
     shadows: Optional[BoxShadowValue] = None
     """
-    A list of shadows behind the text field.
+    A list of shadows behind this text field.
     """
 
     prefix_visibility_mode: OverlayVisibilityMode = OverlayVisibilityMode.ALWAYS
     """
-    Defines the visibility of the [`prefix`][flet.CupertinoTextField.prefix] control
+    Defines the visibility of the [`prefix`][(c).] control
     based on the state of text entry.
 
-    Has no effect if `prefix` is not specified.
+    Note:
+        Has no effect if [`prefix`][(c).] is not specified.
     """
 
     suffix_visibility_mode: OverlayVisibilityMode = OverlayVisibilityMode.ALWAYS
     """
-    Defines the visibility of the [`suffix`][flet.CupertinoTextField.suffix] control
+    Defines the visibility of the [`suffix`][(c).] control
     based on the state of text entry.
 
-    Has no effect if `suffix` is not specified.
+    Note:
+        Has no effect if [`suffix`][(c).] is not specified.
     """
 
     clear_button_visibility_mode: OverlayVisibilityMode = OverlayVisibilityMode.NEVER
     """
     Defines the visibility of the clear button based on the state of text entry.
 
-    Will appear only if no [`suffix`][flet.CupertinoTextField.suffix] is provided.
+    Will appear only if no [`suffix`][(c).] is provided.
     """
 
     clear_button_semantics_label: Optional[str] = "Clear"
@@ -88,16 +88,12 @@ class CupertinoTextField(TextField):
 
     image: Optional[DecorationImage] = None
     """
-    An image to paint above the [`bgcolor`][flet.CupertinoTextField.bgcolor] or
-    [`gradient`][flet.CupertinoTextField.gradient] background.
+    An image to paint above the [`bgcolor`][(c).] or [`gradient`][(c).] background.
     """
 
     padding: PaddingValue = field(default_factory=lambda: Padding.all(7))
     """
-    The padding around the text entry area between the
-    [`prefix`][flet.CupertinoTextField.prefix]
-    and [`suffix`][flet.CupertinoTextField.suffix] or the
-    clear button when
-    [`clear_button_visibility_mode`][flet.CupertinoTextField.clear_button_visibility_mode]
-    is not [`OverlayVisibilityMode.NEVER`][flet.OverlayVisibilityMode.NEVER].
+    The padding around the text entry area between the [`prefix`][(c).]
+    and [`suffix`][(c).] or the clear button when [`clear_button_visibility_mode`][(c).]
+    is not [`OverlayVisibilityMode.NEVER`][flet.].
     """

flet/controls/cupertino/cupertino_timer_picker.py

@@ -24,7 +24,7 @@ class CupertinoTimerPicker(LayoutControl):
     A countdown timer picker in iOS style.
 
     It can show a countdown duration with hour, minute and second spinners. The
-    duration is bound between 0 and 23 hours 59 minutes 59 seconds.
+    duration is bound between `0` and `23` hours `59` minutes `59` seconds.
 
     Raises:
         AssertionError: If [`value`][(c).] is negative.
@@ -42,12 +42,14 @@ class CupertinoTimerPicker(LayoutControl):
 
     value: DurationValue = field(default_factory=lambda: Duration())
     """
-    The initial duration in seconds of the countdown timer.
+    The initial duration of the countdown timer.
+
+    If specified as an integer, it will be assumed to be in seconds.
     """
 
     alignment: Alignment = field(default_factory=lambda: Alignment.CENTER)
     """
-    Defines how the timer picker should be positioned within its parent.
+    Defines how this picker should be positioned within its parent.
     """
 
     second_interval: int = 1
@@ -68,12 +70,12 @@ class CupertinoTimerPicker(LayoutControl):
 
     mode: CupertinoTimerPickerMode = CupertinoTimerPickerMode.HOUR_MINUTE_SECONDS
     """
-    The mode of the timer picker.
+    The mode of this picker.
     """
 
     bgcolor: Optional[ColorValue] = None
     """
-    The background color of this timer picker.
+    The background color of this picker.
     """
 
     item_extent: Number = 32.0
@@ -85,9 +87,10 @@ class CupertinoTimerPicker(LayoutControl):
     """
     Called when the timer's duration changes.
 
-    The [`data`][flet.Event] property of the event handler argument is the new duration.
-    It has the same [type][flet.DurationValue] as
-    [`value`][flet.CupertinoTimerPicker.value].
+    The [`data`][flet.Event.] property of the event
+    handler contains the new duration value.
+    Its type matches [`value`][(c).]: if `value` is a `Duration`,
+    then `data` is also a `Duration`; otherwise, it is an `int` (seconds).
     """
 
     def before_update(self):

flet/controls/exceptions.py

@@ -1,8 +1,8 @@
 __all__ = [
     "FletException",
-    "FletUnsupportedPlatformException",
-    "FletUnimplementedPlatformException",
     "FletPageDisconnectedException",
+    "FletUnimplementedPlatformException",
+    "FletUnsupportedPlatformException",
 ]
 
 
@@ -12,9 +12,9 @@ class FletException(Exception):
 
     See these subclasses/implementations:
 
-    - [`FletUnsupportedPlatformException`][flet.FletUnsupportedPlatformException]
-    - [`FletUnimplementedPlatformException`][flet.FletUnimplementedPlatformException]
-    - [`FletPageDisconnectedException`][flet.FletPageDisconnectedException]
+    - [`FletUnsupportedPlatformException`][flet.]
+    - [`FletUnimplementedPlatformException`][flet.]
+    - [`FletPageDisconnectedException`][flet.]
     """
 
 

flet/controls/icon_data.py

@@ -13,8 +13,8 @@ class IconData(IntEnum):
 
     An icon can come from:
 
-    - the Material icon set via the [`Icons`][flet.Icons] enum,
-    - the Cupertino icon set via the [`CupertinoIcons`][flet.CupertinoIcons] enum,
+    - the Material icon set via the [`Icons`][flet.] enum,
+    - the Cupertino icon set via the [`CupertinoIcons`][flet.] enum,
     - or a custom icon set defined by the developer.
 
     Internally, an icon is stored as an integer that encodes icon's index

flet/controls/keys.py

@@ -3,8 +3,9 @@ from typing import Optional, Union
 
 __all__ = [
     "Key",
-    "ValueKey",
+    "KeyValue",
     "ScrollKey",
+    "ValueKey",
 ]
 
 

flet/controls/layout_control.py

@@ -31,7 +31,7 @@ class LayoutControl(Control):
 
     Note:
         Effective only if this control is a descendant of one of the following:
-        [`Stack`][flet.Stack] control, [`Page.overlay`][flet.Page.overlay] list.
+        [`Stack`][flet.] control, [`Page.overlay`][flet.] list.
     """
 
     top: Optional[Number] = None
@@ -40,7 +40,7 @@ class LayoutControl(Control):
 
     Note:
         Effective only if this control is a descendant of one of the following:
-        [`Stack`][flet.Stack] control, [`Page.overlay`][flet.Page.overlay] list.
+        [`Stack`][flet.] control, [`Page.overlay`][flet.] list.
     """
 
     right: Optional[Number] = None
@@ -49,7 +49,7 @@ class LayoutControl(Control):
 
     Note:
         Effective only if this control is a descendant of one of the following:
-        [`Stack`][flet.Stack] control, [`Page.overlay`][flet.Page.overlay] list.
+        [`Stack`][flet.] control, [`Page.overlay`][flet.] list.
     """
 
     bottom: Optional[Number] = None
@@ -58,7 +58,7 @@ class LayoutControl(Control):
 
     Note:
         Effective only if this control is a descendant of one of the following:
-        [`Stack`][flet.Stack] control, [`Page.overlay`][flet.Page.overlay] list.
+        [`Stack`][flet.] control, [`Page.overlay`][flet.] list.
     """
 
     align: Optional[Alignment] = None
@@ -164,15 +164,15 @@ class LayoutControl(Control):
     """
     aspect_ratio: Optional[Number] = None
     """
-    TBD
+    The aspect ratio of the control.
+    It is defined as the ratio of the width to the height.
     """
 
     animate_opacity: Optional[AnimationValue] = None
     """
-    Enables implicit animation of the [`opacity`][flet.LayoutControl.opacity]
-    property.
+    Enables implicit animation of the [`opacity`][flet.LayoutControl.] property.
 
-    More information [here](https://docs.flet-docs.pages.dev/cookbook/cookbook/animations).
+    More information [here](https://docs.flet-docs.pages.dev/cookbook/animations).
     """
 
     animate_size: Optional[AnimationValue] = None
@@ -183,50 +183,45 @@ class LayoutControl(Control):
     animate_position: Optional[AnimationValue] = None
     """
     Enables implicit animation of the positioning properties
-    ([`left`][flet.LayoutControl.left], [`right`][flet.LayoutControl.right],
-    [`top`][flet.LayoutControl.top] and
-    [`bottom`][flet.LayoutControl.bottom]).
+    ([`left`][flet.LayoutControl.], [`right`][flet.LayoutControl.],
+    [`top`][flet.LayoutControl.] and [`bottom`][flet.LayoutControl.]).
 
-    More information [here](https://docs.flet-docs.pages.dev/cookbook/cookbook/animations).
+    More information [here](https://docs.flet-docs.pages.dev/cookbook/animations).
     """
 
     animate_align: Optional[AnimationValue] = None
     """
-    Enables implicit animation of the [`align`][flet.LayoutControl.align]
-    property.
+    Enables implicit animation of the [`align`][flet.LayoutControl.] property.
 
-    More information [here](https://docs.flet-docs.pages.dev/cookbook/cookbook/animations).
+    More information [here](https://docs.flet-docs.pages.dev/cookbook/animations).
     """
 
     animate_margin: Optional[AnimationValue] = None
     """
-    Enables implicit animation of the [`margin`][flet.LayoutControl.margin]
-    property.
+    Enables implicit animation of the [`margin`][flet.LayoutControl.] property.
 
-    More information [here](https://docs.flet-docs.pages.dev/cookbook/cookbook/animations).
+    More information [here](https://docs.flet-docs.pages.dev/cookbook/animations).
     """
 
     animate_rotation: Optional[AnimationValue] = None
     """
-    Enables implicit animation of the [`rotate`][flet.LayoutControl.rotate]
-    property.
+    Enables implicit animation of the [`rotate`][flet.LayoutControl.] property.
 
-    More information [here](https://docs.flet-docs.pages.dev/cookbook/cookbook/animations).
+    More information [here](https://docs.flet-docs.pages.dev/cookbook/animations).
     """
 
     animate_scale: Optional[AnimationValue] = None
     """
-    Enables implicit animation of the [`scale`][flet.LayoutControl.scale] property.
+    Enables implicit animation of the [`scale`][flet.LayoutControl.] property.
 
-    More information [here](https://docs.flet-docs.pages.dev/cookbook/cookbook/animations).
+    More information [here](https://docs.flet-docs.pages.dev/cookbook/animations).
     """
 
     animate_offset: Optional[AnimationValue] = None
     """
-    Enables implicit animation of the [`offset`][flet.LayoutControl.offset]
-    property.
+    Enables implicit animation of the [`offset`][flet.LayoutControl.] property.
 
-    More information [here](https://docs.flet-docs.pages.dev/cookbook/cookbook/animations).
+    More information [here](https://docs.flet-docs.pages.dev/cookbook/animations).
     """
 
     on_animation_end: Optional[ControlEventHandler["LayoutControl"]] = None
@@ -238,7 +233,7 @@ class LayoutControl(Control):
     The `data` property of the event handler argument contains the name
     of the animation.
 
-    More information [here](https://docs.flet-docs.pages.dev/cookbook/cookbook/animations).
+    More information [here](https://docs.flet-docs.pages.dev/cookbook/animations).
     """
 
 

flet/controls/material/alert_dialog.py

@@ -38,8 +38,8 @@ class AlertDialog(DialogControl):
     The content of this dialog is displayed in the center of this dialog in a
     lighter font.
 
-    Typically this is a [`Column`][flet.Column]
-    that contains this dialog's [`Text`][flet.Text] message.
+    Typically this is a [`Column`][flet.]
+    that contains this dialog's [`Text`][flet.] message.
     """
 
     modal: bool = False
@@ -51,15 +51,14 @@ class AlertDialog(DialogControl):
     """
     The title of this dialog is displayed in a large font at its top.
 
-    Typically a [`Text`][flet.Text] control.
+    Typically a [`Text`][flet.] control.
     """
 
     actions: list[Control] = field(default_factory=list)
     """
     A set of actions that are displayed at the bottom of this dialog.
 
-    Typically this is a list of [`TextButton`][flet.TextButton]
-    controls.
+    Typically this is a list of [`TextButton`][flet.] controls.
     """
 
     bgcolor: Optional[ColorValue] = None
@@ -76,37 +75,35 @@ class AlertDialog(DialogControl):
     """
     A control that is displayed at the top of this dialog.
 
-    Typically a [`Icon`][flet.Icon] control.
+    Typically a [`Icon`][flet.] control.
     """
 
     title_padding: Optional[PaddingValue] = None
     """
-    Padding around the [`title`][flet.AlertDialog.title].
+    Padding around the [`title`][(c).].
 
     If there is no title, no padding will be provided. Otherwise, this padding is used.
 
-    Defaults to providing `24` pixels on the top, left, and right of the
-    [`title`][flet.AlertDialog.title].
-    If the [`content`][flet.AlertDialog.content] is not `None`, then no bottom padding
-    is provided (but see [`content_padding`][flet.AlertDialog.content_padding]).
+    Defaults to `24` pixels on the top, left, and right of the [`title`][(c).].
+    If the [`content`][(c).] is not `None`, then no bottom padding
+    is provided (see [`content_padding`][(c).]).
     If it is not set, then an extra `20` pixels of bottom padding is added to separate
-    the `title` from the `actions`.
+    the [`title`][(c).] from the [`actions`][(c).].
     """
 
     content_padding: Optional[PaddingValue] = None
     """
-    Padding around the [`content`][flet.AlertDialog.content].
+    Padding around the [`content`][(c).].
 
-    If there is no `content`, no padding will be provided. Otherwise, padding of 20
-    pixels is provided above the content to separate the content from the title, and
-    padding of 24 pixels is provided on the left, right, and bottom to separate the
-    content from the other edges of this dialog.
+    If there is no `content`, no padding will be provided. Otherwise, padding of `20`
+    pixels is provided above the content to separate the [`content`][(c).] from
+    the [`title`][(c).], and padding of `24` pixels is provided on the left, right,
+    and bottom to separate the [`content`][(c).] from the other edges of this dialog.
     """
 
     actions_padding: Optional[PaddingValue] = None
     """
-    Padding around the set of [`actions`][flet.AlertDialog.actions] at the bottom of
-    this dialog.
+    Padding around the set of [`actions`][(c).] at the bottom of this dialog.
 
     Typically used to provide padding to the button bar between the button bar and the
     edges of this dialog.
@@ -119,56 +116,54 @@ class AlertDialog(DialogControl):
     """
     Defines the horizontal layout of the actions.
 
-    Internally defaults to `MainAxisAlignment.END`.
+    Internally defaults to [`MainAxisAlignment.END`][flet.].
     """
 
     shape: Optional[OutlinedBorder] = None
     """
     The shape of this dialog.
 
-    Defaults to [`DialogTheme.shape`][flet.DialogTheme.shape]. If it is not set,
-    it defaults to `RoundedRectangleBorder(radius=4.0)`.
+    If `None`, defaults to [`DialogTheme.shape`][flet.].
+    If it is also `None`, it defaults to `RoundedRectangleBorder(radius=4.0)`.
     """
 
     inset_padding: Optional[PaddingValue] = None
     """
     Padding around this dialog itself.
 
-    Defaults to `Padding.symmetric(vertical=40, horizontal=24)` - 40 pixels
-    horizontally and 24 pixels vertically outside of this dialog box.
+    Defaults to `Padding.symmetric(vertical=40, horizontal=24)` - `40` pixels
+    horizontally and `24` pixels vertically outside of this dialog box.
     """
 
     icon_padding: Optional[PaddingValue] = None
     """
-    Padding around the [`icon`][flet.AlertDialog.icon].
+    Padding around the [`icon`][(c).].
     """
 
     action_button_padding: Optional[PaddingValue] = None
     """
-    The padding that surrounds each button in [`actions`][flet.AlertDialog.actions].
+    The padding that surrounds each button in [`actions`][(c).].
     """
 
     shadow_color: Optional[ColorValue] = None
     """
     The color used to paint a drop shadow
-    under this dialog, which reflects this dialog's elevation.
+    under this dialog, which reflects this dialog's [`elevation`][(c).].
     """
 
     icon_color: Optional[ColorValue] = None
     """
-    The color for the Icon in the [`icon`][flet.AlertDialog.icon] of this dialog.
+    The color for the Icon in the [`icon`][(c).] of this dialog.
 
-    If `None`, [`DialogTheme.icon_color`][flet.DialogTheme.icon_color] is used.
-    If that is null, defaults to color scheme's
-    [`ColorScheme.secondary`][flet.ColorScheme.secondary] if
-    [`Theme.use_material3`][flet.Theme.use_material3] is `True`, `Colors.BLACK`
-    otherwise.
+    If `None`, [`DialogTheme.icon_color`][flet.] is used.
+    If that is null, defaults to color scheme's [`ColorScheme.secondary`][flet.] if
+    [`Theme.use_material3`][flet.] is `True`, `Colors.BLACK` otherwise.
     """
 
     scrollable: bool = False
     """
-    Determines whether the [`title`][flet.AlertDialog.title] and
-    [`content`][flet.AlertDialog.content] controls are wrapped in a scrollable.
+    Determines whether the [`title`][(c).] and
+    [`content`][(c).] controls are wrapped in a scrollable.
 
     This configuration is used when the `title` and `content` are expected to overflow.
     Both `title` and `content` are wrapped in a scroll view, allowing all overflowed
@@ -177,7 +172,7 @@ class AlertDialog(DialogControl):
 
     actions_overflow_button_spacing: Optional[Number] = None
     """
-    The spacing between [`actions`][flet.AlertDialog.actions] when the `OverflowBar`
+    The spacing between [`actions`][(c).] when the `OverflowBar`
     switches to a column layout because the actions don't fit horizontally.
 
     If the controls in `actions` do not fit into a single row, they are arranged into a
@@ -189,21 +184,19 @@ class AlertDialog(DialogControl):
     """
     How to align this dialog.
 
-    If `None`, then [`DialogTheme.alignment`][flet.DialogTheme.alignment] is used.
-    If that is also `None`, the default is [`Alignment.CENTER`][flet.Alignment.CENTER].
+    If `None`, then [`DialogTheme.alignment`][flet.] is used.
+    If that is also `None`, the default is [`Alignment.CENTER`][flet.].
     """
 
     content_text_style: Optional[TextStyle] = None
     """
-    The style for the text in the [`content`][flet.AlertDialog.content] of this dialog.
+    The style for the text in the [`content`][(c).] of this dialog.
 
-    If `None`, [`DialogTheme.content_text_style`][flet.DialogTheme.content_text_style]
-    is used.
+    If `None`, [`DialogTheme.content_text_style`][flet.] is used.
     If that's is also `None`, defaults to
-    [`TextTheme.body_medium`][flet.TextTheme.body_medium] of
-    [Theme.text_theme][flet.Theme.text_theme] if
-    [`Theme.use_material3`][flet.Theme.use_material3] is `True`,
-    [`TextTheme.title_medium`][flet.TextTheme.title_medium] otherwise.
+    [`TextTheme.body_medium`][flet.] (if [`Theme.use_material3`][flet.] is `True`;
+    [`TextTheme.title_medium`][flet.] otherwise) of
+    [Theme.text_theme][flet.Theme.text_theme].
     """
 
     title_text_style: Optional[TextStyle] = None
@@ -213,7 +206,8 @@ class AlertDialog(DialogControl):
 
     clip_behavior: ClipBehavior = ClipBehavior.NONE
     """
-    Defines how the contents of this dialog are clipped (or not) to the given `shape`.
+    Defines how the contents of this dialog are clipped (or not)
+    to the given [`shape`][(c).].
     """
 
     semantics_label: Optional[str] = None
@@ -221,8 +215,8 @@ class AlertDialog(DialogControl):
     The semantic label of this dialog used by accessibility frameworks to announce
     screen transitions when this dialog is opened and closed.
 
-    In iOS, if this label is not provided, a semantic label will be inferred from the
-    `title` if it is not null.
+    On iOS, if this label is not provided, a semantic label will be inferred from the
+    [`title`][(c).] if it is not `None`.
     """
 
     barrier_color: Optional[ColorValue] = None
@@ -230,8 +224,8 @@ class AlertDialog(DialogControl):
     The color of the modal barrier that
     darkens everything below this dialog.
 
-    If `None`, then [`DialogTheme.barrier_color`][flet.DialogTheme.barrier_color]
-    is used. If that is also `None`, the default is `Colors.BLACK_54`.
+    If `None`, then [`DialogTheme.barrier_color`][flet.] is used.
+    If that is also `None`, the default is `Colors.BLACK_54`.
     """
 
     def before_update(self):