Struct gtk4::LockButton

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

This widget will be removed in GTK 5 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 text-lock, text-unlock, tooltip-lock, tooltip-unlock and tooltip-not-authorized properties.

Properties

permission

The `GPermission object controlling this button.

Readable | Writeable

text-lock

The text to display when prompting the user to lock.

Readable | Writeable | Construct

text-unlock

The text to display when prompting the user to unlock.

Readable | Writeable | Construct

tooltip-lock

The tooltip to display when prompting the user to lock.

Readable | Writeable | Construct

tooltip-not-authorized

The tooltip to display when the user cannot obtain authorization.

Readable | Writeable | Construct

tooltip-unlock

The tooltip to display when prompting the user to unlock.

Readable | Writeable | Construct

Button

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 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 LayoutManager 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 WidgetExt::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 WidgetExt::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 WidgetExt::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 WidgetExt::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 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 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 will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

tooltip-text

Sets the text of tooltip to be the given string.

Also see 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 will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and 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 Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Actionable

action-name

Readable | Writeable

action-target

Readable | Writeable

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.

Deprecated since 4.10

This widget will be removed in GTK 5

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.

Deprecated since 4.10

This widget will be removed in GTK 5

Returns

the GPermission of @self

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

Sets the GPermission object that controls @self.

Deprecated since 4.10

This widget will be removed in GTK 5

permission

a GPermission object

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

The text to display when prompting the user to lock.

Deprecated since 4.10

This widget will be removed in GTK 5

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

The text to display when prompting the user to lock.

Deprecated since 4.10

This widget will be removed in GTK 5

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

The text to display when prompting the user to unlock.

Deprecated since 4.10

This widget will be removed in GTK 5

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

The text to display when prompting the user to unlock.

Deprecated since 4.10

This widget will be removed in GTK 5

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

The tooltip to display when prompting the user to lock.

Deprecated since 4.10

This widget will be removed in GTK 5

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

The tooltip to display when prompting the user to lock.

Deprecated since 4.10

This widget will be removed in GTK 5

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

The tooltip to display when the user cannot obtain authorization.

Deprecated since 4.10

This widget will be removed in GTK 5

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

The tooltip to display when the user cannot obtain authorization.

Deprecated since 4.10

This widget will be removed in GTK 5

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

The tooltip to display when prompting the user to unlock.

Deprecated since 4.10

This widget will be removed in GTK 5

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

The tooltip to display when prompting the user to unlock.

Deprecated since 4.10

This widget will be removed in GTK 5

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

type ParamSpec = ParamSpecObject

type SetValue = LockButton

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

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

fn param_spec_builder() -> Self::BuilderFn

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