textual
textual copied to clipboard
Published
20 hours ago •
Textualize
Textualize
Is it possible to select/copy the contents of a ScrollView widget?
Discussed in https://github.com/Textualize/textual/discussions/299
Originally posted by jeffwright13 February 20, 2022 I have an application that renders rich Text in a ScrollView object. This works great for displaying text. But is there a way to select/copy the text (using the mouse and Ctrl-C)?
in addition to 'select/copy' text in scrollview object, i want to find and jump to specific line by means of line number. would be helpful if able to dump the current terminal content to clipboard
for now i have to manually calculate the exact y number to jump to because of word wrap
import os
size = os.get_terminal_size()
# msize = self.body.window.layout.width# it is totally not right!
# the width is zero. means adaptive?
# print("WINDOW SIZE:", msize) # not right!
columns, lines = size.columns, size.lines
# print("COLUMNS:", columns)
center = int(lines/2)
# breakpoint()
import math
equivalentLineCountPerLine = [
max(1, math.ceil(length / (columns - 1))) # that's because of the scrollbar taking 1 extra column.
for length in content_line_char_count
]
lineNumber2 = sum(equivalentLineCountPerLine[:lineNumber])
lineNumber2 = max(0, lineNumber2-center)
self.body.set_y(lineNumber2)
the scrollview has been changed according to my needs. don't know how to get this right cause everytime i use 'animate' to move to given y it always scroll all the way back to home so i have to change the code.
after the change i use set_y to position the view
from __future__ import annotations
from rich.console import RenderableType
from rich.style import StyleType
from .. import events
from ..geometry import SpacingDimensions
from ..layouts.grid import GridLayout
from ..message import Message
from ..messages import CursorMove
from ..scrollbar import ScrollTo, ScrollBar
from ..geometry import clamp
from ..view import View
from ..widget import Widget
from ..reactive import Reactive
class ScrollView(View):
def __init__(
self,
contents: RenderableType | Widget | None = None,
*,
auto_width: bool = False,
name: str | None = None,
style: StyleType = "",
fluid: bool = True,
gutter: SpacingDimensions = (0, 0),
) -> None:
from ..views import WindowView
self.fluid = fluid
self.vscroll = ScrollBar(vertical=True)
self.hscroll = ScrollBar(vertical=False)
self.reserved_x = 0
self.reserved_y = 0
self.window = WindowView(
"" if contents is None else contents, auto_width=auto_width, gutter=gutter
)
layout = GridLayout()
layout.add_column("main")
layout.add_column("vscroll", size=1)
layout.add_row("main")
layout.add_row("hscroll", size=1)
layout.add_areas(
content="main,main", vscroll="vscroll,main", hscroll="main,hscroll"
)
layout.show_row("hscroll", False)
layout.show_column("vscroll", False)
super().__init__(name=name, layout=layout)
x: Reactive[float] = Reactive(0, repaint=False)
y: Reactive[float] = Reactive(0, repaint=False)
target_x: Reactive[float] = Reactive(0, repaint=False) # what the fuck is reactive?
target_y: Reactive[float] = Reactive(0, repaint=False)
def validate_x(self, value: float) -> float:
return clamp(value, 0, self.max_scroll_x)
def validate_target_x(self, value: float) -> float:
return clamp(value, 0, self.max_scroll_x)
def validate_y(self, value: float) -> float:
return clamp(value, 0, self.max_scroll_y)
def validate_target_y(self, value: float) -> float:
return clamp(value, 0, self.max_scroll_y)
@property
def max_scroll_y(self) -> float:
return max(0, self.window.virtual_size.height - self.window.size.height)
@property
def max_scroll_x(self) -> float:
return max(0, self.window.virtual_size.width - self.window.size.width)
async def watch_x(self, new_value: float) -> None:
self.window.scroll_x = round(new_value)
self.hscroll.position = round(new_value)
async def watch_y(self, new_value: float) -> None:
self.window.scroll_y = round(new_value)
self.vscroll.position = round(new_value)
async def update(self, renderable: RenderableType, home: bool = True) -> None:
if home:
self.home()
await self.window.update(renderable)
async def on_mount(self, event: events.Mount) -> None:
assert isinstance(self.layout, GridLayout)
self.layout.place(
content=self.window,
vscroll=self.vscroll,
hscroll=self.hscroll,
)
await self.layout.mount_all(self)
def set_y(self, y_):
# self.home()
self.y = y_
self.target_y = y_
self.reserved_y = y_
# what the fuck is making it into 0?
self.animate("y", self.target_y, easing="out_cubic", speed=y_*3)
def set_x(self, x_):
# self.home()
self.x = x_
self.target_x = x_
self.reserved_x = x_
self.animate("x", self.target_x, easing="out_cubic", speed=x_*3)
def home(self) -> None:
# still zero. fuck.
# how about let's nullfy this shit?
self.x = self.y = 0
self.reserved_x = self.reserved_y = 0
self.target_x = self.target_y = 0
def scroll_up(self) -> None:
self.target_y = self.reserved_y
self.target_y += 1.5
self.reserved_y +=1.5
# print("TARGET_Y", self.target_y)
# breakpoint()
self.animate("y", self.target_y, easing="out_cubic", speed=80)
def scroll_down(self) -> None:
self.target_y = self.reserved_y
self.target_y -= 1.5
self.reserved_y -=1.5
# print("TARGET_Y", self.target_y)
# breakpoint()
self.animate("y", self.target_y, easing="out_cubic", speed=80)
def page_up(self) -> None:
self.target_y = self.reserved_y
self.target_y -= self.size.height
self.reserved_y -= self.size.height
self.animate("y", self.target_y, easing="out_cubic")
def page_down(self) -> None:
self.target_y = self.reserved_y
self.target_y += self.size.height
self.reserved_y -= self.size.height
self.animate("y", self.target_y, easing="out_cubic")
def page_left(self) -> None:
self.target_x = self.reserved_x
self.target_x -= self.size.width
self.reserved_x -= self.size.width
self.animate("x", self.target_x, speed=120, easing="out_cubic")
def page_right(self) -> None:
self.target_x = self.reserved_x
self.target_x += self.size.width
self.reserved_x -= self.size.width
self.animate("x", self.target_x, speed=120, easing="out_cubic")
def scroll_in_to_view(self, line: int) -> None:
self.y = self.reserved_y
if line < self.y:
self.y = line
elif line >= self.y + self.size.height:
self.y = line - self.size.height + 1
self.reserved_y = self.y
def scroll_to_center(self, line: int) -> None:
self.target_y = self.reserved_y
self.target_y = line - self.size.height // 2
if abs(self.target_y - self.y) > 1:
# Animate if its more than 1
self.animate("y", self.target_y, easing="out_cubic")
else:
# Jump if its just one step
self.y = self.target_y
self.reserved_y = self.y
async def on_mouse_scroll_up(self, event: events.MouseScrollUp) -> None:
self.scroll_up()
async def on_mouse_scroll_down(self, event: events.MouseScrollUp) -> None:
self.scroll_down()
async def on_key(self, event: events.Key) -> None:
await self.dispatch_key(event)
async def key_down(self) -> None:
self.target_y = self.reserved_y
self.target_y += 2
self.animate("y", self.target_y, easing="linear", speed=100)
self.reserved_y = self.target_y
async def key_up(self) -> None:
self.target_y = self.reserved_y
self.target_y -= 2
self.animate("y", self.target_y, easing="linear", speed=100)
self.reserved_y = self.target_y
async def key_pagedown(self) -> None:
self.target_y = self.reserved_y
self.target_y += self.size.height
self.animate("y", self.target_y, easing="out_cubic")
self.reserved_y = self.target_y
async def key_pageup(self) -> None:
self.target_y = self.reserved_y
self.target_y -= self.size.height
self.animate("y", self.target_y, easing="out_cubic")
self.reserved_y = self.target_y
async def key_end(self) -> None:
self.target_x = self.reserved_x
self.target_y = self.reserved_y
self.target_x = 0
self.target_y = self.window.virtual_size.height - self.size.height
self.animate("x", self.target_x, duration=1, easing="out_cubic")
self.animate("y", self.target_y, duration=1, easing="out_cubic")
self.reserved_y = self.target_y
self.reserved_x = self.target_x
async def key_home(self) -> None:
self.target_x = self.reserved_x
self.target_y = self.reserved_y
self.target_x = 0
self.target_y = 0
self.animate("x", self.target_x, duration=1, easing="out_cubic")
self.animate("y", self.target_y, duration=1, easing="out_cubic")
self.reserved_y = self.target_y
self.reserved_x = self.target_x
async def handle_scroll_up(self) -> None:
self.page_up()
async def handle_scroll_down(self) -> None:
self.page_down()
async def handle_scroll_left(self) -> None:
self.page_left()
async def handle_scroll_right(self) -> None:
self.page_right()
async def handle_scroll_to(self, message: ScrollTo) -> None:
self.target_x = self.reserved_x
self.target_y = self.reserved_y
if message.x is not None:
self.target_x = message.x
if message.y is not None:
self.target_y = message.y
self.animate("x", self.target_x, speed=150, easing="out_cubic")
self.animate("y", self.target_y, speed=150, easing="out_cubic")
self.reserved_y = self.target_y
self.reserved_x = self.target_x
async def handle_window_change(self, message: Message) -> None:
self.x = self.reserved_x
self.y = self.reserved_y
message.stop()
virtual_width, virtual_height = self.window.virtual_size
width, height = self.size
self.x = self.validate_x(self.x)
self.y = self.validate_y(self.y)
self.hscroll.virtual_size = virtual_width
self.hscroll.window_size = width
self.vscroll.virtual_size = virtual_height
self.vscroll.window_size = height
assert isinstance(self.layout, GridLayout)
vscroll_change = self.layout.show_column("vscroll", virtual_height > height)
hscroll_change = self.layout.show_row("hscroll", virtual_width > width)
if hscroll_change or vscroll_change:
self.refresh(layout=True)
self.reserved_x = self.x
self.reserved_y = self.y
def handle_cursor_move(self, message: CursorMove) -> None:
self.scroll_to_center(message.line)
message.stop()
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
Google led me to this issue, but the answer is now in the FAQ: https://github.com/textualize/textual/blob/main/FAQ.md#how-can-i-select-and-copy-text-in-a-textual-app
