msticpy.nbwidgets.get_text module

Module for pre-defined widget layouts.

class msticpy.nbwidgets.get_text.GetText(default=None, description='Enter the value: ', auto_display=False, **kwargs)

Bases: RegisteredWidget, IPyDisplayMixin

GetText.

Widget to set text value.

Create a new instance of GetEnvironmentKey.

Parameters:

  • default (str) – Default value.

  • description (str, optional) – Prompt to display with the text box. (the default is “Enter the value: “) “prompt” is a alias for this parameter

  • auto_display (bool, optional) – Whether to display on instantiation (the default is False)

See also

RegisteredWidget

ALLOWED_KWARGS: ClassVar[list[str]] = ['id_vals', 'val_attrs', 'nb_params', 'name_space', 'register']
display()

Display the interactive widgets.

property layout

Return underlying widget collection.

property value

Get the current value of the widget.