Stability Level

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkBox
                                 +----GtkHBox
                                       +----PolkitLockButton

Implemented Interfaces

PolkitLockButton implements AtkImplementorIface, GtkBuildable and GtkOrientable.

Properties

  "action-id"                gchar*                : Read / Write / Construct Only
  "can-obtain"               gboolean              : Read
  "is-authorized"            gboolean              : Read
  "is-visible"               gboolean              : Read
  "text-lock"                gchar*                : Read / Write / Construct
  "text-not-authorized"      gchar*                : Read / Write / Construct
  "text-unlock"              gchar*                : Read / Write / Construct

Signals

  "changed"                                        : Run Last

Description

PolkitLockButton is a widget that can be used in control panels to allow users to obtain and revoke authorizations needed for the control panel UI to function.

If the user lacks the authorization but authorization can be obtained through authentication, the widget looks like this

and the user can click the button to obtain the authorization. This will pop up an authentication dialog. Once authorization is obtained, the widget changes to this

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

If the user is authorized (either implicitly via the .policy file defaults or through e.g. Local Authority configuration) and no authentication is necessary, the widget will be hidden.

Finally, if the user is not authorized but authorization can be obtained and the obtained authorization will be a one-shot authorization, the widget will be hidden as well. This means that any attempt to use the Mechanism that requires authorization for the specified action will always prompt for authentication. This condition happens exactly when (!polkit_lock_button_get_is_authorized() && polkit_lock_button_get_can_obtain() && !polkit_lock_button_get_is_visible()) is TRUE.

Typically PolkitLockButton is only useful for actions where authorization is retained (cf. the defaults specified in the .policy file for the action) but note that this behavior can be overridden by the Authority implementation.

The typical usage of this widget is like this:

static void
update_sensitivity_according_to_lock_button (FooBar *bar)
{
  gboolean make_sensitive;

  make_sensitive = FALSE;
  if (polkit_lock_button_get_is_authorized (POLKIT_LOCK_BUTTON (bar->priv->lock_button)))
    {
      make_sensitive = TRUE;
    }
  else
    {
      /* Catch the case where authorization is one-shot - this means
       * an authentication dialog will be shown every time a widget the user
       * manipulates calls into the Mechanism.
       */
      if (polkit_lock_button_get_can_obtain (POLKIT_LOCK_BUTTON (bar->priv->lock_button)) &&
          !polkit_lock_button_get_is_visible (POLKIT_LOCK_BUTTON (bar->priv->lock_button)))
        make_sensitive = TRUE;
    }


  /* Make all widgets relying on authorization sensitive according to
   * the value of make_sensitive.
   */
}

static void
on_lock_button_changed (PolkitLockButton *button,
                        gpointer          user_data)
{
  FooBar *bar = FOO_BAR (user_data);

  update_sensitivity_according_to_lock_button (bar);
}

static void
foo_bar_init (FooBar *bar)
{
  /* Construct other widgets */

  bar->priv->lock_button = polkit_lock_button_new ("org.project.mechanism.action-name");
  g_signal_connect (bar->priv->lock_button,
                    "changed",
                    G_CALLBACK (on_lock_button_changed),
                    bar);
  update_sensitity_according_to_lock_button (bar);

  /* Pack bar->priv->lock_button into widget hierarchy */
}

Details

typedef struct _PolkitLockButton PolkitLockButton;

typedef struct {
  GtkHBoxClass parent_class;

  /* Signals */
  void (*changed) (PolkitLockButton *button);
} PolkitLockButtonClass;

GtkWidget *         polkit_lock_button_new              (const gchar *action_id);

gboolean            polkit_lock_button_get_is_authorized
                                                        (PolkitLockButton *button);

gboolean            polkit_lock_button_get_is_visible   (PolkitLockButton *button);

gboolean            polkit_lock_button_get_can_obtain   (PolkitLockButton *button);

void                polkit_lock_button_set_unlock_text  (PolkitLockButton *button,
                                                         const gchar *text);

void                polkit_lock_button_set_lock_text    (PolkitLockButton *button,
                                                         const gchar *text);

void                polkit_lock_button_set_not_authorized_text
                                                        (PolkitLockButton *button,
                                                         const gchar *text);

Property Details

  "action-id"                gchar*                : Read / Write / Construct Only

  "can-obtain"               gboolean              : Read

  "is-authorized"            gboolean              : Read

  "is-visible"               gboolean              : Read

  "text-lock"                gchar*                : Read / Write / Construct

  "text-not-authorized"      gchar*                : Read / Write / Construct

  "text-unlock"              gchar*                : Read / Write / Construct

Signal Details

void                user_function                      (PolkitLockButton *button,
                                                        gpointer          user_data)      : Run Last