Strip
strip
¶
Strip
¶
Represents a 'strip' (horizontal line) of a Textual Widget.
A Strip is like an immutable list of Segments. The immutability allows for effective caching.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
segments |
Iterable[Segment]
|
An iterable of segments. |
required |
cell_length |
int | None
|
The cell length if known, or None to calculate on demand. Defaults to None. |
None
|
cell_length: int
property
¶
Get the number of cells required to render this object.
link_ids: set[str]
property
¶
A set of the link ids in this Strip.
text: str
property
¶
Segment text.
adjust_cell_length(cell_length, style=None)
¶
apply_filter(filter)
¶
Apply a filter to all segments in the strip.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
filter |
LineFilter
|
A line filter object. |
required |
Returns:
Type | Description |
---|---|
Strip
|
A new Strip. |
apply_style(style)
¶
blank(cell_length, style=None)
classmethod
¶
crop(start, end)
¶
divide(cuts)
¶
extend_cell_length(cell_length, style=None)
¶
from_lines(lines, cell_length=None)
classmethod
¶
Convert lines (lists of segments) to a list of Strips.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
lines |
list[list[Segment]]
|
List of lines, where a line is a list of segments. |
required |
cell_length |
int | None
|
Cell length of lines (must be same) or None if not known. Defaults to None. |
None
|
Returns:
Type | Description |
---|---|
list[Strip]
|
List of strips. |
index_to_cell_position(index)
¶
Given a character index, return the cell position of that character.
This is the sum of the cell lengths of all the characters before the character
at index
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
index |
int
|
The index to convert. |
required |
Returns:
Type | Description |
---|---|
int
|
The cell position of the character at |