Struct gtk4::LinkButton

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

A LinkButton is a button with a hyperlink.

It is useful to show quick links to resources.

A link button is created by calling either new() or with_label(). If using the former, the URI you pass to the constructor is used as a label for the widget.

The URI bound to a LinkButton can be set specifically using set_uri().

By default, LinkButton calls show_uri() when the button is clicked. This behaviour can be overridden by connecting to the signal::LinkButton::activate-link signal and returning true from the signal handler.

CSS nodes

LinkButton has a single CSS node with name button. To differentiate it from a plain Button, it gets the .link style class.

Accessibility

LinkButton uses the AccessibleRole::Link role.

Implements

ButtonExt, WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, ActionableExt, WidgetExtManual, AccessibleExtManual, ActionableExtManual

Implementations

impl LinkButton

pub fn new(uri: &str) -> LinkButton

Creates a new LinkButton with the URI as its text.

uri

a valid URI

Returns

a new link button widget.

pub fn with_label(uri: &str, label: &str) -> LinkButton

Creates a new LinkButton containing a label.

uri

a valid URI

label

the text of the button

Returns

a new link button widget.

pub fn builder() -> LinkButtonBuilder

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

This method returns an instance of LinkButtonBuilder which can be used to create LinkButton objects.

pub fn uri(&self) -> GString

Retrieves the URI of the LinkButton.

Returns

a valid URI. The returned string is owned by the link button and should not be modified or freed.

pub fn is_visited(&self) -> bool

Retrieves the “visited” state of the LinkButton.

The button becomes visited when it is clicked. If the URI is changed on the button, the “visited” state is unset again.

The state may also be changed using set_visited().

Returns

true if the link has been visited, false otherwise

pub fn set_uri(&self, uri: &str)

Sets @uri as the URI where the LinkButton points.

As a side-effect this unsets the “visited” state of the button.

uri

a valid URI

pub fn set_visited(&self, visited: bool)

Sets the “visited” state of the LinkButton.

See is_visited() for more details.

visited

the new “visited” state

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

Emitted each time the LinkButton is clicked.

The default handler will call show_uri() with the URI stored inside the property::LinkButton::uri property.

To override the default behavior, you can connect to the ::activate-link signal and stop the propagation of the signal by returning true from your handler.

Returns

true if the signal has been handled

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

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

Trait Implementations

impl Clone for LinkButton

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LinkButton

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

Formats the value using the given formatter.

impl Default for LinkButton

fn default() -> Self

Returns the “default value” for a type.

impl Display for LinkButton

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

Formats the value using the given formatter.

impl Hash for LinkButton

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for LinkButton

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl ParentClassIs for LinkButton

type Parent = Button

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

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

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

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 LinkButton

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

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

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 LinkButton

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for LinkButton

impl IsA<Accessible> for LinkButton

impl IsA<Actionable> for LinkButton

impl IsA<Buildable> for LinkButton

impl IsA<Button> for LinkButton

impl IsA<ConstraintTarget> for LinkButton

impl IsA<Widget> for LinkButton