Trait fltk::prelude::DisplayExt

pub unsafe trait DisplayExt: WidgetExt {
    // Required methods
    fn buffer(&self) -> Option<TextBuffer>;
    fn set_buffer<B: Into<Option<TextBuffer>>>(&mut self, buffer: B);
    fn style_buffer(&self) -> Option<TextBuffer>;
    fn text_font(&self) -> Font;
    fn set_text_font(&mut self, font: Font);
    fn text_color(&self) -> Color;
    fn set_text_color(&mut self, color: Color);
    fn text_size(&self) -> i32;
    fn set_text_size(&mut self, sz: i32);
    fn scroll(&mut self, top_line_num: i32, horiz_offset: i32);
    fn insert(&self, text: &str);
    fn set_insert_position(&mut self, new_pos: i32);
    fn insert_position(&self) -> i32;
    fn position_to_xy(&self, pos: i32) -> (i32, i32);
    fn count_lines(&self, start: i32, end: i32, is_line_start: bool) -> i32;
    fn move_right(&mut self) -> Result<(), FltkError>;
    fn move_left(&mut self) -> Result<(), FltkError>;
    fn move_up(&mut self) -> Result<(), FltkError>;
    fn move_down(&mut self) -> Result<(), FltkError>;
    fn show_cursor(&mut self, val: bool);
    fn set_highlight_data<B: Into<Option<TextBuffer>>, E: Into<Vec<StyleTableEntry>>>(
        &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
    );
    fn unset_highlight_data<B: Into<Option<TextBuffer>>>(
        &mut self,
        style_buffer: B
    );
    fn set_cursor_style(&mut self, style: Cursor);
    fn set_cursor_color(&mut self, color: Color);
    fn set_scrollbar_size(&mut self, size: i32);
    fn set_scrollbar_align(&mut self, align: Align);
    fn cursor_style(&self) -> Cursor;
    fn cursor_color(&self) -> Color;
    fn scrollbar_size(&self) -> i32;
    fn scrollbar_align(&self) -> Align;
    fn line_start(&self, pos: i32) -> i32;
    fn line_end(&self, start_pos: i32, is_line_start: bool) -> i32;
    fn skip_lines(
        &mut self,
        start_pos: i32,
        lines: i32,
        is_line_start: bool
    ) -> i32;
    fn rewind_lines(&mut self, start_pos: i32, lines: i32) -> i32;
    fn next_word(&mut self);
    fn previous_word(&mut self);
    fn word_start(&self, pos: i32) -> i32;
    fn word_end(&self, pos: i32) -> i32;
    fn x_to_col(&self, x: f64) -> f64;
    fn col_to_x(&self, col: f64) -> f64;
    fn set_linenumber_width(&mut self, w: i32);
    fn linenumber_width(&self) -> i32;
    fn set_linenumber_font(&mut self, font: Font);
    fn linenumber_font(&self) -> Font;
    fn set_linenumber_size(&mut self, size: i32);
    fn linenumber_size(&self) -> i32;
    fn set_linenumber_fgcolor(&mut self, color: Color);
    fn linenumber_fgcolor(&self) -> Color;
    fn set_linenumber_bgcolor(&mut self, color: Color);
    fn linenumber_bgcolor(&self) -> Color;
    fn set_linenumber_align(&mut self, align: Align);
    fn linenumber_align(&self) -> Align;
    fn in_selection(&self, x: i32, y: i32) -> bool;
    fn wrap_mode(&mut self, wrap: WrapMode, wrap_margin: i32);
    fn wrapped_column(&self, row: i32, column: i32) -> i32;
    fn wrapped_row(&self, row: i32) -> i32;
    fn set_grammar_underline_color(&mut self, color: Color);
    fn grammar_underline_color(&self) -> Color;
    fn set_spelling_underline_color(&mut self, color: Color);
    fn spelling_underline_color(&self) -> Color;
    fn set_secondary_selection_color(&mut self, color: Color);
    fn secondary_selection_color(&self) -> Color;
    fn show_insert_position(&mut self);
}

Defines the methods implemented by TextDisplay and TextEditor More details can be found in the wiki.

Safety

fltk-rs traits depend on some FLTK internal code

Warning

fltk-rs traits are non-exhaustive, to avoid future breakage if you try to implement them manually, use the Deref and DerefMut pattern or the widget_extends! macro

Required Methods

fn buffer(&self) -> Option<TextBuffer>

Get the associated TextBuffer

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 program

fn style_buffer(&self) -> Option<TextBuffer>

Get the associated style TextBuffer

fn text_font(&self) -> Font

Return the text font

fn set_text_font(&mut self, font: Font)

Sets the text font

fn text_color(&self) -> Color

Return the text color

fn set_text_color(&mut self, color: Color)

Sets the text color

fn text_size(&self) -> i32

Return the text size

fn set_text_size(&mut self, sz: i32)

Sets the text size

fn scroll(&mut self, top_line_num: i32, horiz_offset: i32)

Scroll down the Display widget

fn insert(&self, text: &str)

Insert into Display widget

fn set_insert_position(&mut self, new_pos: i32)

Set the insert position

fn insert_position(&self) -> i32

Return the insert position

fn position_to_xy(&self, pos: i32) -> (i32, i32)

Gets the x and y positions of the cursor

fn count_lines(&self, start: i32, end: i32, is_line_start: bool) -> i32

Counts the lines from start to end

fn move_right(&mut self) -> Result<(), FltkError>

Moves the cursor right

Errors

Errors on failure to move the cursor

fn move_left(&mut self) -> Result<(), FltkError>

Moves the cursor left

Errors

Errors on failure to move the cursor

fn move_up(&mut self) -> Result<(), FltkError>

Moves the cursor up

Errors

Errors on failure to move the cursor

fn move_down(&mut self) -> Result<(), FltkError>

Moves the cursor down

Errors

Errors on failure to move the cursor

fn show_cursor(&mut self, val: bool)

Shows/hides the cursor

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

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

fn unset_highlight_data<B: Into<Option<TextBuffer>>>(&mut self, style_buffer: B)

Unset the style of the text widget

fn set_cursor_style(&mut self, style: Cursor)

Sets the cursor style

fn set_cursor_color(&mut self, color: Color)

Sets the cursor color

fn set_scrollbar_size(&mut self, size: i32)

Sets the scrollbar size in pixels

fn set_scrollbar_align(&mut self, align: Align)

Sets the scrollbar alignment

fn cursor_style(&self) -> Cursor

Returns the cursor style

fn cursor_color(&self) -> Color

Returns the cursor color

fn scrollbar_size(&self) -> i32

Returns the scrollbar size in pixels

fn scrollbar_align(&self) -> Align

Returns the scrollbar alignment

fn line_start(&self, pos: i32) -> i32

Returns the beginning of the line from the current position. Returns new position as index

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

fn skip_lines(&mut self, start_pos: i32, lines: i32, is_line_start: bool) -> i32

Skips lines from start_pos

fn rewind_lines(&mut self, start_pos: i32, lines: i32) -> i32

Rewinds the lines

fn next_word(&mut self)

Goes to the next word

fn previous_word(&mut self)

Goes to the previous word

fn word_start(&self, pos: i32) -> i32

Returns the position of the start of the word, relative to the current position

fn word_end(&self, pos: i32) -> i32

Returns the position of the end of the word, relative to the current position

fn x_to_col(&self, x: f64) -> f64

Convert an x pixel position into a column number.

fn col_to_x(&self, col: f64) -> f64

Convert a column number into an x pixel position

fn set_linenumber_width(&mut self, w: i32)

Sets the linenumber width

fn linenumber_width(&self) -> i32

Gets the linenumber width

fn set_linenumber_font(&mut self, font: Font)

Sets the linenumber font

fn linenumber_font(&self) -> Font

Gets the linenumber font

fn set_linenumber_size(&mut self, size: i32)

Sets the linenumber size

fn linenumber_size(&self) -> i32

Gets the linenumber size

fn set_linenumber_fgcolor(&mut self, color: Color)

Sets the linenumber foreground color

fn linenumber_fgcolor(&self) -> Color

Gets the linenumber foreground color

fn set_linenumber_bgcolor(&mut self, color: Color)

Sets the linenumber background color

fn linenumber_bgcolor(&self) -> Color

Gets the linenumber background color

fn set_linenumber_align(&mut self, align: Align)

Sets the linenumber alignment

fn linenumber_align(&self) -> Align

Gets the linenumber alignment

fn in_selection(&self, x: i32, y: i32) -> bool

Checks whether a pixel is within a text selection

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 info

fn wrapped_column(&self, row: i32, column: i32) -> i32

Correct a column number based on an unconstrained position

fn wrapped_row(&self, row: i32) -> i32

Correct a row number from an unconstrained position

fn set_grammar_underline_color(&mut self, color: Color)

Set the grammar underline color

fn grammar_underline_color(&self) -> Color

Get the grammar underline color

fn set_spelling_underline_color(&mut self, color: Color)

Set the spelling underline color

fn spelling_underline_color(&self) -> Color

Get the spelling underline color

fn set_secondary_selection_color(&mut self, color: Color)

Set the secondary selection color

fn secondary_selection_color(&self) -> Color

Get the secondary selection color

fn show_insert_position(&mut self)

Scrolls the text buffer to show the current insert position

Object Safety

This trait is not object safe.

Implementors

impl DisplayExt for SimpleTerminal

impl DisplayExt for TextDisplay

impl DisplayExt for TextEditor