Skip to content

Commit b75eb0f

Browse files
Update global widgets options maniputation instructions in README
1 parent 52ed516 commit b75eb0f

1 file changed

Lines changed: 9 additions & 22 deletions

File tree

docs/dev/Lua API.rst

Lines changed: 9 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5348,15 +5348,9 @@ If the panel has already been maximized in this fashion, then it will jump to
53485348
its minimum size. Both jumps respect the resizable edges defined by the
53495349
``resize_anchors`` attribute.
53505350

5351-
The time duration that a double click can span can be controlled by widgets API:
5352-
5353-
* ``widgets.getDoubleClickMs()``
5354-
* ``widgets.setDoubleClickMs(value)``
5355-
5356-
The default value is ``500`` and can be changed by the end
5357-
user with a command like::
5358-
5359-
:lua require('gui.widgets').setDoubleClickMs(1000)
5351+
The time duration that a double click can span default value is ``500``.
5352+
It can be controlled via the `control-panel` or `gui/control-panel` interfaces
5353+
(``Mouse double click speed`` option).
53605354

53615355
Window class
53625356
------------
@@ -5558,21 +5552,14 @@ while scrolling will result in faster movement.
55585552
You can click and drag the scrollbar to scroll to a specific spot, or you can
55595553
click and hold on the end arrows or in the unfilled portion of the scrollbar to
55605554
scroll multiple times, just like in a normal browser scrollbar. The speed of
5561-
scroll events when the mouse button is held down can be controlled by two global
5562-
getter/setter pairs:
5563-
5564-
1. The delay before the second scroll event.
5565-
* ``widgets.getScrollInitialDelayMs()``
5566-
* ``widgets.setScrollInitialDelayMs(value)``
5567-
5568-
2. The delay between further scroll events.
5569-
* ``widgets.getScrollDelayMs()``
5570-
* ``widgets.setScrollDelayMs(value)``
5555+
scroll events when the mouse button is held down can be controlled
5556+
via the `control-panel` or `gui/control-panel` interfaces:
55715557

5572-
The defaults are 300 and 20, respectively, but they can be overridden by the
5573-
user in their :file:`dfhack-config/init/dfhack.init` file, for example::
5558+
1. The delay before the second scroll event use
5559+
``Mouse initial scroll repeat delay`` option (default is 300)
55745560

5575-
:lua require('gui.widgets').setScrollDelayMs(100)
5561+
2. The delay between further scroll events use
5562+
``Mouse scroll repeat delay`` option (default is 20)
55765563

55775564
Label class
55785565
-----------

0 commit comments

Comments
 (0)