Struct gtk4::LockButton

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

LockButton is a widget to obtain and revoke authorizations needed to operate the controls.

It is typically used in preference dialogs or control panels.

The required authorization is represented by a GPermission object. Concrete implementations of GPermission may use PolicyKit or some other authorization framework. To obtain a PolicyKit-based GPermission, use polkit_permission_new().

If the user is not currently allowed to perform the action, but can obtain the permission, the widget looks like this:

and the user can click the button to request the permission. Depending on the platform, this may pop up an authentication dialog or ask the user to authenticate in some other way. Once the user has obtained the permission, the widget changes to this:

and the permission can be dropped again by clicking the button. If the user is not able to obtain the permission at all, the widget looks like this:

If the user has the permission and cannot drop it, the button is hidden.

The text (and tooltips) that are shown in the various cases can be adjusted with the property::LockButton::text-lock, property::LockButton::text-unlock, property::LockButton::tooltip-lock, property::LockButton::tooltip-unlock and property::LockButton::tooltip-not-authorized properties.

Implements

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

Implementations

impl LockButton

pub fn new(permission: Option<&impl IsA<Permission>>) -> LockButton

Creates a new lock button which reflects the @permission.

permission

a GPermission

Returns

a new LockButton

pub fn builder() -> LockButtonBuilder

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

This method returns an instance of LockButtonBuilder which can be used to create LockButton objects.

pub fn permission(&self) -> Option<Permission>

Obtains the GPermission object that controls @self.

Returns

the GPermission of @self

pub fn set_permission(&self, permission: Option<&impl IsA<Permission>>)

Sets the GPermission object that controls @self.

permission

a GPermission object

pub fn text_lock(&self) -> Option<GString>

The text to display when prompting the user to lock.

pub fn set_text_lock(&self, text_lock: Option<&str>)

The text to display when prompting the user to lock.

pub fn text_unlock(&self) -> Option<GString>

The text to display when prompting the user to unlock.

pub fn set_text_unlock(&self, text_unlock: Option<&str>)

The text to display when prompting the user to unlock.

pub fn tooltip_lock(&self) -> Option<GString>

The tooltip to display when prompting the user to lock.

pub fn set_tooltip_lock(&self, tooltip_lock: Option<&str>)

The tooltip to display when prompting the user to lock.

pub fn tooltip_not_authorized(&self) -> Option<GString>

The tooltip to display when the user cannot obtain authorization.

pub fn set_tooltip_not_authorized(&self, tooltip_not_authorized: Option<&str>)

The tooltip to display when the user cannot obtain authorization.

pub fn tooltip_unlock(&self) -> Option<GString>

The tooltip to display when prompting the user to unlock.

pub fn set_tooltip_unlock(&self, tooltip_unlock: Option<&str>)

The tooltip to display when prompting the user to unlock.

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

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

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

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

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

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

Trait Implementations

impl Clone for LockButton

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 LockButton

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

Formats the value using the given formatter.

impl Default for LockButton

fn default() -> Self

Returns the “default value” for a type.

impl Display for LockButton

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

Formats the value using the given formatter.

impl Hash for LockButton

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 LockButton

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 LockButton

type Parent = Button

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

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 LockButton

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 LockButton

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for LockButton

impl IsA<Accessible> for LockButton

impl IsA<Actionable> for LockButton

impl IsA<Buildable> for LockButton

impl IsA<Button> for LockButton

impl IsA<ConstraintTarget> for LockButton

impl IsA<Widget> for LockButton