TimestampWidget

class omni.kit.window.filepicker.TimestampWidget(**kwargs)

Bases: object

Methods

__init__(**kwargs)	Timestamp Widget.
add_on_check_changed_fn(fn)	Add a function to be called when the check changes.
create_timestamp_widget()	Create and return a TimestampWidget.
delete_timestamp_widget(widget)	Delete a TimestampWidget.
destroy()	Destroy and clean up the widget.
get_timestamp_url(url)	Returns the URL to use for the timestamp.
on_list_checkpoint(select)	Called when user selects a checkpoint.
on_selection_changed(widget, selected)	Callback for when selection changes.
rebuild(selected)	Rebuild the frame.
set_checkpoint_widget(widget)	Set the checkpoint widget.
set_url(url)	Set the url.

Attributes

check

Get check box status of timestamp widget.

__init__(**kwargs)

Timestamp Widget.

add_on_check_changed_fn(fn)

Add a function to be called when the check changes. The function will be called with the following arguments

Parameters:

fn (Callable) – The function to be.

static create_timestamp_widget() → TimestampWidget

Create and return a TimestampWidget.

Returns:

obj:’TimestampWidget’: A TimestampWidget instance.

static delete_timestamp_widget(

widget: TimestampWidget,

)

Delete a TimestampWidget.

Parameters:

widget( – obj:’TimestampWidget’): The widget to be deleted. If None is passed no action is taken

destroy()

Destroy and clean up the widget.

get_timestamp_url(url: str) → str

Returns the URL to use for the timestamp.

Parameters:

url (str) – The url to use.

Returns:

The url with the timestamp appended to it if the timestamp checkbox is checked.

Return type:

str

on_list_checkpoint(select)

Called when user selects a checkpoint.

Parameters:

select (str) – selected item.

static on_selection_changed(

widget: TimestampWidget,

selected: List[str],

)

Callback for when selection changes.

Parameters:

• ( (widget) – obj:’TimestampWidget’): TimestampWidget that was toggled.

• selected (List[str]) – List of items that were selected. If None is selected no change is made.

rebuild(selected: List[str])

Rebuild the frame. This is called when the user clicks on the rebuild button. :param selected: List of items that have been selected. :type selected: List[str]

set_checkpoint_widget(widget)

Set the checkpoint widget. This is used to provide feedback to the user when they want to check out the state of the experiment

Parameters:

widget (obj) – The widget to be

set_url(url: str)

Set the url.

Parameters:

url (str) – The URL to set.

property check: bool

Get check box status of timestamp widget. :returns: True if the timestamp is valid False otherwise. :rtype: bool