Struct fltk::text::TextEditor

pub struct TextEditor { /* fields omitted */ }

Creates an editable text display widget

Implementations

impl TextEditor

pub fn set_insert_mode(&mut self, b: bool)

Set to insert mode

pub fn insert_mode(&self) -> bool

Returns whether insert mode is set

pub fn set_tab_nav(&mut self, val: bool)

Set tab navigation

pub fn tab_nav(&self) -> bool

Returns whether tab navigation is set

pub fn copy(&self)

Copies the text within the TextEditor widget

pub fn cut(&self)

Cuts the text within the TextEditor widget

pub fn paste(&self)

Pastes text from the clipboard into the TextEditor widget

pub fn undo(&self)

Undo changes in the TextEditor widget

pub fn kf_default(&mut self, c: Key)

Inserts the text associated with key 'c'

pub fn kf_ignore(&mut self, c: Key)

Ignores the key 'c' in editor

pub fn kf_backspace(&mut self)

Does a backspace

pub fn kf_enter(&mut self)

Inserts a new line

pub fn kf_move(&mut self, c: Key)

Moves the cursor in the direction indicated by the key

pub fn kf_shift_move(&mut self, c: Key)

Extends the current selection in the direction of key 'c'

pub fn kf_ctrl_move(&mut self, c: Key)

Moves the current text cursor in the direction indicated by control key 'c'

pub fn kf_c_s_move(&mut self, c: Key)

Extends the current selection in the direction indicated by control key 'c'

pub fn kf_meta_move(&mut self, c: Key)

Moves the current text cursor in the direction indicated by meta key 'c'

pub fn kf_m_s_move(&mut self, c: Key)

Extends the current selection in the direction indicated by meta key 'c'

pub fn kf_home(&mut self)

Moves the text cursor to the beginning of the current line

pub fn kf_end(&mut self)

Moves the text cursor to the end of the current line

pub fn kf_left(&mut self)

Moves the text cursor one character to the left

pub fn kf_up(&mut self)

Moves the text cursor one line up

pub fn kf_right(&mut self)

Moves the text cursor one character to the right

pub fn kf_down(&mut self)

Moves the text cursor one line down

pub fn kf_page_up(&mut self)

Moves the text cursor up one page

pub fn kf_page_down(&mut self)

Moves the text cursor down one page

pub fn kf_insert(&mut self)

Toggles the insert mode for the editor

pub fn kf_delete(&mut self)

Does a delete of selected text or the current character in the current buffer

pub fn kf_select_all(&mut self)

Selects all text in the associated buffer

Trait Implementations

impl Clone for TextEditor

fn clone(&self) -> TextEditor

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TextEditor

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

Formats the value using the given formatter.

impl DisplayExt for TextEditor

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

Get the associated TextBuffer

fn set_buffer(&mut self, buffer: Option<TextBuffer>)

Sets the associated 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) -> u32

Return the text size

fn set_text_size(&mut self, sz: u32)

Sets the text size

fn scroll(&mut self, topLineNum: u32, horizOffset: u32)

Scroll down the Display widget

fn insert(&self, text: &str)

Insert into Display widget

fn set_insert_position(&mut self, newPos: u32)

Set the insert position

fn insert_position(&self) -> u32

Return the insert position

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

Gets the x and y positions of the cursor

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

Counts the lines from start to end

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

Moves the cursor right

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

Moves the cursor left

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

Moves the cursor up

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

Moves the cursor down

fn show_cursor(&mut self, val: bool)

Shows/hides the cursor

fn set_highlight_data(
    &mut self,
    style_buffer: TextBuffer,
    entries: Vec<StyleTableEntry>
) -> StyleTables

Sets the style of the text widget

fn set_cursor_style(&mut self, style: TextCursor)

Sets the cursor style

fn set_cursor_color(&mut self, color: Color)

Sets the cursor color

fn set_scrollbar_width(&mut self, width: i32)

Sets the scrollbar width

fn set_scrollbar_size(&mut self, size: u32)

Sets the scrollbar size in pixels

fn set_scrollbar_align(&mut self, align: Align)

Sets the scrollbar alignment

fn cursor_style(&self) -> TextCursor

Returns the cursor style

fn cursor_color(&self) -> Color

Returns the cursor color

fn scrollbar_width(&self) -> u32

Returns the scrollback width

fn scrollbar_size(&self) -> u32

Returns the scrollbar size in pixels

fn scrollbar_align(&self) -> Align

Returns the scrollbar alignment

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

Returns the beginning of the line from the current position

fn line_end(&self, start_pos: u32, is_line_start: bool) -> u32

Returns the ending of the line from the current position

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

Skips lines from start_pos

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

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: u32) -> u32

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

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

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: u32)

Sets the linenumber size

fn linenumber_size(&self) -> u32

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

impl Send for TextEditor

impl Sync for TextEditor

impl WidgetExt for TextEditor

fn new(x: i32, y: i32, width: i32, height: i32, title: &str) -> TextEditor

Creates a new widget, takes an x, y coordinates, as well as a width and height, plus a title

fn default() -> Self

Creates a default and zero initialized widget

fn with_pos(self, x: i32, y: i32) -> Self

Initialize to position x, y

fn with_size(self, width: i32, height: i32) -> Self

Initialilze to dimensions width and height

fn set_pos(&mut self, x: i32, y: i32)

Set to position x, y

fn set_size(&mut self, width: i32, height: i32)

Set to dimensions width and height

fn with_label(self, title: &str) -> Self

Initialize with label/title

fn with_align(self, align: Align) -> Self

Sets the initial alignment of the widget

fn set_label(&mut self, title: &str)

Sets the widget's label

fn redraw(&mut self)

Redraws a widget, necessary for resizing and changing positions

fn show(&mut self)

Shows the widget

fn hide(&mut self)

Hides the widget

fn x(&self) -> i32

Returns the x coordinate of the widget

fn y(&self) -> i32

Returns the y coordinate of the widget

fn width(&self) -> i32

Returns the width of the widget

fn height(&self) -> i32

Returns the height of the widget

fn label(&self) -> String

Returns the label of the widget

unsafe fn as_widget_ptr(&self) -> *mut Fl_Widget

transforms a widget to a base Fl_Widget, for internal use

unsafe fn from_widget_ptr(ptr: *mut Fl_Widget) -> Self

transforms a widget pointer to a Widget, for internal use

fn activate(&mut self)

Activates the widget

fn deactivate(&mut self)

Deactivates the widget

fn redraw_label(&mut self)

Redraws the label of the widget

fn resize(&mut self, x: i32, y: i32, width: i32, height: i32)

Resizes and/or moves the widget, takes x, y, width and height

fn tooltip(&self) -> Option<String>

Returns the tooltip text

fn set_tooltip(&mut self, txt: &str)

Sets the tooltip text

fn get_type<T: WidgetType>(&self) -> T

Returns the widget type when applicable

fn set_type<T: WidgetType>(&mut self, typ: T)

Sets the widget type

fn color(&self) -> Color

Returns the widget color

fn set_color(&mut self, color: Color)

Sets the widget's color

fn label_color(&self) -> Color

Returns the widget label's color

fn set_label_color(&mut self, color: Color)

Sets the widget label's color

fn label_font(&self) -> Font

Returns the widget label's font

fn set_label_font(&mut self, font: Font)

Sets the widget label's font

fn label_size(&self) -> i32

Returns the widget label's size

fn set_label_size(&mut self, sz: i32)

Sets the widget label's size

fn label_type(&self) -> LabelType

Returns the widget label's type

fn set_label_type(&mut self, typ: LabelType)

Sets the widget label's type

fn frame(&self) -> FrameType

Returns the widget's frame type

fn set_frame(&mut self, typ: FrameType)

Sets the widget's frame type

fn changed(&self) -> bool

Returns whether the widget was changed

fn set_changed(&mut self)

Mark the widget as changed

fn clear_changed(&mut self)

Clears the changed status of the widget

fn align(&self) -> Align

Returns the alignment of the widget

fn set_align(&mut self, align: Align)

Sets the alignment of the widget

fn set_image<I: ImageExt>(&mut self, image: Option<I>)

Sets the image of the widget

fn image(&self) -> Option<Image>

Gets the image associated with the widget

fn set_deimage<I: ImageExt>(&mut self, image: Option<I>)

Sets the image of the widget

fn deimage(&self) -> Option<Image>

Gets the image associated with the widget

fn set_callback(&mut self, cb: Box<dyn FnMut()>)

Sets the callback when the widget is triggered (clicks for example)

unsafe fn unset_callback(&mut self)

INTERNAL: Unset the defined callback

fn handle(&mut self, cb: Box<dyn FnMut(Event) -> bool>)

Set a custom handler, where events are managed manually, akin to Fl_Widget::handle(int) Handled or ignored events shoult return true, unhandled events should return false

fn draw(&mut self, cb: Box<dyn FnMut()>)

Set a custom draw method

fn set_trigger(&mut self, trigger: CallbackTrigger)

Sets the default callback trigger for a widget

fn below_of<W: WidgetExt>(self, w: &W, padding: i32) -> Self

Positions the widget below w

fn above_of<W: WidgetExt>(self, w: &W, padding: i32) -> Self

Positions the widget above w

fn right_of<W: WidgetExt>(self, w: &W, padding: i32) -> Self

Positions the widget to the right of w

fn left_of<W: WidgetExt>(self, w: &W, padding: i32) -> Self

Positions the widget to the left of w

fn center_of<W: WidgetExt>(self, w: &W) -> Self

Positions the widget to the center of w

fn size_of<W: WidgetExt>(self, w: &W) -> Self

Takes the size of w

fn parent(&self) -> Option<Widget>

Returns the parent of the widget

fn selection_color(&mut self) -> Color

Gets the selection color of the widget

fn set_selection_color(&mut self, color: Color)

Sets the selection color of the widget

fn do_callback(&mut self)

Runs the already registered callback

fn inside(&self, wid: Widget) -> bool

Checks whether the self widget is inside another widget

fn window(&self) -> Option<Window>

Returns the direct window holding the widget

fn top_window(&self) -> Option<Window>

Returns the topmost window holding the widget

fn takes_events(&self) -> bool

Checks whether a widget is capable of taking events

fn emit<T: 'static + Copy + Send + Sync>(&mut self, sender: Sender<T>, msg: T)

Emits a message on callback using a sender

unsafe fn user_data(&self) -> Option<Box<dyn FnMut()>>

INTERNAL: Retakes ownership of the user callback data

unsafe fn set_user_data(&mut self, data: *mut c_void)

INTERNAL: Manually set the user data

unsafe fn raw_user_data(&self) -> *mut c_void

INTERNAL: Retakes ownership of the user callback data

fn delete(&mut self)

Manually delete a widget

unsafe fn unsafe_delete(&mut self)

Manually delete a widget and recursively force-cleans capturing callbacks

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

Make the widget take focus

fn set_visible_focus(&mut self)

Set the widget to have visible focus

fn clear_visible_focus(&mut self)

Clear visible focus

fn visible_focus(&mut self, v: bool)

Set the visible focus using a flag

fn has_visible_focus(&mut self) -> bool

Return whether the widget has visible focus

fn was_deleted(&self) -> bool

Check if a widget was deleted

unsafe fn cleanup(&mut self)

INTERNAL: Cleanup after widget deletion

unsafe fn draw_data(&mut self) -> Option<Box<dyn FnMut()>>

INTERNAL: Retrieve the draw data

unsafe fn set_draw_data(&mut self, data: *mut c_void)

INTERNAL: Manually set the draw data

unsafe fn unset_draw_callback(&mut self)

INTERNAL: Unset the draw callback

fn damage(&self) -> bool

Return whether the widget was damaged

fn set_damage(&mut self, flag: bool)

Signal the widget as damaged and it should be redrawn in the next event loop cycle

fn clear_damage(&mut self)

Clear the damaged flag

fn as_window(&mut self) -> Option<Window>

Return the widget as a window if it's a window

fn as_group(&mut self) -> Option<Group>

Return the widget as a group widget if it's a group widget