Struct rstk::check_button::TkCheckButton

pub struct TkCheckButton {
    pub id: String,
    // some fields omitted
}

Refers to a check-button widget

Fields

id: String

Implementations

impl TkCheckButton

pub fn command(&self, command: impl Fn(bool) + Send + 'static)

Sets the function to be called when the button is clicked. This function takes one boolean parameter, which is the new state of the check button.

pub fn invoke(&self)

Toggles the button’s state and calls the button’s command, as if it were clicked.

pub fn is_selected(&self) -> bool

Returns true/false if button is selected (checked) or not.

pub fn selected(&self, value: bool)

Sets the selected (checked) state.

pub fn state(&self, value: State)

Sets the state of the button, usually normal (clickable) or disabled (unclickable).

Trait Implementations

impl Clone for TkCheckButton

fn clone(&self) -> TkCheckButton

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TkCheckButton

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

Formats the value using the given formatter.

impl PartialEq<TkCheckButton> for TkCheckButton

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

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

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

This method tests for !=.

impl TkGridLayout for TkCheckButton

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 TkLabelOptions for TkCheckButton

fn compound(&self, value: Compound)

Sets how to arrange the image relative to the text.

fn font(&self, definition: &TkFont)

Sets the font to use for text.

fn foreground(&self, colour: &str)

Sets the foreground (text) colour.

fn image(&self, image: &TkImage)

Sets an image to display on the widget.

fn padding(&self, values: &[u64])

Sets space around the widget. Takes an array of up to four values, specifying the number of pixels on the different sides:

fn text(&self, value: &str)

Sets the text label for the widget.

fn underline(&self, index: u64)

Underlines the character at the given index position.

fn width(&self, value: i64)

Sets the width of the widget, in characters

impl TkPackLayout for TkCheckButton

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 TkCheckButton

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 TkCheckButton