carbonkivy.uix.shell

Submodules

• carbonkivy.uix.shell.shell

Attributes

UIX
filename

Classes

UIShell	Stack layout class. See module documentation for more information.
UIShellButton	This mixin class provides
UIShellHeader	Box layout class. See module documentation for more information.
UIShellHeaderMenuButton	This mixin class provides
UIShellHeaderName	Implements the creation and addition of child widgets as declarative
UIShellLayout	Stack layout class. See module documentation for more information.
UIShellLeftPanel	RelativeLayout class, see module documentation for more information.
UIShellPanelLayout	Stack layout class. See module documentation for more information.
UIShellPanelSelectionItem	This mixin class provides
UIShellPanelSelectionLayout	Box layout class. See module documentation for more information.
UIShellRightPanel	RelativeLayout class, see module documentation for more information.

Package Contents

carbonkivy.uix.shell.UIX

class carbonkivy.uix.shell.UIShell(*args, **kwargs)

Bases: carbonkivy.uix.stacklayout.CStackLayout

Stack layout class. See module documentation for more information.

class carbonkivy.uix.shell.UIShellButton(**kwargs)

Bases: carbonkivy.uix.button.CButtonGhost

This mixin class provides Button behavior. Please see the button behaviors module documentation for more information.

Events:

on_press

Fired when the button is pressed.

on_release

Fired when the button is released (i.e. the touch/click that pressed the button goes away).

active

class carbonkivy.uix.shell.UIShellHeader(*args, **kwargs)

Bases: carbonkivy.uix.boxlayout.CBoxLayout

Box layout class. See module documentation for more information.

class carbonkivy.uix.shell.UIShellHeaderMenuButton(**kwargs)

Bases: UIShellButton

This mixin class provides Button behavior. Please see the button behaviors module documentation for more information.

Events:

on_press

Fired when the button is pressed.

on_release

Fired when the button is released (i.e. the touch/click that pressed the button goes away).

class carbonkivy.uix.shell.UIShellHeaderName(*args, **kwargs)

Bases: carbonkivy.uix.label.CLabel, carbonkivy.behaviors.StateFocusBehavior

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

class carbonkivy.uix.shell.UIShellLayout(*args, **kwargs)

Bases: carbonkivy.uix.stacklayout.CStackLayout

Stack layout class. See module documentation for more information.

class carbonkivy.uix.shell.UIShellLeftPanel(**kwargs)

Bases: carbonkivy.uix.relativelayout.CRelativeLayout

RelativeLayout class, see module documentation for more information.

overlay

visibility

panel_shell

panel_width

animation

pos

Position of the widget.

pos is a ReferenceListProperty of (x, y) properties.

on_visibility(*args) → None

on_touch_down(touch)

Receive a touch down event.

Parameters:

touch: MotionEvent class

Touch received. The touch is in parent coordinates. See relativelayout for a discussion on coordinate systems.

Returns:

bool If True, the dispatching of the touch event will stop. If False, the event will continue to be dispatched to the rest of the widget tree.

on_touch_up(touch)

Receive a touch up event. The touch is in parent coordinates.

See on_touch_down() for more information.

class carbonkivy.uix.shell.UIShellPanelLayout(*args, **kwargs)

Bases: UIShellLayout

Stack layout class. See module documentation for more information.

class carbonkivy.uix.shell.UIShellPanelSelectionItem(**kwargs)

Bases: kivy.uix.behaviors.ButtonBehavior, carbonkivy.uix.boxlayout.CBoxLayout, carbonkivy.behaviors.StateFocusBehavior, carbonkivy.behaviors.HoverBehavior, carbonkivy.behaviors.SelectableBehavior

This mixin class provides Button behavior. Please see the button behaviors module documentation for more information.

Events:

on_press

Fired when the button is pressed.

on_release

Fired when the button is released (i.e. the touch/click that pressed the button goes away).

text

left_icon

right_icon

on_touch_down(touch: kivy.input.providers.mouse.MouseMotionEvent) → bool

Receive a touch down event.

Parameters:

touch: MotionEvent class

Touch received. The touch is in parent coordinates. See relativelayout for a discussion on coordinate systems.

Returns:

bool If True, the dispatching of the touch event will stop. If False, the event will continue to be dispatched to the rest of the widget tree.

on_left_icon(*args) → None

on_text(*args) → None

on_right_icon(*args) → None

class carbonkivy.uix.shell.UIShellPanelSelectionLayout(**kwargs)

Bases: carbonkivy.uix.selectionlayout.CSelectionLayout

Box layout class. See module documentation for more information.

class carbonkivy.uix.shell.UIShellRightPanel(**kwargs)

Bases: carbonkivy.uix.relativelayout.CRelativeLayout

RelativeLayout class, see module documentation for more information.

overlay

visibility

panel_shell

panel_width

master

animation

on_visibility(*args) → None

on_touch_down(touch)

Receive a touch down event.

Parameters:

touch: MotionEvent class

Touch received. The touch is in parent coordinates. See relativelayout for a discussion on coordinate systems.

Returns:

bool If True, the dispatching of the touch event will stop. If False, the event will continue to be dispatched to the rest of the widget tree.

on_touch_up(touch)

Receive a touch up event. The touch is in parent coordinates.

See on_touch_down() for more information.

carbonkivy.uix.shell.filename