Class CreateDialogPartialT

protocol ooodev.dialog.partial.create_dialog_partial_t.CreateDialogPartialT[source]

Type for CreateDialogPartial

Classes that implement this protocol must have the following methods / attributes:

create_dialog(x, y, width, height, title)[source]

Creates a dialog.

Parameters:

  • x (int) – X coordinate. If -1, the dialog Position is not set.

  • y (int) – Y coordinate. If -1, the dialog Position is not set.

  • width (int) – Width. If -1, the dialog Size is not set.

  • height (int) – Height. If -1, the dialog Size is not set.

  • title (str) – Dialog title.

Returns:

An empty dialog. The dialog contains methods for adding controls.

Return type:

Dialog

input_box(title, msg, input_value='', ok_lbl='OK', cancel_lbl='Cancel', is_password=False)[source]

Displays an input box and returns the results.

Parameters:

  • title (str) – Title for the dialog

  • msg (str) – Message to display such as “Input your Name”

  • input_value (str, optional) – Value of input box when first displayed.

  • ok_lbl (str, optional) – OK button Label. Defaults to “OK”.

  • cancel_lbl (str, optional) – Cancel Button Label. Defaults to “Cancel”.

  • is_password (bool, optional) – Determines if the input box is masked for password input. Defaults to False.

Returns:

The value of input or empty string.

Return type:

str

msgbox(msg: str) → MessageBoxResultsEnum
msgbox(msg: str, title: str) → MessageBoxResultsEnum
msgbox(msg: str, title: str) → MessageBoxResultsEnum
msgbox(msg: str, title: str) → MessageBoxResultsEnum
msgbox(msg: str, title: str) → MessageBoxResultsEnum
msgbox(**kwds)

Helper for @overload to raise when called.