Struct libhelium::Button

pub struct Button { /* private fields */ }

A class to derive UI Buttons from.

Since: 1.0

Properties

color

Readable | Writeable

is-disclosure

Readable | Writeable

is-iconic

Readable | Writeable

is-outline

Readable | Writeable

is-tint

Readable | Writeable

is-fill

Readable | Writeable

is-pill

Readable | Writeable

is-textual

Readable | Writeable

icon

Readable | Writeable

text

Readable | Writeable

Button

can-shrink

Whether the size of the button can be made smaller than the natural size of its contents.

For text buttons, setting this property will allow ellipsizing the label.

If the contents of a button are an icon or a custom widget, setting this property has no effect.

Readable | Writeable

child

The child widget.

Readable | Writeable

has-frame

Whether the button has a frame.

Readable | Writeable

icon-name

The name of the icon used to automatically populate the button.

Readable | Writeable

label

Text of the label inside the button, if the button contains a label widget.

Readable | Writeable

use-underline

If set, an underline in the text indicates that the following character is to be used as mnemonic.

Readable | Writeable

Widget

can-focus

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

can-target

Whether the widget can receive pointer events.

Readable | Writeable

css-classes

A list of css classes applied to this widget.

Readable | Writeable

css-name

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable | Construct Only

cursor

The cursor used by @widget.

Readable | Writeable

focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

Readable | Writeable

focusable

Whether this widget itself will accept the input focus.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

has-default

Whether the widget is the default widget.

Readable

has-focus

Whether the widget has the input focus.

Readable

has-tooltip

Enables or disables the emission of the ::query-tooltip signal on @widget.

A value of true indicates that @widget can have a tooltip, in this case the widget will be queried using [query-tooltip][struct@crate::gtk::Widget#query-tooltip] to determine whether it will provide a tooltip or not.

Readable | Writeable

height-request

Override for height request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

hexpand

Whether to expand horizontally.

Readable | Writeable

hexpand-set

Whether to use the hexpand property.

Readable | Writeable

layout-manager

The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

margin-bottom

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable

margin-end

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable

margin-start

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable

margin-top

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable

name

The name of the widget.

Readable | Writeable

opacity

The requested opacity of the widget.

Readable | Writeable

overflow

How content outside the widget’s content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

parent

The parent widget of this widget.

Readable

receives-default

Whether the widget will receive the default action when it is focused.

Readable | Writeable

root

The [gtk::Root][crate::gtk::Root] widget of the widget tree containing this widget.

This will be None if the widget is not contained in a root widget.

Readable

scale-factor

The scale factor of the widget.

Readable

sensitive

Whether the widget responds to input.

Readable | Writeable

tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see Gtk::Tooltip::set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: [has-tooltip][struct@crate::gtk::Widget#has-tooltip] will automatically be set to true and there will be taken care of [query-tooltip][struct@crate::gtk::Widget#query-tooltip] in the default signal handler.

Note that if both [tooltip-text][struct@crate::gtk::Widget#tooltip-text] and [tooltip-markup][struct@crate::gtk::Widget#tooltip-markup] are set, the last one wins.

Readable | Writeable

tooltip-text

Sets the text of tooltip to be the given string.

Also see Gtk::Tooltip::set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: [has-tooltip][struct@crate::gtk::Widget#has-tooltip] will automatically be set to true and there will be taken care of [query-tooltip][struct@crate::gtk::Widget#query-tooltip] in the default signal handler.

Note that if both [tooltip-text][struct@crate::gtk::Widget#tooltip-text] and [tooltip-markup][struct@crate::gtk::Widget#tooltip-markup] are set, the last one wins.

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space.

Readable | Writeable

vexpand

Whether to expand vertically.

Readable | Writeable

vexpand-set

Whether to use the vexpand property.

Readable | Writeable

visible

Whether the widget is visible.

Readable | Writeable

width-request

Override for width request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

Accessible

accessible-role

The accessible role of the given [gtk::Accessible][crate::gtk::Accessible] implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Actionable

action-name

The name of the action with which this widget should be associated.

Readable | Writeable

action-target

The target value of the actionable widget’s action.

Readable | Writeable

Implements

HeButtonExt, [trait@gtk::prelude::ButtonExt], [trait@gtk::prelude::WidgetExt], [trait@glib::ObjectExt], [trait@gtk::prelude::AccessibleExt], [trait@gtk::prelude::BuildableExt], [trait@gtk::prelude::ConstraintTargetExt], [trait@gtk::prelude::ActionableExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl Button

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

pub fn new(icon: Option<&str>, text: Option<&str>) -> 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

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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 HasParamSpec for Button

type ParamSpec = ParamSpecObject

type SetValue = Button

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Button>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Button

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

where H: Hasher,

Hashes the memory address of this object.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Button

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for Button

type Parent = Button

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

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

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

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

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

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

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

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<Accessible> for Button

impl IsA<Actionable> for Button

impl IsA<Buildable> for Button

impl IsA<Button> for Button

impl IsA<ConstraintTarget> for Button

impl IsA<Widget> for Button