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, initial=None, readonly=False, placeholder=None, on_change=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.
factory – Optional factory that must be able to return a implementation of a MulitlineTextInput Widget.
initial (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.

MIN_HEIGHT = 100¶

MIN_WIDTH = 100¶

add(*children)¶

Add nodes as children of this one. 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.

Parameters: children – Nodes to add as children of this node.
Raises: ValueError – If this node is a leaf, and cannot have children.

property app¶

The App to which this widget belongs. On setting the app we also iterate over all children of this widget and set them to the same app.

Returns: The toga.App to which this widget belongs.
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¶

focus()¶

property id¶

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

Returns: The widgets identifier as a str.

insert(index, child)¶

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

Parameters

index – Position of child node.
child – A node to insert as a child of this node.

Raises

ValueError – If this node is a leaf, and cannot have children.

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 child nodes of this node. This does nothing if a given node is not a child of this node.

Parameters: children – Child nodes to remove.
Raises: ValueError – If this node is a leaf, and cannot have children.

property root¶

The root of the tree containing this node.

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

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. On setting the window, we automatically update all children of this widget to belong to the same window.

Returns: The toga.Window to which the widget belongs.