Struct fltk::text::TextDisplay

pub struct TextDisplay { /* fields omitted */ }

Creates a non-editable text display widget

Implementations

impl TextDisplay

pub fn new(x: i32, y: i32, w: i32, h: i32, buf: &mut TextBuffer) -> TextDisplay

Create an new TextDisplay widget

pub fn default(buf: &mut TextBuffer) -> TextDisplay

Creates a default and zero initialized TextDisplay

Trait Implementations

impl Debug for TextDisplay

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

Formats the value using the given formatter.

impl DisplayExt for TextDisplay

fn buffer<'a>(&'a self) -> &'a mut TextBuffer

Get the associated TextBuffer

fn set_buffer<'a>(&'a mut self, buffer: &'a mut 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)

Moves the cursor right

fn move_left(&mut self)

Moves the cursor left

fn move_up(&mut self)

Moves the cursor up

fn move_down(&mut self)

Moves the cursor down

fn show_cursor(&mut self, val: bool)

Shows/hides the cursor

fn set_styly_table_entry(
    &mut self,
    style_buffer: &mut TextBuffer,
    entries: &Vec<StyleTableEntry>
)

Sets the style of the text widget

fn set_cursor_style(&mut self, style: CursorStyle)

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) -> CursorStyle

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 From<Widget> for TextDisplay

fn from(wid: Widget) -> Self

Performs the conversion.

impl Send for TextDisplay

impl Sync for TextDisplay

impl WidgetExt for TextDisplay

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

Creates a new widget, takes an x, y coordinates, as well as a width and height, plus a title # Arguments * x - The x coordinate in the screen * y - The y coordinate in the screen * width - The width of the widget * heigth - The height of the widget * title - The title or label of the widget

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 with_label(self, title: &str) -> Self

Initialize with label/title

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

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<T: WidgetType>(&self) -> T

Returns the widget label's type

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

Sets the widget label's type

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

Returns the widget's frame type

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

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<Image: ImageExt>(&mut self, image: &Image)

Sets the image of the widget

fn set_image_with_size<Image: ImageExt>(
    &mut self,
    image: &Image,
    w: i32,
    h: i32
)

Sets the resized image of the widget

fn image(&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)

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

unsafe fn memcpy(&self) -> TextDisplay

Gets a shallow copy of the widget, an escape hatch!