bec/bec_widgets
0
0
Fork 0
mirror of https://github.com/bec-project/bec_widgets.git synced 2025-07-13 19:21:50 +02:00
Code Activity

docs(scan_control): docs extended

Browse Source
This commit is contained in:
wyzula_j
2024-09-04 14:23:35 +02:00
committed by wyzula_j
parent b07e67715c
commit 730e25fd3a
2 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/user/widgets/scan_control/hide_scan_control.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 42 KiB

12
docs/user/widgets/scan_control/scan_control.md
View File

@ -8,9 +8,11 @@ The [`Scan Control`](/api_reference/_autosummary/bec_widgets.cli.client.ScanCont
## Key Features:
- **Automatic Interface Generation**: Automatically generates a control interface based on scan signatures and `gui_config`.
- **Dynamic Argument Bundling**: Supports the dynamic addition and removal of argument bundles such as positioners controls.
- **Dynamic Argument Bundling**: Supports the dynamic addition and removal of argument bundles such as positioner controls.
- **Visual Parameter Grouping**: Provides a visual representation of scan parameters, grouped by their functionality.
- **Integrated Scan Controls**: Includes start abd stop controls for managing scan execution.
- **Integrated Scan Controls**: Includes start and stop controls for managing scan execution.
- **Persistent Scan Parameters**: Remembers scan parameters when switching between scans. If you configure scan 1 and switch to scan 2, scan 2 will inherit the same parameters if it has never been selected before.
- **Toggle to Reload Parameters from Last Executed Scan**: Includes a toggle to load scan parameters from the last executed scan from the BEC server, ensuring the user can quickly revert to previous configurations.
```{note}
By default, this widget supports scans that are derived from the following base classes and have a defined `gui_config`:
@ -27,10 +29,16 @@ The full procedure how to design `gui_config` for your custom scan class is desc
Within the BECDesigner's [property editor](https://doc.qt.io/qt-6/designer-widget-mode.html#the-property-editor/), the `ScanControl` widget can be customized to suit your application's requirements. The widget provides the following customization options:
- **Hide Scan Control**: Allows you to hide the scan control buttons from the widget interface. This is useful when you want to place the control buttons in a different location.
- **Hide Scan Selection**: Allows you to hide the scan selection combobox from the widget interface. This is useful when you want to restrict the user to a specific scan type or implement a custom scan selection mechanism.
- **Hide Scan Remember Toggle**: Allows you to hide the toggle button that reloads scan parameters from the last executed scan. This is useful if you want to disable or restrict this functionality in specific scenarios.
**BEC Designer properties:**
```{figure} ./hide_scan_control.png
```
**Example of usage:**
```{figure} ./scan_control.gif
```
````
````{tab} Examples