GtkHotkeyInfo

typedef struct _GtkHotkeyInfo GtkHotkeyInfo;

gtk_hotkey_info_bind ()

gboolean            gtk_hotkey_info_bind                (GtkHotkeyInfo *self,
                                                         GError **error);

Register the hotkey with the system. The "activated" signal will now be emitted when the user presses the keyboard combination matching the hotkey's signature.

gtk_hotkey_info_unbind ()

gboolean            gtk_hotkey_info_unbind              (GtkHotkeyInfo *self,
                                                         GError **error);

Remove the hotkey binding from the system. The "activated" signal will no longer be emitted when the hotkey is pressed.

gtk_hotkey_info_get_application_id ()

const gchar*        gtk_hotkey_info_get_application_id  (GtkHotkeyInfo *self);

Get the unique system identifier for the hotkey. See "application-id" for details.

gtk_hotkey_info_get_key_id ()

const gchar*        gtk_hotkey_info_get_key_id          (GtkHotkeyInfo *self);

Get the identifier the owning application use to identify this hotkey. See "key-id" for details.

gtk_hotkey_info_get_app_info ()

GAppInfo*           gtk_hotkey_info_get_app_info        (GtkHotkeyInfo *self);

Not to be confused with the value of the "application-id" property. The hotkey can be associated with an installed desktop application via a GAppInfo. This is not mandatory and this method returns NULL if no desktop application has been associated with this hotkey.

See the "app-info" property for details.

gtk_hotkey_info_get_signature ()

const gchar*        gtk_hotkey_info_get_signature       (GtkHotkeyInfo *self);

Get the keyboard signature of the hotkey. This could for example be '<Alt>F3' or '<Control><Shift>G'.

gtk_hotkey_info_get_description ()

const gchar*        gtk_hotkey_info_get_description     (GtkHotkeyInfo *self);

Get the free form description of the hotkey. The description is not guaranteed to be set and may be NULL.

FIXME: Do we need to take i18n into account here?

gtk_hotkey_info_set_description ()

void                gtk_hotkey_info_set_description     (GtkHotkeyInfo *self,
                                                         const gchar *description);

Set a description for the hotkey. See also gtk_hotkey_info_get_description().

gtk_hotkey_info_equals ()

gboolean            gtk_hotkey_info_equals              (GtkHotkeyInfo *hotkey1,
                                                         GtkHotkeyInfo *hotkey2,
                                                         gboolean sloppy_equals);

Compare two GtkHotkeyInfos to see if they are equal. This method allows an optional 'sloppy equality' which ignores "description" and "app-info".

gtk_hotkey_info_activated ()

void                gtk_hotkey_info_activated           (GtkHotkeyInfo *self,
                                                         guint event_time);

Emit the "activated" signal on a hotkey. Mainly called by GtkHotkeyListener implementations. This method should not normally be used by applications.

gtk_hotkey_info_new ()

GtkHotkeyInfo*      gtk_hotkey_info_new                 (const gchar *app_id,
                                                         const gchar *key_id,
                                                         const gchar *signature,
                                                         GAppInfo *app_info);

Create a new hotkey. To actually trigger the hotkey when the user enters the right keyboard combination call gtk_hotkey_info_bind(). To save and load your hotkey settings use the GtkHotkeyRegistry provided by gtk_hotkey_registry_get_default().

The "app-info" property

  "app-info"                 GAppInfo*             : Read / Write / Construct Only

A GAppInfo associated with the key. This is mainly useful for external applications which can use the information provided by the GAppInfo to display meaningful messages to the user. Like 'The keyboard combination <Alt>F3' is already assigned to the application "Deskbar Applet", please select another'.

The "application-id" property

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

A free form string chosen by the application using the hotkey, under which the application identifies itself.

Default value: NULL

The "bound" property

  "bound"                    gboolean              : Read

Property reflecting whether or not this hotkey has been bound to a GtkHotkeyListener. If this property is TRUE you will receive "activated" signals when the hotkey is triggered by the user.

Default value: FALSE

The "description" property

  "description"              gchar*                : Read / Write

An optional free form description of the hotkey.

Default value: ""

The "key-id" property

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

A free form string the application using the hotkey has attributed the hotkey so that it can be identified later on. Applications are encouraged to choose descriptive key ids.

Default value: NULL

The "signature" property

  "signature"                gchar*                : Read / Write / Construct Only

The keyboard signature of the hotkey. This could for example by '<Alt>F3' or '<Control><Shift>G'. The signature should be parsable by gtk_accelerator_parse().

Default value: NULL

The "activated" signal

void                user_function                      (GtkHotkeyInfo *hotkey,
                                                        guint          event_time,
                                                        gpointer       user_data)       : Run Last

Emitted when a hotkey has been activated.