Struct fltk::text::TextDisplay
source · pub struct TextDisplay { /* private fields */ }
Expand description
Creates a non-editable text display widget
Trait Implementations§
source§impl Clone for TextDisplay
impl Clone for TextDisplay
source§fn clone(&self) -> TextDisplay
fn clone(&self) -> TextDisplay
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for TextDisplay
impl Debug for TextDisplay
source§impl Default for TextDisplay
impl Default for TextDisplay
source§impl DisplayExt for TextDisplay
impl DisplayExt for TextDisplay
source§fn buffer(&self) -> Option<TextBuffer>
fn buffer(&self) -> Option<TextBuffer>
Get the associated
TextBuffer
source§fn set_buffer<B: Into<Option<TextBuffer>>>(&mut self, buffer: B)
fn set_buffer<B: Into<Option<TextBuffer>>>(&mut self, buffer: B)
Sets the associated
TextBuffer
.
Since the widget is long-lived, the lifetime of the buffer is prolonged to the lifetime of the programsource§fn style_buffer(&self) -> Option<TextBuffer>
fn style_buffer(&self) -> Option<TextBuffer>
Get the associated style
TextBuffer
source§fn set_text_font(&mut self, font: Font)
fn set_text_font(&mut self, font: Font)
Sets the text font
source§fn text_color(&self) -> Color
fn text_color(&self) -> Color
Return the text color
source§fn set_text_color(&mut self, color: Color)
fn set_text_color(&mut self, color: Color)
Sets the text color
source§fn set_text_size(&mut self, sz: i32)
fn set_text_size(&mut self, sz: i32)
Sets the text size
source§fn set_insert_position(&mut self, new_pos: i32)
fn set_insert_position(&mut self, new_pos: i32)
Set the insert position
source§fn insert_position(&self) -> i32
fn insert_position(&self) -> i32
Return the insert position
source§fn count_lines(&self, start: i32, end: i32, is_line_start: bool) -> i32
fn count_lines(&self, start: i32, end: i32, is_line_start: bool) -> i32
Counts the lines from start to end
source§fn show_cursor(&mut self, val: bool)
fn show_cursor(&mut self, val: bool)
Shows/hides the cursor
source§fn set_highlight_data<B: Into<Option<TextBuffer>>, E: Into<Vec<StyleTableEntry>>>(
&mut self,
style_buffer: B,
entries: E
)
fn set_highlight_data<B: Into<Option<TextBuffer>>, E: Into<Vec<StyleTableEntry>>>( &mut self, style_buffer: B, entries: E )
Sets the style of the text widget
source§fn set_highlight_data_ext<B: Into<Option<TextBuffer>>, E: Into<Vec<StyleTableEntryExt>>>(
&mut self,
style_buffer: B,
entries: E
)
fn set_highlight_data_ext<B: Into<Option<TextBuffer>>, E: Into<Vec<StyleTableEntryExt>>>( &mut self, style_buffer: B, entries: E )
Sets the style of the text widget
source§fn unset_highlight_data<B: Into<Option<TextBuffer>>>(&mut self, style_buffer: B)
fn unset_highlight_data<B: Into<Option<TextBuffer>>>(&mut self, style_buffer: B)
Unset the style of the text widget
source§fn set_cursor_style(&mut self, style: Cursor)
fn set_cursor_style(&mut self, style: Cursor)
Sets the cursor style
source§fn set_cursor_color(&mut self, color: Color)
fn set_cursor_color(&mut self, color: Color)
Sets the cursor color
source§fn set_scrollbar_size(&mut self, size: i32)
fn set_scrollbar_size(&mut self, size: i32)
Sets the scrollbar size in pixels
source§fn set_scrollbar_align(&mut self, align: Align)
fn set_scrollbar_align(&mut self, align: Align)
Sets the scrollbar alignment
source§fn cursor_style(&self) -> Cursor
fn cursor_style(&self) -> Cursor
Returns the cursor style
source§fn cursor_color(&self) -> Color
fn cursor_color(&self) -> Color
Returns the cursor color
source§fn scrollbar_size(&self) -> i32
fn scrollbar_size(&self) -> i32
Returns the scrollbar size in pixels
source§fn scrollbar_align(&self) -> Align
fn scrollbar_align(&self) -> Align
Returns the scrollbar alignment
source§fn line_start(&self, pos: i32) -> i32
fn line_start(&self, pos: i32) -> i32
Returns the beginning of the line from the current position.
Returns new position as index
source§fn line_end(&self, start_pos: i32, is_line_start: bool) -> i32
fn line_end(&self, start_pos: i32, is_line_start: bool) -> i32
Returns the ending of the line from the current position.
Returns new position as index
source§fn skip_lines(&mut self, start_pos: i32, lines: i32, is_line_start: bool) -> i32
fn skip_lines(&mut self, start_pos: i32, lines: i32, is_line_start: bool) -> i32
Skips lines from
start_pos
source§fn previous_word(&mut self)
fn previous_word(&mut self)
Goes to the previous word
source§fn word_start(&self, pos: i32) -> i32
fn word_start(&self, pos: i32) -> i32
Returns the position of the start of the word, relative to the current position
source§fn word_end(&self, pos: i32) -> i32
fn word_end(&self, pos: i32) -> i32
Returns the position of the end of the word, relative to the current position
source§fn set_linenumber_width(&mut self, w: i32)
fn set_linenumber_width(&mut self, w: i32)
Sets the linenumber width
source§fn linenumber_width(&self) -> i32
fn linenumber_width(&self) -> i32
Gets the linenumber width
source§fn set_linenumber_font(&mut self, font: Font)
fn set_linenumber_font(&mut self, font: Font)
Sets the linenumber font
source§fn linenumber_font(&self) -> Font
fn linenumber_font(&self) -> Font
Gets the linenumber font
source§fn set_linenumber_size(&mut self, size: i32)
fn set_linenumber_size(&mut self, size: i32)
Sets the linenumber size
source§fn linenumber_size(&self) -> i32
fn linenumber_size(&self) -> i32
Gets the linenumber size
source§fn set_linenumber_fgcolor(&mut self, color: Color)
fn set_linenumber_fgcolor(&mut self, color: Color)
Sets the linenumber foreground color
source§fn linenumber_fgcolor(&self) -> Color
fn linenumber_fgcolor(&self) -> Color
Gets the linenumber foreground color
source§fn set_linenumber_bgcolor(&mut self, color: Color)
fn set_linenumber_bgcolor(&mut self, color: Color)
Sets the linenumber background color
source§fn linenumber_bgcolor(&self) -> Color
fn linenumber_bgcolor(&self) -> Color
Gets the linenumber background color
source§fn set_linenumber_align(&mut self, align: Align)
fn set_linenumber_align(&mut self, align: Align)
Sets the linenumber alignment
source§fn linenumber_align(&self) -> Align
fn linenumber_align(&self) -> Align
Gets the linenumber alignment
source§fn in_selection(&self, x: i32, y: i32) -> bool
fn in_selection(&self, x: i32, y: i32) -> bool
Checks whether a pixel is within a text selection
source§fn wrap_mode(&mut self, wrap: WrapMode, wrap_margin: i32)
fn wrap_mode(&mut self, wrap: WrapMode, wrap_margin: i32)
Sets the wrap mode of the Display widget.
If the wrap mode is
AtColumn
, wrap margin is the column.
If the wrap mode is AtPixel
, wrap margin is the pixel.
For more infosource§fn wrapped_column(&self, row: i32, column: i32) -> i32
fn wrapped_column(&self, row: i32, column: i32) -> i32
Correct a column number based on an unconstrained position
source§fn wrapped_row(&self, row: i32) -> i32
fn wrapped_row(&self, row: i32) -> i32
Correct a row number from an unconstrained position
source§fn set_grammar_underline_color(&mut self, color: Color)
fn set_grammar_underline_color(&mut self, color: Color)
Set the grammar underline color
source§fn grammar_underline_color(&self) -> Color
fn grammar_underline_color(&self) -> Color
Get the grammar underline color
source§fn set_spelling_underline_color(&mut self, color: Color)
fn set_spelling_underline_color(&mut self, color: Color)
Set the spelling underline color
source§fn spelling_underline_color(&self) -> Color
fn spelling_underline_color(&self) -> Color
Get the spelling underline color
source§fn set_secondary_selection_color(&mut self, color: Color)
fn set_secondary_selection_color(&mut self, color: Color)
Set the secondary selection color
source§fn secondary_selection_color(&self) -> Color
fn secondary_selection_color(&self) -> Color
Get the secondary selection color
source§fn show_insert_position(&mut self)
fn show_insert_position(&mut self)
Scrolls the text buffer to show the current insert position
source§impl PartialEq for TextDisplay
impl PartialEq for TextDisplay
source§impl WidgetBase for TextDisplay
impl WidgetBase for TextDisplay
source§fn new<T: Into<Option<&'static str>>>(
x: i32,
y: i32,
width: i32,
height: i32,
title: T
) -> TextDisplay
fn new<T: Into<Option<&'static str>>>( x: i32, y: i32, width: i32, height: i32, title: T ) -> TextDisplay
Creates a new widget, takes an x, y coordinates, as well as a width and height, plus a title Read more
source§fn default_fill() -> Self
fn default_fill() -> Self
Constructs a widget with the size of its parent
source§unsafe fn from_widget_ptr(ptr: *mut Fl_Widget) -> Self
unsafe fn from_widget_ptr(ptr: *mut Fl_Widget) -> Self
transforms a widget pointer to a Widget, for internal use Read more
source§unsafe fn from_widget<W: WidgetExt>(w: W) -> Self
unsafe fn from_widget<W: WidgetExt>(w: W) -> Self
Get a widget from base widget Read more
source§fn handle<F: FnMut(&mut Self, Event) -> bool + 'static>(&mut self, cb: F)
fn handle<F: FnMut(&mut Self, Event) -> bool + 'static>(&mut self, cb: F)
Set a custom handler, where events are managed manually, akin to
Fl_Widget::handle(int)
.
Handled or ignored events should return true, unhandled events should return false.
takes the widget as a closure argument.
The ability to handle an event might depend on handling other events, as explained heresource§fn draw<F: FnMut(&mut Self) + 'static>(&mut self, cb: F)
fn draw<F: FnMut(&mut Self) + 'static>(&mut self, cb: F)
Set a custom draw method.
takes the widget as a closure argument.
macOS requires that
WidgetBase::draw
actually calls drawing functionssource§fn resize_callback<F: FnMut(&mut Self, i32, i32, i32, i32) + 'static>(
&mut self,
cb: F
)
fn resize_callback<F: FnMut(&mut Self, i32, i32, i32, i32) + 'static>( &mut self, cb: F )
Perform a callback on resize.
Avoid resizing the parent or the same widget to avoid infinite recursion
source§unsafe fn assume_derived(&mut self)
unsafe fn assume_derived(&mut self)
Makes the widget derived Read more
source§impl WidgetExt for TextDisplay
impl WidgetExt for TextDisplay
source§fn with_label(self, title: &str) -> Self
fn with_label(self, title: &str) -> Self
Initialize with a label
source§fn with_align(self, align: Align) -> Self
fn with_align(self, align: Align) -> Self
Initialize with alignment
source§fn with_type<T: WidgetType>(self, typ: T) -> Self
fn with_type<T: WidgetType>(self, typ: T) -> Self
Initialize with type
source§fn below_of<W: WidgetExt>(self, wid: &W, padding: i32) -> Self
fn below_of<W: WidgetExt>(self, wid: &W, padding: i32) -> Self
Initialize at bottom of another widget
source§fn above_of<W: WidgetExt>(self, wid: &W, padding: i32) -> Self
fn above_of<W: WidgetExt>(self, wid: &W, padding: i32) -> Self
Initialize above of another widget
source§fn right_of<W: WidgetExt>(self, wid: &W, padding: i32) -> Self
fn right_of<W: WidgetExt>(self, wid: &W, padding: i32) -> Self
Initialize right of another widget
source§fn left_of<W: WidgetExt>(self, wid: &W, padding: i32) -> Self
fn left_of<W: WidgetExt>(self, wid: &W, padding: i32) -> Self
Initialize left of another widget
source§fn center_of_parent(self) -> Self
fn center_of_parent(self) -> Self
Initialize center of parent
source§fn size_of_parent(self) -> Self
fn size_of_parent(self) -> Self
Initialize to the size of the parent
source§fn set_label(&mut self, title: &str)
fn set_label(&mut self, title: &str)
Sets the widget’s label.
labels support special symbols preceded by an
@
sign.
and for the associated formatting.source§fn measure_label(&self) -> (i32, i32)
fn measure_label(&self) -> (i32, i32)
Measures the label’s width and height
source§fn as_widget_ptr(&self) -> *mut Fl_Widget
fn as_widget_ptr(&self) -> *mut Fl_Widget
transforms a widget to a base
Fl_Widget
, for internal usesource§fn deactivate(&mut self)
fn deactivate(&mut self)
Deactivates the widget
source§fn redraw_label(&mut self)
fn redraw_label(&mut self)
Redraws the label of the widget
source§fn resize(&mut self, x: i32, y: i32, width: i32, height: i32)
fn resize(&mut self, x: i32, y: i32, width: i32, height: i32)
Resizes and/or moves the widget, takes x, y, width and height
source§fn widget_resize(&mut self, x: i32, y: i32, width: i32, height: i32)
fn widget_resize(&mut self, x: i32, y: i32, width: i32, height: i32)
Does a simple resize ignoring class-specific resize functionality
source§fn set_tooltip(&mut self, txt: &str)
fn set_tooltip(&mut self, txt: &str)
Sets the tooltip text
source§fn label_color(&self) -> Color
fn label_color(&self) -> Color
Returns the widget label’s color
source§fn set_label_color(&mut self, color: Color)
fn set_label_color(&mut self, color: Color)
Sets the widget label’s color
source§fn label_font(&self) -> Font
fn label_font(&self) -> Font
Returns the widget label’s font
source§fn set_label_font(&mut self, font: Font)
fn set_label_font(&mut self, font: Font)
Sets the widget label’s font
source§fn label_size(&self) -> i32
fn label_size(&self) -> i32
Returns the widget label’s size
source§fn set_label_size(&mut self, sz: i32)
fn set_label_size(&mut self, sz: i32)
Sets the widget label’s size
source§fn label_type(&self) -> LabelType
fn label_type(&self) -> LabelType
Returns the widget label’s type
source§fn set_label_type(&mut self, typ: LabelType)
fn set_label_type(&mut self, typ: LabelType)
Sets the widget label’s type
source§fn set_changed(&mut self)
fn set_changed(&mut self)
Mark the widget as changed
source§fn clear_changed(&mut self)
fn clear_changed(&mut self)
Clears the changed status of the widget
source§fn set_trigger(&mut self, trigger: CallbackTrigger)
fn set_trigger(&mut self, trigger: CallbackTrigger)
Sets the default callback trigger for a widget, equivalent to
when()
source§fn trigger(&self) -> CallbackTrigger
fn trigger(&self) -> CallbackTrigger
Return the callback trigger, equivalent to
when()
source§fn selection_color(&self) -> Color
fn selection_color(&self) -> Color
Gets the selection color of the widget
source§fn set_selection_color(&mut self, color: Color)
fn set_selection_color(&mut self, color: Color)
Sets the selection color of the widget
source§fn do_callback(&mut self)
fn do_callback(&mut self)
Runs the already registered callback
source§fn top_window(&self) -> Option<Box<dyn WindowExt>>
fn top_window(&self) -> Option<Box<dyn WindowExt>>
Returns the topmost window holding the widget
source§fn takes_events(&self) -> bool
fn takes_events(&self) -> bool
Checks whether a widget is capable of taking events
source§fn set_visible_focus(&mut self)
fn set_visible_focus(&mut self)
Set the widget to have visible focus
source§fn clear_visible_focus(&mut self)
fn clear_visible_focus(&mut self)
Clear visible focus
source§fn visible_focus(&mut self, v: bool)
fn visible_focus(&mut self, v: bool)
Set the visible focus using a flag
source§fn has_visible_focus(&self) -> bool
fn has_visible_focus(&self) -> bool
Return whether the widget has visible focus
source§fn was_deleted(&self) -> bool
fn was_deleted(&self) -> bool
Check if a widget was deleted
source§fn set_damage(&mut self, flag: bool)
fn set_damage(&mut self, flag: bool)
Signal the widget as damaged and it should be redrawn in the next event loop cycle
source§fn damage_type(&self) -> Damage
fn damage_type(&self) -> Damage
Return the damage mask
source§fn set_damage_type(&mut self, mask: Damage)
fn set_damage_type(&mut self, mask: Damage)
Signal the type of damage a widget received
source§fn set_damage_area(&mut self, mask: Damage, x: i32, y: i32, w: i32, h: i32)
fn set_damage_area(&mut self, mask: Damage, x: i32, y: i32, w: i32, h: i32)
Signal damage for an area inside the widget
source§fn clear_damage(&mut self)
fn clear_damage(&mut self)
Clear the damaged flag
source§fn as_window(&self) -> Option<Box<dyn WindowExt>>
fn as_window(&self) -> Option<Box<dyn WindowExt>>
Return the widget as a window if it’s a window
source§fn as_group(&self) -> Option<Group>
fn as_group(&self) -> Option<Group>
Return the widget as a group widget if it’s a group widget
source§fn inside<W: WidgetExt>(&self, wid: &W) -> bool
fn inside<W: WidgetExt>(&self, wid: &W) -> bool
Checks whether the self widget is inside another widget
source§fn get_type<T: WidgetType>(&self) -> T
fn get_type<T: WidgetType>(&self) -> T
Returns the widget type when applicable
source§fn set_type<T: WidgetType>(&mut self, typ: T)
fn set_type<T: WidgetType>(&mut self, typ: T)
Sets the widget type
source§fn set_image_scaled<I: ImageExt>(&mut self, image: Option<I>)
fn set_image_scaled<I: ImageExt>(&mut self, image: Option<I>)
Sets the image of the widget scaled to the widget’s size
source§unsafe fn image_mut(&self) -> Option<&mut Image>
unsafe fn image_mut(&self) -> Option<&mut Image>
Get a reference type of the widget’s image Read more
source§fn set_deimage<I: ImageExt>(&mut self, image: Option<I>)
fn set_deimage<I: ImageExt>(&mut self, image: Option<I>)
Sets the deactivated image of the widget
source§fn set_deimage_scaled<I: ImageExt>(&mut self, image: Option<I>)
fn set_deimage_scaled<I: ImageExt>(&mut self, image: Option<I>)
Sets the deactivated image of the widget scaled to the widget’s size
source§fn deimage(&self) -> Option<Box<dyn ImageExt>>
fn deimage(&self) -> Option<Box<dyn ImageExt>>
Gets the deactivated image associated with the widget
source§unsafe fn deimage_mut(&self) -> Option<&mut Image>
unsafe fn deimage_mut(&self) -> Option<&mut Image>
Get a reference type of the widget’s deactivated image Read more
source§fn set_callback<F: FnMut(&mut Self) + 'static>(&mut self, cb: F)
fn set_callback<F: FnMut(&mut Self) + 'static>(&mut self, cb: F)
Sets the callback when the widget is triggered (clicks for example)
takes the widget as a closure argument
source§fn emit<T: 'static + Clone + Send + Sync>(&mut self, sender: Sender<T>, msg: T)
fn emit<T: 'static + Clone + Send + Sync>(&mut self, sender: Sender<T>, msg: T)
Emits a message on callback using a sender
source§unsafe fn into_widget<W: WidgetBase>(&self) -> W
unsafe fn into_widget<W: WidgetBase>(&self) -> W
Upcast a
WidgetExt
to some widget type Read moresource§fn visible_r(&self) -> bool
fn visible_r(&self) -> bool
Returns whether a widget or any of its parents are visible (recursively)
source§fn is_same<W: WidgetExt>(&self, other: &W) -> bool
fn is_same<W: WidgetExt>(&self, other: &W) -> bool
Return whether two widgets object point to the same widget
source§fn active_r(&self) -> bool
fn active_r(&self) -> bool
Returns whether a widget or any of its parents are active (recursively)
source§fn handle_event(&mut self, event: Event) -> bool
fn handle_event(&mut self, event: Event) -> bool
Handle a specific event
source§fn is_derived(&self) -> bool
fn is_derived(&self) -> bool
Check whether a widget is derived
source§fn as_base_widget(&self) -> Widgetwhere
Self: Sized,
fn as_base_widget(&self) -> Widgetwhere
Self: Sized,
Upcast a
WidgetExt
to a Widgetimpl Eq for TextDisplay
impl Send for TextDisplay
Available on non-crate feature
single-threaded
only.impl Sync for TextDisplay
Available on non-crate feature
single-threaded
only.Auto Trait Implementations§
Blanket Implementations§
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