StringField

A StringField displays text that the user can edit.

Create a StringField

The following code shows how to create a StringField. A SimpleStringModel is used to store the string that is displayed. The data model can then be read or set anywhere and will automatically be updated in the UI. A callback function is then assigned to the data model to react to the user finishing editing the data.

self.string_model = ui.SimpleStringModel()
ui.StringField(model=self.string_model, width=250, height=25)
self.string_model.as_string = "A StringField is editable text"
self.val_changed_id = self.string_model.subscribe_end_edit_fn(self.on_end_edit_string)

end_edit_string Callback

This is the callback that was assigned to the data model in the previous code. The callback then operates on the data and sets another StringField’s data model to display the length of the string.

def on_end_edit_string(self, item_model):
    string_field_val = item_model.as_string
    str_len = len(string_field_val)
    self.string_model_result.as_string = "Characters in StringField: " + str(str_len)

DataModel:

SimpleStringModel see: SimpleStringModel

Keyword Arguments:

Show...

password_mode :

This property holds the password mode. If the field is in the password mode when the entered text is obscured.

read_only :

This property holds if the field is read-only.

multiline :

Multiline allows to press enter and create a new line.

allow_tab_input :

This property holds if the field allows Tab input.

width : ui.Length

This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.

height : ui.Length

This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.

name : str

The name of the widget that user can set.

style_type_name_override : str

By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.

identifier : str

An optional identifier of the widget we can use to refer to it in queries.

visible : bool

This property holds whether the widget is visible.

visibleMin : float

If the current zoom factor and DPI is less than this value, the widget is not visible.

visibleMax : float

If the current zoom factor and DPI is bigger than this value, the widget is not visible.

tooltip : str

Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style

tooltip_fn : Callable

Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.

tooltip_offset_x : float

Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.

tooltip_offset_y : float

Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.

enabled : bool

This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.

selected : bool

This property holds a flag that specifies the widget has to use eSelected state of the style.

checked : bool

This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.

dragging : bool

This property holds if the widget is being dragged.

opaque_for_mouse_events : bool

If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either

skip_draw_when_clipped : bool

The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.

mouse_moved_fn : Callable

Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)

mouse_pressed_fn : Callable

Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.

mouse_released_fn : Callable

Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)

mouse_double_clicked_fn : Callable

Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)

mouse_wheel_fn : Callable

Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)

mouse_hovered_fn : Callable

Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)

drag_fn : Callable

Specify that this Widget is draggable, and set the callback that is attached to the drag operation.

accept_drop_fn : Callable

Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.

drop_fn : Callable

Specify that this Widget accepts drops and set the callback to the drop operation.

computed_content_size_changed_fn : Callable

Called when the size of the widget is changed.

Properies / Methods:

Show...

def allow_tab_input(self) -> bool:

This property holds if the field allows Tab input. type : bool

def allow_tab_input(self, arg1: bool) -> None:

This property holds if the field allows Tab input.

def multiline(self) -> bool:

Multiline allows to press enter and create a new line. type : bool

def multiline(self, arg1: bool) -> None:

Multiline allows to press enter and create a new line.

def password_mode(self) -> bool:

This property holds the password mode. If the field is in the password mode when the entered text is obscured. type : bool

def password_mode(self, arg1: bool) -> None:

This property holds the password mode. If the field is in the password mode when the entered text is obscured.

def read_only(self) -> bool:

This property holds if the field is read-only. type : bool

def read_only(self, arg1: bool) -> None:

This property holds if the field is read-only.