GI.Gtk.Objects.ShortcutTrigger

GtkShortcutTrigger tracks how a GtkShortcut should be activated.

To find out if a GtkShortcutTrigger triggers, you can call shortcutTriggerTrigger 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.

Exported types

newtype ShortcutTrigger

Memory-managed wrapper type.

Constructors

ShortcutTrigger (ManagedPtr ShortcutTrigger)

Instances

Eq ShortcutTrigger

Defined in GI.Gtk.Objects.ShortcutTrigger

Methods

(==) :: ShortcutTrigger -> ShortcutTrigger -> Bool

(/=) :: ShortcutTrigger -> ShortcutTrigger -> Bool

GObject ShortcutTrigger

Defined in GI.Gtk.Objects.ShortcutTrigger

ManagedPtrNewtype ShortcutTrigger

Defined in GI.Gtk.Objects.ShortcutTrigger

Methods

toManagedPtr :: ShortcutTrigger -> ManagedPtr ShortcutTrigger

TypedObject ShortcutTrigger

Defined in GI.Gtk.Objects.ShortcutTrigger

Methods

glibType :: IO GType

HasParentTypes ShortcutTrigger

Defined in GI.Gtk.Objects.ShortcutTrigger

IsGValue (Maybe ShortcutTrigger)

Convert ShortcutTrigger to and from GValue. See toGValue and fromGValue.

Defined in GI.Gtk.Objects.ShortcutTrigger

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe ShortcutTrigger -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe ShortcutTrigger)

type ParentTypes ShortcutTrigger

Defined in GI.Gtk.Objects.ShortcutTrigger

type ParentTypes ShortcutTrigger = '[Object]

class (GObject o, IsDescendantOf ShortcutTrigger o) => IsShortcutTrigger o

Type class for types which can be safely cast to ShortcutTrigger, for instance with toShortcutTrigger.

Instances

(GObject o, IsDescendantOf ShortcutTrigger o) => IsShortcutTrigger o

Defined in GI.Gtk.Objects.ShortcutTrigger

toShortcutTrigger :: (MonadIO m, IsShortcutTrigger o) => o -> m ShortcutTrigger

Cast to ShortcutTrigger, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, compare, equal, forceFloating, freezeNotify, getv, hash, isFloating, notify, notifyByPspec, print, printLabel, ref, refSink, runDispose, stealData, stealQdata, thawNotify, toLabel, toString, trigger, unref, watchClosure.

Getters

getData, getProperty, getQdata.

Setters

setData, setDataFull, setProperty.

compare

shortcutTriggerCompare

Arguments

:: (HasCallStack, MonadIO m, IsShortcutTrigger a, IsShortcutTrigger b)

=> a

trigger1: a GtkShortcutTrigger

-> b

trigger2: a GtkShortcutTrigger

-> m Int32

Returns: An integer less than, equal to, or greater than zero if trigger1 is found, respectively, to be less than, to match, or be greater than 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.

equal

shortcutTriggerEqual

Arguments

:: (HasCallStack, MonadIO m, IsShortcutTrigger a, IsShortcutTrigger b)

=> a

trigger1: a GtkShortcutTrigger

-> b

trigger2: a GtkShortcutTrigger

-> m Bool

Returns: True if trigger1 and trigger2 are equal

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.

hash

shortcutTriggerHash

Arguments

:: (HasCallStack, MonadIO m, IsShortcutTrigger a)

=> a

trigger: a GtkShortcutTrigger

-> m Word32

Returns: a hash value corresponding to trigger

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.

parseString

shortcutTriggerParseString

Arguments

:: (HasCallStack, MonadIO m)

=> Text

string: the string to parse

-> m (Maybe ShortcutTrigger)

Returns: a new GtkShortcutTrigger

Tries to parse the given string into a trigger.

On success, the parsed trigger is returned. When parsing failed, Nothing is returned.

The accepted strings are:

• never, for GtkNeverTrigger
• a string parsed by acceleratorParse, 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 >.

print

shortcutTriggerPrint

Arguments

:: (HasCallStack, MonadIO m, IsShortcutTrigger a)

=> a

self: a GtkShortcutTrigger

-> String

string: a GString to print into

-> m ()

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.

printLabel

shortcutTriggerPrintLabel

Arguments

:: (HasCallStack, MonadIO m, IsShortcutTrigger a, IsDisplay b)

=> a

self: a GtkShortcutTrigger

-> b

display: GdkDisplay to print for

-> String

string: a GString to print into

-> m Bool

Returns: True if something was printed or False if the trigger did not have a textual representation suitable for end users.

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.

toLabel

shortcutTriggerToLabel

Arguments

:: (HasCallStack, MonadIO m, IsShortcutTrigger a, IsDisplay b)

=> a

self: a GtkShortcutTrigger

-> b

display: GdkDisplay to print for

-> m Text

Returns: a new string

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.

toString

shortcutTriggerToString

Arguments

:: (HasCallStack, MonadIO m, IsShortcutTrigger a)

=> a

self: a GtkShortcutTrigger

-> m Text

Returns: a new string

Prints the given trigger into a human-readable string.

This is a small wrapper around shortcutTriggerPrint to help when debugging.

trigger

shortcutTriggerTrigger

Arguments

:: (HasCallStack, MonadIO m, IsShortcutTrigger a, IsEvent b)

=> a

self: a GtkShortcutTrigger

-> b

event: the event to check

-> Bool

enableMnemonics: 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.

-> m KeyMatch

Returns: Whether the event triggered the shortcut

Checks if the given event triggers self.