gui.widget_readme_file_editor module

This widget contains the functionality of a simple readme and notes editor. The widget can be executed as a standalone version.

Functionalities provided in this widget:

1. Provides text viewer panel previewing the setup info. The setup information contains every important piece of information which can be obtained from the hardware.

2. Provides a text editor panel for arbitrary notes

3. The content of both panels will be saved automatically with each experiment - widget_main_window does that. In addition, the notes panel can be saved to and loaded from a file of the user’s choice from within this editor widget.

class WidgetRFE(*args, mw_obj=None, **kwargs)

Bases: PyQt5.QtWidgets.QWidget, ui_readmefile.Ui_Widget_readmefile

Readme editor widget

Inherits:

QtWidgets.QWidget Ui_readmefile: Widget layout

__init__(*args, mw_obj=None, **kwargs)

Init editor widget

Parameters

mw_obj (MainWindow,optional) – Reference to the Main Window. This is the object where all the setup information comes from. Defaults to None, but this defeats the purpose.

clear_all()

Clears the notes panel

fill_standard_fields()

Refreshes setup info panel with current information

This function can be called manually upon button press, but more importantly this is called during the start of each experiment, before the content of both panels (setup info and notes) is saved to disk.

get_all_the_symbols()

Helper function for testing

Fills the setup info panel with the symbols of the local and the global scope.

insert_notes_template()

Insert some standard fields at cursor position

open_notes_file_dialog()

save_notes_file_dialog()