gui: add WaiterOverlay. To display processing wheel on top of another widget #3876

payno · 2023-06-23T06:31:02Z

Changelog:

add a silx.gui.widgets.WaitingOverlay

TODO

add a silx.gui.widgets.WaitingOverlay
- display the 'waiting wheel' on top of the parent widget
- reuse 'silx.gui.widgets.WaitingPushButton.WaitingPushButton' behind
- remove silx.gui.plot.ImageStack._PlotWithWaitingLabel to use the WaitingOverlay instead
add test
add example

extra

close #3807

screenshot

vallsv · 2023-06-24T09:03:00Z

Please remember to remove this poor vvalls from your commit message. It's not me.

vallsv · 2023-06-24T09:11:36Z

As reminder

Also if we are about to use getWidgetHandle(), this widget is recreated when we change the silx backend. I suggest to create a sigBackendChanged in the PlotWidget. That's something i also have to clean up in Flint, so it would make my life easier. What do you think @t20100
The popup widget could also be better centered to the plot, in case it's a plot. @t20100 shows me that it exists an API to reach the rect collation inside the axes.

vallsv · 2023-07-10T07:27:17Z

I think it would be better to deprecate _PlotWithWaitingLabel as you did in a previous commit.
That's a way to allow us to drop some code in the future.

payno · 2023-07-10T07:59:24Z

Originally I wanted to deprecate it (_PlotWithWaitingLabel) but at the end I find it more convenient to keep it to handle autoResetWoom and connection with the new WaiterOverlay

src/silx/gui/plot/ImageStack.py

src/silx/gui/utils/waiteroverlay.py

t20100 · 2023-07-10T08:36:03Z

it exists an API to reach the rect inside the axes.

Yes it is here:

silx/src/silx/gui/plot/PlotWidget.py

Lines 3302 to 3307 in f68529b

    
               def getPlotBoundsInPixels(self): 
        
                   """Plot area bounds in widget coordinates in pixels. 
        
                   :return: bounds as a 4-tuple of int: (left, top, width, height) 
        
                   """ 
        
                   return self._backend.getPlotBoundsInPixels()

And could be used as a special case for handling resize.

src/silx/gui/plot/ImageStack.py

src/silx/gui/utils/waiteroverlay.py

t20100 · 2023-07-20T13:47:14Z

src/silx/gui/utils/waiteroverlay.py

+        # register to resize event
+        parent.installEventFilter(self)
+
+    def setText(self, text: str):


For completeness, it would be good to have a getText method and docstrings for the public API

👍 For 'homogeneity' I might go for a text() -> str if this is fine with you

src/silx/gui/utils/waiteroverlay.py

src/silx/gui/plot/ImageStack.py

src/silx/gui/utils/test/test_waiter_overlay.py

t20100 · 2023-07-20T14:17:53Z

src/silx/gui/utils/waiteroverlay.py

+        if isinstance(parent, PlotWidget):
+            parent = parent.getWidgetHandle()


I think we can simplify the parenting, I'll make you a PR if I have a working solution

And parenting by with getWidgetHandle(), the change of backend needs to be handled, or the widget will disappear

vallsv · 2023-07-20T14:19:05Z

Finally you have to use plot.sigBackendChanged to update the parent, else i am afraid it will not work when we switch from matplotlib/opengl. I can be wrong.

I can to the job if you like.

As you already have a setParent it's probably not so difficult.

src/silx/gui/utils/waiteroverlay.py

t20100 · 2023-07-21T11:35:46Z

Finally you have to use plot.sigBackendChanged to update the parent

This is done (with other things) in #3912

t20100 · 2023-10-23T09:38:34Z

What is the status of this PR?
Is it still a draft?

payno · 2023-10-24T08:38:36Z

What is the status of this PR? Is it still a draft?

I think it is ready for review now :)

… widget

Co-authored-by: Thomas VINCENT <[email protected]>

…n removed

Co-authored-by: Thomas VINCENT <[email protected]>

…ty instead of setWaiting

…t be used

…on (more intuitive)

t20100

LGTM, thanks!

It would be good to add the example to the doc, here: https://github.com/silx-kit/silx/blob/main/doc/source/sample_code/index.rst
And to add the WaitingOverlay to the API doc: https://github.com/silx-kit/silx/tree/main/doc/source/modules/gui/widgets

examples/waiterOverlay.py

src/silx/gui/plot/ImageStack.py

src/silx/gui/widgets/WaitingOverlay.py

Co-authored-by: Thomas VINCENT <[email protected]>

This was referenced Jun 26, 2023

Create a sigBackendChanged to the PlotWidget #3883

Closed

PlotWidget: Added sigBackendChanged #3890

Merged

payno force-pushed the fix_3807 branch from d7418fb to b912ed9 Compare June 27, 2023 12:06

payno force-pushed the fix_3807 branch 2 times, most recently from 018dcff to f68529b Compare July 10, 2023 07:10

t20100 reviewed Jul 10, 2023

View reviewed changes

payno changed the title ~~Draft: gui: add WaiterOverlay. To dispaly processing wheel on top of another…~~ Draft: gui: add WaiterOverlay. To display processing wheel on top of another… Jul 20, 2023

payno force-pushed the fix_3807 branch 3 times, most recently from 28da0ee to 941aeea Compare July 20, 2023 08:05

payno changed the title ~~Draft: gui: add WaiterOverlay. To display processing wheel on top of another…~~ gui: add WaiterOverlay. To display processing wheel on top of another… Jul 20, 2023

t20100 reviewed Jul 20, 2023

View reviewed changes

src/silx/gui/utils/waiteroverlay.py Outdated Show resolved Hide resolved

t20100 reviewed Jul 20, 2023

View reviewed changes

src/silx/gui/utils/waiteroverlay.py Outdated Show resolved Hide resolved

payno force-pushed the fix_3807 branch from 89e9dc6 to 49499b1 Compare July 21, 2023 09:03

t20100 mentioned this pull request Jul 21, 2023

WaiterOverlay updates #3912

Merged

payno force-pushed the fix_3807 branch from 8e85050 to 8dc57ef Compare August 28, 2023 10:01

payno changed the title ~~gui: add WaiterOverlay. To display processing wheel on top of another…~~ Draft: gui: add WaiterOverlay. To display processing wheel on top of another… Aug 28, 2023

payno changed the title ~~Draft: gui: add WaiterOverlay. To display processing wheel on top of another…~~ Draft: gui: add WaiterOverlay. To display processing wheel on top of another widget Oct 24, 2023

payno changed the title ~~Draft: gui: add WaiterOverlay. To display processing wheel on top of another widget~~ gui: add WaiterOverlay. To display processing wheel on top of another widget Oct 24, 2023

gui: add WaiterOverlay. To dispaly processing wheel on top of another…

973cda5

… widget

payno and others added 24 commits October 24, 2023 17:01

WaiterOverlay: fix parenting since is a QWidget

810d485

waiteroverlay: fix - QPoint expects ints

2d8cb40

Update src/silx/gui/plot/ImageStack.py

50e9a94

Co-authored-by: Thomas VINCENT <[email protected]>

Update src/silx/gui/plot/ImageStack.py

911a63a

Co-authored-by: Thomas VINCENT <[email protected]>

Update src/silx/gui/utils/waiteroverlay.py

407575f

Co-authored-by: Thomas VINCENT <[email protected]>

Update src/silx/gui/utils/waiteroverlay.py

58ddb8e

Co-authored-by: Thomas VINCENT <[email protected]>

Update src/silx/gui/utils/waiteroverlay.py

0ef0c81

Co-authored-by: Thomas VINCENT <[email protected]>

ImageStack: fix isAutoResetZoom since _PlotWithWaitingLabel has bee…

94fccca

…n removed

WaiterOverlay: add an example with a QFrame

4c9cd06

Update src/silx/gui/utils/waiteroverlay.py

ea37ebc

Co-authored-by: Thomas VINCENT <[email protected]>

WaiterOverlay: move it to from silx.gui.utils to silx.gui.widgets

c5afb73

Refactor parent handling, add support of backend update, use visibili…

0b95d5f

…ty instead of setWaiting

Rename module to WaiterOverlay

415db4d

move WaiterOverlay test to silx.gui.widgets.test

7248525

remove useless change of visibility

5b6fac4

update WaiterOverlay test

8c8f0e9

rename WaiterOverlay -> WaitingOverlay

06c00d1

Add text getter and a test

9a3640c

fix ImageStack: WaiterOverlay has been renamed WaitingOverlay

88bfea5

WaitingWidget: fix some usage of setWaiting when now 'setvisible' mus…

94134fc

…t be used

WatingOverlay: by default: make the waiting button wait on constructi…

94627da

…on (more intuitive)

WaitingOverlay: expose setIconSize

ee6ac1a

examples: add an example of usage for the WaitingOverlay widget

d0cab26

silx.gui.plot.ImageStack: increase waiting overlay icon size

2a5007a

payno force-pushed the fix_3807 branch from 15144b0 to 2a5007a Compare October 24, 2023 15:01

t20100 approved these changes Oct 25, 2023

View reviewed changes

examples/waiterOverlay.py Outdated Show resolved Hide resolved

examples/waiterOverlay.py Outdated Show resolved Hide resolved

src/silx/gui/plot/ImageStack.py Show resolved Hide resolved

src/silx/gui/widgets/WaitingOverlay.py Show resolved Hide resolved

payno and others added 2 commits October 25, 2023 14:19

Update examples/waiterOverlay.py

9c1ea99

Co-authored-by: Thomas VINCENT <[email protected]>

Update examples/waiterOverlay.py

f7642d1

Co-authored-by: Thomas VINCENT <[email protected]>

t20100 merged commit e3b5eab into main Nov 21, 2023
7 checks passed

t20100 deleted the fix_3807 branch November 21, 2023 13:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

gui: add WaiterOverlay. To display processing wheel on top of another widget #3876

gui: add WaiterOverlay. To display processing wheel on top of another widget #3876

payno commented Jun 23, 2023 •

edited

Loading

vallsv commented Jun 24, 2023

vallsv commented Jun 24, 2023 •

edited

Loading

vallsv commented Jul 10, 2023

payno commented Jul 10, 2023

t20100 commented Jul 10, 2023

t20100 Jul 20, 2023

payno Jul 21, 2023

t20100 Jul 20, 2023

t20100 Jul 20, 2023

vallsv commented Jul 20, 2023 •

edited

Loading

t20100 commented Jul 21, 2023 •

edited

Loading

t20100 commented Oct 23, 2023

payno commented Oct 24, 2023

t20100 left a comment

		if isinstance(parent, PlotWidget):
		parent = parent.getWidgetHandle()

gui: add WaiterOverlay. To display processing wheel on top of another widget #3876

gui: add WaiterOverlay. To display processing wheel on top of another widget #3876

Conversation

payno commented Jun 23, 2023 • edited Loading

TODO

extra

screenshot

vallsv commented Jun 24, 2023

vallsv commented Jun 24, 2023 • edited Loading

vallsv commented Jul 10, 2023

payno commented Jul 10, 2023

t20100 commented Jul 10, 2023

t20100 Jul 20, 2023

Choose a reason for hiding this comment

payno Jul 21, 2023

Choose a reason for hiding this comment

t20100 Jul 20, 2023

Choose a reason for hiding this comment

t20100 Jul 20, 2023

Choose a reason for hiding this comment

vallsv commented Jul 20, 2023 • edited Loading

t20100 commented Jul 21, 2023 • edited Loading

t20100 commented Oct 23, 2023

payno commented Oct 24, 2023

t20100 left a comment

Choose a reason for hiding this comment

payno commented Jun 23, 2023 •

edited

Loading

vallsv commented Jun 24, 2023 •

edited

Loading

vallsv commented Jul 20, 2023 •

edited

Loading

t20100 commented Jul 21, 2023 •

edited

Loading