Multi-line text input#

The Multi-line text input is similar to the text input but designed for larger inputs, similar to the textarea field of HTML.

Usage#

import toga

textbox = toga.MultilineTextInput(id='view1')

Reference#

class toga.widgets.multilinetextinput.MultilineTextInput(id=None, style=None, factory=None, value=None, readonly=False, placeholder=None, on_change=None, initial=None)#

A multi-line text input widget.

Parameters:

id (str) – An identifier for this widget.
style (Style) – An optional style object. If no style is provided then a new one will be created for the widget.
value (str) – The initial text of the widget.
readonly (bool) – Whether a user can write into the text input, defaults to False.
placeholder (str) – The placeholder text for the widget.
on_change (callable) – The handler to invoke when the text changes.

MIN_HEIGHT = 100#

MIN_WIDTH = 100#

add(*children)#

Add the provided widgets as children of this widget.

If a node already has a different parent, it will be moved over. This does nothing if a node already is a child of this node.

Raises ValueError if this widget cannot have children.

Parameters:: children – The widgets to add as children of this widget.

property app#

The App to which this widget belongs.

When setting the app for a widget, all children of this widget will be recursively assigned to the same app.

Raises ValueError if the widget is already associated with another app.

property can_have_children#

Determine if the node can have children.

This does not resolve whether there actually are any children; it only confirms whether children are theoretically allowed.

property children#

The children of this node. This always returns a list, even if the node is a leaf and cannot have children.

Returns:: A list of the children for this widget.

clear()#: Clears the text from the widget.

property enabled#: Is the widget currently enabled? i.e., can the user interact with the widget?

focus()#: Set this widget to have the current input focus.

property id#: The node identifier. This id can be used to target styling directives.

insert(index, child)#

Insert a widget as a child of this widget.

If the node already has a parent, ownership of the widget will be transferred.

Raises ValueError if this node cannot have children.

Parameters:

index – The position in the list of children where the new widget should be added.
child – The child to insert as a child of this node.

property on_change#

The handler to invoke when the value changes.

Returns:: The function callable that is called on a content change.

property parent#

The parent of this node.

Returns:: The parent of this node. Returns None if this node is the root node.

property placeholder#

The placeholder text.

Returns:: The placeholder text as a str`.

property readonly#

Whether a user can write into the text input.

Returns:: True if the user can only read, False if the user can read and write the text.

refresh()#: Refresh the layout and appearance of the tree this node is contained in.

refresh_sublayouts()#

remove(*children)#

Remove the provided widgets as children of this node.

This does nothing if a given node is not a child of this node.

Raises ValueError if this node is a leaf, and cannot have children.

Parameters:: children – The child nodes to remove.

property root#

The root of the tree containing this node.

Returns:: The root node. Returns self if this node is the root node.

scroll_to_bottom()#: Scroll the view to make the bottom of the text field visible.

scroll_to_top()#: Scroll the view to make the top of the text field visible.

property tab_index#: The position of the widget in the focus chain for the window.

property value#

The value of the multi line text input field.

Returns:: The text of the Widget as a str.

property window#

The window to which this widget belongs.

When setting the window for a widget, all children of this widget will be recursively assigned to the same window.