Trait ButtonExt

Source

pub trait ButtonExt:
    IsA<Button>
    + Sealed
    + 'static {
Show 24 methods    // Provided methods
    fn clicked(&self) { ... }
    fn must_always_show_image(&self) -> bool { ... }
    fn event_window(&self) -> Option<Window> { ... }
    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_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

Provided Methods§

Source

fn clicked(&self)

Emits a clicked signal to the given Button.

Source

fn must_always_show_image(&self) -> bool

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

§Returns

true if the button will always show the image

Source

fn event_window(&self) -> Option<Window>

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

§Returns

self’s event window.

Source

fn image(&self) -> Option<Widget>

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

Source

fn image_position(&self) -> PositionType

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

§Returns

the position

Source

fn label(&self) -> Option<GString>

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.

Source

fn relief(&self) -> ReliefStyle

Returns the current relief style of the given Button.

§Returns

The current ReliefStyle

Source

fn uses_underline(&self) -> bool

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.

Source

fn set_always_show_image(&self, always_show: bool)

If true, the button will ignore the 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

Source

fn set_image(&self, image: Option<&impl IsA<Widget>>)

Set the image of self to the given widget. The image will be displayed if the label text is None or if 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

Source

fn set_image_position(&self, position: PositionType)

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

§`position`

the position

Source

fn set_label(&self, label: &str)

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

Source

fn set_relief(&self, relief: ReliefStyle)

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

Source

fn set_use_underline(&self, use_underline: bool)

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

Source

fn connect_activate<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

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 clicked signal.

Source