Struct ShapedTextLayout 

pub struct ShapedTextLayout {
    pub layout: Arc<LineLayout>,
    pub wrap_width: Option<Pixels>,
}

Shaped text with its wrap width, which is how a layout is measured and queried.

Get one from WindowTextSystem::shape_text. ShapedText derefs to it. Its methods convert between pixel positions and UTF-8 byte indices, so you can place a caret or find the character under the mouse. All positions are in logical pixels, relative to the top-left corner of the text.

Fields

layout: Arc<LineLayout>

The laid-out document.

wrap_width: Option<Pixels>

The width that lines wrap at, or None when the text does not wrap.

Implementations

impl ShapedTextLayout

pub fn len(&self) -> usize

Returns the length of the text in UTF-8 bytes.

pub fn width(&self) -> Pixels

Returns the width of the widest line, capped at the wrap width.

pub fn size(&self, line_height: Pixels) -> Size<Pixels>

Returns the size of the whole layout, with each line line_height tall.

pub fn line_count(&self) -> usize

Returns the number of visual lines in this layout.

pub fn ascent(&self) -> Pixels

Returns the distance from the baseline up to the tallest glyphs.

pub fn descent(&self) -> Pixels

Returns the distance from the baseline down to the lowest glyphs.

pub fn visual_lines(&self) -> &[VisualLine]

Returns the visual lines in paint order.

pub fn fragments_for_line(&self, line: &VisualLine) -> &[PaintFragment]

Returns the fragments belonging to a visual line.

pub fn font_size(&self) -> Pixels

Returns the base font size that the text was shaped at, in logical pixels.

pub fn byte_index_for_pixel_point( &self, pixel_point: Point<Pixels>, line_height: Pixels, ) -> Result<usize, usize>

The UTF-8 byte index for a point in GPUI layout coordinates.

The backend returns the logical start of the visual cluster under the point. Whitespace is hit like any other cluster. Positions outside the line return the boundary at that visual edge in Err.

See also Self::closest_byte_index_for_pixel_point.

pub fn closest_byte_index_for_pixel_point( &self, pixel_point: Point<Pixels>, line_height: Pixels, ) -> Result<usize, usize>

Returns the UTF-8 byte index of the cluster boundary closest to a point.

Use this for a click or drag that should always land on the nearest character, even when the point is outside the text. For right-to-left clusters, the visual left edge maps to the logical end and the visual right edge maps to the logical start. Zero-width clusters share a stop with an adjacent cluster, and visual order breaks the tie.

Errors

Returns Err with the index when the point is outside a visual line, and Ok otherwise. Both cases give an index, so use either value.

pub fn closest_caret_for_pixel_point( &self, pixel_point: Point<Pixels>, line_height: Pixels, ) -> Result<CaretPosition, CaretPosition>

Returns the closest backend-native caret for a point in GPUI layout coordinates.

Returns Err with the caret at that edge when the point is outside a visual line, the same way as Self::closest_byte_index_for_pixel_point.

pub fn visual_position_for_byte_index( &self, byte_index: usize, line_height: Pixels, ) -> Option<Point<Pixels>>

Returns the top-left corner of the caret for a UTF-8 byte index, or None if the index is past the end.

The position is on the cluster boundary, at the visual edge that matches the text direction. An index inside an atomic cluster snaps to the start of that cluster. On a soft-wrap boundary, the index places the caret at the start of the following visual line.

pub fn visual_position_for_caret( &self, caret: CaretPosition, line_height: Pixels, ) -> Option<Point<Pixels>>

Returns the top-left corner of the caret for caret, or None if the caret has no position.

pub fn normalized_caret(&self, caret: CaretPosition) -> CaretPosition

Moves a caret onto a valid cluster boundary, keeping its affinity when it can.

pub fn adjacent_visual_caret( &self, caret: CaretPosition, direction: VisualDirection, ) -> Option<CaretPosition>

Returns the next caret stop to the left or right of caret on screen.

Returns None when there is no caret stop in that direction.

pub fn logical_cluster_before( &self, caret: CaretPosition, ) -> Option<Range<usize>>

Returns the byte range of the cluster before caret in logical order.

pub fn logical_cluster_after( &self, caret: CaretPosition, ) -> Option<Range<usize>>

Returns the byte range of the cluster after caret in logical order.

pub fn caret_movement( &self, caret: CaretPosition, movement: TextMovement, vertical_navigation_x: Option<Pixels>, ) -> CaretMovement

Returns where the caret lands after movement, without changing any state.

Pass the vertical_navigation_x from the previous move to keep the caret’s column across consecutive up or down moves. The result carries the new value.

pub fn selection_movement( &self, selection: CaretSelection, movement: TextMovement, extend: bool, vertical_navigation_x: Option<Pixels>, line_height: Pixels, ) -> CaretSelectionMovement

Returns where a selection lands after movement, using visual order.

Without extend, a left or right cluster or word move on a non-empty selection collapses it to the visual edge in that direction. Other moves start from the caret. With extend, the anchor stays fixed and the caret moves.

• selection is the current anchor and caret.
• movement gives the direction and the unit.
• extend keeps the anchor fixed when true, and collapses the selection when false.
• vertical_navigation_x carries the column across vertical moves.
• line_height converts caret positions into comparable visual coordinates.

pub fn selection_from_pixel_point( &self, pixel_point: Point<Pixels>, line_height: Pixels, kind: TextSelectionKind, ) -> Range<usize>

Selects the word or line at a point in GPUI layout coordinates.

pub fn selection_bounds( &self, byte_range: Range<usize>, line_height: Pixels, ) -> SmallVec<[Bounds<Pixels>; 4]>

Returns rectangles covering all selected clusters in visual order.

Trait Implementations

impl Debug for ShapedTextLayout

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for ShapedTextLayout

type Target = LineLayout

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.