class: ShortcutTrigger

[19:7] extends: object

Tracks how a GtkShortcut can be activated. To find out if a GtkShortcutTrigger triggers, you can call [method@Gtk.ShortcutTrigger.trigger] on a GdkEvent. GtkShortcutTriggers contain functions that allow easy presentation to end users as well as being printed for debugging. All GtkShortcutTriggers are immutable, you can only specify their properties during construction. If you want to change a trigger, you have to replace it with a new one.

Members

• handleObj
• lib
• retainedCallbacks
• signalHandlerNames
• signalSetterHandlers

Methods

• ShortcutTrigger (argString = null)

  Tries to parse the given string into a trigger. On success, the parsed trigger is returned. When parsing failed, %NULL is returned. The accepted strings are: - never, for GtkNeverTrigger - a string parsed by gtk_accelerator_parse(), for a GtkKeyvalTrigger, e.g. <Control>C - underscore, followed by a single character, for GtkMnemonicTrigger, e.g. _l - two valid trigger strings, separated by a | character, for a GtkAlternativeTrigger: <Control>q|<Control>w Note that you will have to escape the < and > characters when specifying triggers in XML files, such as GtkBuilder ui files. Use < instead of < and > instead of >.

  • @p argString is the string to parse.

• toNativeHandle (Source)

  Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

  • @p Source is the raw handle, raw buffer, wrapper, or null.
  • @r A raw pointer carrier or null when no pointer is present.

• getLib ()

  Returns the opened native library for this generated wrapper.

  • @r The opened native library.

• handle ()

  Returns the wrapped NativeHandle.

  • @r The wrapped NativeHandle.

• isNull ()

  Returns true when the wrapped handle is null.

  • @r A bool.

• describe ()

  Returns a small string for debugging generated wrappers.

  • @r A string.

• asObject ()

  Wraps this handle as Object.

  • @r A Object object.

• compare (object trigger2)

  The types of @trigger1 and @trigger2 are gconstpointer only to allow use of this function as a GCompareFunc. They must each be a GtkShortcutTrigger.

  • @p trigger2 is a GtkShortcutTrigger.

• equal (object trigger2)

  Checks if @trigger1 and @trigger2 trigger under the same conditions. The types of @one and @two are gconstpointer only to allow use of this function with GHashTable. They must each be a GtkShortcutTrigger.

  • @p trigger2 is a GtkShortcutTrigger.

• hash ()

  Generates a hash value for a GtkShortcutTrigger. The output of this function is guaranteed to be the same for a given value only per-process. It may change between different processor architectures or even different versions of GTK. Do not use this function as a basis for building protocols or file formats. The types of @trigger is gconstpointer only to allow use of this function with GHashTable. They must each be a GtkShortcutTrigger.

• print (arg1String)

  Prints the given trigger into a string for the developer. This is meant for debugging and logging. The form of the representation may change at any time and is not guaranteed to stay identical.

  • @p string is a GString to print into.
  • @r None.

• print_label (object display, arg2String)

  Prints the given trigger into a string. This function is returning a translated string for presentation to end users for example in menu items or in help texts. The @display in use may influence the resulting string in various forms, such as resolving hardware keycodes or by causing display-specific modifier names. The form of the representation may change at any time and is not guaranteed to stay identical.

  • @p display is GdkDisplay to print for.
  • @p string is a GString to print into.

• to_label (object display)

  Gets textual representation for the given trigger. This function is returning a translated string for presentation to end users for example in menu items or in help texts. The @display in use may influence the resulting string in various forms, such as resolving hardware keycodes or by causing display-specific modifier names. The form of the representation may change at any time and is not guaranteed to stay identical.

  • @p display is GdkDisplay to print for.

• to_string ()

  Prints the given trigger into a human-readable string. This is a small wrapper around [method@Gtk.ShortcutTrigger.print] to help when debugging.

• trigger (object event, bool enable_mnemonics)

  Checks if the given @event triggers @self.

  • @p event is the event to check.
  • @p enable_mnemonics is %TRUE if mnemonics should trigger. Usually the value of this property is determined by checking that the passed in
  • @event is a Key event and has the right modifiers set..