bestgui.paramtype¶
Utility functions and classes for parameter insertion handling.
- class bestgui.paramtype.BaseFileParam(name, label='', mandatory=False, default=None, width=40, multiple=False, numcheck=None, workdir=None)¶
- check()¶
- get_value()¶
- get_workdir()¶
- set_value(value)¶
- set_workdir_getter(workdir)¶
- workdir¶
- class bestgui.paramtype.BaseParam(name, label='', mandatory=False, default=None)¶
- check()¶
- clear()¶
- enabled¶
- get_enabled()¶
- get_value()¶
- set_enabled(enabled)¶
- set_value(value)¶
- value¶
- Parameter value.
- class bestgui.paramtype.Check(name, options, label='', mandatory=False, default=None)¶
Base class for parameters that require check buttons.
options – a sequence of lenght two or a colon separated list of two values
The first item in “options” (the one with index 0) is the value of the parameter when the button is non checked, the second (the one with index 1) is the value of the parameter when the button is checked.
- get_value()¶
- on_toggled(widget=None, data=None)¶
- set_value(value)¶
- class bestgui.paramtype.CheckChar(name, options, label='', mandatory=False, default=None)¶
- get_value()¶
- class bestgui.paramtype.CheckString(name, options, label='', mandatory=False, default=None)¶
- get_value()¶
- class bestgui.paramtype.Dir(name, label='', mandatory=False, default=None, width=40, multiple=False, numcheck=None, workdir=None)¶
- get_value()¶
- class bestgui.paramtype.Entry(name, label='', mandatory=False, default=None, width=10, description='')¶
Base class for parameters that require an entry widget.
- get_value()¶
- on_clear(widget, data=None)¶
- on_populate_popup(widget, menu, data=None)¶
- on_set_default(widget, data=None)¶
- set_value(value)¶
- class bestgui.paramtype.File(name, label='', mandatory=False, default=None, width=40, action=None, patterns=[], multiple=False, numcheck=None, workdir=None)¶
- parse_patterns(patterns)¶
- set_patterns(filechooser)¶
- class bestgui.paramtype.Path(name, label='', mandatory=False, default=None, width=40, action=None, patterns=[], workdir=None)¶
- get_value()¶
- class bestgui.paramtype.Radio(name, options, label='', mandatory=False, default=None)¶
Base class for parameters that require radio buttons
- get_options()¶
- get_value()¶
- options¶
- The radio button options.
- set_options(options)¶
- set_value(value)¶
- class bestgui.paramtype.RadioChar(name, options, label='', mandatory=False, default=None)¶
- get_value()¶
- class bestgui.paramtype.RadioScalar(name, options, label='', mandatory=False, default=None)¶
- class bestgui.paramtype.RadioString(name, options, label='', mandatory=False, default=None)¶
Base class for parameters that require radio buttons
The “NONE” string is treated as a special value.
- get_value()¶
- class bestgui.paramtype.Scalar(name, label='', mandatory=False, default=None, width=6, range=None)¶
- check()¶
- class bestgui.paramtype.String(name, label='', mandatory=False, default=None, width=40, description='')¶
- get_value()¶
- class bestgui.paramtype.StringVector(name, label='', mandatory=False, default=None, width=40, description='', lencheck=None)¶
- get_value()¶
- class bestgui.paramtype.Vector(name, label='', mandatory=False, default=None, width=10, description='', lencheck=None)¶
- check()¶
- bestgui.paramtype.checknum(value, condition)¶
