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

flet/controls/material/checkbox.py

@@ -36,26 +36,25 @@ class Checkbox(LayoutControl, AdaptiveControl):
     """
     The value of this checkbox.
 
-    - If `True` the checkbox is checked.
-    - If `False` the checkbox is unchecked.
-    - If `None` and [`tristate`][flet.Checkbox.tristate] is `True` the checkbox
-        is indeterminate. (displayed as a dash)
+    - If `True`, this checkbox is checked.
+    - If `False`, this checkbox is unchecked.
+    - If `None` and [`tristate`][(c).] is `True`, this checkbox
+        is indeterminate (displayed as a dash).
     """
 
     label_position: LabelPosition = LabelPosition.RIGHT
     """
-    Defines on which side of the checkbox the `label` should be shown.
+    Defines on which side of the checkbox the [`label`][(c).] should be shown.
     """
 
     label_style: Optional[TextStyle] = None
     """
-    The label's style.
+    The [`label`][(c).]'s text style.
     """
 
     tristate: bool = False
     """
-    If `True` the checkbox's [`value`][flet.Checkbox.value] can be `True`, `False`,
-    or `None`.
+    If `True` the checkbox's [`value`][(c).] can be `True`, `False`, or `None`.
     """
 
     autofocus: bool = False
@@ -67,52 +66,48 @@ class Checkbox(LayoutControl, AdaptiveControl):
 
     fill_color: Optional[ControlStateValue[ColorValue]] = None
     """
-    The color that fills the checkbox in
-    all or specific [`ControlState`][flet.ControlState]s.
+    The color that fills this checkbox in all or specific [`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].
+    Note:
+        Supported states: [`ControlState.SELECTED`][flet.],
+        [`ControlState.HOVERED`][flet.], [`ControlState.DISABLED`][flet.],
+        [`ControlState.FOCUSED`][flet.], and [`ControlState.DEFAULT`][flet.].
     """
 
     overlay_color: Optional[ControlStateValue[ColorValue]] = None
     """
-    The color of the checkbox's overlay in
-    various [`ControlState`][flet.ControlState] states.
+    The color of this checkbox's overlay in various [`ControlState`][flet.] states.
 
-    This property supports the following `ControlState` values: `PRESSED`, `SELECTED`,
-    `HOVERED` and `FOCUSED`.
+    Note:
+        Supported states: [`ControlState.PRESSED`][flet.],
+        [`ControlState.SELECTED`][flet.], [`ControlState.HOVERED`][flet.],
+        [`ControlState.FOCUSED`][flet.], and [`ControlState.DEFAULT`][flet.].
     """
 
     check_color: Optional[ColorValue] = None
     """
-    The color to use for the check icon when
-    this checkbox is checked.
+    The color to use for the check icon when this checkbox is checked.
     """
 
     active_color: Optional[ColorValue] = None
     """
-    The color to use when this checkbox is
-    checked.
+    The color to use when this checkbox is checked.
     """
 
     hover_color: Optional[ColorValue] = None
     """
-    The color to use when this checkbox is
-    hovered.
+    The color to use when this checkbox is hovered.
     """
 
     focus_color: Optional[ColorValue] = None
     """
     The color for the checkbox's Material when it has the input focus.
-    If [`overlay_color`][flet.Checkbox.overlay_color] returns a non-None color in the
-    [`ControlState.FOCUSED`][flet.ControlState.FOCUSED] state, it will be used instead.
+    If [`overlay_color`][(c).] returns a non-None color in the
+    [`ControlState.FOCUSED`][flet.] state, it will be used instead.
 
-    Defaults to [`CheckboxTheme.overlay_color`][flet.CheckboxTheme.overlay_color] in the
-    [`FOCUSED`][flet.ControlState.FOCUSED] state, or if that is `None`,
-    falls back to [`Theme.focus_color`][flet.Theme.focus_color].
+    Defaults to [`CheckboxTheme.overlay_color`][flet.] in the
+    [`ControlState.FOCUSED`][flet.] state, or if that is `None`,
+    falls back to [`Theme.focus_color`][flet.].
     """
 
     semantics_label: Optional[str] = None
@@ -125,7 +120,7 @@ class Checkbox(LayoutControl, AdaptiveControl):
     """
     The shape of the checkbox.
 
-    Defaults to [`CheckboxTheme.shape`][flet.CheckboxTheme.shape], or if that is `None`,
+    Defaults to [`CheckboxTheme.shape`][flet.], or if that is `None`,
     falls back to `RoundedRectangleBorder(radius=2)`.
     """
 
@@ -133,26 +128,23 @@ class Checkbox(LayoutControl, AdaptiveControl):
     """
     The radius of the circular Material ink response (ripple) in logical pixels.
 
-    Defaults to [`CheckboxTheme.splash_radius`][flet.CheckboxTheme.splash_radius],
+    Defaults to [`CheckboxTheme.splash_radius`][flet.],
     or if that is `None`, falls back to `20.0`.
     """
 
     border_side: Optional[ControlStateValue[BorderSide]] = None
     """
-    The color and width of the checkbox's border in all or specific
-    [`ControlState`][flet.ControlState]s.
+    The color and width of this checkbox's border in all or specific
+    [`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],
-    [`ControlState.PRESSED`][flet.ControlState.PRESSED],
-    [`ControlState.ERROR`][flet.ControlState.ERROR],
-    and [`ControlState.DEFAULT`][flet.ControlState.DEFAULT].
-
-    Defaults to [`CheckboxTheme.border_side`][flet.CheckboxTheme.border_side],
-    or if that is `None`,
+    Defaults to [`CheckboxTheme.border_side`][flet.], or if that is `None`,
     falls back to `BorderSide` with a width of `2.0`.
+
+    Note:
+        Supported states: [`ControlState.SELECTED`][flet.],
+        [`ControlState.HOVERED`][flet.], [`ControlState.DISABLED`][flet.],
+        [`ControlState.FOCUSED`][flet.], [`ControlState.PRESSED`][flet.],
+        [`ControlState.ERROR`][flet.], and [`ControlState.DEFAULT`][flet.].
     """
 
     error: bool = False
@@ -171,23 +163,23 @@ class Checkbox(LayoutControl, AdaptiveControl):
     mouse_cursor: Optional[MouseCursor] = None
     """
     The cursor to be displayed when a mouse pointer enters or is hovering over this
-    control.
+    checkbox.
 
-    Defaults to [`CheckboxTheme.mouse_cursor`][flet.CheckboxTheme.mouse_cursor],
+    Defaults to [`CheckboxTheme.mouse_cursor`][flet.],
     or if that is `None`, falls back to `MouseCursor.CLICK`.
     """
 
     on_change: Optional[ControlEventHandler["Checkbox"]] = None
     """
-    Called when the state of the Checkbox is changed.
+    Called when the state of this checkbox is changed.
     """
 
     on_focus: Optional[ControlEventHandler["Checkbox"]] = None
     """
-    Called when the control has received focus.
+    Called when this checkbox has received focus.
     """
 
     on_blur: Optional[ControlEventHandler["Checkbox"]] = None
     """
-    Called when the control has lost focus.
+    Called when this checkbox has lost focus.
     """

flet/controls/material/chip.py

@@ -36,117 +36,112 @@ class Chip(LayoutControl):
 
     label: StrOrControl
     """
-    The primary content of the chip.
+    The primary content of this chip.
 
-    Typically a [`Text`][flet.Text] control.
+    Typically a [`Text`][flet.] control.
     """
 
     leading: Optional[Control] = None
     """
-    A `Control` to display to the left of the chip's [`label`][flet.Chip.label].
+    A `Control` to display to the left of this chip's [`label`][(c).].
 
-    Typically the leading control is an [`Icon`][flet.Icon]
-    or a [`CircleAvatar`][flet.CircleAvatar].
+    Typically the leading control is an [`Icon`][flet.] or a [`CircleAvatar`][flet.].
     """
 
     selected: bool = False
     """
-    If `on_select` event is specified, `selected` property is used to determine whether
-    the chip is selected or not.
+    If [`on_select`][(c).] event is specified, `selected` property is used to
+    determine whether this chip is selected or not.
     """
 
     selected_color: Optional[ColorValue] = None
     """
-    The color used for the chip's background
-    when it is selected.
+    The color used for this chip's background when it is selected.
     """
 
     elevation: Optional[Number] = None
     """
-    A non-negative value which defines the size of the shadow below the chip.
+    A non-negative value which defines the size of the shadow below this chip.
 
     Defaults to `0`.
     """
 
     bgcolor: Optional[ColorValue] = None
     """
-    Color to be used for the unselected,
-    enabled chip's background.
+    Color to be used for the unselected, enabled chip's background.
     """
 
     show_checkmark: bool = True
     """
-    If `on_select` event is specified and chip is selected, `show_checkmark` is used to
-    determine whether or not to show a checkmark.
+    If [`on_select`][(c).] event is specified and chip is selected, `show_checkmark`
+    is used to determine whether or not to show a checkmark.
     """
 
     check_color: Optional[ColorValue] = None
     """
-    Color of the chip's check mark when a
-    check mark is visible.
+    The color of this chip's check mark when a check mark is visible.
     """
 
     shadow_color: Optional[ColorValue] = None
     """
-    The color used for the chip's background
-    when the elevation is greater than `0` and the chip is not selected.
+    The color used for this chip's background
+    when the elevation is greater than `0` and this chip is not selected.
     """
 
     shape: Optional[OutlinedBorder] = None
     """
-    The shape of the border around the chip.
+    The shape of the border around this chip.
 
-    Defaults to [`ChipTheme.shape`][flet.ChipTheme.shape], or if that is resolves to
+    Defaults to [`ChipTheme.shape`][flet.], or if that is resolves to
     `None`, falls back to `RoundedRectangleBorder(radius=8)`.
     """
 
     padding: Optional[PaddingValue] = None
     """
-    The padding between the [`label`][flet.Chip.label] and the outside shape.
+    The padding between the [`label`][(c).] and the outside shape.
 
     Defaults to `8` logical pixels on all sides.
     """
 
     delete_icon: Optional[Control] = None
     """
-    A `Control` to display to the right of the chip's [`label`][flet.Chip.label]
-    in case [`on_delete`][flet.Chip.on_delete] event is specified.
+    A `Control` to display to the right of this chip's [`label`][(c).]
+    in case [`on_delete`][(c).] event is specified.
     """
 
     delete_icon_tooltip: Optional[str] = None
     """
-    The text to be used for the chip's `delete_icon` tooltip. If not provided or
+    The text to be used for this chip's `delete_icon` tooltip. If not provided or
     provided with an empty string, the tooltip of the delete icon will not be displayed.
     """
 
     delete_icon_color: Optional[ColorValue] = None
     """
-    The color of the [`delete_icon`][flet.Chip.delete_icon].
+    The color of the [`delete_icon`][(c).].
     """
 
     disabled_color: Optional[ColorValue] = None
     """
-    The color used for the chip's background
-    if it is disabled.
+    The color used for this chip's background if it is disabled.
     """
 
     label_padding: Optional[PaddingValue] = None
     """
-    The padding around the [`label`][flet.Chip.label].
+    The padding around the [`label`][(c).].
 
     By default, this is `4` logical pixels at the beginning and the end of
-    the [`label`][flet.Chip.label], and zero on `top` and `bottom`.
+    the [`label`][(c).], and zero on `top` and `bottom`.
     """
 
     label_text_style: Optional[TextStyle] = None
     """
-    The style to be applied to the chip's [`label`][flet.Chip.label].
+    The style to be applied to this chip's [`label`][(c).].
     """
 
     selected_shadow_color: Optional[ColorValue] = None
     """
-    The color used for the chip's background
-    when the elevation is greater than `0` and the chip is selected.
+    The color used for this chip's background
+    when the elevation is greater than `0` and this chip is selected.
     """
 
     autofocus: bool = False
@@ -159,13 +154,13 @@ class Chip(LayoutControl):
 
     color: Optional[ControlStateValue[ColorValue]] = None
     """
-    The color that fills the chip in various [`ControlState`][flet.ControlState].
+    The color that fills this chip in various [`ControlState`][flet.].
     """
 
     elevation_on_click: Optional[Number] = None
     """
-    The elevation to be applied on the chip relative to its parent during the press
-    motion. This controls the size of the shadow below the chip.
+    The elevation to be applied on this chip relative to its parent during the press
+    motion. This controls the size of the shadow below this chip.
 
     Defaults to `8.0`.
 
@@ -185,22 +180,22 @@ class Chip(LayoutControl):
 
     border_side: Optional[BorderSide] = None
     """
-    Defines the color and weight of the chip's outline.
+    Defines the color and weight of this chip's outline.
     """
 
     leading_size_constraints: Optional[BoxConstraints] = None
     """
-    The size constraints for the [`leading`][flet.Chip.leading] control.
+    The size constraints for the [`leading`][(c).] control.
 
-    When unspecified, it defaults to a minimum size of chip height or label height
+    If `None`, it defaults to a minimum size of chip height or label height
     (whichever is greater) and a padding of `8.0` pixels on all sides.
     """
 
     delete_icon_size_constraints: Optional[BoxConstraints] = None
     """
-    The size constraints for the [`delete_icon`][flet.Chip.delete_icon] control.
+    The size constraints for the [`delete_icon`][(c).] control.
 
-    When unspecified, it defaults to a minimum size of chip height or label height
+    If `None`, it defaults to a minimum size of chip height or label height
     (whichever is greater) and a padding of 8.0 pixels on all sides.
     """
 
@@ -216,12 +211,12 @@ class Chip(LayoutControl):
 
     leading_drawer_animation_style: Optional[AnimationStyle] = None
     """
-    The animation style for the [`leading`][flet.Chip.leading] control's animations.
+    The animation style for the [`leading`][(c).] control's animations.
     """
 
     delete_drawer_animation_style: Optional[AnimationStyle] = None
     """
-    The animation style for the [`delete_icon`][flet.Chip.delete_icon]'s animations.
+    The animation style for the [`delete_icon`][(c).]'s animations.
     """
 
     on_click: Optional[ControlEventHandler["Chip"]] = None
@@ -229,20 +224,22 @@ class Chip(LayoutControl):
     Called when the user clicks on this chip.
 
     Note:
-        Cannot be specified together with [`on_select`][flet.Chip.on_select] event.
+        Cannot be specified together with [`on_select`][(c).].
     """
 
     on_delete: Optional[ControlEventHandler["Chip"]] = None
     """
-    Called when the user clicks on the [`delete_icon`][flet.Chip.delete_icon].
+    Called when the user clicks on the [`delete_icon`][(c).].
     """
 
     on_select: Optional[ControlEventHandler["Chip"]] = None
     """
-    Called when the user clicks on the chip.
+    Called when the user clicks on this chip.
+
+    It internally changes [`selected`][(c).] property to the opposite value.
 
-    It internally changes [`selected`][flet.Chip.selected] property to the opposite
-    value. Cannot be specified together with [`on_click`][flet.Chip.on_click] event.
+    Note:
+        Cannot be specified together with [`on_click`][(c).].
     """
 
     on_focus: Optional[ControlEventHandler["Chip"]] = None

flet/controls/material/circle_avatar.py

@@ -31,17 +31,17 @@ class CircleAvatar(LayoutControl):
     """
     The content of this avatar.
 
-    Typically a [`Text`][flet.Text] control.
+    Typically a [`Text`][flet.] control.
 
-    If this avatar is to have an image, use
-    [`background_image_src`][flet.CircleAvatar.background_image_src] instead.
+    Tip:
+        If this avatar is to have an image, use [`background_image_src`][(c).] instead.
     """
 
     foreground_image_src: Optional[str] = None
     """
     The source (local asset file or URL) of the foreground image in the circle.
 
-    Fallbacks to [`background_image_src`][flet.CircleAvatar.background_image_src].
+    Fallbacks to [`background_image_src`][(c).].
 
     Typically used as profile image.
     """
@@ -51,17 +51,16 @@ class CircleAvatar(LayoutControl):
     The source (local asset file or URL) of the background image in the circle.
     Changing the background image will cause the avatar to animate to the new image.
 
-    Typically used as a fallback image for
-    [`foreground_image_src`][flet.CircleAvatar.foreground_image_src].
-    If this avatar is to have the user's initials, use
-    [`content`][flet.CircleAvatar.content] instead.
+    If this avatar is to have the user's initials, use [`content`][(c).] instead.
+
+    Typically used as a fallback image for [`foreground_image_src`][(c).].
     """
 
     color: Optional[ColorValue] = None
     """
     The default color for text in this avatar.
 
-    Defaults to the primary text theme color if no `bgcolor` is specified.
+    Defaults to the primary text theme color if no [`bgcolor`][(c).] is specified.
     """
 
     bgcolor: Optional[ColorValue] = None
@@ -74,15 +73,14 @@ class CircleAvatar(LayoutControl):
     radius: Optional[Number] = None
     """
     The size of the avatar, expressed as the radius (half the diameter). If `radius` is
-    specified, then neither [`min_radius`][flet.CircleAvatar.min_radius] nor
-    [`max_radius`][flet.CircleAvatar.max_radius] may be specified.
+    specified, then neither [`min_radius`][(c).] nor
+    [`max_radius`][(c).] may be specified.
     """
 
     min_radius: Optional[Number] = None
     """
     The minimum size of the avatar, expressed as the radius (half the diameter). If
-    `min_radius` is specified, then [`radius`][flet.CircleAvatar.radius] should not
-    be specified.
+    `min_radius` is specified, then [`radius`][(c).] should not be specified.
 
     Defaults to `0.0`.
     """
@@ -91,21 +89,20 @@ class CircleAvatar(LayoutControl):
     """
     The maximum size of the avatar, expressed as the radius (half the diameter).
 
-    If `max_radius` is specified, then [`radius`][flet.CircleAvatar.radius] should
-    not be specified.
-
     Defaults to "infinity".
+
+    Note:
+        If `max_radius` is specified, then [`radius`][(c).] should not be specified.
     """
 
     on_image_error: Optional[ControlEventHandler["CircleAvatar"]] = None
     """
-    Called when an error occurs while loading the
-    [`background_image_src`][flet.CircleAvatar.background_image_src] or
-    [`foreground_image_src`][flet.CircleAvatar.foreground_image_src].
+    Called when an error occurs while loading the [`background_image_src`][(c).] or
+    [`foreground_image_src`][(c).].
 
-    The [`data`][flet.Event.data] property of the event handler argument is
-    a string whose value is either `"background"` or `"foreground"` indicating
-    the error's origin.
+    The [`data`][flet.Event.] property of the event handler argument is
+    a string whose value is either `"background"` or `"foreground"`
+    indicating the error's origin.
     """
 
     def before_update(self):