Trait gtk::prelude::ButtonExt

source · [−]
pub trait ButtonExt: 'static {

Show 26 methods    fn clicked(&self);
    fn must_always_show_image(&self) -> bool;
    fn event_window(&self) -> Option<Window>;
    fn gets_focus_on_click(&self) -> bool;
    fn image(&self) -> Option<Widget>;
    fn image_position(&self) -> PositionType;
    fn label(&self) -> Option<GString>;
    fn relief(&self) -> ReliefStyle;
    fn uses_underline(&self) -> bool;
    fn set_always_show_image(&self, always_show: bool);
    fn set_focus_on_click(&self, focus_on_click: bool);
    fn set_image(&self, image: Option<&impl IsA<Widget>>);
    fn set_image_position(&self, position: PositionType);
    fn set_label(&self, label: &str);
    fn set_relief(&self, relief: ReliefStyle);
    fn set_use_underline(&self, use_underline: bool);
    fn connect_activate<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId;
    fn emit_activate(&self);
    fn connect_clicked<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId;
    fn emit_clicked(&self);
    fn connect_always_show_image_notify<F: Fn(&Self) + 'static>(
        &self, 
        f: F
    ) -> SignalHandlerId;
    fn connect_image_notify<F: Fn(&Self) + 'static>(
        &self, 
        f: F
    ) -> SignalHandlerId;
    fn connect_image_position_notify<F: Fn(&Self) + 'static>(
        &self, 
        f: F
    ) -> SignalHandlerId;
    fn connect_label_notify<F: Fn(&Self) + 'static>(
        &self, 
        f: F
    ) -> SignalHandlerId;
    fn connect_relief_notify<F: Fn(&Self) + 'static>(
        &self, 
        f: F
    ) -> SignalHandlerId;
    fn connect_use_underline_notify<F: Fn(&Self) + 'static>(
        &self, 
        f: F
    ) -> SignalHandlerId;

}
Expand description

Trait containing all Button methods.

Implementors

Button, ColorButton, FontButton, LinkButton, LockButton, ModelButton, ScaleButton, ToggleButton

Required Methods

Emits a signal::Button::clicked signal to the given Button.

Returns whether the button will ignore the property::Settings::gtk-button-images setting and always show the image, if available.

Returns

true if the button will always show the image

Returns the button’s event window if it is realized, None otherwise. This function should be rarely needed.

Returns

self’s event window.

Available on non-crate feature v3_20 only.

Returns whether the button grabs focus when it is clicked with the mouse. See set_focus_on_click().

Deprecated since 3.20

Use WidgetExt::gets_focus_on_click() instead

Returns

true if the button grabs focus when it is clicked with the mouse.

Gets the widget that is currenty set as the image of self. This may have been explicitly set by set_image() or constructed by gtk_button_new_from_stock().

Returns

a Widget or None in case there is no image

Gets the position of the image relative to the text inside the button.

Returns

the position

Fetches the text from the label of the button, as set by set_label(). If the label text has not been set the return value will be None. This will be the case if you create an empty button with Button::new() to use as a container.

Returns

The text of the label widget. This string is owned by the widget and must not be modified or freed.

Returns the current relief style of the given Button.

Returns

The current ReliefStyle

Returns whether an embedded underline in the button label indicates a mnemonic. See gtk_button_set_use_underline ().

Returns

true if an embedded underline in the button label indicates the mnemonic accelerator keys.

If true, the button will ignore the property::Settings::gtk-button-images setting and always show the image, if available.

Use this property if the button would be useless or hard to use without the image.

always_show

true if the menuitem should always show the image

Available on non-crate feature v3_20 only.

Sets whether the button will grab focus when it is clicked with the mouse. Making mouse clicks not grab focus is useful in places like toolbars where you don’t want the keyboard focus removed from the main area of the application.

Deprecated since 3.20

Use WidgetExt::set_focus_on_click() instead

focus_on_click

whether the button grabs focus when clicked with the mouse

Set the image of self to the given widget. The image will be displayed if the label text is None or if property::Button::always-show-image is true. You don’t have to call WidgetExt::show() on image yourself.

image

a widget to set as the image for the button, or None to unset

Sets the position of the image relative to the text inside the button.

position

the position

Sets the text of the label of the button to str. This text is also used to select the stock item if gtk_button_set_use_stock() is used.

This will also clear any previously set labels.

label

a string

Sets the relief style of the edges of the given Button widget. Two styles exist, ReliefStyle::Normal and ReliefStyle::None. The default style is, as one can guess, ReliefStyle::Normal. The deprecated value ReliefStyle::Half behaves the same as ReliefStyle::Normal.

relief

The GtkReliefStyle as described above

If true, an underline in the text of the button label indicates the next character should be used for the mnemonic accelerator key.

use_underline

true if underlines in the text indicate mnemonics

The ::activate signal on GtkButton is an action signal and emitting it causes the button to animate press then release. Applications should never connect to this signal, but use the signal::Button::clicked signal.

Emitted when the button has been activated (pressed and released).

Implementors