Add editingTimeout signal to Qgs(Double)SpinBox

[nyalldawson]

Emitted when either:

1. 2 seconds has elapsed since the last value change in the widget (eg last key press or scroll wheel event)
2. or, immediately after the widget has lost focus after its value was changed.

This signal can be used to respond semi-instantly to changes in the spin box, without responding too quickly
while the user in the middle of setting the value.

[nyalldawson]

For motivation see #59398 (comment)

[github-actions]

🪟 Windows builds

Download Windows builds of this PR for testing.
Debug symbols for this build are available here.
(Built from commit b489454)

🪟 Windows Qt6 builds

Download Windows Qt6 builds of this PR for testing.
(Built from commit b489454)

[nicogodet]

Very! Very nice!
Many thanks!

Is it possible to change the timeout delay ? 2 sec can be quite long sometimes

[uclaros]

Is it possible to change the timeout delay ? 2 sec can be quite long sometimes

It would make sense to add a setTimeout( int msec );
There are cases that could benefit from a small delay.

[nyalldawson]

@nicogodet @uclaros do you think the timeout should be a qsettings value? Or set via API per widget?

[nicogodet]

I'm in favor for an API method

[YoannQDQ]

Maybe both? A default QSettings timeout which can be overriden per widget?

[uclaros]

I'd say API. This is more of a helper instead of manually creating the qtimers.
This would also make sense to have in other widgets that quickly change values, like the QgsFilterLineEdit

[nyalldawson]

I guess I'm just confused why we'd want different timeout behaviour across different widgets. Wont that be inconsistent and feel "odd" for users?

[DelazJ]

While at it, removing the duplicate "the"?

Suggested change

QgsDoubleSpinBox.__attribute_docs__ = {'returnPressed': 'Emitted when the Return or Enter key is used in the line edit.\n\n.. versionadded:: 3.40\n', 'textEdited': 'Emitted when the the value has been manually edited via line edit.\n\n.. versionadded:: 3.40\n', 'editingTimeout': 'Emitted when either:\n\n1. 2 seconds has elapsed since the last value change in the widget (eg last key press or scroll wheel event)\n2. or, immediately after the widget has lost focus after its value was changed.\n\nThis signal can be used to respond semi-instantly to changes in the spin box, without responding too quickly\nwhile the user in the middle of setting the value.\n\n.. versionadded:: 3.42\n'}

QgsDoubleSpinBox.__attribute_docs__ = {'returnPressed': 'Emitted when the Return or Enter key is used in the line edit.\n\n.. versionadded:: 3.40\n', 'textEdited': 'Emitted when the value has been manually edited via line edit.\n\n.. versionadded:: 3.40\n', 'editingTimeout': 'Emitted when either:\n\n1. 2 seconds has elapsed since the last value change in the widget (eg last key press or scroll wheel event)\n2. or, immediately after the widget has lost focus after its value was changed.\n\nThis signal can be used to respond semi-instantly to changes in the spin box, without responding too quickly\nwhile the user in the middle of setting the value.\n\n.. versionadded:: 3.42\n'}

sorry for having only such basic suggestions...

[nicogodet]

@nyalldawson Thinking on what would be my use case:

• If heavy function is connected to this signal I would set a long delay
• If value is crucial, user may think twice but start typing before thinking and it would trigger unwanted update while he is still thinking
• On layout PR, a smaller delay (eg. 0.5sec would be enough)

I'm not a UX expert, just my thought

[uclaros]

I would not use this for the case of typing values like the #59398 case. I really think that the editingFinished which was used is a better fit for expensive actions as the triggering is explicit.
I see this more as a way to limit the total number of signals for example when using the mouse wheel. Similar to the auto apply timer in QgsLayerStylingWidget. For this use case 2 sec is too much!

[nyalldawson]

Ok, API added for setting the timeout interval now. I've also decreased the default timeout interval to 1 second.