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

flet/controls/cupertino/cupertino_list_tile.py

@@ -20,8 +20,7 @@ class CupertinoListTile(LayoutControl):
     """
     An iOS-style list tile.
 
-    Can also serve as a cupertino equivalent of the
-    Material [`ListTile`][flet.ListTile].
+    Can also serve as a cupertino equivalent of the Material [`ListTile`][flet.].
 
     Raises:
         AssertionError: If [`title`][(c).] is neither a string nor a visible Control.
@@ -31,92 +30,81 @@ class CupertinoListTile(LayoutControl):
     """
     The primary content of this list tile.
 
-    Typically a [`Text`][flet.Text] control.
+    Typically a [`Text`][flet.] control.
     """
 
     subtitle: Optional[StrOrControl] = None
     """
-    Additional content displayed below the [`title`][flet.CupertinoListTile.title].
+    Additional content displayed below the [`title`][(c).].
 
-    Typically a [`Text`][flet.Text] control.
+    Typically a [`Text`][flet.] control.
     """
 
     leading: Optional[IconDataOrControl] = None
     """
-    A control to display before the [`title`][flet.CupertinoListTile.title].
+    A control to display before the [`title`][(c).].
     """
 
     trailing: Optional[IconDataOrControl] = None
     """
-    A control to display after the [`title`][flet.CupertinoListTile.title].
+    A control to display after the [`title`][(c).].
 
-    Typically an [`Icon`][flet.Icon] control.
+    Typically an [`Icon`][flet.] control.
     """
 
     bgcolor: Optional[ColorValue] = None
     """
-    The list tile's background color.
+    The background color of this list tile.
     """
 
     bgcolor_activated: Optional[ColorValue] = None
     """
-    The list tile's background color
-    after the tile was tapped.
+    The background color of this list tile after it was tapped.
     """
 
     padding: Optional[PaddingValue] = None
     """
-    The tile's internal padding. Insets a CupertinoListTile's contents: its
-    [`leading`][flet.CupertinoListTile.leading],
-    [`title`][flet.CupertinoListTile.title],
-    [`subtitle`][flet.CupertinoListTile.subtitle],
-    [`additional_info`][flet.CupertinoListTile.additional_info]
-    and [`trailing`][flet.CupertinoListTile.trailing] controls.
-    """  # noqa: E501
+    The tile's internal padding. Insets a CupertinoListTile's contents:
+    its [`leading`][(c).], [`title`][(c).], [`subtitle`][(c).],
+    [`additional_info`][(c).] and [`trailing`][(c).] controls.
+    """
 
     url: Optional[Union[str, Url]] = None
     """
     The URL to open when this button is clicked.
 
-    Additionally, if [`on_click`][flet.CupertinoListTile.on_click] event callback is
+    Additionally, if [`on_click`][(c).] event callback is
     provided, it is fired after that.
     """
 
     toggle_inputs: bool = False
     """
-    Whether clicking on a list tile should toggle the state of togglable controls
-    like [`Radio`][flet.Radio], [`Checkbox`][flet.Checkbox]
-    or [`Switch`][flet.Switch] inside the tile.
+    Whether clicking on this tile should toggle the state of (visible) toggleable
+    controls like [`Radio`][flet.], [`Checkbox`][flet.] or [`Switch`][flet.] inside it.
     """
 
     additional_info: Optional[StrOrControl] = None
     """
-    A `Control` to display on the right of the list tile,
-    before [`trailing`][flet.CupertinoListTile.trailing].
+    A `Control` to display on the right of the list tile, before [`trailing`][(c).].
 
-    Similar to [`subtitle`][flet.CupertinoListTile.subtitle], an
-    [`additional_info`][flet.CupertinoListTile.additional_info] is used to
-    display additional information.
+    Similar to [`subtitle`][(c).], an [`additional_info`][(c).]
+    is used to display additional information.
 
-    Typically a [`Text`][flet.Text] control.
+    Typically a [`Text`][flet.] control.
     """
 
     leading_size: Optional[Number] = None
     """
-    Used to constrain the width and height of
-    [`leading`][flet.CupertinoListTile.leading] control.
+    Used to constrain the width and height of [`leading`][(c).] control.
 
-    Defaults to `30.0`, if [`notched=True`][flet.CupertinoListTile.notched],
-    else `28.0`.
+    Defaults to `30.0`, if [`notched`][(c).] is `True`, else `28.0`.
     """
 
     leading_to_title: Optional[Number] = None
     """
-    The horizontal space between [`leading`][flet.CupertinoListTile.leading]
-    and `[`title`][flet.CupertinoListTile.title].
+    The horizontal space between [`leading`][(c).] and `[`title`][(c).].
 
-    Defaults to `12.0`, if [`notched=True`][flet.CupertinoListTile.notched],
-    else `16.0`.
+    Defaults to `12.0`, if [`notched`][(c).] is `True`, else `16.0`.
     """
 
     notched: bool = False

flet/controls/cupertino/cupertino_navigation_bar.py

@@ -24,8 +24,8 @@ class CupertinoNavigationBar(LayoutControl):
 
     Raises:
         AssertionError: If [`destinations`][(c).] does not contain at least two visible
-            [`NavigationBarDestination`][flet.NavigationBarDestination]s.
-            IndexError: If [`selected_index`][(c).] is out of range.
+            [`NavigationBarDestination`][flet.]s.
+        IndexError: If [`selected_index`][(c).] is out of range.
     """
 
     destinations: list[NavigationBarDestination]
@@ -33,17 +33,17 @@ class CupertinoNavigationBar(LayoutControl):
     The destinations of this navigation bar.
 
     Note:
-        Must be a list of two or more [`NavigationBarDestination`][flet.NavigationBarDestination]s.
-    """  # noqa: E501
+        Must be a list of two or more [`NavigationBarDestination`][flet.]s.
+    """
 
     selected_index: int = 0
     """
-    The index into [`destinations`][flet.CupertinoNavigationBar.destinations] for the
-    currently selected [`NavigationBarDestination`][flet.NavigationBarDestination].
+    The index into [`destinations`][(c).] for the
+    currently selected [`NavigationBarDestination`][flet.].
 
     Note:
         Must be a value between `0` and the length of visible
-        [`destinations`][flet.CupertinoNavigationBar.destinations], inclusive.
+        [`destinations`][(c).], inclusive.
     """
 
     bgcolor: Optional[ColorValue] = None
@@ -53,14 +53,13 @@ class CupertinoNavigationBar(LayoutControl):
 
     active_color: Optional[ColorValue] = None
     """
-    The foreground color of the icon and
-    title of the selected destination.
+    The foreground color of the icon and title of the
+    selected [`destination`][(c).destinations].
     """
 
     inactive_color: ColorValue = CupertinoColors.INACTIVE_GRAY
     """
-    The foreground color of the icon and
-    title of the unselected destinations.
+    The foreground color of the icon and title of the unselected [`destinations`][(c).].
     """
 
     border: Optional[Border] = None

flet/controls/cupertino/cupertino_picker.py

@@ -31,23 +31,22 @@ class CupertinoPicker(LayoutControl):
 
     item_extent: Number = 32.0
     """
-    The uniform height of all [`controls`][flet.CupertinoPicker.controls].
+    The uniform height of all [`controls`][(c).].
     """
 
     selected_index: int = 0
     """
-    The index (starting from `0`) of the selected item in
-    the [`controls`][flet.CupertinoPicker.controls] list.
+    The index (starting from `0`) of the selected item in the [`controls`][(c).] list.
     """
 
     bgcolor: Optional[ColorValue] = None
     """
-    The background color of the timer picker.
+    The background color of this timer picker.
     """
 
     use_magnifier: bool = False
     """
-    Whether to use the magnifier for the center item of the wheel.
+    Whether to use the magnifier for the center item of this picker's wheel.
     """
 
     looping: bool = False
@@ -57,11 +56,14 @@ class CupertinoPicker(LayoutControl):
 
     magnification: Number = 1.0
     """
-    The zoomed-in rate of the magnifier, if it is used.
+    The zoomed-in or magnification rate of the magnifier.
 
     If the value is greater than `1.0`, the item in the center will be zoomed in by that
     rate, and it will also be rendered as flat, not cylindrical like the rest of the
     list. The item will be zoomed-out if magnification is less than `1.0`.
+
+    Note:
+        Has effect only if [`use_magnifier`][(c).] is `True`.
     """
 
     squeeze: Number = 1.45
@@ -87,13 +89,12 @@ class CupertinoPicker(LayoutControl):
     matching the height of the center row.
 
     Defaults to a rounded rectangle in iOS 14 style with
-    [`default_selection_overlay_bgcolor`][flet.CupertinoPicker.default_selection_overlay_bgcolor] as background color.
-    """  # noqa: E501
+    [`default_selection_overlay_bgcolor`][(c).] as background color.
+    """
 
     default_selection_overlay_bgcolor: ColorValue = CupertinoColors.TERTIARY_SYSTEM_FILL
     """
-    The default background color of the
-    [`selection_overlay`][flet.CupertinoPicker.selection_overlay].
+    The default background color of the [`selection_overlay`][(c).].
     """
 
     on_change: Optional[ControlEventHandler["CupertinoPicker"]] = None

flet/controls/cupertino/cupertino_radio.py

@@ -22,35 +22,33 @@ class CupertinoRadio(LayoutControl):
 
     label: Optional[str] = None
     """
-    The clickable label to display on the right of a Radio.
+    The clickable label to display on the right of this radio.
     """
 
     value: str = ""
     """
-    The value to set to [`RadioGroup`][flet.RadioGroup] ancestor/parent when the radio
+    The value to set to [`RadioGroup`][flet.] ancestor/parent when this radio
     is selected.
     """
 
     label_position: LabelPosition = LabelPosition.RIGHT
     """
-    The position of the label relative to the radio.
+    The position of the label relative to this radio.
     """
 
     fill_color: Optional[ColorValue] = None
     """
-    The color that fills the radio.
+    The color that fills this radio.
     """
 
     active_color: Optional[ColorValue] = Colors.PRIMARY
     """
-    The color used to fill this radio
-    when it is selected.
+    The color used to fill this radio when it is selected.
     """
 
     inactive_color: Optional[ColorValue] = None
     """
-    The color used to fill this radio
-    when it is not selected.
+    The color used to fill this radio when it is not selected.
     """
 
     autofocus: bool = False
@@ -63,19 +61,18 @@ class CupertinoRadio(LayoutControl):
 
     use_checkmark_style: bool = False
     """
-    Whether the radio displays in a checkbox style or the default radio style.
+    Whether the radio displays in a checkbox style instead of the default radio style.
     """
 
     toggleable: bool = False
     """
-    Set to `True` if this radio button is allowed to be returned to an indeterminate
-    state by selecting it again when selected.
+    Whether this radio button can return to an indeterminate state
+    by selecting it again when already selected.
     """
 
     focus_color: Optional[ColorValue] = None
     """
-    The color for the radio's border
-    when it has the input focus.
+    The color for the radio's border when it has the input focus.
     """
 
     mouse_cursor: Optional[MouseCursor] = None

flet/controls/cupertino/cupertino_segmented_button.py

@@ -18,8 +18,7 @@ class CupertinoSegmentedButton(LayoutControl):
     Raises:
         AssertionError: If [`controls`][(c).] does not contain at least two visible
             controls.
-        IndexError: If [`selected_index`][flet.CupertinoSegmentedButton.selected_index]
-            is out of range.
+        IndexError: If [`selected_index`][(c).] is out of range.
     """
 
     controls: list[Control]
@@ -33,29 +32,27 @@ class CupertinoSegmentedButton(LayoutControl):
     selected_index: int = 0
     """
     The index (starting from 0) of the selected segment in the
-    [`controls`][flet.CupertinoSegmentedButton.controls] list.
+    [`controls`][(c).] list.
     """
 
     selected_color: Optional[ColorValue] = None
     """
-    The color of the button when it is
-    selected.
+    The color of this button when it is selected.
     """
 
     unselected_color: Optional[ColorValue] = None
     """
-    The color of the button when it is not
-    selected.
+    The color of this button when it is not selected.
     """
 
     border_color: Optional[ColorValue] = None
     """
-    The color of the button's border.
+    The color of this button's border.
     """
 
     padding: Optional[PaddingValue] = None
     """
-    The button's padding.
+    This button's padding.
     """
 
     click_color: Optional[ColorValue] = None
@@ -63,7 +60,7 @@ class CupertinoSegmentedButton(LayoutControl):
     The color used to fill the background
     of this control when temporarily interacting with through a long press or drag.
 
-    Defaults to the [`selected_color`][flet.CupertinoSegmentedButton.selected_color]
+    Defaults to the [`selected_color`][(c).]
     with 20% opacity.
     """
 
@@ -72,9 +69,9 @@ class CupertinoSegmentedButton(LayoutControl):
     The color used to fill the background of the segment when it is disabled.
 
     If `None`, this color will be 50% opacity of the
-    [`selected_color`][flet.CupertinoSegmentedButton.selected_color] when
+    [`selected_color`][(c).] when
     the segment is selected. If the segment is unselected, this color will be
-    set to the [`unselected_color`][flet.CupertinoSegmentedButton.unselected_color].
+    set to the [`unselected_color`][(c).].
     """
 
     disabled_text_color: Optional[ColorValue] = None

flet/controls/cupertino/cupertino_slider.py

@@ -41,9 +41,8 @@ class CupertinoSlider(LayoutControl):
     The minimum value the user can select.
 
     Note:
-        - Must be less than or equal to [`max`][flet.CupertinoSlider.max].
-        - If the [`max`][flet.CupertinoSlider.max] is equal to the `min`,
-            then the slider is disabled.
+        - Must be less than or equal to [`max`][(c).].
+        - If the [`max`][(c).] is equal to the `min`, then this slider is disabled.
     """
 
     max: Number = 1.0
@@ -51,9 +50,8 @@ class CupertinoSlider(LayoutControl):
     The maximum value the user can select.
 
     Note:
-        - Must be greater than or equal to [`min`][flet.CupertinoSlider.min].
-        - If the [`min`][flet.CupertinoSlider.min] is equal to the `max`,
-            then the slider is disabled.
+        - Must be greater than or equal to [`min`][(c).].
+        - If the [`min`][(c).] is equal to the `max`, then this slider is disabled.
     """
 
     divisions: Optional[int] = None
@@ -65,8 +63,7 @@ class CupertinoSlider(LayoutControl):
 
     active_color: Optional[ColorValue] = None
     """
-    The color to use for the portion of the
-    slider track that is active.
+    The color to use for the portion of the slider track that is active.
 
     The "active" side of the slider is the side between the thumb and the minimum
     value.
@@ -74,7 +71,7 @@ class CupertinoSlider(LayoutControl):
 
     thumb_color: Optional[ColorValue] = None
     """
-    The color of the thumb.
+    The color of this slider's thumb.
     """
 
     on_change: Optional[ControlEventHandler["CupertinoSlider"]] = None

flet/controls/cupertino/cupertino_sliding_segmented_button.py

@@ -22,8 +22,8 @@ class CupertinoSlidingSegmentedButton(LayoutControl):
     Raises:
         AssertionError: If [`controls`][(c).] does not contain at least two
             visible controls.
-        IndexError: If [`selected_index`][flet.CupertinoSlidingSegmentedButton.selected_index] is out of range.
-    """  # noqa: E501
+        IndexError: If [`selected_index`][(c).] is out of range.
+    """
 
     controls: list[Control]
     """
@@ -35,47 +35,44 @@ class CupertinoSlidingSegmentedButton(LayoutControl):
 
     selected_index: int = 0
     """
-    The index (starting from 0) of the selected segment in the `controls` list.
+    The index (starting from 0) of the selected segment in the [`controls`][(c).] list.
     """
 
     bgcolor: ColorValue = CupertinoColors.TERTIARY_SYSTEM_FILL
     """
-    The background color of the button.
+    The background color of this button.
     """
 
     thumb_color: Optional[ColorValue] = None
     """
-    The color of the button when it is not
-    selected.
+    The color of this button when it is not selected.
     """
 
     padding: PaddingValue = field(
         default_factory=lambda: Padding.symmetric(vertical=2, horizontal=3)
     )
     """
-    The amount of space by which to inset the
-    [`controls`][flet.CupertinoSlidingSegmentedButton.controls].
+    The amount of space by which to inset the [`controls`][(c).].
     """
 
     proportional_width: bool = False
     """
     Determine whether segments have proportional widths based on their content.
 
-    If false, all segments will have the same width, determined by the longest
-    segment. If true, each segment's width will be determined by its individual
+    If `False`, all segments will have the same width, determined by the longest
+    segment. If `True`, each segment's width will be determined by its individual
     content.
 
-    If the max width of parent constraints is smaller than the width that the
-    segmented control needs, The segment widths will scale down proportionally
-    to ensure the segment control fits within the boundaries; similarly, if
-    the min width of parent constraints is larger, the segment width will scales
-    up to meet the min width requirement.
+    If the max width of parent constraints is smaller than the width that this control
+    needs, the segment widths will scale down proportionally to ensure this control
+    fits within the boundaries; similarly, if the min width of parent constraints is
+    larger, the segment width will scales up to meet the min width requirement.
     """
 
     on_change: Optional[ControlEventHandler["CupertinoSlidingSegmentedButton"]] = None
     """
-    Called when the state of the button is changed - when one of the `controls` is
-    clicked.
+    Called when the state of the button is changed -
+    when one of the [`controls`][(c).] is clicked.
     """
 
     def before_update(self):

flet/controls/cupertino/cupertino_switch.py

@@ -17,7 +17,9 @@ __all__ = ["CupertinoSwitch"]
 @control("CupertinoSwitch")
 class CupertinoSwitch(LayoutControl):
     """
-    An iOS-style switch. Used to toggle the on/off state of a single setting.
+    An iOS-style switch.
+
+    Used to toggle the on/off state of a single setting.
     """
 
     label: Optional[str] = None
@@ -32,7 +34,7 @@ class CupertinoSwitch(LayoutControl):
 
     label_position: LabelPosition = LabelPosition.RIGHT
     """
-    The position of the label relative to the switch.
+    The position of the [`label`][(c).] relative to this switch.
     """
 
     thumb_color: Optional[ColorValue] = None
@@ -42,8 +44,7 @@ class CupertinoSwitch(LayoutControl):
 
     focus_color: Optional[ColorValue] = None
     """
-    The color to use for the focus highlight
-    for keyboard interactions.
+    The color to use for the focus highlight for keyboard interactions.
     """
 
     autofocus: bool = False
@@ -56,14 +57,12 @@ class CupertinoSwitch(LayoutControl):
 
     on_label_color: Optional[ColorValue] = None
     """
-    The color to use for the accessibility
-    label when the switch is on.
+    The color to use for the accessibility label when the switch is on.
     """
 
     off_label_color: Optional[ColorValue] = None
     """
-    The color to use for the accessibility
-    label when the switch is off.
+    The color to use for the accessibility label when the switch is off.
     """
 
     active_thumb_image: Optional[str] = None
@@ -82,79 +81,69 @@ class CupertinoSwitch(LayoutControl):
 
     active_track_color: Optional[ColorValue] = None
     """
-    The color to use on the track when this
-    switch is on.
+    The color to use on the track when this switch is on.
     """
 
     inactive_thumb_color: Optional[ColorValue] = None
     """
-    The color to use on the thumb when this
-    switch is off.
+    The color to use on the thumb when this switch is off.
 
-    If `None`, defaults to [`thumb_color`][flet.CupertinoSwitch.thumb_color],
-    and if this is also `None`, defaults to
-    [`CupertinoColors.WHITE`][flet.CupertinoColors.WHITE].
+    If `None`, defaults to [`thumb_color`][(c).], and if this is also `None`,
+    defaults to [`CupertinoColors.WHITE`][flet.].
     """
 
     inactive_track_color: Optional[ColorValue] = None
     """
-    The color to use on the track when this
-    switch is off.
+    The color to use on the track when this switch is off.
     """
 
     track_outline_color: Optional[ControlStateValue[ColorValue]] = None
     """
     The outline color of this switch's track
-    in various [`ControlState`][flet.ControlState]s.
+    in various [`ControlState`][flet.]s.
 
-    Supported states: [`ControlState.SELECTED`][flet.ControlState.SELECTED],
-    [`ControlState.HOVERED`][flet.ControlState.HOVERED],
-    [`ControlState.DISABLED`][flet.ControlState.DISABLED],
-    [`ControlState.FOCUSED`][flet.ControlState.FOCUSED],
-    and [`ControlState.DEFAULT`][flet.ControlState.DEFAULT].
+    Supported states: [`ControlState.SELECTED`][flet.],
+    [`ControlState.HOVERED`][flet.], [`ControlState.DISABLED`][flet.],
+    [`ControlState.FOCUSED`][flet.], and [`ControlState.DEFAULT`][flet.].
     """
 
     track_outline_width: Optional[ControlStateValue[Optional[Number]]] = None
     """
     The outline width of this switch's track in all or specific
-    [`ControlState`][flet.ControlState]s.
+    [`ControlState`][flet.]s.
 
-    Supported states: [`ControlState.SELECTED`][flet.ControlState.SELECTED],
-    [`ControlState.HOVERED`][flet.ControlState.HOVERED],
-    [`ControlState.DISABLED`][flet.ControlState.DISABLED],
-    [`ControlState.FOCUSED`][flet.ControlState.FOCUSED],
-    and [`ControlState.DEFAULT`][flet.ControlState.DEFAULT].
+    Supported states: [`ControlState.SELECTED`][flet.],
+    [`ControlState.HOVERED`][flet.], [`ControlState.DISABLED`][flet.],
+    [`ControlState.FOCUSED`][flet.], and [`ControlState.DEFAULT`][flet.].
     """
 
     thumb_icon: Optional[ControlStateValue[IconData]] = None
     """
     The icon of this Switch's thumb in various
-    [`ControlState`][flet.ControlState]s.
+    [`ControlState`][flet.]s.
 
-    Supported states: [`ControlState.SELECTED`][flet.ControlState.SELECTED],
-    [`ControlState.HOVERED`][flet.ControlState.HOVERED],
-    [`ControlState.DISABLED`][flet.ControlState.DISABLED],
-    [`ControlState.FOCUSED`][flet.ControlState.FOCUSED],
-    and [`ControlState.DEFAULT`][flet.ControlState.DEFAULT].
+    Supported states: [`ControlState.SELECTED`][flet.],
+    [`ControlState.HOVERED`][flet.], [`ControlState.DISABLED`][flet.],
+    [`ControlState.FOCUSED`][flet.], and [`ControlState.DEFAULT`][flet.].
     """
 
     on_change: Optional[ControlEventHandler["CupertinoSwitch"]] = None
     """
-    Called when the state of the switch is changed.
+    Called when the state of this switch is changed.
     """
 
     on_focus: Optional[ControlEventHandler["CupertinoSwitch"]] = None
     """
-    Called when the control has received focus.
+    Called when this switch has received focus.
     """
 
     on_blur: Optional[ControlEventHandler["CupertinoSwitch"]] = None
     """
-    Called when the control has lost focus.
+    Called when this switch has lost focus.
     """
 
     on_image_error: Optional[ControlEventHandler["CupertinoSwitch"]] = None
     """
-    Called when the image ([`active_thumb_image`][flet.CupertinoSwitch.active_thumb_image] or
-    [`inactive_thumb_image`][flet.CupertinoSwitch.inactive_thumb_image]) fails to load.
-    """  # noqa: E501
+    Called when [`active_thumb_image`][(c).] or
+    [`inactive_thumb_image`][(c).] fails to load.
+    """