Text Input¶
The text input widget is a simple input field for user entry of text data.
Usage¶
import toga
input = toga.TextInput(placeholder='enter name here')
Reference¶
-
class
toga.interface.widgets.textinput.TextInput(id=None, style=None, initial=None, placeholder=None, readonly=False)¶ Text input widget
Instantiate a new instance of the text input widget
Parameters: - id (
str) – An identifier for this widget. - style (
colosseum.CSSNode) – an optional style object. If no style is provided then a new one will be created for the widget. - initial (
str) – The initial text - placeholder (
str) – The placeholder text - readonly (
bool) – Whether a user can write into the text input, defaults to False
-
add(child)¶ Add a widget as a child of this one.
Raises an
ValueErrorif this widget is a leaf, and cannot have children.Parameters: child ( toga.Widget) – The child to add to the widget
-
app¶ The App to which this widget belongs.
Return type: toga.App
-
children¶ The children of this node.
This always returns a list, even if the node is a leaf and cannot have children.
Return type: listReturns: A list of the children for this widget
-
clear()¶ Clear the value
-
hide()¶ Hide the widget from the super view.
-
id¶ The node identifier. This id can be used to target CSS directives
Return type: str
-
parent¶ The parent of this node.
Return type: toga.Widget
-
placeholder¶ The placeholder text
Return type: str
-
readonly¶ Whether a user can write into the text input
Return type: bool
-
set_font(font)¶ Set a font on this widget.
Parameters: font ( toga.Font) – The new font
-
show()¶ Show the widget on the super view.
-
style¶ The style object for this widget.
Returns: The style for this widget Return type: colosseum.CSSNode
-
value¶ The value of the text input field
Return type: str
-
window¶ The Window to which this widget belongs.
Return type: toga.Window
- id (