LockButtonProtocol

public protocol LockButtonProtocol : ButtonProtocol

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

An example GtkLockButton

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 [propertyGtk.LockButton:text-lock], [propertyGtk.LockButton:text-unlock], [propertyGtk.LockButton:tooltip-lock], [propertyGtk.LockButton:tooltip-unlock] and [propertyGtk.LockButton:tooltip-not-authorized] properties.

The LockButtonProtocol protocol exposes the methods and properties of an underlying GtkLockButton instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see LockButton. Alternatively, use LockButtonRef as a lighweight, unowned reference if you already have an instance you just want to use.

Show on GitHub
  • ptr

    Untyped pointer to the underlying GtkLockButton instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
    Show on GitHub
  • lock_button_ptr Default implementation

    Typed pointer to the underlying GtkLockButton instance.

    Default Implementation

    Return the stored, untyped pointer as a typed pointer to the GtkLockButton instance.

    Declaration

    Swift

    var lock_button_ptr: UnsafeMutablePointer<GtkLockButton>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to LockButtonProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

LockButton Class

  • Bind a LockButtonPropertyName source property to a given target object.

    Declaration

    Swift

    @discardableResult
@inlinable
func bind<Q, T>(property source_property: LockButtonPropertyName, to target: T, _ target_property: Q, flags f: BindingFlags = .default, transformFrom transform_from: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }, transformTo transform_to: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }) -> BindingRef! where Q : PropertyNameProtocol, T : ObjectProtocol

    Parameters

    source_property

    the source property to bind
    target

    the target object to bind to
    target_property

    the target property to bind to
    flags

    the flags to pass to the Binding
    transform_from

    ValueTransformer to use for forward transformation
    transform_to

    ValueTransformer to use for backwards transformation

    Return Value

    binding reference or nil in case of an error

    Show on GitHub
  • get(property:) Extension method

    Get the value of a LockButton property

    Declaration

    Swift

    @inlinable
func get(property: LockButtonPropertyName) -> GLibObject.Value

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub
  • set(property:value:) Extension method

    Set the value of a LockButton property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

    @inlinable
func set(property: LockButtonPropertyName, value v: GLibObject.Value)

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

LockButton Class: LockButtonProtocol extension (methods and fields)

  • getPermission() Extension method

    Obtains the GPermission object that controls button.

    Declaration

    Swift

    @inlinable
func getPermission() -> GIO.PermissionRef!
    Show on GitHub
  • set(permission:) Extension method

    Sets the GPermission object that controls button.

    Declaration

    Swift

    @inlinable
func set(permission: GIO.PermissionRef? = nil)
    Show on GitHub
  • set(permission:) Extension method

    Sets the GPermission object that controls button.

    Declaration

    Swift

    @inlinable
func set<PermissionT>(permission: PermissionT?) where PermissionT : PermissionProtocol
    Show on GitHub
  • permission Extension method

    The `GPermission object controlling this button.

    Declaration

    Swift

    @inlinable
var permission: GIO.PermissionRef! { get nonmutating set }
    Show on GitHub