carbonkivy.uix.textinput

Submodules

• carbonkivy.uix.textinput.textinput

Attributes

UIX
filename

Classes

CTextInput	TextInput class. See module documentation for more information.
CTextInputHelperText	Implements the creation and addition of child widgets as declarative
CTextInputLabel	Implements the creation and addition of child widgets as declarative
CTextInputLayout	RelativeLayout class, see module documentation for more information.
CTextInputTrailingIconButton	This mixin class provides

Package Contents

carbonkivy.uix.textinput.UIX

class carbonkivy.uix.textinput.CTextInput(**kwargs)

Bases: carbonkivy.behaviors.AdaptiveBehavior, kivy.uix.textinput.TextInput, carbonkivy.behaviors.DeclarativeBehavior

TextInput class. See module documentation for more information.

Events:

on_text_validate

Fired only in multiline=False mode when the user hits ‘enter’. This will also unfocus the textinput.

on_double_tap

Fired when a double tap happens in the text input. The default behavior selects the text around the cursor position. More info at on_double_tap().

on_triple_tap

Fired when a triple tap happens in the text input. The default behavior selects the line around the cursor position. More info at on_triple_tap().

on_quad_touch

Fired when four fingers are touching the text input. The default behavior selects the whole text. More info at on_quad_touch().

Warning

When changing a TextInput property that requires re-drawing, e.g. modifying the text, the updates occur on the next clock cycle and not instantly. This might cause any changes to the TextInput that occur between the modification and the next cycle to be ignored, or to use previous values. For example, after a update to the text, changing the cursor in the same clock frame will move it using the previous text and will likely end up in an incorrect position. The solution is to schedule any updates to occur on the next clock cycle using schedule_once().

Note

Selection is cancelled when TextInput is focused. If you need to show selection when TextInput is focused, you should delay (use Clock.schedule) the call to the functions for selecting text (select_all, select_text).

Changed in version 1.10.0: background_disabled_active has been removed.

Changed in version 1.9.0: TextInput now inherits from FocusBehavior. keyboard_mode, show_keyboard(), hide_keyboard(), focus(), and input_type have been removed since they are now inherited from FocusBehavior.

Changed in version 1.7.0: on_double_tap, on_triple_tap and on_quad_touch events added.

Changed in version 2.1.0: keyboard_suggestions is now inherited from FocusBehavior.

on_parent(*args) → None

on_password(*args) → None

class carbonkivy.uix.textinput.CTextInputHelperText(*args, **kwargs)

Bases: carbonkivy.uix.label.CLabel

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

class carbonkivy.uix.textinput.CTextInputLabel(*args, **kwargs)

Bases: carbonkivy.uix.label.CLabel

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

class carbonkivy.uix.textinput.CTextInputLayout(**kwargs)

Bases: carbonkivy.behaviors.AdaptiveBehavior, carbonkivy.behaviors.BackgroundColorBehaviorRectangular, carbonkivy.behaviors.StateFocusBehavior, kivy.uix.relativelayout.RelativeLayout, carbonkivy.behaviors.DeclarativeBehavior, carbonkivy.behaviors.HierarchicalLayerBehavior, carbonkivy.behaviors.HoverBehavior

RelativeLayout class, see module documentation for more information.

ctextinput_area

on_kv_post(*args)

update_specs(*args) → None

class carbonkivy.uix.textinput.CTextInputTrailingIconButton(**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).

carbonkivy.uix.textinput.filename