bec-widgets 0.94.7__py3-none-any.whl → 0.95.1__py3-none-any.whl

docs/user/widgets/ring_progress_bar.md

@@ -1,54 +0,0 @@
-(user.widgets.spiral_progress_bar)=
-# [Ring Progress Bar](/api_reference/_autosummary/bec_widgets.cli.client.RingProgressBar)
-
-**Purpose:**
-
-The ring Progress Bar widget is a circular progress bar that can be used to visualize the progress of a task. The
-widget is designed to be used in applications where the progress of a task is represented as a percentage. The Spiral
-Progress Bar widget is a part of the BEC Widgets library and can be controlled directly using its API, or hooked up to
-the progress of a device readback or scan.
-
-**Key Features:**
-
-- circular progress bar to show updates on the progress of a task.
-- hooks to update the progress bar from a device readback or scan.
-- multiple progress rings to show different tasks in parallel.
-
-**Example of Use:**
-![RingProgressBar](./progress_bar.gif)
-
-**Code example:**
-
-The following code snipped demonstrates how to create a `RingProgressBar` using BEC Widgets within BEC.
-```python
-# adds a new dock with a ring progress bar
-progress = gui.add_dock().add_widget("RingProgressBar")
-# customize the size of the ring
-progress.set_line_width(20)
-```
-
-By default, the Ring Progress Bar widget will display a single ring. To add more rings, use the add_ring method:
-
-```python
-# adds a new dock with a ring progress bar
-progress.add_ring()
-```
-
-To access rings and specify their properties, you can use `progress.rings` with an index specifying the ring index (
-starting from 0):
-
-```python
-progress.rings[0].set_line_width(20)  # set the width of the first ring
-progress.rings[1].set_line_width(10)  # set the width of the second ring
-```
-
-By default, the `RingProgressBar` widget is set with `progress.enable_auto_update(True)`, which will automatically
-update the bars in the widget. To manually set updates for each progress bar, use the set_update method. Note that
-manually updating a ring will disable the automatic update for the whole widget:
-
-```python
-progress.rings[0].set_update("scan")  # set the update of the first ring to be an overall scan progress
-progress.rings[1].set_update("device",
-                             "samx")  # set the update of the second ring to be a device readback (in this case, samx)
-```
-

docs/user/widgets/scan_control.md

@@ -1,35 +0,0 @@
-(user.widgets.scan_control)=
-
-# Scan Control
-
-**Purpose:**
-
-The `ScanControl` widget is designed to generate a graphical user interface (GUI) to control various scan operations
-based on the scan's signature and `gui_config`. The widget is used to control the scan operations, such as starting,
-stopping, and pausing the scan. The widget also provides a graphical representation of the scan progress and the scan
-status. The widget is designed to be used in conjunction with the `ScanServer` and `ScanBundler` services from the BEC
-core services.
-
-By default the widget supports only the scans which have defined `gui_config` and are inhereted from these scan classes:
-
-- [ScanBase](https://beamline-experiment-control.readthedocs.io/en/latest/api_reference/_autosummary/bec_server.scan_server.scans.ScanBase.html)
-- [SyncFlyScanBase](https://beamline-experiment-control.readthedocs.io/en/latest/api_reference/_autosummary/bec_server.scan_server.scans.SyncFlyScanBase.html)
-- [AsyncFlyScanBase](https://beamline-experiment-control.readthedocs.io/en/latest/api_reference/_autosummary/bec_server.scan_server.scans.AsyncFlyScanBase.html)
-
-**Key Features:**
-
-- Automatically generates a control interface based on scan signatures and `gui_config`.
-- Supports adding and removing argument bundles dynamically.
-- Provides a visual representation of scan parameters grouped by functionality.
-- Integrates start and stop controls for executing and halting scans.
-
-**Example of Use:**
-
-**Code example:**
-The following code snipped demonstrates how to create a `ScanControl` widget using BEC Widgets within `BECIPythonClient`
-
-![ScanControl](./scan_control.gif)
-
-```python
-scan_control = gui.add_dock().add_widget("ScanControl")
-```

docs/user/widgets/text_box.md

@@ -1,33 +0,0 @@
-(user.widgets.text_box)=
-# [Text Box Widget](/api_reference/_autosummary/bec_widgets.cli.client.TextBox)
-**Purpose:**
-
-The Text Box Widget is a widget that allows you to display text within the BEC GUI. The widget can be used to display plain text or HTML text.
-
-**Key Features:**
-
-- set the text to display.
-- automatically detects if the text is plain text or HTML text.
-- set background color and font color.
-
-**Code example:**
-
-The following code snipped demonstrates how to create a `TextBox` widget using BEC Widgets within BEC.
-```python
-text_box = gui.add_dock().add_widget("TextBox")
-# set the text to display
-text_box.set_text("Hello, World!")
-# set the background color and font color
-text_box.set_color(backgroud_color="#FFF", font_color="#000")
-# set the text to display as HTML
-text_box.set_text("<h1>Welcome to BEC Widgets</h1><p>This is an example of displaying <strong>HTML</strong> text.</p>")
-```
-
-
-
-
-
-
-
-
-

docs/user/widgets/website.md

@@ -1,21 +0,0 @@
-(user.widgets.website)=
-# [Website Widget](/api_reference/_autosummary/bec_widgets.cli.client.WebsiteWidget)
-**Purpose:**
-
-The Website Widget is a widget that allows you to display a website within the BEC GUI. The widget can be used to display any website. 
-
-**Key Features:**
-
-- set the URL of the website to display.
-- reload the website.
-- navigate back and forward in the website history.
-
-**Code example:**
-
-The following code snipped demonstrates how to create a `WebsiteWidget` using BEC Widgets within BEC.
-```python
-# adds a new dock with a website widget
-web = gui.add_dock().add_widget("Website")
-# set the URL of the website to display
-web.set_url("https://bec.readthedocs.io/en/latest/")
-```