magicclass.utils package¶
Submodules¶
magicclass.utils.functions module¶
- class magicclass.utils.functions.MessageBoxMode(value)[source]¶
Bases:
enum.Enum
An enumeration.
- ABOUT = 'about'¶
- ERROR = 'error'¶
- INFO = 'info'¶
- QUESTION = 'question'¶
- WARNING = 'warn'¶
- magicclass.utils.functions.get_signature(func)[source]¶
Similar to
inspect.signature
but safely returnsSignature
.
- magicclass.utils.functions.iter_members(cls: type, exclude_prefix: str = '__') Iterable[tuple[str, typing.Any]] [source]¶
Iterate over all the members in the order of source code line number. This function is identical to inspect.getmembers except for the order of the results. We have to sort the name in the order of line number.
- magicclass.utils.functions.open_url(link: str) None [source]¶
Open the link with the default browser.
- Parameters
link (str) -- Link to the home page.
- magicclass.utils.functions.show_messagebox(mode: str | MessageBoxMode = MessageBoxMode.INFO, title: str = None, text: str = None, parent=None) bool [source]¶
Freeze the GUI and open a messagebox dialog.
- Parameters
mode (str or MessageBoxMode, default is MessageBoxMode.INFO) -- Mode of message box. Must be "error", "warn", "info", "question" or "about".
title (str, optional) -- Title of messagebox.
text (str, optional) -- Text in messagebox.
parent (QWidget, optional) -- Parent widget.
- Returns
If "OK" or "Yes" is clicked, return True. Otherwise return False.
- Return type
bool