carbonkivy.behaviors

Submodules

Classes

AdaptiveBehavior

BackgroundColorBehavior

BackgroundColorBehaviorCircular

BackgroundColorBehaviorRectangular

DeclarativeBehavior

Implements the creation and addition of child widgets as declarative

ElevationBehavior

HierarchicalLayerBehavior

HoverBehavior

SelectableBehavior

SelectionBehavior

StateFocusBehavior

TooltipBehavior

Package Contents

class carbonkivy.behaviors.AdaptiveBehavior[source]
adaptive
on_adaptive(*args) None[source]
class carbonkivy.behaviors.BackgroundColorBehavior(*args, **kwargs)[source]
bg_source

Background image path.

radius

Canvas radius.

bg_color

The background color of the widget.

active_color

The background color of the widget if its touch state is down.

bg_color_disabled

The background color of the widget if disabled.

bg_color_focus

The background color of the widget if focused.

inset_color

The color of border inset.

inset_color_disabled

The color of border inset if disabled.

inset_color_focus

The color of border inset if focused.

line_color

The border of the specified color will be used to border the widget.

line_color_disabled

The border of the specified color will be used to border the widget if disabled.

line_color_focus

The border of the specified color will be used to border the widget if focused.

inset_width

The width of border inset.

line_width

Border of the specified width will be used to border the widget.

angle
background_origin
cstate
on_bg_color(instance: object, color: list | str) None[source]

Fired when the values of bg_color change.

on_inset_color(instance: object, color: list | str) None[source]

Fired when the values of inset_color change.

on_line_color(instance: object, color: list | str) None[source]

Fired when the values of line_color change.

on_cstate(*args) None[source]
on_disabled(*args) None[source]
update_background_origin(instance, pos: list) None[source]

Fired when the values of pos change.

class carbonkivy.behaviors.BackgroundColorBehaviorCircular(*args, **kwargs)[source]

Bases: BackgroundColorBehavior

radius

Canvas radius.

class carbonkivy.behaviors.BackgroundColorBehaviorRectangular(*args, **kwargs)[source]

Bases: BackgroundColorBehavior

class carbonkivy.behaviors.DeclarativeBehavior(*args, **kwargs)[source]

Implements the creation and addition of child widgets as declarative programming style.

id

Widget ID.

id is an StringProperty and defaults to ‘’.

bind_update(*args, **kwargs) None[source]
get_ids() dict[source]

Returns a dictionary of widget IDs defined in Python code that is written in a declarative style.

register_element(*args) None[source]
class carbonkivy.behaviors.ElevationBehavior(*args, **kwargs)[source]

Bases: kivy.event.EventDispatcher

shadow_offset
shadow_blur_radius
shadow_color
on_shadow_color(instance, value) None[source]
class carbonkivy.behaviors.HierarchicalLayerBehavior(*args, **kwargs)[source]
layer_code
on_parent(*args) None[source]
set_layer_code(*args) None[source]
class carbonkivy.behaviors.HoverBehavior(**kwargs)[source]
hover
hover_enabled
hover_color
element_hover(instance: object, pos: list, *args) None[source]
is_visible(*args) bool[source]
on_hover_enabled(*args) None[source]
on_hover(*args) None[source]
class carbonkivy.behaviors.SelectableBehavior(**kwargs)[source]

Bases: kivy.event.EventDispatcher

selected
default
on_default(instance: object, value: bool, *args) None[source]
class carbonkivy.behaviors.SelectionBehavior(**kwargs)[source]

Bases: kivy.event.EventDispatcher

selected_items
selection_attr
selection_type
selection_items
add_widget(widget, *args, **kwargs)[source]
update_selection(instance: object, value: bool, *args) None[source]
class carbonkivy.behaviors.StateFocusBehavior(**kwargs)[source]
focus
focus_enabled
on_focus_enabled(*args) None[source]
on_touch(instance: object, touch: list[float, float], *args) None[source]
on_focus(*args) None[source]
class carbonkivy.behaviors.TooltipBehavior(**kwargs)[source]
tooltip
on_tooltip(*args) None[source]