carbonkivy.uix.tab

Submodules

Attributes

UIX

filename

Classes

CTab

Screen is an element intended to be used with a ScreenManager.

CTabHeader

Box layout class. See module documentation for more information.

CTabHeaderIcon

The CBaseIcon class inherits from Label to display icons from IBM's icon library using the generated icon font.

CTabHeaderItem

This mixin class provides

CTabHeaderItemLayout

Box layout class. See module documentation for more information.

CTabHeaderPrimaryText

Implements the creation and addition of child widgets as declarative

CTabHeaderSecondaryText

Implements the creation and addition of child widgets as declarative

CTabLayout

Stack layout class. See module documentation for more information.

CTabManager

Screen manager. This is the main class that will control your

Package Contents

carbonkivy.uix.tab.UIX[source]
class carbonkivy.uix.tab.CTab(*args, **kwargs)[source]

Bases: carbonkivy.uix.screen.screen.CScreen

Screen is an element intended to be used with a ScreenManager. Check module documentation for more information.

Events:
on_pre_enter: ()

Event fired when the screen is about to be used: the entering animation is started.

on_enter: ()

Event fired when the screen is displayed: the entering animation is complete.

on_pre_leave: ()

Event fired when the screen is about to be removed: the leaving animation is started.

on_leave: ()

Event fired when the screen is removed: the leaving animation is finished.

Changed in version 1.6.0: Events on_pre_enter, on_enter, on_pre_leave and on_leave were added.

class carbonkivy.uix.tab.CTabHeader(**kwargs)[source]

Bases: carbonkivy.behaviors.SelectionBehavior, carbonkivy.uix.boxlayout.CBoxLayout

Box layout class. See module documentation for more information.

tab_manager
on_tab_manager(*args) None[source]
add_widget(widget, *args, **kwargs) Any[source]

Add a new widget as a child of this widget.

Parameters:
widget: Widget

Widget to add to our list of children.

index: int, defaults to 0

Index to insert the widget in the list. Notice that the default of 0 means the widget is inserted at the beginning of the list and will thus be drawn on top of other sibling widgets. For a full discussion of the index and widget hierarchy, please see the Widgets Programming Guide.

Added in version 1.0.5.

canvas: str, defaults to None

Canvas to add widget’s canvas to. Can be ‘before’, ‘after’ or None for the default canvas.

Added in version 1.9.0.

>>> from kivy.uix.button import Button
>>> from kivy.uix.slider import Slider
>>> root = Widget()
>>> root.add_widget(Button())
>>> slider = Slider()
>>> root.add_widget(slider)
class carbonkivy.uix.tab.CTabHeaderIcon(**kwargs)[source]

Bases: carbonkivy.uix.icon.CIcon

The CBaseIcon class inherits from Label to display icons from IBM’s icon library using the generated icon font.

class carbonkivy.uix.tab.CTabHeaderItem(**kwargs)[source]

Bases: kivy.uix.behaviors.ButtonBehavior, carbonkivy.uix.boxlayout.CBoxLayout, carbonkivy.behaviors.StateFocusBehavior, 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).

primary_text
secondary_text
icon
name_tab
tab_manager
font_size
icon_size
on_font_size(*args) None[source]
on_icon_size(*args) None[source]
on_selected(*args) None[source]
on_touch_down(touch: kivy.input.providers.mouse.MouseMotionEvent) bool[source]

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_primary_text(*args) None[source]
on_icon(*args) None[source]
class carbonkivy.uix.tab.CTabHeaderItemLayout(*args, **kwargs)[source]

Bases: carbonkivy.uix.boxlayout.CBoxLayout

Box layout class. See module documentation for more information.

class carbonkivy.uix.tab.CTabHeaderPrimaryText(*args, **kwargs)[source]

Bases: carbonkivy.uix.label.CLabel

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

class carbonkivy.uix.tab.CTabHeaderSecondaryText(*args, **kwargs)[source]

Bases: carbonkivy.uix.label.CLabel

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

class carbonkivy.uix.tab.CTabLayout(*args, **kwargs)[source]

Bases: carbonkivy.uix.stacklayout.CStackLayout

Stack layout class. See module documentation for more information.

class carbonkivy.uix.tab.CTabManager(**kwargs)[source]

Bases: carbonkivy.uix.screenmanager.CScreenManager

Screen manager. This is the main class that will control your Screen stack and memory.

By default, the manager will show only one screen at a time.

carbonkivy.uix.tab.filename[source]