8.6.8. pymodaq_gui.utils package

• 8.6.8.1. pymodaq_gui.utils.widget_sync package
  • 8.6.8.1.1. pymodaq_gui.utils.widget_sync.core module
    • BaseWidgetSync
      • BaseWidgetSync.bind()
      • BaseWidgetSync.check_connection_mode()
      • BaseWidgetSync.disable()
      • BaseWidgetSync.enable()
      • BaseWidgetSync.is_enabled()
      • BaseWidgetSync.set_value()
      • BaseWidgetSync.unbind()
      • BaseWidgetSync.unbind_all()
      • BaseWidgetSync.validate_property_connection()
      • BaseWidgetSync.connected_widgets
      • BaseWidgetSync.connection_count
      • BaseWidgetSync.data_type
      • BaseWidgetSync.staticMetaObject
      • BaseWidgetSync.value
      • BaseWidgetSync.value_changed
    • DataType
      • DataType.BOOL
      • DataType.FLOAT
      • DataType.INT
      • DataType.OBJECT
      • DataType.STR
    • DictSync
      • DictSync.append_to_list()
      • DictSync.bind_dict()
      • DictSync.bind_parameter()
      • DictSync.bind_properties()
      • DictSync.pop_from_list()
      • DictSync.remove_from_list()
      • DictSync.set_value()
      • DictSync.update_key()
      • DictSync.staticMetaObject
      • DictSync.value
    • SyncMode
      • SyncMode.BIDIRECTIONAL
      • SyncMode.FROM_SYNC
      • SyncMode.TO_SYNC
    • ValueSync
      • ValueSync.add()
      • ValueSync.set_value()
      • ValueSync.staticMetaObject
      • ValueSync.value
  • 8.6.8.1.2. pymodaq_gui.utils.widget_sync.factories module
    • WidgetSyncFactories
      • WidgetSyncFactories.for_checkbox()
      • WidgetSyncFactories.for_combobox()
      • WidgetSyncFactories.for_lineedit()
      • WidgetSyncFactories.for_property()
      • WidgetSyncFactories.for_slider()
      • WidgetSyncFactories.for_spinbox()
  • 8.6.8.1.3. Qt Widget Synchronization
  • BaseWidgetSync
    • BaseWidgetSync.bind()
    • BaseWidgetSync.check_connection_mode()
    • BaseWidgetSync.disable()
    • BaseWidgetSync.enable()
    • BaseWidgetSync.is_enabled()
    • BaseWidgetSync.set_value()
    • BaseWidgetSync.unbind()
    • BaseWidgetSync.unbind_all()
    • BaseWidgetSync.validate_property_connection()
    • BaseWidgetSync.connected_widgets
    • BaseWidgetSync.connection_count
    • BaseWidgetSync.data_type
    • BaseWidgetSync.staticMetaObject
    • BaseWidgetSync.value
    • BaseWidgetSync.value_changed
  • DataType
    • DataType.BOOL
    • DataType.FLOAT
    • DataType.INT
    • DataType.OBJECT
    • DataType.STR
  • DictSync
    • DictSync.append_to_list()
    • DictSync.bind_dict()
    • DictSync.bind_parameter()
    • DictSync.bind_properties()
    • DictSync.pop_from_list()
    • DictSync.remove_from_list()
    • DictSync.set_value()
    • DictSync.update_key()
    • DictSync.staticMetaObject
    • DictSync.value
  • SyncMode
    • SyncMode.BIDIRECTIONAL
    • SyncMode.FROM_SYNC
    • SyncMode.TO_SYNC
  • ValueSync
    • ValueSync.add()
    • ValueSync.set_value()
    • ValueSync.staticMetaObject
    • ValueSync.value
  • WidgetSync
  • WidgetSyncFactories
    • WidgetSyncFactories.for_checkbox()
    • WidgetSyncFactories.for_combobox()
    • WidgetSyncFactories.for_lineedit()
    • WidgetSyncFactories.for_property()
    • WidgetSyncFactories.for_slider()
    • WidgetSyncFactories.for_spinbox()
• 8.6.8.2. pymodaq_gui.utils.widgets package
  • 8.6.8.2.1. pymodaq_gui.utils.widgets.collapsible_widget module
    • CollapsibleWidget
      • CollapsibleWidget.connect_signals()
      • CollapsibleWidget.init_ui()
      • CollapsibleWidget.set_expanded()
      • CollapsibleWidget.toggle_content()
      • CollapsibleWidget.staticMetaObject
      • CollapsibleWidget.toggled_signal
  • 8.6.8.2.2. pymodaq_gui.utils.widgets.combo module
    • ComboBox
      • ComboBox.get_items()
      • ComboBox.setEnabled()
      • ComboBox.set_items()
      • ComboBox.enabled_changed
      • ComboBox.items
      • ComboBox.items_changed
      • ComboBox.staticMetaObject
  • 8.6.8.2.3. pymodaq_gui.utils.widgets.highlighted_combo module
    • ComboModel
      • ComboModel.data()
      • ComboModel.rowCount()
      • ComboModel.set_data()
      • ComboModel.set_highlighted_index()
      • ComboModel.staticMetaObject
    • HighlightedComboBox
      • HighlightedComboBox.addItems()
      • HighlightedComboBox.combo_model()
      • HighlightedComboBox.set_highlighted_index()
      • HighlightedComboBox.set_style()
      • HighlightedComboBox.style_color_from_qcolor()
      • HighlightedComboBox.activated_color
      • HighlightedComboBox.highlighted_index
      • HighlightedComboBox.staticMetaObject
  • 8.6.8.2.4. pymodaq_gui.utils.widgets.label module
    • LabelWithFont
      • LabelWithFont.set_color()
      • LabelWithFont.staticMetaObject
  • 8.6.8.2.5. pymodaq_gui.utils.widgets.lcd module
    • LCD
      • LCD.setupui()
      • LCD.setvalues()
      • LCD.staticMetaObject
  • 8.6.8.2.6. pymodaq_gui.utils.widgets.multistate_led module
    • LedState
      • LedState.FALSE
      • LedState.TRUE
    • MultistateLED
      • MultistateLED.changeEvent()
      • MultistateLED.cycle()
      • MultistateLED.get_state()
      • MultistateLED.mouseReleaseEvent()
      • MultistateLED.paintEvent()
      • MultistateLED.set_gradient()
      • MultistateLED.set_shape()
      • MultistateLED.set_size()
      • MultistateLED.set_state()
      • MultistateLED.set_states()
      • MultistateLED.sizeHint()
      • MultistateLED.state_names()
      • MultistateLED.state_changed
      • MultistateLED.staticMetaObject
    • main()
  • 8.6.8.2.7. pymodaq_gui.utils.widgets.painter_utils module
    • desaturate()
    • draw_shape()
    • make_brush()
  • 8.6.8.2.8. pymodaq_gui.utils.widgets.pattern_completer module
    • PatternCompleter
      • PatternCompleter.add_completer()
      • PatternCompleter.cleanup_pattern_completer()
      • PatternCompleter.init_pattern_completer()
      • PatternCompleter.set_global_config()
      • PatternCompleter.set_visual_indicator()
      • PatternCompleter.update_completer_config()
      • PatternCompleter.update_completions()
    • PatternCompleterDelegate
      • PatternCompleterDelegate.add_completer()
      • PatternCompleterDelegate.createEditor()
      • PatternCompleterDelegate.destroyEditor()
      • PatternCompleterDelegate.setEditorData()
      • PatternCompleterDelegate.setModelData()
      • PatternCompleterDelegate.set_global_config()
      • PatternCompleterDelegate.update_completer_config()
      • PatternCompleterDelegate.update_completions()
      • PatternCompleterDelegate.staticMetaObject
    • PatternLineEdit
      • PatternLineEdit.keyPressEvent()
      • PatternLineEdit.staticMetaObject
    • PatternPlainTextEdit
      • PatternPlainTextEdit.keyPressEvent()
      • PatternPlainTextEdit.staticMetaObject
    • PatternTextEdit
      • PatternTextEdit.keyPressEvent()
      • PatternTextEdit.staticMetaObject
  • 8.6.8.2.9. pymodaq_gui.utils.widgets.push module
    • ActionMenu
      • ActionMenu.contextMenuEvent()
      • ActionMenu.staticMetaObject
    • EditPush
      • EditPush.emit_clicked()
      • EditPush.set_pushs()
      • EditPush.clicked
      • EditPush.staticMetaObject
    • EditPushInfo
    • EditPushRel
      • EditPushRel.set_pushs()
      • EditPushRel.staticMetaObject
    • PushButtonIcon
      • PushButtonIcon.contextMenuEvent()
      • PushButtonIcon.staticMetaObject
    • ToolButtonIcon
      • ToolButtonIcon.staticMetaObject
    • main()
  • 8.6.8.2.10. pymodaq_gui.utils.widgets.qled module
    • QLED
      • QLED.LED_Clicked()
      • QLED.get_state()
      • QLED.scale()
      • QLED.setReadOnly()
      • QLED.set_as()
      • QLED.set_as_false()
      • QLED.set_as_true()
      • QLED.staticMetaObject
      • QLED.value_changed
  • 8.6.8.2.11. pymodaq_gui.utils.widgets.search_lineedit module
    • DemoWindow
      • DemoWindow.on_search_changed()
      • DemoWindow.staticMetaObject
    • SearchLineEdit
      • SearchLineEdit.create_search_icon()
      • SearchLineEdit.paintEvent()
      • SearchLineEdit.searchTextChanged
      • SearchLineEdit.staticMetaObject
  • 8.6.8.2.12. pymodaq_gui.utils.widgets.spinbox module
    • QSpinBoxWithShortcut
      • QSpinBoxWithShortcut.staticMetaObject
    • QSpinBox_ro
      • QSpinBox_ro.staticMetaObject
    • SpinBox
      • SpinBox.set_font_size()
      • SpinBox.staticMetaObject
  • 8.6.8.2.13. pymodaq_gui.utils.widgets.statusbar_separator module
    • StatuBarSeparator
      • StatuBarSeparator.staticMetaObject
  • 8.6.8.2.14. pymodaq_gui.utils.widgets.table module
    • BooleanDelegate
      • BooleanDelegate.createEditor()
      • BooleanDelegate.setEditorData()
      • BooleanDelegate.setModelData()
      • BooleanDelegate.staticMetaObject
    • MyStyle
      • MyStyle.drawPrimitive()
      • MyStyle.staticMetaObject
    • SpinBoxDelegate
      • SpinBoxDelegate.createEditor()
      • SpinBoxDelegate.setEditorData()
      • SpinBoxDelegate.setModelData()
      • SpinBoxDelegate.staticMetaObject
    • TableModel
      • TableModel.clear()
      • TableModel.columnCount()
      • TableModel.data()
      • TableModel.dropMimeData()
      • TableModel.flags()
      • TableModel.get_data()
      • TableModel.get_data_all()
      • TableModel.headerData()
      • TableModel.insertRows()
      • TableModel.insert_data()
      • TableModel.is_checked()
      • TableModel.removeRows()
      • TableModel.remove_row()
      • TableModel.rowCount()
      • TableModel.setData()
      • TableModel.set_data_all()
      • TableModel.supportedDropActions()
      • TableModel.validate_data()
      • TableModel.raw_data
      • TableModel.staticMetaObject
    • TableView
      • TableView.setupview()
      • TableView.staticMetaObject
  • 8.6.8.2.15. pymodaq_gui.utils.widgets.tree_layout module
    • CustomTree
      • CustomTree.staticMetaObject
    • TreeLayout
      • TreeLayout.collapse_all()
      • TreeLayout.current_node_path()
      • TreeLayout.expand_all()
      • TreeLayout.open_tree_selection()
      • TreeLayout.populate_sub_tree()
      • TreeLayout.populate_tree()
      • TreeLayout.setupUi()
      • TreeLayout.tree_open_children()
      • TreeLayout.tree_open_parents()
      • TreeLayout.item_clicked_sig
      • TreeLayout.item_double_clicked_sig
      • TreeLayout.staticMetaObject
      • TreeLayout.status_sig
      • TreeLayout.treewidget
  • 8.6.8.2.16. pymodaq_gui.utils.widgets.tree_toml module
    • TreeFromToml
      • TreeFromToml.dict_to_param()
      • TreeFromToml.param_to_dict()
      • TreeFromToml.param_to_object()
      • TreeFromToml.commit_config_changes_cache()
      • TreeFromToml.show_dialog()
      • TreeFromToml.value_changed()
      • TreeFromToml.params
      • TreeFromToml.settings_name
      • TreeFromToml.staticMetaObject
  • 8.6.8.2.17. pymodaq_gui.utils.widgets.widget_bkg module
    • WidgetWithBkg
      • WidgetWithBkg.setup_palette()
      • WidgetWithBkg.staticMetaObject
  • 8.6.8.2.18. pymodaq_gui.utils.widgets.widget_with_label_title module
    • WidgetWithLabelTitle
      • WidgetWithLabelTitle.insert_widget()
      • WidgetWithLabelTitle.set_attached()
      • WidgetWithLabelTitle.set_label_visible()
      • WidgetWithLabelTitle.set_title()
      • WidgetWithLabelTitle.sig_attach_detach
      • WidgetWithLabelTitle.sig_close
      • WidgetWithLabelTitle.staticMetaObject
  • 8.6.8.2.19. pymodaq_gui.utils.widgets.widget_with_title_in_toolbar module
    • WidgetWithTitleInToolbar
      • WidgetWithTitleInToolbar.insert_widget()
      • WidgetWithTitleInToolbar.set_label_visible()
      • WidgetWithTitleInToolbar.set_title()
      • WidgetWithTitleInToolbar.staticMetaObject
  • 8.6.8.2.20. pymodaq_gui.utils.widgets.window module
    • make_window()

• 8.6.8.3. pymodaq_gui.utils.app_worker module
  • ExtensionWorker
    • ExtensionWorker.pause()
    • ExtensionWorker.start()
    • ExtensionWorker.stop()
    • ExtensionWorker.terminate_workers()
    • ExtensionWorker.update_worker_ntask()
    • ExtensionWorker.h5_manager
    • ExtensionWorker.has_data_processor
    • ExtensionWorker.is_running
    • ExtensionWorker.module_and_data_saver
    • ExtensionWorker.modules_manager
    • ExtensionWorker.n_tasks
    • ExtensionWorker.processor_worker
    • ExtensionWorker.saver_worker
    • ExtensionWorker.settings
    • ExtensionWorker.staticMetaObject
    • ExtensionWorker.workers_terminated
  • ProcessorWorker
    • ProcessorWorker.do_process_data()
    • ProcessorWorker.name
    • ProcessorWorker.params
    • ProcessorWorker.staticMetaObject
    • ProcessorWorker.worker_setting_name
  • SaverWorker
    • SaverWorker.add_nav_axes()
    • SaverWorker.save_data()
    • SaverWorker.name
    • SaverWorker.nav_axes_signal
    • SaverWorker.params
    • SaverWorker.saver
    • SaverWorker.staticMetaObject
    • SaverWorker.worker_setting_name
• 8.6.8.4. pymodaq_gui.utils.custom_app module
  • CustomApp
    • CustomApp.get_local_folder()
    • CustomApp.get_theme()
    • CustomApp.apply_size_hint()
    • CustomApp.connect_things()
    • CustomApp.do_things_after_ui_setup()
    • CustomApp.enable_workflow_actions()
    • CustomApp.get_help_markdown()
    • CustomApp.insert_custom_status_widgets()
    • CustomApp.populate_status_bar()
    • CustomApp.quit_fun()
    • CustomApp.set_permanent_status()
    • CustomApp.setup_actions()
    • CustomApp.setup_docks()
    • CustomApp.setup_docks_and_widgets()
    • CustomApp.setup_menu()
    • CustomApp.setup_menus_and_toolbars()
    • CustomApp.setup_ui()
    • CustomApp.setup_workflow_actions()
    • CustomApp.update_status()
    • CustomApp.dockarea
    • CustomApp.docks
    • CustomApp.h5_base_group_name
    • CustomApp.h5_manager
    • CustomApp.h5saver
    • CustomApp.log_signal
    • CustomApp.mainwindow
    • CustomApp.menubar
    • CustomApp.module_and_data_saver
    • CustomApp.params
    • CustomApp.show_h5file_statusbar_widgets
    • CustomApp.show_workflow_actions
    • CustomApp.splash_sc
    • CustomApp.staticMetaObject
    • CustomApp.statusbar
    • CustomApp.thread_manager
    • CustomApp.title
  • WorkFlowActions
    • WorkFlowActions.LOG
    • WorkFlowActions.PAUSE
    • WorkFlowActions.START
    • WorkFlowActions.STOP
• 8.6.8.5. pymodaq_gui.utils.dock module
  • Dock
    • Dock.removeWidget()
    • Dock.removeWidgets()
    • Dock.setOrientation()
    • Dock.dock_focused
    • Dock.grid_layout
    • Dock.staticMetaObject
  • DockArea
    • DockArea.addTempArea()
    • DockArea.moveDock()
    • DockArea.dock_signal
    • DockArea.staticMetaObject
• 8.6.8.6. pymodaq_gui.utils.enums module
  • MenuToolbarNames
    • MenuToolbarNames.FILE
    • MenuToolbarNames.HELP
    • MenuToolbarNames.RUNTIME
    • MenuToolbarNames.SETTINGS
    • MenuToolbarNames.TOOLBARS
    • MenuToolbarNames.TOOLS
    • MenuToolbarNames.VIEW
• 8.6.8.7. pymodaq_gui.utils.file_io module
  • select_file()
  • select_file_filter()
• 8.6.8.8. pymodaq_gui.utils.layout module
  • load_layout_state()
  • save_layout_state()
• 8.6.8.9. pymodaq_gui.utils.list_picker module
  • ListPicker
    • ListPicker.pick_dialog()
    • ListPicker.staticMetaObject
• 8.6.8.10. pymodaq_gui.utils.menu_utils module
  • IterableMenu
    • IterableMenu.staticMetaObject
  • MenuButton
    • MenuButton.update_entries()
    • MenuButton.staticMetaObject
    • MenuButton.triggered
  • StickyMenu
    • StickyMenu.mouseReleaseEvent()
    • StickyMenu.staticMetaObject
  • build_menu_from_iterable()
• 8.6.8.11. pymodaq_gui.utils.shared_ui module
  • PymodaqUpdateTableWidget
    • PymodaqUpdateTableWidget.append_row()
    • PymodaqUpdateTableWidget.setHorizontalHeaderLabels()
    • PymodaqUpdateTableWidget.sizeHint()
    • PymodaqUpdateTableWidget.staticMetaObject
  • SharedUI
    • SharedUI.affect_application()
    • SharedUI.check_update()
    • SharedUI.connect_things()
    • SharedUI.hide()
    • SharedUI.quit_fun()
    • SharedUI.restart_fun()
    • SharedUI.setup_actions()
    • SharedUI.setup_docks_and_widgets()
    • SharedUI.setup_menus_and_toolbars()
    • SharedUI.show()
    • SharedUI.show_about()
    • SharedUI.show_app_help()
    • SharedUI.show_changelog()
    • SharedUI.show_config()
    • SharedUI.show_help()
    • SharedUI.show_log()
    • SharedUI.staticMetaObject
  • main()
• 8.6.8.12. pymodaq_gui.utils.splash module
  • MySplash
    • MySplash.showMessage()
    • MySplash.staticMetaObject
  • get_pymodaq_pixmap()
  • get_splash_sc()
• 8.6.8.13. pymodaq_gui.utils.status_palette module
  • 8.6.8.13.1. PyMoDAQ Status Color Palette
    • 8.6.8.13.1.1. Rationale
    • 8.6.8.13.1.2. Color Definitions
    • 8.6.8.13.1.3. Usage with MultistateLED
    • 8.6.8.13.1.4. Usage in a parameter tree
  • Status
    • Status.CRITICAL
    • Status.ERROR
    • Status.IDLE
    • Status.OFF
    • Status.RUNNING
    • Status.WARNING
  • StatusPalette
    • StatusPalette.as_states()
    • StatusPalette.color()
    • StatusPalette.subset()
• 8.6.8.14. pymodaq_gui.utils.styling module
  • Font
    • Font.apply_to_widget()
    • Font.get_font()
    • Font.color
    • Font.font_name
    • Font.font_size
    • Font.isbold
    • Font.isitalic
  • alpha_color()
  • button_style()
  • color_from_depth()
  • color_to_rgba()
  • create_color()
  • create_font()
  • create_icon()
  • make_shape_icon()
  • menu_style()
  • resource_path_exists()
  • text_color()
  • transform_icon()
• 8.6.8.15. pymodaq_gui.utils.utils module
  • clickable()
  • create_nested_menu()
  • first_available_integer()
  • h5tree_to_QTree()
  • mkQApp()
  • pngbinary2Qlabel()
  • set_dark_palette()
  • set_enable_recursive()
  • widget_to_png_to_bytes()