Prompt#

class omni.kit.window.file.Prompt(
title: str,
text: str,
button_text: List[str],
button_fn: List[Callable[[], None]],
modal: bool = False,
callback_addons: List[Callable[[], None]] = [],
callback_destroy: List[Callable[[], None]] = [],
decode_text: bool = True,
)#

Bases: object

A pop up window in context manager style to perform operations when inside the context.

Parameters:
  • title (str) – window title.

  • text (str) – decription of the operation to perform when in context.

  • button_text (List[str]) – text of buttons to create.

  • button_fn (List[Callable]) – functions to call after clicking buttons.

Keyword Arguments:
  • modal (bool) – True to disable hang detection when in context.

  • callback_addons (List[Callable]) – callbacks to perform after initializing the window.

  • callback_destroy (List[Callable]) – callbacks to perform after destroying the window.

  • decode_text (bool) – unwrap quotes if set.

Methods

__init__(title, text, button_text, button_fn)

destroy()

Destructor.

hide()

Hide the window.

is_visible()

set_text(text)

Set the operation description.

show()

Show the window.

__init__(
title: str,
text: str,
button_text: List[str],
button_fn: List[Callable[[], None]],
modal: bool = False,
callback_addons: List[Callable[[], None]] = [],
callback_destroy: List[Callable[[], None]] = [],
decode_text: bool = True,
)#
destroy()#

Destructor.

hide()#

Hide the window.

is_visible()#
Returns:

Return True if window is visible.

set_text(text)#

Set the operation description.

show()#

Show the window.