Struct rstk::text::TkText

pub struct TkText {
    pub id: String,
}

Refers to a text widget

Fields

id: String

Implementations

impl TkText

pub fn background(&self, colour: &str)

Specifies the background colour.

Colours are specified as a string, by either:

• name - using one of the values in the tk colours list
• rgb - as a 6-digit hexadecimal value in form “#RRGGBB”

pub fn border_width(&self, width: u64)

Size of border around widget.

pub fn delete(
    &self,
    (from_line, from_character): (u64, u64),
    (to_line, to_character): (u64, u64)
)

Delete a range of text.

pub fn delete_char(&self, (line, character): (u64, u64))

Delete a single character in text.

pub fn font(&self, definition: &str)

Specifies the font to use for text.

pub fn foreground(&self, colour: &str)

Specifies the foreground (text) colour.

Colours are specified as a string, by either:

• name - using one of the values in the tk colours list
• rgb - as a 6-digit hexadecimal value in form “#RRGGBB”

pub fn get(
    &self,
    (from_line, from_character): (u64, u64),
    (to_line, to_character): (u64, u64)
) -> String

Get a range of text.

pub fn get_to_end(&self, (from_line, from_character): (u64, u64)) -> String

Get a range of text from a position to end.

pub fn height(&self, height: u64)

Height of text, in rows

pub fn insert(&self, (line, character): (u64, u64), text: &str)

Insert at given (line, character) position of text.

pub fn insert_end(&self, text: &str)

Inserts at end of text.

pub fn insert_end_with_tags(&self, text: &str, tags: &[&str])

Inserts at end of text, with given tags.

pub fn insert_image(&self, (line, character): (u64, u64), image: &TkImage)

Inserts an image at given (line, character) position of text.

pub fn insert_widget(
    &self,
    (line, character): (u64, u64),
    widget: &impl TkWidget
)

Inserts a Tk widget at given (line, character) position of text.

pub fn insert_with_tags(
    &self,
    (line, character): (u64, u64),
    text: &str,
    tags: &[&str]
)

Insert at given (line, character) position of text, with given tags.

pub fn mark_gravity_left(&self, mark: &str)

Sets named mark’s gravity to left.

pub fn mark_gravity_right(&self, mark: &str)

Sets named mark’s gravity to right.

pub fn mark_index(&self, mark: &str) -> (u64, u64)

Returns a (line, character) tuple for the given mark’s position.

pub fn mark_names(&self) -> Vec<String>

Returns a list of all the mark names defined in this text widget.

pub fn mark_next(&self, (line, character): (u64, u64)) -> String

Returns name of next mark from given position.

pub fn mark_previous(&self, (line, character): (u64, u64)) -> String

Returns name of previous mark to given position.

pub fn mark_set(&self, mark: &str, (line, character): (u64, u64))

Sets named mark to given position.

pub fn mark_unset(&self, mark: &str)

Removes named mark.

pub fn padx(&self, value: u64)

Amount of horizontal padding for widget.

pub fn pady(&self, value: u64)

Amount of vertical padding for widget.

pub fn relief(&self, value: Relief)

Style of border around label.

pub fn replace(
    &self,
    (from_line, from_character): (u64, u64),
    (to_line, to_character): (u64, u64),
    text: &str
)

Replaces a range of text with new text.

pub fn search(
    &self,
    text: &str,
    (line, character): (u64, u64)
) -> Option<(u64, u64)>

Searches the text widget from given position for the text, returning an Option type containing either the position of the found text or none.

pub fn see(&self, (line, character): (u64, u64))

Arranges text widget display to ensure the given line, character is visible.

pub fn state(&self, value: State)

Sets the state of the widget (normal or disabled only).

pub fn tag_add(
    &self,
    tag: &str,
    (from_line, from_character): (u64, u64),
    (to_line, to_character): (u64, u64)
)

Associates given tag with text in specified range.

pub fn tag_bind(
    &self,
    tag: &str,
    pattern: &str,
    command: impl Fn(TkEvent) + Send + 'static
)

Binds event to given tag.

pub fn tag_delete(&self, tag: &str)

Deletes a tag.

pub fn tag_configure(&self, tag: &str, option: &str, value: &str)

Formatting is applied to tags using configuration options.

For the available options, see the Tk manual

pub fn tag_names(&self) -> Vec<String>

Returns a list of all the tag names defined in this text widget.

pub fn tag_names_at(&self, (line, character): (u64, u64)) -> Vec<String>

Returns a list of all the tag names defined in this text widget at the given location.

pub fn tag_remove(
    &self,
    tag: &str,
    (from_line, from_character): (u64, u64),
    (to_line, to_character): (u64, u64)
)

De-associates given tag with text in specified range.

pub fn width(&self, width: u64)

Width of text, in columns

pub fn wrap(&self, value: Wrapping)

How wrapping should be performed of long lines.

Trait Implementations

impl Clone for TkText

fn clone(&self) -> TkText

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TkText

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

Formats the value using the given formatter.

impl PartialEq<TkText> for TkText

fn eq(&self, other: &TkText) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &TkText) -> bool

This method tests for !=.

impl TkGridLayout for TkText

fn grid(&self) -> GridLayout

Creates a GridLayout instance for placing this widget within its parent.

fn grid_configure(&self, option: &str, value: &str)

Sets properties for widget layout directly through Tk: see Tk manual for options.

fn grid_forget(&self)

Removes this widget from layout.

impl TkPackLayout for TkText

fn pack(&self) -> PackLayout

Creates a PackLayout instance for placing this widget within its parent

fn pack_configure(&self, option: &str, value: &str)

Sets properties for widget layout

fn pack_forget(&self)

Removes this widget from layout

impl TkWidget for TkText

fn id(&self) -> &str

Returns the widget’s id reference - used within tk

fn bind(&self, pattern: &str, command: impl Fn(TkEvent) + Send + 'static)

Binds a command to this widget to call on given event pattern

fn cget(&self, option: &str) -> String

Retrieve the value of a configuration option as a string.

fn configure(&self, option: &str, value: &str)

Used to change properties of a widget. This function can be used to directly configure the widget using an option-value string pair:

fn destroy(&self)

Destroys a widget and its children.

fn winfo(&self, option: &str) -> String

winfo retrieves information about widget.

fn focus(&self)

Makes this widget the focus window (e.g. for key presses)

fn position_x(&self) -> u64

Returns the widget x position in pixels, within its parent.

fn position_y(&self) -> u64

Returns the widget y position in pixels, within its parent.

fn widget_height(&self) -> u64

Returns the widget height in pixels.

fn widget_width(&self) -> u64

Returns the widget width in pixels.

fn mouse_position(&self) -> (i64, i64)

Returns the position of the mouse on screen of widget as (x,y).

fn mouse_x(&self) -> i64

Gives the x position of the mouse on screen of widget.

fn mouse_y(&self) -> i64

Gives the y position of the mouse on screen of widget.

fn screen_height(&self) -> u64

Height of screen of widget in pixels.

fn screen_height_mm(&self) -> u64

Height of screen of widget in millimetres.

fn screen_width(&self) -> u64

Width of screen of widget in pixels.

fn screen_width_mm(&self) -> u64

Width of screen of widget in millimetres.

fn lower(&self)

Lowers the widget in stacking order.

fn raise(&self)

Raises the widget in stacking order.

fn grid_configure_column(&self, index: u64, option: &str, value: &str)

Sets property for a given column of the grid layout contained within this widget.

fn grid_configure_row(&self, index: u64, option: &str, value: &str)

Sets property for a given row of the grid layout contained within this widget.

impl StructuralPartialEq for TkText