Class: Gtk::LockButton

Inherits:
Button
  • Object
show all
Defined in:
(unknown)

Overview

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.

Instance Method Summary collapse

Methods inherited from Button

#can_shrink, #can_shrink=, #can_shrink?, #child, #child=, #has_frame, #has_frame=, #has_frame?, #icon_name, #icon_name=, #initialize_raw, #label, #label=, #use_underline, #use_underline=, #use_underline?

Methods inherited from Widget

#accessible_role, #accessible_role=, #action_set_enabled, #activate, #activate_action, #activate_action_variant, #activate_default, #activate_signal, #activate_signal=, #activate_signal_from_name=, #add_binding, #add_binding_action, #add_binding_signal, #add_controller, #add_css_class, #add_mnemonic_label, #add_shortcut, #add_tick_callback, #allocate, #allocated_baseline, #allocated_height, #allocated_width, #baseline, #bind_template_callback_full, #bind_template_child, #bind_template_child_full, #can_focus, #can_focus=, #can_focus?, #can_target, #can_target=, #can_target?, #child_focus, #child_visible, #child_visible=, #children, #clipboard, #compute_bounds, #compute_expand, #compute_point, #compute_transform, #contains, #create_pango_context, #create_pango_layout, #css_classes, #css_classes=, #css_name, #css_name=, #cursor, #cursor=, #cursor_from_name=, default_direction, default_direction=, #direction, #direction=, #display, #dispose_template, #drag_check_threshold, #error_bell, #first_child, #focus_child, #focus_child=, #focus_on_click, #focus_on_click=, #focus_on_click?, #focusable, #focusable=, #focusable?, #font_map, #font_map=, #font_options, #font_options=, #frame_clock, #get_allocation, #get_ancestor, #get_color, #get_preferred_size, #get_size, #get_size_request, #get_template_child, #grab_focus, #halign, #halign=, #has_css_class, #has_default, #has_default=, #has_default?, #has_focus, #has_focus=, #has_focus?, #has_tooltip, #has_tooltip=, #has_tooltip?, #has_visible_focus, have_template?, #height, #height_request, #height_request=, #hexpand, #hexpand=, #hexpand?, #hexpand_set, #hexpand_set=, #hexpand_set?, #hide, #in_destruction, #init_template, #insert_action_group, #insert_action_group_raw, #insert_after, #insert_before, #install_action, #install_property_action, #is_ancestor, #is_drawable, #is_focus, #is_sensitive, #is_visible, #keynav_failed, #last_child, #layout_manager, #layout_manager=, #layout_manager_type, #layout_manager_type=, #list_mnemonic_labels, #map, #mapped, #margin_bottom, #margin_bottom=, #margin_end, #margin_end=, #margin_start, #margin_start=, #margin_top, #margin_top=, #measure, #mnemonic_activate, #name, #name=, #native, #next_sibling, #observe_children, #observe_controllers, #opacity, #opacity=, #overflow, #overflow=, #pango_context, #parent, #parent=, #pick, #prev_sibling, #primary_clipboard, #query_action, #queue_allocate, #queue_draw, #queue_resize, #realize, #realized, #receives_default, #receives_default=, #receives_default?, #remove_controller, #remove_css_class, #remove_mnemonic_label, #remove_tick_callback, #request_mode, #root, #root=, #scale_factor, #scale_factor=, #sensitive, #sensitive=, #sensitive?, #set_size_request, #set_size_request_raw, #set_state_flags, #set_template, #set_template_raw, #settings, #should_layout, #show, #size_allocate, #snapshot_child, #state_flags, #style_context, #style_context_raw, #template=, template_children, #template_from_resource=, #template_scope=, #tooltip_markup, #tooltip_markup=, #tooltip_text, #tooltip_text=, #translate_coordinates, #translate_coordinates_raw, #trigger_tooltip_query, #unmap, #unparent, #unrealize, #unset_state_flags, #valign, #valign=, #vexpand, #vexpand=, #vexpand?, #vexpand_set, #vexpand_set=, #vexpand_set?, #visible, #visible=, #visible?, #width, #width_request, #width_request=

Constructor Details

#initialize(permission) ⇒ Gtk::Widget

Creates a new lock button which reflects the permission.

Parameters:

  • permission (Gio::Permission) —

    a GPermission

Instance Method Details

#permission ⇒ Gio::Permission

The `GPermission object controlling this button.

Returns:

  • (Gio::Permission) —

    permission

#permission=(permission) ⇒ Gio::Permission

The `GPermission object controlling this button.

Parameters:

  • permission (Gio::Permission)

Returns:

  • (Gio::Permission) —

    permission

  • (Gio::Permission) —

    permission

#text_lock ⇒ String

The text to display when prompting the user to lock.

Returns:

  • (String) —

    text-lock

#text_lock=(text_lock) ⇒ String

The text to display when prompting the user to lock.

Parameters:

  • text_lock (String)

Returns:

  • (String) —

    text-lock

  • (String) —

    text-lock

#text_unlock ⇒ String

The text to display when prompting the user to unlock.

Returns:

  • (String) —

    text-unlock

#text_unlock=(text_unlock) ⇒ String

The text to display when prompting the user to unlock.

Parameters:

  • text_unlock (String)

Returns:

  • (String) —

    text-unlock

  • (String) —

    text-unlock

#tooltip_lock ⇒ String

The tooltip to display when prompting the user to lock.

Returns:

  • (String) —

    tooltip-lock

#tooltip_lock=(tooltip_lock) ⇒ String

The tooltip to display when prompting the user to lock.

Parameters:

  • tooltip_lock (String)

Returns:

  • (String) —

    tooltip-lock

  • (String) —

    tooltip-lock

#tooltip_not_authorized ⇒ String

The tooltip to display when the user cannot obtain authorization.

Returns:

  • (String) —

    tooltip-not-authorized

#tooltip_not_authorized=(tooltip_not_authorized) ⇒ String

The tooltip to display when the user cannot obtain authorization.

Parameters:

  • tooltip_not_authorized (String)

Returns:

  • (String) —

    tooltip-not-authorized

  • (String) —

    tooltip-not-authorized

#tooltip_unlock ⇒ String

The tooltip to display when prompting the user to unlock.

Returns:

  • (String) —

    tooltip-unlock

#tooltip_unlock=(tooltip_unlock) ⇒ String

The tooltip to display when prompting the user to unlock.

Parameters:

  • tooltip_unlock (String)

Returns:

  • (String) —

    tooltip-unlock

  • (String) —

    tooltip-unlock