opihiexarata.gui.name module

This window is for allowing the user to fill out the name of the object which they are observing, used when doing new targets.

This is just a simple input dialog.

class opihiexarata.gui.name.TargetNameWindow[source]

Bases: QWidget

__init__() None[source]

Setting up the window for the user prompt.

Parameters:

None

Return type:

None

static _sanitize_input(raw_input: str = None) str[source]

Sanitization of the raw input to the proper input.

Parameters:

raw_input (string) – The raw input to be sanitized.

Returns:

sanitized_input – The sanitized input.

Return type:

string

staticMetaObject = PySide6.QtCore.QMetaObject("TargetNameWindow" inherits "QWidget": )
opihiexarata.gui.name.ask_user_target_name_window(default: str = None) str[source]

Use the target name window to prompt the user for the name of the object that they are studying.

Parameters:

default (string) – The default name to provide should the user interact with the dialog box to submit a name. (That is, they cancel or close it.)

Returns:

target_name – The target name as specified (or the default if something went amiss.)

Return type:

string

opihiexarata.gui.name.main() None[source]