Struct Terminal
pub struct Terminal { /* private fields */ }Available on crate feature
terminal only.Implementations§
§impl Terminal
impl Terminal
pub fn new(handle: TerminalHandle) -> Terminal
pub fn selection_color(self, selection_color: impl Into<Color>) -> Terminal
pub fn on_measured( self, callback: impl Into<EventHandler<(f32, f32)>>, ) -> Terminal
pub fn font_family(self, font_family: impl Into<String>) -> Terminal
pub fn font_size(self, font_size: f32) -> Terminal
pub fn foreground(self, foreground: impl Into<Color>) -> Terminal
pub fn background(self, background: impl Into<Color>) -> Terminal
Trait Implementations§
§impl AccessibilityExt for Terminal
impl AccessibilityExt for Terminal
§fn get_accessibility_data(&mut self) -> &mut AccessibilityData
fn get_accessibility_data(&mut self) -> &mut AccessibilityData
Returns a mutable reference to the element’s accessibility data.
§fn accessibility(self, accessibility: AccessibilityData) -> Self
fn accessibility(self, accessibility: AccessibilityData) -> Self
Replace all of the element’s accessibility data at once. See
AccessibilityData.§fn a11y_id(self, a11y_id: impl Into<Option<NodeId>>) -> Self
fn a11y_id(self, a11y_id: impl Into<Option<NodeId>>) -> Self
Set an explicit accessibility id instead of an autogenerated one. See
AccessibilityId.§fn a11y_focusable(self, a11y_focusable: impl Into<Focusable>) -> Self
fn a11y_focusable(self, a11y_focusable: impl Into<Focusable>) -> Self
Set whether the element can receive keyboard focus. See
Focusable.§fn a11y_auto_focus(self, a11y_auto_focus: impl Into<bool>) -> Self
fn a11y_auto_focus(self, a11y_auto_focus: impl Into<bool>) -> Self
Request that the element be focused automatically when it is mounted.
§fn a11y_member_of(self, a11y_member_of: impl Into<NodeId>) -> Self
fn a11y_member_of(self, a11y_member_of: impl Into<NodeId>) -> Self
Mark the element as a member of the group identified by the given
AccessibilityId.§fn a11y_role(self, a11y_role: impl Into<Role>) -> Self
fn a11y_role(self, a11y_role: impl Into<Role>) -> Self
Set the accessibility role exposed in the accessibility tree. See
AccessibilityRole.§fn a11y_alt(self, value: impl Into<Box<str>>) -> Self
fn a11y_alt(self, value: impl Into<Box<str>>) -> Self
Set the text label that describes the element in the accessibility tree.
§fn a11y_builder(self, with: impl FnOnce(&mut Node)) -> Self
fn a11y_builder(self, with: impl FnOnce(&mut Node)) -> Self
Edit the underlying
accesskit node directly for advanced accessibility properties.§impl ElementExt for Terminal
impl ElementExt for Terminal
fn diff(&self, other: &Rc<dyn ElementExt>) -> DiffModifies
fn layout(&self) -> Cow<'_, LayoutData>
fn accessibility(&self) -> Cow<'_, AccessibilityData>
fn events_handlers( &self, ) -> Option<Cow<'_, HashMap<EventName, EventHandlerType, FxBuildHasher>>>
fn should_hook_measurement(&self) -> bool
fn measure( &self, context: LayoutContext<'_>, ) -> Option<(Size2D<f32, ()>, Rc<dyn Any>)>
fn render(&self, context: RenderContext<'_>)
fn into_element(self) -> Element
fn changed(&self, _other: &Rc<dyn ElementExt>) -> bool
fn effect(&self) -> Option<Cow<'_, EffectData>>
fn style(&self) -> Cow<'_, StyleState>
fn text_style(&self) -> Cow<'_, TextStyleData>
fn layer(&self) -> Layer
fn should_measure_inner_children(&self) -> bool
fn is_point_inside(&self, context: EventMeasurementContext<'_>) -> bool
fn clip(&self, _context: ClipContext<'_>)
fn render_rect(&self, area: &Rect<f32, ()>, scale_factor: f32) -> RRect
§impl EventHandlersExt for Terminal
impl EventHandlersExt for Terminal
§fn get_event_handlers(
&mut self,
) -> &mut HashMap<EventName, EventHandlerType, FxBuildHasher>
fn get_event_handlers( &mut self, ) -> &mut HashMap<EventName, EventHandlerType, FxBuildHasher>
Returns a mutable reference to the element’s event handler map.
§fn with_event_handlers(
self,
event_handlers: HashMap<EventName, EventHandlerType, FxBuildHasher>,
) -> Self
fn with_event_handlers( self, event_handlers: HashMap<EventName, EventHandlerType, FxBuildHasher>, ) -> Self
Replace all of this element’s event handlers with the given map.
§fn on_mouse_down(
self,
on_mouse_down: impl Into<EventHandler<Event<MouseEventData>>>,
) -> Self
fn on_mouse_down( self, on_mouse_down: impl Into<EventHandler<Event<MouseEventData>>>, ) -> Self
Fires when a mouse button is pressed down over the element.
§fn on_mouse_up(
self,
on_mouse_up: impl Into<EventHandler<Event<MouseEventData>>>,
) -> Self
fn on_mouse_up( self, on_mouse_up: impl Into<EventHandler<Event<MouseEventData>>>, ) -> Self
Fires when a mouse button is released over the element.
§fn on_mouse_move(
self,
on_mouse_move: impl Into<EventHandler<Event<MouseEventData>>>,
) -> Self
fn on_mouse_move( self, on_mouse_move: impl Into<EventHandler<Event<MouseEventData>>>, ) -> Self
Fires when the cursor moves over the element.
§fn on_global_pointer_press(
self,
on_global_pointer_press: impl Into<EventHandler<Event<PointerEventData>>>,
) -> Self
fn on_global_pointer_press( self, on_global_pointer_press: impl Into<EventHandler<Event<PointerEventData>>>, ) -> Self
Fires when a pointer (mouse or touch) is pressed anywhere, even outside the element.
§fn on_global_pointer_down(
self,
on_global_pointer_down: impl Into<EventHandler<Event<PointerEventData>>>,
) -> Self
fn on_global_pointer_down( self, on_global_pointer_down: impl Into<EventHandler<Event<PointerEventData>>>, ) -> Self
Fires when a pointer (mouse or touch) goes down anywhere, even outside the element.
§fn on_global_pointer_move(
self,
on_global_pointer_move: impl Into<EventHandler<Event<PointerEventData>>>,
) -> Self
fn on_global_pointer_move( self, on_global_pointer_move: impl Into<EventHandler<Event<PointerEventData>>>, ) -> Self
Fires when a pointer (mouse or touch) moves anywhere, even outside the element.
§fn on_capture_global_pointer_move(
self,
on_capture_global_pointer_move: impl Into<EventHandler<Event<PointerEventData>>>,
) -> Self
fn on_capture_global_pointer_move( self, on_capture_global_pointer_move: impl Into<EventHandler<Event<PointerEventData>>>, ) -> Self
Like
on_global_pointer_move, but fires during the top-down capture phase.§fn on_capture_global_pointer_press(
self,
on_capture_global_pointer_press: impl Into<EventHandler<Event<PointerEventData>>>,
) -> Self
fn on_capture_global_pointer_press( self, on_capture_global_pointer_press: impl Into<EventHandler<Event<PointerEventData>>>, ) -> Self
Like
on_global_pointer_press, but fires during the top-down capture phase.§fn on_key_down(
self,
on_key_down: impl Into<EventHandler<Event<KeyboardEventData>>>,
) -> Self
fn on_key_down( self, on_key_down: impl Into<EventHandler<Event<KeyboardEventData>>>, ) -> Self
Fires when a key is pressed down while the element is focused.
§fn on_key_up(
self,
on_key_up: impl Into<EventHandler<Event<KeyboardEventData>>>,
) -> Self
fn on_key_up( self, on_key_up: impl Into<EventHandler<Event<KeyboardEventData>>>, ) -> Self
Fires when a key is released while the element is focused.
§fn on_global_key_down(
self,
on_global_key_down: impl Into<EventHandler<Event<KeyboardEventData>>>,
) -> Self
fn on_global_key_down( self, on_global_key_down: impl Into<EventHandler<Event<KeyboardEventData>>>, ) -> Self
Fires when a key is pressed down, regardless of which element is focused.
§fn on_global_key_up(
self,
on_global_key_up: impl Into<EventHandler<Event<KeyboardEventData>>>,
) -> Self
fn on_global_key_up( self, on_global_key_up: impl Into<EventHandler<Event<KeyboardEventData>>>, ) -> Self
Fires when a key is released, regardless of which element is focused.
§fn on_wheel(
self,
on_wheel: impl Into<EventHandler<Event<WheelEventData>>>,
) -> Self
fn on_wheel( self, on_wheel: impl Into<EventHandler<Event<WheelEventData>>>, ) -> Self
Fires when the scroll wheel is used over the element.
§fn on_touch_cancel(
self,
on_touch_cancel: impl Into<EventHandler<Event<TouchEventData>>>,
) -> Self
fn on_touch_cancel( self, on_touch_cancel: impl Into<EventHandler<Event<TouchEventData>>>, ) -> Self
Fires when an ongoing touch is cancelled by the system.
§fn on_touch_start(
self,
on_touch_start: impl Into<EventHandler<Event<TouchEventData>>>,
) -> Self
fn on_touch_start( self, on_touch_start: impl Into<EventHandler<Event<TouchEventData>>>, ) -> Self
Fires when a touch point is placed on the element.
§fn on_touch_move(
self,
on_touch_move: impl Into<EventHandler<Event<TouchEventData>>>,
) -> Self
fn on_touch_move( self, on_touch_move: impl Into<EventHandler<Event<TouchEventData>>>, ) -> Self
Fires when a touch point moves across the element.
§fn on_touch_end(
self,
on_touch_end: impl Into<EventHandler<Event<TouchEventData>>>,
) -> Self
fn on_touch_end( self, on_touch_end: impl Into<EventHandler<Event<TouchEventData>>>, ) -> Self
Fires when a touch point is lifted from the element.
§fn on_pointer_press(
self,
on_pointer_press: impl Into<EventHandler<Event<PointerEventData>>>,
) -> Self
fn on_pointer_press( self, on_pointer_press: impl Into<EventHandler<Event<PointerEventData>>>, ) -> Self
Fires when the element is pressed and released by a pointer (mouse or touch).
§fn on_pointer_down(
self,
on_pointer_down: impl Into<EventHandler<Event<PointerEventData>>>,
) -> Self
fn on_pointer_down( self, on_pointer_down: impl Into<EventHandler<Event<PointerEventData>>>, ) -> Self
Fires when a pointer (mouse or touch) goes down over the element.
§fn on_pointer_move(
self,
on_pointer_move: impl Into<EventHandler<Event<PointerEventData>>>,
) -> Self
fn on_pointer_move( self, on_pointer_move: impl Into<EventHandler<Event<PointerEventData>>>, ) -> Self
Fires when a pointer (mouse or touch) moves over the element.
§fn on_pointer_enter(
self,
on_pointer_enter: impl Into<EventHandler<Event<PointerEventData>>>,
) -> Self
fn on_pointer_enter( self, on_pointer_enter: impl Into<EventHandler<Event<PointerEventData>>>, ) -> Self
Fires when a pointer enters the element.
§fn on_pointer_leave(
self,
on_pointer_leave: impl Into<EventHandler<Event<PointerEventData>>>,
) -> Self
fn on_pointer_leave( self, on_pointer_leave: impl Into<EventHandler<Event<PointerEventData>>>, ) -> Self
Fires when a pointer leaves the element.
§fn on_pointer_over(
self,
on_pointer_over: impl Into<EventHandler<Event<PointerEventData>>>,
) -> Self
fn on_pointer_over( self, on_pointer_over: impl Into<EventHandler<Event<PointerEventData>>>, ) -> Self
Fires when a pointer is over the element, including over its children.
§fn on_pointer_out(
self,
on_pointer_out: impl Into<EventHandler<Event<PointerEventData>>>,
) -> Self
fn on_pointer_out( self, on_pointer_out: impl Into<EventHandler<Event<PointerEventData>>>, ) -> Self
Fires when a pointer leaves the element or one of its children.
§fn on_file_drop(
self,
on_file_drop: impl Into<EventHandler<Event<FileEventData>>>,
) -> Self
fn on_file_drop( self, on_file_drop: impl Into<EventHandler<Event<FileEventData>>>, ) -> Self
Fires when a file is dropped onto the element.
§fn on_global_file_hover(
self,
on_global_file_hover: impl Into<EventHandler<Event<FileEventData>>>,
) -> Self
fn on_global_file_hover( self, on_global_file_hover: impl Into<EventHandler<Event<FileEventData>>>, ) -> Self
Fires when a dragged file hovers anywhere over the window.
§fn on_global_file_hover_cancelled(
self,
on_global_file_hover_cancelled: impl Into<EventHandler<Event<FileEventData>>>,
) -> Self
fn on_global_file_hover_cancelled( self, on_global_file_hover_cancelled: impl Into<EventHandler<Event<FileEventData>>>, ) -> Self
Fires when a dragged file stops hovering over the window.
§fn on_ime_preedit(
self,
on_ime_preedit: impl Into<EventHandler<Event<ImePreeditEventData>>>,
) -> Self
fn on_ime_preedit( self, on_ime_preedit: impl Into<EventHandler<Event<ImePreeditEventData>>>, ) -> Self
Fires while text is being composed through an input method editor (IME).
§fn on_sized(
self,
on_sized: impl Into<EventHandler<Event<SizedEventData>>>,
) -> Selfwhere
Self: LayoutExt,
fn on_sized(
self,
on_sized: impl Into<EventHandler<Event<SizedEventData>>>,
) -> Selfwhere
Self: LayoutExt,
Fires when the element’s measured size or position changes.
§fn on_press(
self,
on_press: impl Into<EventHandler<Event<PressEventData>>>,
) -> Self
fn on_press( self, on_press: impl Into<EventHandler<Event<PressEventData>>>, ) -> Self
This is generally the best event in which to run “press” logic, this might be called
onClick, onActivate, or onConnect in other platforms. Read more§fn on_secondary_down(
self,
on_secondary_down: impl Into<EventHandler<Event<PressEventData>>>,
) -> Self
fn on_secondary_down( self, on_secondary_down: impl Into<EventHandler<Event<PressEventData>>>, ) -> Self
Also called the context menu click in other platforms.
Gets triggered when: Read more
§fn on_all_press(
self,
on_press: impl Into<EventHandler<Event<PressEventData>>>,
) -> Self
fn on_all_press( self, on_press: impl Into<EventHandler<Event<PressEventData>>>, ) -> Self
Gets triggered when: Read more
§fn on_focus_press(
self,
on_focus_press: impl Into<EventHandler<Event<FocusPressEventData>>>,
) -> Self
fn on_focus_press( self, on_focus_press: impl Into<EventHandler<Event<FocusPressEventData>>>, ) -> Self
Gets triggered when: Read more
§impl LayoutExt for Terminal
impl LayoutExt for Terminal
§fn get_layout(&mut self) -> &mut LayoutData
fn get_layout(&mut self) -> &mut LayoutData
Returns a mutable reference to the element’s layout data.
§fn layout(self, layout: LayoutData) -> Self
fn layout(self, layout: LayoutData) -> Self
Replace all of the element’s layout data at once. See
LayoutData.Auto Trait Implementations§
impl Freeze for Terminal
impl !RefUnwindSafe for Terminal
impl !Send for Terminal
impl !Sync for Terminal
impl Unpin for Terminal
impl UnsafeUnpin for Terminal
impl !UnwindSafe for Terminal
Blanket Implementations§
§impl<T> AnyEq for T
impl<T> AnyEq for T
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> ComponentProps for T
impl<T> ComponentProps for T
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Convert
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more