Struct gtk::Button

#[repr(transparent)]
pub struct Button { /* private fields */ }

The Button widget is generally used to trigger a callback function that is called when the button is pressed. The various signals and how to use them are outlined below.

The Button widget can hold any valid child widget. That is, it can hold almost any other standard Widget. The most commonly used child is the Label.

CSS nodes

GtkButton has a single CSS node with name button. The node will get the style classes .image-button or .text-button, if the content is just an image or label, respectively. It may also receive the .flat style class.

Other style classes that are commonly used with GtkButton include .suggested-action and .destructive-action. In special cases, buttons can be made round by adding the .circular style class.

Button-like widgets like ToggleButton, MenuButton, VolumeButton, LockButton, ColorButton, FontButton or FileChooserButton use style classes such as .toggle, .popup, .scale, .lock, .color, .font, .file to differentiate themselves from a plain GtkButton.

Implements

ButtonExt, BinExt, ContainerExt, WidgetExt, glib::ObjectExt, BuildableExt, ActionableExt, ContainerExtManual, WidgetExtManual, BuildableExtManual

Implementations

impl Button

pub const NONE: Option<&'static Button> = None

pub fn new() -> Button

Creates a new Button widget. To add a child widget to the button, use ContainerExt::add().

Returns

The newly created Button widget.

pub fn from_icon_name(icon_name: Option<&str>, size: IconSize) -> Button

Creates a new button containing an icon from the current icon theme.

If the icon name isn’t known, a “broken image” icon will be displayed instead. If the current icon theme is changed, the icon will be updated appropriately.

This function is a convenience wrapper around new() and ButtonExt::set_image().

icon_name

an icon name or None

size

an icon size (IconSize)

Returns

a new Button displaying the themed icon

pub fn with_label(label: &str) -> Button

Creates a Button widget with a Label child containing the given text.

label

The text you want the Label to hold.

Returns

The newly created Button widget.

pub fn with_mnemonic(label: &str) -> Button

Creates a new Button containing a label. If characters in label are preceded by an underscore, they are underlined. If you need a literal underscore character in a label, use “__” (two underscores). The first underlined character represents a keyboard accelerator called a mnemonic. Pressing Alt and that key activates the button.

label

The text of the button, with an underscore in front of the mnemonic character

Returns

a new Button

pub fn builder() -> ButtonBuilder

Creates a new builder-pattern struct instance to construct Button objects.

This method returns an instance of ButtonBuilder which can be used to create Button objects.

Trait Implementations

impl Clone for Button

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Button

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

Formats the value using the given formatter.

impl Default for Button

fn default() -> Self

Returns the “default value” for a type.

impl Display for Button

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

Formats the value using the given formatter.

impl Hash for Button

fn hash<H>(&self, state: &mut H)where
    H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given Hasher.

impl<T: ButtonImpl> IsSubclassable<T> for Button

fn class_init(class: &mut Class<Self>)

Override the virtual methods of this class for the given subclass and do other class initialization.

fn instance_init(instance: &mut InitializingObject<T>)

Instance specific initialization.

impl Ord for Button

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

const fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

const fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for Button

type Parent = Bin

impl<OT: ObjectType> PartialEq<OT> for Button

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for Button

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

const fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

const fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

const fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

const fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Button

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Button

impl IsA<Actionable> for Button

impl IsA<Bin> for Button

impl IsA<Buildable> for Button

impl IsA<Button> for CheckButton

impl IsA<Button> for ColorButton

impl IsA<Button> for FontButton

impl IsA<Button> for LinkButton

impl IsA<Button> for LockButton

impl IsA<Button> for MenuButton

impl IsA<Button> for ModelButton

impl IsA<Button> for RadioButton

impl IsA<Button> for ScaleButton

impl IsA<Button> for ToggleButton

impl IsA<Button> for VolumeButton

impl IsA<Container> for Button

impl IsA<Widget> for Button