Struct fltk::misc::HelpView

pub struct HelpView { /* fields omitted */ }

Creates a HelpView widget

Implementations

impl HelpView

pub fn directory(&self) -> PathBuf

Return the directory

pub fn filename(&self) -> PathBuf

Return the filename

pub fn find(&self, s: &str, start_from: usize) -> Option<usize>

Find a string, returns the index

pub fn value(&self) -> Option<String>

Get the value of the widget

pub fn set_value(&mut self, val: &str)

Set value of the widget

pub fn clear_selection(&mut self)

Clear selection

pub fn select_all(&mut self)

Select all

pub fn set_topline(&mut self, n: &str)

Set the topline string

pub fn set_topline2(&mut self, arg1: i32)

Set the leftline position

pub fn topline(&self) -> i32

Get the topline position

pub fn set_leftline(&mut self, arg1: i32)

Set the leftline position

pub fn leftline(&self) -> i32

Gets the current leftline in pixels

pub fn text_font(&self) -> Font

Gets the text font

pub fn set_text_font(&mut self, f: Font)

Sets the text font

pub fn text_size(&self) -> u32

Gets the text size

pub fn set_text_size(&mut self, s: u32)

Sets the text size

pub fn text_color(&self) -> Color

Gets the text's color

pub fn set_text_color(&mut self, color: Color)

Sets the text's color

pub fn scrollbar_size(&self) -> u32

Gets the scrollbar size

pub fn set_scrollbar_size(&mut self, new_size: u32)

Sets the scrollbar size

pub fn load(&mut self, f: &str) -> Result<(), FltkError>

Load a view from a file or URI

Trait Implementations

impl Clone for HelpView

fn clone(&self) -> HelpView

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HelpView

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

Formats the value using the given formatter.

impl Default for HelpView

fn default() -> Self

Returns the "default value" for a type.

impl Send for HelpView

impl Sync for HelpView

impl WidgetBase for HelpView

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

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

fn delete(mut wid: Self)

Deletes widgets and their children.

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

transforms a widget pointer to a Widget, for internal use

unsafe fn from_widget<W: WidgetExt>(w: W) -> Self

Get a widget from base widget

fn handle<F: FnMut(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 shoult return true, unhandled events should return false

fn handle2<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 shoult return true, unhandled events should return false takes the widget as a closure argument

fn draw<F: FnMut() + 'static>(&mut self, cb: F)

Set a custom draw method

fn draw2<F: FnMut(&mut Self) + 'static>(&mut self, cb: F)

Set a custom draw method takes the widget as a closure argument

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

INTERNAL: Retrieve the draw data

unsafe fn handle_data(&mut self) -> Option<Box<dyn FnMut(Event) -> bool>>

INTERNAL: Retrieve the handle data

impl WidgetExt for HelpView

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 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 measure_label(&self) -> (i32, i32)

Measures the label's width and height

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

transforms a widget to a base Fl_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 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_trigger(&mut self, trigger: CallbackTrigger)

Sets the default callback trigger for a widget

fn trigger(&self) -> CallbackTrigger

Return the callback trigger

fn parent(&self) -> Option<Box<dyn GroupExt>>

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 window(&self) -> Option<Box<dyn WindowExt>>

Returns the direct window holding the widget

fn top_window(&self) -> Option<Box<dyn WindowExt>>

Returns the topmost window holding the widget

fn takes_events(&self) -> bool

Checks whether a widget is capable of taking events

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

INTERNAL: Retakes ownership of the user callback data

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

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(&self) -> Option<Box<dyn WindowExt>>

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

fn as_group(&self) -> Option<Box<dyn GroupExt>>

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

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

Positions the widget below w, the size of w should be known

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

Positions the widget above w, the size of w should be known

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

Positions the widget to the right of w, the size of w should be known

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

Positions the widget to the left of w, the size of w should be known

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

Positions the widget to the center of w, the size of w should be known

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

Takes the size of w, the size of w should be known

fn inside<W: WidgetExt>(&self, wid: &W) -> bool

Checks whether the self widget is inside another widget

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

Initialize to position x, y, (should only be called on initialization)

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

Initialilze to dimensions width and height, (should only be called on initialization)

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

Initialize with label/title, (should only be called on initialization)

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

Sets the initial alignment of the widget, (should only be called on initialization)

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

Sets the image of the widget

fn image(&self) -> Option<Box<dyn ImageExt>>

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<Box<dyn ImageExt>>

Gets the image associated with the widget

fn set_callback<F: FnMut() + 'static>(&mut self, cb: F)

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

fn set_callback2<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

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

Emits a message on callback using a sender

unsafe fn into_widget<W: WidgetBase>(&self) -> W where
    Self: Sized, 

Upcast a WidgetExt to a Widget