Args in a table
This commit is contained in:
parent
5f268fdf3a
commit
69209f8b70
1 changed files with 7 additions and 5 deletions
12
README.md
12
README.md
|
@ -12,11 +12,13 @@ pip install showdialog
|
|||
Opens GTK MessageDialog
|
||||
|
||||
#### Args
|
||||
- title (`str`): Dialog caption
|
||||
- text (`Union[Tuple[Optional[str], bool], Optional[str]]`): Dialog primary text, str or tuple `(text, use_markup)`
|
||||
- sectext (`Union[Tuple[Optional[str], bool], Optional[str]]`, optional): Dialog secondary text, str or tuple. Defaults to `None`.
|
||||
- btns (`Gtk.ButtonsType`, optional): Dialog buttons. Defaults to `Gtk.ButtonsType.OK`.
|
||||
- msgtype (`Gtk.MessageType`, optional): Dialog message type. Defaults to `Gtk.MessageType.INFO`.
|
||||
|Name|Type|Description|Default value|
|
||||
|:--:|:--:|:----------|:------:|
|
||||
|title|`str`|Dialog caption|*Required*|
|
||||
|text|`Tuple[Optional[str], bool] | Optional[str]`|Dialog primary text, str or tuple: `(text, use_markup)`|*Required*|
|
||||
|sectext|`Tuple[Optional[str], bool] | Optional[str]`, optional|Dialog secondary text, str or tuple|`None`|
|
||||
|btns|`Gtk.ButtonsType`|Dialog buttons|`Gtk.ButtonsType.OK`|
|
||||
|msgtype|`Gtk.MessageType`|Dialog message type|`Gtk.MessageType.INFO`|
|
||||
|
||||
#### Example:
|
||||
```python
|
||||
|
|
Loading…
Reference in a new issue