first commit
This commit is contained in:
commit
417e54da96
5696 changed files with 900003 additions and 0 deletions
|
|
@ -0,0 +1 @@
|
|||
from .selectioncontrol import MDCheckbox, MDSwitch, Thumb # NOQA F401
|
||||
Binary file not shown.
Binary file not shown.
|
|
@ -0,0 +1,145 @@
|
|||
#:import get_color_from_hex kivy.utils.get_color_from_hex
|
||||
#:import colors kivymd.color_definitions.colors
|
||||
|
||||
|
||||
<MDCheckbox>
|
||||
canvas:
|
||||
Clear
|
||||
Color:
|
||||
rgba: self.color
|
||||
Rectangle:
|
||||
texture: self.texture
|
||||
size: self.texture_size
|
||||
pos:
|
||||
int(self.center_x - self.texture_size[0] / 2.), \
|
||||
int(self.center_y - self.texture_size[1] / 2.)
|
||||
|
||||
color: self._current_color
|
||||
halign: "center"
|
||||
valign: "middle"
|
||||
|
||||
|
||||
<Thumb>
|
||||
radius: self.width / 2
|
||||
ripple_scale: 2
|
||||
|
||||
ThumbIcon:
|
||||
id: icon
|
||||
font_size: "16sp"
|
||||
theme_text_color: "Custom"
|
||||
pos_hint: {"center_x": .5, "center_y": .5}
|
||||
|
||||
|
||||
<MDSwitch>
|
||||
canvas.before:
|
||||
Color:
|
||||
rgba:
|
||||
( \
|
||||
self.track_color_disabled \
|
||||
if self.track_color_disabled else \
|
||||
self.theme_cls.disabled_hint_text_color) \
|
||||
if self.disabled else \
|
||||
( \
|
||||
( \
|
||||
self.track_color_active \
|
||||
if self.track_color_active else \
|
||||
self.theme_cls.primary_color[:-1] + [.5]) \
|
||||
if self.active else \
|
||||
(self.track_color_inactive \
|
||||
if self.track_color_inactive else \
|
||||
self.theme_cls.disabled_hint_text_color) \
|
||||
)
|
||||
RoundedRectangle:
|
||||
size:
|
||||
(self.width + dp(14), dp(28)) \
|
||||
if root.widget_style == "ios" else \
|
||||
( \
|
||||
(self.width - dp(8), dp(16)) \
|
||||
if app.theme_cls.material_style == "M2" else \
|
||||
(self.width + dp(16), dp(32)) \
|
||||
)
|
||||
pos:
|
||||
(self.x - dp(2), self.center_y - dp(14)) \
|
||||
if root.widget_style == "ios" else \
|
||||
(self.x + dp(8), self.center_y - dp(8))
|
||||
radius:
|
||||
[dp(14)] \
|
||||
if root.widget_style == "ios" else \
|
||||
[dp(7) if app.theme_cls.material_style == "M2" else dp(16)]
|
||||
Color:
|
||||
rgba:
|
||||
( \
|
||||
self.theme_cls.disabled_hint_text_color \
|
||||
if not root.active else (0, 0, 0, 0) \
|
||||
) \
|
||||
if root.widget_style == "ios" \
|
||||
or app.theme_cls.material_style == "M3" else \
|
||||
(0, 0, 0, 0)
|
||||
SmoothLine:
|
||||
width:
|
||||
1 \
|
||||
if root.widget_style == "ios" \
|
||||
or app.theme_cls.material_style == "M2" else \
|
||||
1.4
|
||||
rounded_rectangle:
|
||||
( \
|
||||
self.x - dp(2), self.center_y - dp(14), self.width + dp(14), \
|
||||
dp(28), dp(14), dp(14), dp(14), dp(14), dp(28) \
|
||||
) \
|
||||
if root.widget_style == "ios" else \
|
||||
( \
|
||||
(1, 1, 1, 1, 1, 1, 1, 1, 1) \
|
||||
if app.theme_cls.material_style == "M2" else \
|
||||
( \
|
||||
self.x + dp(8), self.center_y - dp(8), self.width + dp(16), \
|
||||
dp(32), dp(16), dp(16), dp(16), dp(16), dp(32) \
|
||||
)
|
||||
)
|
||||
|
||||
Thumb:
|
||||
id: thumb
|
||||
size_hint: None, None
|
||||
size: dp(24), dp(24)
|
||||
elevation:
|
||||
(2.5 if root.active else 1) \
|
||||
if app.theme_cls.material_style != "M3" else \
|
||||
0
|
||||
pos:
|
||||
(root.pos[0] + root._thumb_pos[0], root.pos[1] + root._thumb_pos[1]) \
|
||||
if root.widget_style == "ios" \
|
||||
or app.theme_cls.material_style == "M2" else \
|
||||
( \
|
||||
root.pos[0] + self.width + root._thumb_pos[0], \
|
||||
root.pos[1] + (root.height / 2 - self.height / 2) + root._thumb_pos[1] \
|
||||
)
|
||||
_no_ripple_effect:
|
||||
True \
|
||||
if app.theme_cls.material_style == "M3" \
|
||||
and root.widget_style != "ios" else \
|
||||
False
|
||||
md_bg_color:
|
||||
( \
|
||||
root.thumb_color_disabled \
|
||||
if root.thumb_color_disabled else \
|
||||
get_color_from_hex(colors["Gray"]["800"]) \
|
||||
) \
|
||||
if root.disabled else \
|
||||
( \
|
||||
(root.thumb_color_active \
|
||||
if root.thumb_color_active else \
|
||||
root.theme_cls.primary_color \
|
||||
) \
|
||||
if root.active else \
|
||||
( \
|
||||
root.thumb_color_inactive \
|
||||
if root.thumb_color_inactive else \
|
||||
get_color_from_hex(colors["Gray"]["50"] \
|
||||
) \
|
||||
) \
|
||||
)
|
||||
on_touch_down:
|
||||
if self.collide_point(*args[1].pos) and not root.disabled: \
|
||||
root.on_thumb_down()
|
||||
on_touch_up:
|
||||
if self.collide_point(*args[1].pos) and not root.disabled: \
|
||||
setattr(root, "active", not root.active)
|
||||
|
|
@ -0,0 +1,957 @@
|
|||
"""
|
||||
Components/SelectionControls
|
||||
============================
|
||||
|
||||
.. seealso::
|
||||
|
||||
`Material Design spec, Checkbox <https://m3.material.io/components/checkbox/overview>`_
|
||||
|
||||
`Material Design spec, Switch <https://m3.material.io/components/switch/overview>`_
|
||||
|
||||
.. rubric:: Selection controls allow the user to select options.
|
||||
|
||||
`KivyMD` provides the following selection controls classes for use:
|
||||
|
||||
- MDCheckbox_
|
||||
- MDSwitch_
|
||||
|
||||
.. MDCheckbox:
|
||||
MDCheckbox
|
||||
----------
|
||||
|
||||
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/checkbox.png
|
||||
:align: center
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from kivy.lang import Builder
|
||||
|
||||
from kivymd.app import MDApp
|
||||
|
||||
|
||||
KV = '''
|
||||
MDFloatLayout:
|
||||
|
||||
MDCheckbox:
|
||||
size_hint: None, None
|
||||
size: "48dp", "48dp"
|
||||
pos_hint: {'center_x': .5, 'center_y': .5}
|
||||
'''
|
||||
|
||||
|
||||
class Example(MDApp):
|
||||
def build(self):
|
||||
self.theme_cls.primary_palette = "Green"
|
||||
self.theme_cls.theme_style = "Dark"
|
||||
return Builder.load_string(KV)
|
||||
|
||||
|
||||
Example().run()
|
||||
|
||||
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/checkbox.gif
|
||||
:align: center
|
||||
|
||||
.. Note:: Be sure to specify the size of the checkbox. By default, it is
|
||||
`(dp(48), dp(48))`, but the ripple effect takes up all the available
|
||||
space.
|
||||
|
||||
Control state
|
||||
-------------
|
||||
|
||||
.. code-block:: kv
|
||||
|
||||
MDCheckbox:
|
||||
on_active: app.on_checkbox_active(*args)
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
def on_checkbox_active(self, checkbox, value):
|
||||
if value:
|
||||
print('The checkbox', checkbox, 'is active', 'and', checkbox.state, 'state')
|
||||
else:
|
||||
print('The checkbox', checkbox, 'is inactive', 'and', checkbox.state, 'state')
|
||||
|
||||
MDCheckbox with group
|
||||
---------------------
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from kivy.lang import Builder
|
||||
|
||||
from kivymd.app import MDApp
|
||||
|
||||
KV = '''
|
||||
<Check@MDCheckbox>:
|
||||
group: 'group'
|
||||
size_hint: None, None
|
||||
size: dp(48), dp(48)
|
||||
|
||||
|
||||
MDFloatLayout:
|
||||
|
||||
Check:
|
||||
active: True
|
||||
pos_hint: {'center_x': .4, 'center_y': .5}
|
||||
|
||||
Check:
|
||||
pos_hint: {'center_x': .6, 'center_y': .5}
|
||||
'''
|
||||
|
||||
|
||||
class Example(MDApp):
|
||||
def build(self):
|
||||
self.theme_cls.primary_palette = "Green"
|
||||
self.theme_cls.theme_style = "Dark"
|
||||
return Builder.load_string(KV)
|
||||
|
||||
|
||||
Example().run()
|
||||
|
||||
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/checkbox-group.gif
|
||||
:align: center
|
||||
|
||||
Parent and child checkboxes
|
||||
---------------------------
|
||||
|
||||
Checkboxes can have a parent-child relationship with other checkboxes. When
|
||||
the parent checkbox is checked, all child checkboxes are checked. If a parent
|
||||
checkbox is unchecked, all child checkboxes are unchecked. If some, but not all,
|
||||
child checkboxes are checked, the parent checkbox becomes an indeterminate
|
||||
checkbox.
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
.. code-block:: kv
|
||||
|
||||
MDCheckbox:
|
||||
group: "root" # this is a required name for the parent checkbox group
|
||||
|
||||
MDCheckbox:
|
||||
group: "child" # this is a required name for a group of child checkboxes
|
||||
|
||||
MDCheckbox:
|
||||
group: "child" # this is a required name for a group of child checkboxes
|
||||
|
||||
Example
|
||||
-------
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from kivy.lang import Builder
|
||||
from kivy.properties import StringProperty
|
||||
|
||||
from kivymd.app import MDApp
|
||||
from kivymd.uix.boxlayout import MDBoxLayout
|
||||
|
||||
KV = '''
|
||||
<CheckItem>
|
||||
adaptive_height: True
|
||||
|
||||
MDCheckbox:
|
||||
size_hint: None, None
|
||||
size: "48dp", "48dp"
|
||||
group: root.group
|
||||
|
||||
MDLabel:
|
||||
text: root.text
|
||||
adaptive_height: True
|
||||
theme_text_color: "Custom"
|
||||
text_color: "#B2B6AE"
|
||||
pos_hint: {"center_y": .5}
|
||||
|
||||
|
||||
MDBoxLayout:
|
||||
orientation: "vertical"
|
||||
md_bg_color: "#141612"
|
||||
|
||||
MDTopAppBar:
|
||||
md_bg_color: "#21271F"
|
||||
specific_text_color: "#B2B6AE"
|
||||
elevation: 0
|
||||
title: "Meal options"
|
||||
left_action_items: [["arrow-left", lambda x: x]]
|
||||
anchor_title: "left"
|
||||
|
||||
MDBoxLayout:
|
||||
orientation: "vertical"
|
||||
adaptive_height: True
|
||||
padding: "12dp", "36dp", 0, 0
|
||||
|
||||
CheckItem:
|
||||
text: "Recieve emails"
|
||||
group: "root"
|
||||
|
||||
MDBoxLayout:
|
||||
orientation: "vertical"
|
||||
adaptive_height: True
|
||||
padding: "24dp", 0, 0, 0
|
||||
|
||||
CheckItem:
|
||||
text: "Daily"
|
||||
group: "child"
|
||||
|
||||
CheckItem:
|
||||
text: "Weekly"
|
||||
group: "child"
|
||||
|
||||
CheckItem:
|
||||
text: "Monthly"
|
||||
group: "child"
|
||||
|
||||
MDWidget:
|
||||
'''
|
||||
|
||||
|
||||
class CheckItem(MDBoxLayout):
|
||||
text = StringProperty()
|
||||
group = StringProperty()
|
||||
|
||||
|
||||
class Example(MDApp):
|
||||
def build(self):
|
||||
self.theme_cls.theme_style = "Dark"
|
||||
self.theme_cls.primary_palette = "Teal"
|
||||
return Builder.load_string(KV)
|
||||
|
||||
|
||||
Example().run()
|
||||
|
||||
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/checkbox-parent-child.gif
|
||||
:align: center
|
||||
|
||||
.. MDSwitch:
|
||||
MDSwitch
|
||||
--------
|
||||
|
||||
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/switch.png
|
||||
:align: center
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from kivy.lang import Builder
|
||||
|
||||
from kivymd.app import MDApp
|
||||
|
||||
KV = '''
|
||||
MDFloatLayout:
|
||||
|
||||
MDSwitch:
|
||||
pos_hint: {'center_x': .5, 'center_y': .5}
|
||||
'''
|
||||
|
||||
|
||||
class Example(MDApp):
|
||||
def build(self):
|
||||
self.theme_cls.primary_palette = "Green"
|
||||
self.theme_cls.theme_style = "Dark"
|
||||
return Builder.load_string(KV)
|
||||
|
||||
|
||||
Example().run()
|
||||
|
||||
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/md-switch.gif
|
||||
:align: center
|
||||
|
||||
.. Note:: Control state of :class:`~MDSwitch` same way as in
|
||||
:class:`~MDCheckbox`.
|
||||
"""
|
||||
|
||||
__all__ = ("MDCheckbox", "MDSwitch")
|
||||
|
||||
import os
|
||||
|
||||
from kivy.animation import Animation
|
||||
from kivy.clock import Clock
|
||||
from kivy.lang import Builder
|
||||
from kivy.metrics import dp, sp
|
||||
from kivy.properties import (
|
||||
BooleanProperty,
|
||||
ColorProperty,
|
||||
ListProperty,
|
||||
StringProperty,
|
||||
)
|
||||
from kivy.uix.behaviors import ToggleButtonBehavior
|
||||
from kivy.uix.floatlayout import FloatLayout
|
||||
|
||||
from kivymd import uix_path
|
||||
from kivymd.theming import ThemableBehavior
|
||||
from kivymd.uix.behaviors import (
|
||||
CircularRippleBehavior,
|
||||
CommonElevationBehavior,
|
||||
ScaleBehavior,
|
||||
)
|
||||
from kivymd.uix.floatlayout import MDFloatLayout
|
||||
from kivymd.uix.label import MDIcon
|
||||
from kivymd.utils import asynckivy
|
||||
|
||||
with open(
|
||||
os.path.join(uix_path, "selectioncontrol", "selectioncontrol.kv"),
|
||||
encoding="utf-8",
|
||||
) as kv_file:
|
||||
Builder.load_string(kv_file.read())
|
||||
|
||||
|
||||
class MDCheckbox(
|
||||
CircularRippleBehavior, ScaleBehavior, ToggleButtonBehavior, MDIcon
|
||||
):
|
||||
"""
|
||||
Checkbox class.
|
||||
|
||||
For more information, see in the
|
||||
:class:`~kivymd.uix.behaviors.CircularRippleBehavior` and
|
||||
:class:`~kivy.uix.behaviors.ToggleButtonBehavior` and
|
||||
:class:`~kivymd.uix.label.MDIcon`
|
||||
classes documentation.
|
||||
"""
|
||||
|
||||
__allow_child_checkboxes_active = True
|
||||
__allow_root_checkbox_active = True
|
||||
|
||||
active = BooleanProperty(False)
|
||||
"""
|
||||
Indicates if the checkbox is active or inactive.
|
||||
|
||||
:attr:`active` is a :class:`~kivy.properties.BooleanProperty`
|
||||
and defaults to `False`.
|
||||
"""
|
||||
|
||||
checkbox_icon_normal = StringProperty("checkbox-blank-outline")
|
||||
"""
|
||||
Background icon of the checkbox used for the default graphical
|
||||
representation when the checkbox is not pressed.
|
||||
|
||||
:attr:`checkbox_icon_normal` is a :class:`~kivy.properties.StringProperty`
|
||||
and defaults to `'checkbox-blank-outline'`.
|
||||
"""
|
||||
|
||||
checkbox_icon_down = StringProperty("checkbox-marked")
|
||||
"""
|
||||
Background icon of the checkbox used for the default graphical
|
||||
representation when the checkbox is pressed.
|
||||
|
||||
:attr:`checkbox_icon_down` is a :class:`~kivy.properties.StringProperty`
|
||||
and defaults to `'checkbox-marked'`.
|
||||
"""
|
||||
|
||||
radio_icon_normal = StringProperty("checkbox-blank-circle-outline")
|
||||
"""
|
||||
Background icon (when using the `group` option) of the checkbox used for
|
||||
the default graphical representation when the checkbox is not pressed.
|
||||
|
||||
:attr:`radio_icon_normal` is a :class:`~kivy.properties.StringProperty`
|
||||
and defaults to `'checkbox-blank-circle-outline'`.
|
||||
"""
|
||||
|
||||
radio_icon_down = StringProperty("checkbox-marked-circle")
|
||||
"""
|
||||
Background icon (when using the `group` option) of the checkbox used for
|
||||
the default graphical representation when the checkbox is pressed.
|
||||
|
||||
:attr:`radio_icon_down` is a :class:`~kivy.properties.StringProperty`
|
||||
and defaults to `'checkbox-marked-circle'`.
|
||||
"""
|
||||
|
||||
color_active = ColorProperty(None)
|
||||
"""
|
||||
Color in (r, g, b, a) or string format when the checkbox is in the active state.
|
||||
|
||||
.. versionadded:: 1.0.0
|
||||
|
||||
.. code-block:: kv
|
||||
|
||||
MDCheckbox:
|
||||
color_active: "red"
|
||||
|
||||
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/checkbox-color-active.png
|
||||
:align: center
|
||||
|
||||
:attr:`color_active` is a :class:`~kivy.properties.ColorProperty`
|
||||
and defaults to `None`.
|
||||
"""
|
||||
|
||||
color_inactive = ColorProperty(None)
|
||||
"""
|
||||
Color in (r, g, b, a) or string format when the checkbox is in the inactive state.
|
||||
|
||||
.. versionadded:: 1.0.0
|
||||
|
||||
.. code-block:: kv
|
||||
|
||||
MDCheckbox:
|
||||
color_inactive: "blue"
|
||||
|
||||
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/checkbox-color-inactive.png
|
||||
:align: center
|
||||
|
||||
:attr:`color_inactive` is a :class:`~kivy.properties.ColorProperty`
|
||||
and defaults to `None`.
|
||||
"""
|
||||
|
||||
disabled_color = ColorProperty(None)
|
||||
"""
|
||||
Color in (r, g, b, a) or string format when the checkbox is in the disabled state.
|
||||
|
||||
.. code-block:: kv
|
||||
|
||||
MDCheckbox:
|
||||
disabled_color: "lightgrey"
|
||||
disabled: True
|
||||
active: True
|
||||
|
||||
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/checkbox-disabled-color.png
|
||||
:align: center
|
||||
|
||||
:attr:`disabled_color` is a :class:`~kivy.properties.ColorProperty`
|
||||
and defaults to `None`.
|
||||
"""
|
||||
|
||||
# Deprecated property.
|
||||
|
||||
selected_color = ColorProperty(None, deprecated=True)
|
||||
"""
|
||||
Color in (r, g, b, a) or string format when the checkbox is in the active state.
|
||||
|
||||
.. deprecated:: 1.0.0
|
||||
Use :attr:`color_active` instead.
|
||||
|
||||
:attr:`selected_color` is a :class:`~kivy.properties.ColorProperty`
|
||||
and defaults to `None`.
|
||||
"""
|
||||
|
||||
unselected_color = ColorProperty(None, deprecated=True)
|
||||
"""
|
||||
Color in (r, g, b, a) or string format when the checkbox is in the inactive state.
|
||||
|
||||
.. deprecated:: 1.0.0
|
||||
Use :attr:`color_inactive` instead.
|
||||
|
||||
:attr:`unselected_color` is a :class:`~kivy.properties.ColorProperty`
|
||||
and defaults to `None`.
|
||||
"""
|
||||
|
||||
_current_color = ColorProperty([0.0, 0.0, 0.0, 0.0])
|
||||
|
||||
def __init__(self, **kwargs):
|
||||
self.check_anim_out = Animation(
|
||||
scale_value_x=0, scale_value_y=0, duration=0.1, t="out_quad"
|
||||
)
|
||||
self.check_anim_in = Animation(
|
||||
scale_value_x=1, scale_value_y=1, duration=0.1, t="out_quad"
|
||||
)
|
||||
super().__init__(**kwargs)
|
||||
self.color_active = self.theme_cls.primary_color
|
||||
self.color_inactive = self.theme_cls.secondary_text_color
|
||||
self.disabled_color = self.theme_cls.divider_color
|
||||
self._current_color = self.color_inactive
|
||||
self.check_anim_out.bind(
|
||||
on_complete=lambda *x: self.check_anim_in.start(self)
|
||||
)
|
||||
self.bind(
|
||||
checkbox_icon_normal=self.update_icon,
|
||||
checkbox_icon_down=self.update_icon,
|
||||
radio_icon_normal=self.update_icon,
|
||||
radio_icon_down=self.update_icon,
|
||||
group=self.update_icon,
|
||||
color_active=self.update_color,
|
||||
color_inactive=self.update_color,
|
||||
disabled_color=self.update_color,
|
||||
disabled=self.update_color,
|
||||
state=self.update_color,
|
||||
)
|
||||
self.theme_cls.bind(
|
||||
theme_style=self.update_primary_color,
|
||||
primary_color=self.update_primary_color,
|
||||
)
|
||||
self.update_icon()
|
||||
self.update_color()
|
||||
|
||||
def update_primary_color(self, instance, value) -> None:
|
||||
"""
|
||||
Called when the values of
|
||||
:attr:`kivymd.theming.ThemableBehavior.theme_cls.theme_style` and
|
||||
:attr:`kivymd.theming.ThemableBehavior.theme_cls.primary_color`
|
||||
change.
|
||||
"""
|
||||
|
||||
if value in ("Dark", "Light"):
|
||||
if not self.disabled:
|
||||
self.color = self.theme_cls.primary_color
|
||||
else:
|
||||
self.color = self.disabled_color
|
||||
else:
|
||||
self.color_active = value
|
||||
|
||||
def update_icon(self, *args) -> None:
|
||||
"""
|
||||
Called when the values of
|
||||
:attr:`checkbox_icon_normal` and
|
||||
:attr:`checkbox_icon_down` and
|
||||
:attr:`radio_icon_normal` and
|
||||
:attr:`group`
|
||||
change.
|
||||
"""
|
||||
|
||||
if self.state == "down":
|
||||
self.icon = (
|
||||
self.radio_icon_down
|
||||
if self.group and self.group not in ["root", "child"]
|
||||
else self.checkbox_icon_down
|
||||
if self.group != "root"
|
||||
else "minus-box"
|
||||
)
|
||||
else:
|
||||
self.icon = (
|
||||
self.radio_icon_normal
|
||||
if self.group and self.group not in ["root", "child"]
|
||||
else self.checkbox_icon_normal
|
||||
)
|
||||
|
||||
def update_color(self, *args) -> None:
|
||||
"""
|
||||
Called when the values of
|
||||
:attr:`color_active` and
|
||||
:attr:`color_inactive` and
|
||||
:attr:`disabled_color` and
|
||||
:attr:`disabled` and
|
||||
:attr:`state`
|
||||
change.
|
||||
"""
|
||||
|
||||
if self.disabled:
|
||||
self._current_color = self.disabled_color
|
||||
elif self.state == "down":
|
||||
self._current_color = self.color_active
|
||||
else:
|
||||
self._current_color = self.color_inactive
|
||||
|
||||
def on_state(self, *args) -> None:
|
||||
"""Called when the values of :attr:`state` change."""
|
||||
|
||||
if self.state == "down":
|
||||
self.check_anim_in.cancel(self)
|
||||
self.check_anim_out.start(self)
|
||||
self.update_icon()
|
||||
if self.group:
|
||||
self._release_group(self)
|
||||
self.active = True
|
||||
else:
|
||||
self.check_anim_in.cancel(self)
|
||||
if not self.group:
|
||||
self.check_anim_out.start(self)
|
||||
self.update_icon()
|
||||
self.active = False
|
||||
|
||||
def on_active(self, *args) -> None:
|
||||
"""Called when the values of :attr:`active` change."""
|
||||
|
||||
self.state = "down" if self.active else "normal"
|
||||
|
||||
if (
|
||||
self.group
|
||||
and self.group == "root"
|
||||
and MDCheckbox.__allow_root_checkbox_active
|
||||
):
|
||||
self.set_child_active(self.active)
|
||||
elif self.group and self.group == "child":
|
||||
if MDCheckbox.__allow_child_checkboxes_active:
|
||||
self.set_root_active()
|
||||
|
||||
def set_root_active(self) -> None:
|
||||
root_checkbox = self.get_widgets("root")
|
||||
if root_checkbox:
|
||||
MDCheckbox.__allow_root_checkbox_active = False
|
||||
root_checkbox[0].active = True in [
|
||||
child.active for child in self.get_widgets("child")
|
||||
]
|
||||
MDCheckbox.__allow_root_checkbox_active = True
|
||||
|
||||
def set_child_active(self, active: bool):
|
||||
for child in self.get_widgets("child"):
|
||||
child.active = active
|
||||
MDCheckbox.__allow_child_checkboxes_active = True
|
||||
|
||||
def on_touch_down(self, touch):
|
||||
if self.collide_point(touch.x, touch.y):
|
||||
if self.group and self.group == "root":
|
||||
MDCheckbox.__allow_child_checkboxes_active = False
|
||||
return super().on_touch_down(touch)
|
||||
|
||||
def _release_group(self, current):
|
||||
if self.group and self.group in ["root", "child"]:
|
||||
return
|
||||
super()._release_group(current)
|
||||
|
||||
|
||||
class ThumbIcon(MDIcon):
|
||||
"""
|
||||
Implements icon for the :class:`~Thumb` widget.
|
||||
|
||||
.. versionadded:: 1.0.0
|
||||
"""
|
||||
|
||||
|
||||
class Thumb(CommonElevationBehavior, CircularRippleBehavior, MDFloatLayout):
|
||||
"""Implements a thumb for the :class:`~MDSwitch` widget."""
|
||||
|
||||
def _set_ellipse(self, instance, value):
|
||||
self.ellipse.size = (self._ripple_rad, self._ripple_rad)
|
||||
if self.ellipse.size[0] > self.width * 1.5 and not self._fading_out:
|
||||
self.fade_out()
|
||||
self.ellipse.pos = (
|
||||
self.center_x - self._ripple_rad / 2.0,
|
||||
self.center_y - self._ripple_rad / 2.0,
|
||||
)
|
||||
self.stencil.pos = (
|
||||
self.center_x - (self.width * self.ripple_scale) / 2,
|
||||
self.center_y - (self.height * self.ripple_scale) / 2,
|
||||
)
|
||||
|
||||
|
||||
class MDSwitch(ThemableBehavior, FloatLayout):
|
||||
"""
|
||||
Switch class.
|
||||
|
||||
For more information, see in the
|
||||
:class:`~kivymd.theming.ThemableBehavior` and
|
||||
:class:`~kivy.uix.floatlayout.FloatLayout` classes documentation.
|
||||
"""
|
||||
|
||||
active = BooleanProperty(False)
|
||||
"""
|
||||
Indicates if the switch is active or inactive.
|
||||
|
||||
:attr:`active` is a :class:`~kivy.properties.BooleanProperty`
|
||||
and defaults to `False`.
|
||||
"""
|
||||
|
||||
icon_active = StringProperty()
|
||||
"""
|
||||
Thumb icon when the switch is in the active state (only M3 style).
|
||||
|
||||
.. versionadded:: 1.0.0
|
||||
|
||||
.. code-block:: kv
|
||||
|
||||
MDSwitch:
|
||||
active: True
|
||||
icon_active: "check"
|
||||
|
||||
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/switch-icon-active.png
|
||||
:align: center
|
||||
|
||||
:attr:`icon_active` is a :class:`~kivy.properties.StringProperty`
|
||||
and defaults to `''`.
|
||||
"""
|
||||
|
||||
icon_inactive = StringProperty()
|
||||
"""
|
||||
Thumb icon when the switch is in an inactive state (only M3 style).
|
||||
|
||||
.. versionadded:: 1.0.0
|
||||
|
||||
.. code-block:: kv
|
||||
|
||||
MDSwitch:
|
||||
icon_inactive: "close"
|
||||
|
||||
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/switch-icon-inactive.png
|
||||
:align: center
|
||||
|
||||
:attr:`icon_inactive` is a :class:`~kivy.properties.StringProperty`
|
||||
and defaults to `''`.
|
||||
"""
|
||||
|
||||
icon_active_color = ColorProperty(None)
|
||||
"""
|
||||
Thumb icon color in (r, g, b, a) or string format when the switch is in the
|
||||
active state (only M3 style).
|
||||
|
||||
.. versionadded:: 1.0.0
|
||||
|
||||
.. code-block:: kv
|
||||
|
||||
MDSwitch:
|
||||
active: True
|
||||
icon_active: "check"
|
||||
icon_active_color: "white"
|
||||
|
||||
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/switch-icon-active-color.png
|
||||
:align: center
|
||||
|
||||
:attr:`icon_active_color` is a :class:`~kivy.properties.ColorProperty`
|
||||
and defaults to `None`.
|
||||
"""
|
||||
|
||||
icon_inactive_color = ColorProperty(None)
|
||||
"""
|
||||
Thumb icon color in (r, g, b, a) or string format when the switch is in an
|
||||
inactive state (only M3 style).
|
||||
|
||||
.. versionadded:: 1.0.0
|
||||
|
||||
.. code-block:: kv
|
||||
|
||||
MDSwitch:
|
||||
icon_inactive: "close"
|
||||
icon_inactive_color: "grey"
|
||||
|
||||
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/switch-icon-inactive-color.png
|
||||
:align: center
|
||||
|
||||
:attr:`icon_inactive_color` is a :class:`~kivy.properties.ColorProperty`
|
||||
and defaults to `None`.
|
||||
"""
|
||||
|
||||
thumb_color_active = ColorProperty(None)
|
||||
"""
|
||||
The color in (r, g, b, a) or string format of the thumb when the switch is active.
|
||||
|
||||
.. versionadded:: 1.0.0
|
||||
|
||||
.. code-block:: kv
|
||||
|
||||
MDSwitch:
|
||||
active: True
|
||||
thumb_color_active: "brown"
|
||||
|
||||
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/switch-thumb-color-active.png
|
||||
:align: center
|
||||
|
||||
:attr:`thumb_color_active` is an :class:`~kivy.properties.ColorProperty`
|
||||
and default to `None`.
|
||||
"""
|
||||
|
||||
thumb_color_inactive = ColorProperty(None)
|
||||
"""
|
||||
The color in (r, g, b, a) or string format of the thumb when the switch is inactive.
|
||||
|
||||
.. versionadded:: 1.0.0
|
||||
|
||||
.. code-block:: kv
|
||||
|
||||
MDSwitch:
|
||||
thumb_color_inactive: "brown"
|
||||
|
||||
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/switch-thumb-color-inactive.png
|
||||
:align: center
|
||||
|
||||
:attr:`thumb_color_inactive` is an :class:`~kivy.properties.ColorProperty`
|
||||
and default to `None`.
|
||||
"""
|
||||
|
||||
thumb_color_disabled = ColorProperty(None)
|
||||
"""
|
||||
The color in (r, g, b, a) or string format of the thumb when the switch is
|
||||
in the disabled state.
|
||||
|
||||
.. code-block:: kv
|
||||
|
||||
MDSwitch:
|
||||
active: True
|
||||
thumb_color_disabled: "brown"
|
||||
disabled: True
|
||||
|
||||
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/switch-thumb-color-disabled.png
|
||||
:align: center
|
||||
|
||||
:attr:`thumb_color_disabled` is an :class:`~kivy.properties.ColorProperty`
|
||||
and default to `None`.
|
||||
"""
|
||||
|
||||
track_color_active = ColorProperty(None)
|
||||
"""
|
||||
The color in (r, g, b, a) or string format of the track when the switch is active.
|
||||
|
||||
.. code-block:: kv
|
||||
|
||||
MDSwitch:
|
||||
active: True
|
||||
track_color_active: "red"
|
||||
|
||||
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/switch-track-color-active.png
|
||||
:align: center
|
||||
|
||||
:attr:`track_color_active` is an :class:`~kivy.properties.ColorProperty`
|
||||
and default to `None`.
|
||||
"""
|
||||
|
||||
track_color_inactive = ColorProperty(None)
|
||||
"""
|
||||
The color in (r, g, b, a) or string format of the track when the switch is inactive.
|
||||
|
||||
.. versionadded:: 1.0.0
|
||||
|
||||
.. code-block:: kv
|
||||
|
||||
MDSwitch:
|
||||
track_color_inactive: "red"
|
||||
|
||||
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/switch-track-color-inactive.png
|
||||
:align: center
|
||||
|
||||
:attr:`track_color_inactive` is an :class:`~kivy.properties.ColorProperty`
|
||||
and default to `None`.
|
||||
"""
|
||||
|
||||
track_color_disabled = ColorProperty(None)
|
||||
"""
|
||||
The color in (r, g, b, a) or string format of the track when the switch is
|
||||
in the disabled state.
|
||||
|
||||
.. code-block:: kv
|
||||
|
||||
MDSwitch:
|
||||
track_color_disabled: "lightgrey"
|
||||
disabled: True
|
||||
|
||||
.. image:: https://github.com/HeaTTheatR/KivyMD-data/raw/master/gallery/kivymddoc/switch-track-color-disabled.png
|
||||
:align: center
|
||||
|
||||
:attr:`track_color_disabled` is an :class:`~kivy.properties.ColorProperty`
|
||||
and default to `None`.
|
||||
"""
|
||||
|
||||
_thumb_pos = ListProperty([0, 0])
|
||||
|
||||
def __init__(self, **kwargs):
|
||||
super().__init__(**kwargs)
|
||||
self.bind(icon_active=self.set_icon, icon_inactive=self.set_icon)
|
||||
self.size_hint = (None, None)
|
||||
self.size = (dp(36), dp(48))
|
||||
Clock.schedule_once(self._check_style)
|
||||
Clock.schedule_once(lambda x: self._update_thumb_pos(animation=False))
|
||||
Clock.schedule_once(lambda x: self.on_active(self, self.active))
|
||||
|
||||
def set_icon(self, instance_switch, icon_value: str) -> None:
|
||||
"""
|
||||
Called when the values of
|
||||
:attr:`icon_active` and :attr:`icon_inactive` change.
|
||||
"""
|
||||
|
||||
def set_icon(*args):
|
||||
icon = icon_value if icon_value else "blank"
|
||||
self.ids.thumb.ids.icon.icon = icon
|
||||
|
||||
Clock.schedule_once(set_icon, 0.2)
|
||||
|
||||
def on_active(self, instance_switch, active_value: bool) -> None:
|
||||
"""Called when the values of :attr:`active` change."""
|
||||
|
||||
if self.theme_cls.material_style == "M3" and self.widget_style != "ios":
|
||||
size = (
|
||||
(
|
||||
(dp(16), dp(16))
|
||||
if not self.icon_inactive
|
||||
else (dp(24), dp(24))
|
||||
)
|
||||
if not active_value
|
||||
else (dp(24), dp(24))
|
||||
)
|
||||
icon = "blank"
|
||||
color = (0, 0, 0, 0)
|
||||
|
||||
if self.icon_active and active_value:
|
||||
icon = self.icon_active
|
||||
color = (
|
||||
self.icon_active_color
|
||||
if self.icon_active_color
|
||||
else self.theme_cls.text_color
|
||||
)
|
||||
elif self.icon_inactive and not active_value:
|
||||
icon = self.icon_inactive
|
||||
color = (
|
||||
self.icon_inactive_color
|
||||
if self.icon_inactive_color
|
||||
else self.theme_cls.text_color
|
||||
)
|
||||
|
||||
Animation(size=size, t="out_quad", d=0.2).start(self.ids.thumb)
|
||||
Animation(color=color, t="out_quad", d=0.2).start(
|
||||
self.ids.thumb.ids.icon
|
||||
)
|
||||
self.set_icon(self, icon)
|
||||
|
||||
self._update_thumb_pos()
|
||||
|
||||
# FIXME: If you move the cursor from the switch during the
|
||||
# `on_touch_down` event, the animation of returning the thumb to
|
||||
# the previous size does not work. The following code fixes this.
|
||||
def on_thumb_down(self) -> None:
|
||||
"""
|
||||
Called at the on_touch_down event of the :class:`~Thumb` object.
|
||||
Indicates the state of the switch "on/off" by an animation of
|
||||
increasing the size of the thumb.
|
||||
"""
|
||||
|
||||
if self.widget_style != "ios" and self.theme_cls.material_style == "M3":
|
||||
if self.active:
|
||||
size = (dp(28), dp(28))
|
||||
pos = (
|
||||
self.ids.thumb.pos[0] - dp(2),
|
||||
self.ids.thumb.pos[1] - dp(1.8),
|
||||
)
|
||||
else:
|
||||
size = (dp(26), dp(26))
|
||||
pos = (
|
||||
(
|
||||
self.ids.thumb.pos[0] - dp(5),
|
||||
self.ids.thumb.pos[1] - dp(5),
|
||||
)
|
||||
if not self.icon_inactive
|
||||
else (
|
||||
self.ids.thumb.pos[0] + dp(1),
|
||||
self.ids.thumb.pos[1] - dp(1),
|
||||
)
|
||||
)
|
||||
Animation(size=size, pos=pos, t="out_quad", d=0.2).start(
|
||||
self.ids.thumb
|
||||
)
|
||||
|
||||
def _update_thumb_pos(self, *args, animation=True):
|
||||
if self.active:
|
||||
_thumb_pos = (
|
||||
self.width
|
||||
- (
|
||||
dp(14)
|
||||
if self.widget_style == "ios"
|
||||
or self.theme_cls.material_style == "M2"
|
||||
else dp(28)
|
||||
),
|
||||
self.height / 2
|
||||
- (
|
||||
dp(12)
|
||||
if self.widget_style == "ios"
|
||||
or self.theme_cls.material_style == "M2"
|
||||
else dp(16)
|
||||
),
|
||||
)
|
||||
else:
|
||||
_thumb_pos = (
|
||||
0 if not self.icon_inactive else dp(-14),
|
||||
self.height / 2
|
||||
- (
|
||||
dp(12)
|
||||
if self.widget_style == "ios"
|
||||
or self.theme_cls.material_style == "M2"
|
||||
else dp(16)
|
||||
),
|
||||
)
|
||||
Animation.cancel_all(self, "_thumb_pos")
|
||||
|
||||
if animation:
|
||||
Animation(_thumb_pos=_thumb_pos, duration=0.2, t="out_quad").start(
|
||||
self
|
||||
)
|
||||
else:
|
||||
self._thumb_pos = _thumb_pos
|
||||
|
||||
def _check_style(self, *args):
|
||||
if self.widget_style == "ios" or self.theme_cls.material_style == "M2":
|
||||
self.set_icon(self, "")
|
||||
Loading…
Add table
Add a link
Reference in a new issue