OpenPNM_f2b2c850ec1011e8abce74d435ecf773¶
- author:
PMEAL Team
- contact:
- email:
- organization:
- address:
- copyright:
- date:
Sep 20 2019 16:39
- dragonflyVersion:
4.0.0.0514
- UUID:
f2b2c850ec1011e8abce74d435ecf773
Class Code¶
- class OrsPythonPlugins.OpenPNM_f2b2c850ec1011e8abce74d435ecf773.OpenPNM_f2b2c850ec1011e8abce74d435ecf773.OpenPNM_f2b2c850ec1011e8abce74d435ecf773(*args, **kwargs)¶
- handleChanged(oldState, newState)¶
This method is called when the state of the application is changed.
- Parameters:
oldState (str) – name of the old (previous) state
newState (str) – name of the new (current) state
- handleTriggered(eventData)¶
This method is called on every user input (mouse move, mouse click, key press, …) when the current state of the application is one of those declared by the plugin. This method can be used to perform specific tasks even if no action is currently in progress.
- Parameters:
eventData (OrsEvent.eventdata.InputEventData) – the event data
- openWidget(name, dock=None, tab=None, x=-1, y=-1, w=-1, l=-1, order=-1, show=True)¶
Instantiates the widget with the provided name. This is done only if it is not already instantiated.
- Parameters:
name (str) – name of the widget to instantiate
dock (str) – docking location in the main window (left, right, top, bottom, center, floating)
tab (str) – name of the tab to dock in
x (int) – position of top left corner of window in x. Use -1 for default value.
y (int) – position of top left corner of window in y. Use -1 for default value.
w (int) – width of window. Use -1 for default value.
l (int) – height of window. Use -1 for default value.
order (int.) – position of widget in docking location. Use -1 to put at the end.
show (bool) – if
True, the form is also shown after being instantiated. If the form already exists, a “raise” is done. IfFalse, no call to show the form is made.
- classmethod startupDefault(openMainForm=True)¶
Creates an instance of the plugin class and opens the main form (if required) at the default position.
- Returns:
output (AbstractPlugin) – plugin instance