-
Notifications
You must be signed in to change notification settings - Fork 770
/
scrollbar.py
376 lines (308 loc) · 12.1 KB
/
scrollbar.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
from __future__ import annotations
from math import ceil
from typing import ClassVar, Type
import rich.repr
from rich.color import Color
from rich.console import Console, ConsoleOptions, RenderableType, RenderResult
from rich.segment import Segment, Segments
from rich.style import Style, StyleType
from . import events
from .geometry import Offset
from .message import Message
from .reactive import Reactive
from .renderables.blank import Blank
from .widget import Widget
class ScrollMessage(Message, bubble=False):
pass
@rich.repr.auto
class ScrollUp(ScrollMessage, verbose=True):
"""Message sent when clicking above handle."""
@rich.repr.auto
class ScrollDown(ScrollMessage, verbose=True):
"""Message sent when clicking below handle."""
@rich.repr.auto
class ScrollLeft(ScrollMessage, verbose=True):
"""Message sent when clicking above handle."""
@rich.repr.auto
class ScrollRight(ScrollMessage, verbose=True):
"""Message sent when clicking below handle."""
class ScrollTo(ScrollMessage, verbose=True):
"""Message sent when click and dragging handle."""
def __init__(
self,
x: float | None = None,
y: float | None = None,
animate: bool = True,
) -> None:
self.x = x
self.y = y
self.animate = animate
super().__init__()
def __rich_repr__(self) -> rich.repr.Result:
yield "x", self.x, None
yield "y", self.y, None
yield "animate", self.animate, True
class ScrollBarRender:
def __init__(
self,
virtual_size: int = 100,
window_size: int = 0,
position: float = 0,
thickness: int = 1,
vertical: bool = True,
style: StyleType = "bright_magenta on #555555",
) -> None:
self.virtual_size = virtual_size
self.window_size = window_size
self.position = position
self.thickness = thickness
self.vertical = vertical
self.style = style
@classmethod
def render_bar(
cls,
size: int = 25,
virtual_size: float = 50,
window_size: float = 20,
position: float = 0,
thickness: int = 1,
vertical: bool = True,
back_color: Color = Color.parse("#555555"),
bar_color: Color = Color.parse("bright_magenta"),
) -> Segments:
if vertical:
bars = ["▁", "▂", "▃", "▄", "▅", "▆", "▇", " "]
else:
bars = ["▉", "▊", "▋", "▌", "▍", "▎", "▏", " "]
back = back_color
bar = bar_color
len_bars = len(bars)
width_thickness = thickness if vertical else 1
_Segment = Segment
_Style = Style
blank = " " * width_thickness
foreground_meta = {"@mouse.up": "release", "@mouse.down": "grab"}
if window_size and size and virtual_size and size != virtual_size:
step_size = virtual_size / size
thumb_size = window_size / step_size * len_bars
if thumb_size < len_bars:
virtual_size += step_size
step_size = virtual_size / size
start = int(position / step_size * len_bars)
end = start + max(len_bars, ceil(thumb_size))
start_index, start_bar = divmod(max(0, start), len_bars)
end_index, end_bar = divmod(max(0, end), len_bars)
upper = {"@mouse.up": "scroll_up"}
lower = {"@mouse.up": "scroll_down"}
upper_back_segment = Segment(blank, _Style(bgcolor=back, meta=upper))
lower_back_segment = Segment(blank, _Style(bgcolor=back, meta=lower))
segments = [upper_back_segment] * int(size)
segments[end_index:] = [lower_back_segment] * (size - end_index)
segments[start_index:end_index] = [
_Segment(blank, _Style(bgcolor=bar, meta=foreground_meta))
] * (end_index - start_index)
# Apply the smaller bar characters to head and tail of scrollbar for more "granularity"
if start_index < len(segments):
bar_character = bars[len_bars - 1 - start_bar]
if bar_character != " ":
segments[start_index] = _Segment(
bar_character * width_thickness,
_Style(bgcolor=back, color=bar, meta=foreground_meta)
if vertical
else _Style(bgcolor=bar, color=back, meta=foreground_meta),
)
if end_index < len(segments):
bar_character = bars[len_bars - 1 - end_bar]
if bar_character != " ":
segments[end_index] = _Segment(
bar_character * width_thickness,
_Style(bgcolor=bar, color=back, meta=foreground_meta)
if vertical
else _Style(bgcolor=back, color=bar, meta=foreground_meta),
)
else:
style = _Style(bgcolor=back)
segments = [_Segment(blank, style=style)] * int(size)
if vertical:
return Segments(segments, new_lines=True)
else:
return Segments((segments + [_Segment.line()]) * thickness, new_lines=False)
def __rich_console__(
self, console: Console, options: ConsoleOptions
) -> RenderResult:
size = (
(options.height or console.height)
if self.vertical
else (options.max_width or console.width)
)
thickness = (
(options.max_width or console.width)
if self.vertical
else (options.height or console.height)
)
_style = console.get_style(self.style)
bar = self.render_bar(
size=size,
window_size=self.window_size,
virtual_size=self.virtual_size,
position=self.position,
vertical=self.vertical,
thickness=thickness,
back_color=_style.bgcolor or Color.parse("#555555"),
bar_color=_style.color or Color.parse("bright_magenta"),
)
yield bar
@rich.repr.auto
class ScrollBar(Widget):
renderer: ClassVar[Type[ScrollBarRender]] = ScrollBarRender
"""The class used for rendering scrollbars.
This can be overridden and set to a ScrollBarRender-derived class
in order to delegate all scrollbar rendering to that class. E.g.:
```
class MyScrollBarRender(ScrollBarRender): ...
app = MyApp()
ScrollBar.renderer = MyScrollBarRender
app.run()
```
Because this variable is accessed through specific instances
(rather than through the class ScrollBar itself) it is also possible
to set this on specific scrollbar instance to change only that
instance:
```
my_widget.horizontal_scrollbar.renderer = MyScrollBarRender
```
"""
DEFAULT_CSS = """
ScrollBar {
link-hover-color: ;
link-hover-background:;
link-hover-style: ;
link-color: transparent;
link-background: transparent;
}
"""
def __init__(
self, vertical: bool = True, name: str | None = None, *, thickness: int = 1
) -> None:
self.vertical = vertical
self.thickness = thickness
self.grabbed_position: float = 0
super().__init__(name=name)
self.auto_links = False
window_virtual_size: Reactive[int] = Reactive(100)
window_size: Reactive[int] = Reactive(0)
position: Reactive[int] = Reactive(0)
mouse_over: Reactive[bool] = Reactive(False)
grabbed: Reactive[Offset | None] = Reactive(None)
def __rich_repr__(self) -> rich.repr.Result:
yield from super().__rich_repr__()
yield "window_virtual_size", self.window_virtual_size
yield "window_size", self.window_size
yield "position", self.position
if self.thickness > 1:
yield "thickness", self.thickness
def render(self) -> RenderableType:
assert self.parent is not None
styles = self.parent.styles
if self.grabbed:
background = styles.scrollbar_background_active
color = styles.scrollbar_color_active
elif self.mouse_over:
background = styles.scrollbar_background_hover
color = styles.scrollbar_color_hover
else:
background = styles.scrollbar_background
color = styles.scrollbar_color
color = background + color
scrollbar_style = Style.from_color(color.rich_color, background.rich_color)
return self._render_bar(scrollbar_style)
def _render_bar(self, scrollbar_style: Style) -> RenderableType:
"""Get a renderable for the scrollbar with given style.
Args:
scrollbar_style: Scrollbar style.
Returns:
Scrollbar renderable.
"""
window_size = (
self.window_size if self.window_size < self.window_virtual_size else 0
)
virtual_size = self.window_virtual_size
return self.renderer(
virtual_size=ceil(virtual_size),
window_size=ceil(window_size),
position=self.position,
thickness=self.thickness,
vertical=self.vertical,
style=scrollbar_style,
)
def _on_hide(self, event: events.Hide) -> None:
if self.grabbed:
self.release_mouse()
def _on_enter(self, event: events.Enter) -> None:
self.mouse_over = True
def _on_leave(self, event: events.Leave) -> None:
self.mouse_over = False
def action_scroll_down(self) -> None:
self.post_message(ScrollDown() if self.vertical else ScrollRight())
def action_scroll_up(self) -> None:
self.post_message(ScrollUp() if self.vertical else ScrollLeft())
def action_grab(self) -> None:
self.capture_mouse()
def action_released(self) -> None:
self.capture_mouse(False)
async def _on_mouse_up(self, event: events.MouseUp) -> None:
if self.grabbed:
self.release_mouse()
event.stop()
def _on_mouse_capture(self, event: events.MouseCapture) -> None:
self.grabbed = event.mouse_position
self.grabbed_position = self.position
def _on_mouse_release(self, event: events.MouseRelease) -> None:
self.grabbed = None
event.stop()
async def _on_mouse_move(self, event: events.MouseMove) -> None:
if self.grabbed and self.window_size:
x: float | None = None
y: float | None = None
if self.vertical:
size = self.size.height
virtual_size = self.window_virtual_size
step_size = virtual_size / size
thumb_size = self.window_size / step_size
if thumb_size < 1:
virtual_size = ceil(virtual_size + step_size)
y = round(
self.grabbed_position
+ (
(event.screen_y - self.grabbed.y)
* (virtual_size / self.window_size)
)
)
else:
size = self.size.width
virtual_size = self.window_virtual_size
step_size = virtual_size / size
thumb_size = self.window_size / step_size
if thumb_size < 1:
virtual_size = ceil(virtual_size + step_size)
x = round(
self.grabbed_position
+ (
(event.screen_x - self.grabbed.x)
* (virtual_size / self.window_size)
)
)
self.post_message(ScrollTo(x=x, y=y))
event.stop()
async def _on_click(self, event: events.Click) -> None:
event.stop()
class ScrollBarCorner(Widget):
"""Widget which fills the gap between horizontal and vertical scrollbars,
should they both be present."""
def __init__(self, name: str | None = None):
super().__init__(name=name)
def render(self) -> RenderableType:
assert self.parent is not None
styles = self.parent.styles
color = styles.scrollbar_corner_color
return Blank(color)