Skip to main content

TextSurface

Struct TextSurface 

Source
pub struct TextSurface { /* private fields */ }

Implementations§

Source§

impl TextSurface

Source

pub fn new(name: impl Into<String>) -> Self

Source

pub fn theme(self, theme: DefaultTheme) -> Self

Source

pub fn theme_when<F>(self, theme: F) -> Self
where F: Fn() -> DefaultTheme + 'static,

Source

pub fn text_style(self, text_style: TextStyle) -> Self

Source

pub fn text_style_when<F>(self, text_style: F) -> Self
where F: Fn(DefaultTheme) -> TextStyle + 'static,

Source

pub fn padding(self, padding: Insets) -> Self

Source

pub fn min_width(self, width: f32) -> Self

Source

pub fn min_height(self, height: f32) -> Self

Source

pub fn wrap(self, wrap: TextWrap) -> Self

Source

pub fn set_wrap(&mut self, wrap: TextWrap)

Wrap lines to the surface’s width, or not. Callers measure the surface again afterwards.

Source

pub fn direction(self, direction: TextDirection) -> Self

Source

pub fn set_direction(&mut self, direction: TextDirection)

Lay the text out in direction. Callers measure the surface again afterwards.

Source

pub fn status(self, status: Signal<TextSurfaceStatus>) -> Self

Keep status up to date with the caret, the selection, the text an input method is composing, and the lines on screen.

Source

pub fn style_spans(self, spans: Vec<TextSurfaceStyleSpan>) -> Self

Source

pub fn set_style_spans(&mut self, spans: Vec<TextSurfaceStyleSpan>)

Source

pub fn current_style_spans(&self) -> &[TextSurfaceStyleSpan]

Source

pub fn style_overlays(self, overlays: Vec<TextSurfaceStyleOverlay>) -> Self

Source

pub fn set_style_overlays(&mut self, overlays: Vec<TextSurfaceStyleOverlay>)

Source

pub fn current_style_overlays(&self) -> &[TextSurfaceStyleOverlay]

Source

pub fn value(self, value: impl Into<String>) -> Self

Source

pub fn placeholder(self, placeholder: impl Into<String>) -> Self

Source

pub fn read_only(self, read_only: bool) -> Self

Source

pub fn is_read_only(&self) -> bool

Source

pub fn selectable(self, selection_scope: SelectionScope) -> Self

Source

pub fn selection_scope(self, selection_scope: SelectionScope) -> Self

Source

pub fn clipboard_behavior(self, behavior: SelectionClipboardBehavior) -> Self

Source

pub fn copy_to_clipboard(self, enabled: bool) -> Self

Source

pub fn current_value(&self) -> &str

Source

pub fn set_value(&mut self, value: impl Into<String>)

Source

pub fn set_selection(&mut self, anchor: usize, focus: usize)

Select from anchor to focus, byte offsets snapped to grapheme boundaries, or place the caret when they are equal. The caret is scrolled into view at the next layout.

Source

pub fn on_change<F>(self, on_change: F) -> Self
where F: FnMut(String) + 'static,

Source

pub fn on_change_with_ctx<F>(self, on_change: F) -> Self
where F: FnMut(&mut EventCtx, String) + 'static,

Self::on_change, with the event context first.

Source

pub fn select_all(&mut self, ctx: &mut EventCtx)

Select the entire document.

Source

pub fn copy(&mut self, ctx: &mut EventCtx)

Copy the current selection to the clipboard. No-op when the selection is collapsed.

Source

pub fn cut(&mut self, ctx: &mut EventCtx)

Copy the current selection to the clipboard and delete it. No-op when read-only or the selection is collapsed.

Source

pub fn paste(&mut self, ctx: &mut EventCtx)

Replace the current selection with the clipboard text. No-op when read-only or the clipboard has no text.

Source

pub fn selected_text(&self) -> &str

Currently selected document text (empty when the selection is collapsed).

Trait Implementations§

Source§

impl Widget for TextSurface

Source§

fn event(&mut self, ctx: &mut EventCtx, event: &Event)

Source§

fn command(&mut self, ctx: &mut EventCtx, command: &Command<'_>)

Receive a typed command addressed directly to this widget. Commands are target-only and do not capture or bubble through the widget tree.
Source§

fn measure(&mut self, ctx: &mut MeasureCtx, constraints: Constraints) -> Size

Source§

fn paint(&self, ctx: &mut PaintCtx)

Source§

fn layer_options(&self) -> LayerOptions

Source§

fn semantics(&self, ctx: &mut SemanticsCtx)

Source§

fn accepts_focus(&self) -> bool

Source§

fn focus_changed(&mut self, ctx: &mut EventCtx, focused: bool)

Source§

fn debug_name(&self) -> &'static str

Source§

fn diagnostics(&self, _ctx: &mut WidgetDiagnosticsCtx)

Publish widget-specific state for an inspector snapshot. Read more
Source§

fn measure_size( &mut self, ctx: &mut MeasureCtx, constraints: Constraints, ) -> Size

Compute a provisional size. Containers can override this to query child sizes without committing their final layouts. The default preserves existing custom widgets by delegating to measure; it may mutate state. Child measure calls still commit state. Use child size probes explicitly when only their scalar results are needed. Results must match measure for the same content and constraints. A final measure is still required before arrangement after a probe miss.
Source§

fn measure_axis( &mut self, ctx: &mut MeasureCtx, constraints: Constraints, axis: Axis, ) -> f32

Query one component of measure_size under exactly the same constraints. Overrides may avoid computing the other component, but must return the same extent. Like size probes, this does not replace final measurement.
Source§

fn intrinsic_size( &mut self, ctx: &mut MeasureCtx, axis: Axis, available_cross: f32, ) -> IntrinsicSize

Report the smallest and preferred extent along one axis. Read more
Source§

fn arrange(&mut self, _ctx: &mut ArrangeCtx, _bounds: Rect)

Source§

fn supports_output_reuse(&self) -> bool

Opt into retaining paint and semantics between targeted invalidations. Output must depend only on widget state, context, and observed sources; changes must invalidate the widget. Untracked readers and callbacks with side effects should keep the default. An opaque descendant also prevents caching its ancestors. Explicit subtree/window requests always rerun them. A source observed only in paint or semantics invalidates that callback, not its descendants. Mutating child state requires a child/subtree request.
Source§

fn layer_properties(&self) -> LayerProperties

Source§

fn layer_properties_at(&self, frame_time: f64) -> LayerProperties

Layer properties for the frame shown at frame_time. Override this instead of Widget::layer_properties when they come from Motion values; the runtime refreshes them without repainting when the motion invalidates Transform or Effect.
Source§

fn stack_host_options(&self) -> Option<StackHostOptions>

Source§

fn stack_surface_options(&self) -> Option<StackSurfaceOptions>

Source§

fn overlay_options(&self) -> Option<OverlayOptions>

Describe this widget as the logical owner of a presented overlay. Read more
Source§

fn hit_test_self(&self) -> bool

Whether points inside this widget that none of its children take hit the widget itself. Containers laid over other content, like a layer of floating views, return false so those points reach what is behind them.
Source§

fn visit_children(&self, _visitor: &mut dyn WidgetPodVisitor)

Visit this widget’s logical children. Read more
Source§

fn visit_children_mut(&mut self, _visitor: &mut dyn WidgetPodMutVisitor)

Mutably visit this widget’s logical children. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.