Struct gtk::LockButton

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

GtkLockButton is a widget that can be used in control panels or preference dialogs to allow users to obtain and revoke authorizations needed to operate the controls. The required authorization is represented by a gio::Permission object. Concrete implementations of gio::Permission may use PolicyKit or some other authorization framework. To obtain a PolicyKit-based gio::Permission, 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

LockButtonExt, ButtonExt, BinExt, ContainerExt, WidgetExt, glib::ObjectExt, BuildableExt, ActionableExt, ContainerExtManual, WidgetExtManual, BuildableExtManual

Implementations

impl LockButton

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

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

Creates a new lock button which reflects the permission.

permission

a gio::Permission

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.

Trait Implementations

impl Clone for LockButton

fn clone(&self) -> Self

Returns a copy of the value.

const 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,

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.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: 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 ==.

const 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.

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

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

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

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

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

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

const 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<Actionable> for LockButton

impl IsA<Bin> for LockButton

impl IsA<Buildable> for LockButton

impl IsA<Button> for LockButton

impl IsA<Container> for LockButton

impl IsA<Widget> for LockButton