pymhf.gui.decorators module — pyMHF documentation

pymhf.gui.decorators.BOOLEAN(label: str, **extra_args)#

Create a boolean entry field in the form of a checkbox which can take extra arguments. To see what extra arguments are available, see the DearPyGUI documentation here.

Note: This decorator MUST be applied closer to the decorated function than the @property decorator

pymhf.gui.decorators.ENUM(label: str, enum: Type[Enum], **extra_args)#

Create an enum entry field which can take extra arguments. To see what extra arguments are available, see the DearPyGUI documentation here.

Note: This decorator MUST be applied closer to the decorated function than the @property decorator

pymhf.gui.decorators.FLOAT(label: str, is_slider: bool = False, **extra_args)#

Create a float entry field which can take extra arguments. Internally this uses double precision when interfacing with DearPyGUI to minimise loss of accuracy. To see what extra arguments are available, see the DearPyGUI documentation here. If is_slider is True, a slider will be used to render the widget instead. The allowed extra argument for this case can be found here.

Note: This decorator MUST be applied closer to the decorated function than the @property decorator

pymhf.gui.decorators.INTEGER(label: str, is_slider: bool = False, **extra_args)#

Create an integer entry field which can take extra arguments. To see what extra arguments are available, see the DearPyGUI documentation here. If is_slider is True, a slider will be used to render the widget instead. The allowed extra argument for this case can be found here.

Note: This decorator MUST be applied closer to the decorated function than the @property decorator

pymhf.gui.decorators.STRING(label: str, **extra_args)#

Create a string entry field which can take extra arguments. To see what extra arguments are available, see the DearPyGUI documentation here.

Note: This decorator MUST be applied closer to the decorated function than the @property decorator

pymhf.gui.decorators.gui_button(label: str)#

pymhf.gui.decorators.gui_combobox(label: str, items: list[str] | None = None)#

pymhf.gui.decorators.gui_group(group_label: str | None = None)#

Add all the gui elements defined within this context manager to the same group. This can be nested to create sub-groups to arbitrary depth.

class pymhf.gui.decorators.gui_variable#

Bases: object

classmethod BOOLEAN(label: str, **extra_args)#

Create a boolean entry field in the form of a checkbox which can take extra arguments. To see what extra arguments are available, see the DearPyGUI documentation here.

Note: This decorator MUST be applied closer to the decorated function than the @property decorator

classmethod ENUM(label: str, enum: Type[Enum], **extra_args)#

Create an enum entry field which can take extra arguments. To see what extra arguments are available, see the DearPyGUI documentation here.

Note: This decorator MUST be applied closer to the decorated function than the @property decorator

classmethod FLOAT(label: str, is_slider: bool = False, **extra_args)#

Create a float entry field which can take extra arguments. Internally this uses double precision when interfacing with DearPyGUI to minimise loss of accuracy. To see what extra arguments are available, see the DearPyGUI documentation here. If is_slider is True, a slider will be used to render the widget instead. The allowed extra argument for this case can be found here.

Note: This decorator MUST be applied closer to the decorated function than the @property decorator

classmethod INTEGER(label: str, is_slider: bool = False, **extra_args)#

Create an integer entry field which can take extra arguments. To see what extra arguments are available, see the DearPyGUI documentation here. If is_slider is True, a slider will be used to render the widget instead. The allowed extra argument for this case can be found here.

Note: This decorator MUST be applied closer to the decorated function than the @property decorator

classmethod STRING(label: str, **extra_args)#

Create a string entry field which can take extra arguments. To see what extra arguments are available, see the DearPyGUI documentation here.

Note: This decorator MUST be applied closer to the decorated function than the @property decorator

pymhf.gui.decorators.no_gui(cls: Mod)#

Mark the mod as not requiring a tab in the gui.

pymhf.gui.decorators module#