package ocgtk

You can search for identifiers within the package.

in-package search v0.2.0

OCaml bindings for GTK 4

Install

dune-project

Dependency

github.com Edit opam file Versions (2)

Authors

C

Chris Armstrong

Maintainers

H

hello@chrisarmstrong.dev

Sources

v0.1-preview2.tar.gz

sha256=4e50fdb5093136a10fc8ffbe388e44cbcb70d52f8afdd48863ec7e22580ff054

doc/ocgtk.gtk/Ocgtk_gtk/Gtk/Wrappers/Shortcut_trigger/index.html

Module `Wrappers.Shortcut_trigger`

type t = [ `shortcut_trigger | `object_ ] Gobject.obj

val parse_string : string -> t

Create a new ShortcutTrigger

val trigger : 
  t ->
  Ocgtk_gdk.Gdk.Wrappers.Event.t ->
  bool ->
  Ocgtk_gdk.Gdk.keymatch

Checks if the given @event triggers @self.

val to_string : t -> string

Prints the given trigger into a human-readable string.

This is a small wrapper around method@Gtk.ShortcutTrigger.print to help when debugging.

val to_label : t -> Ocgtk_gdk.Gdk.Wrappers.Display.t -> 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.

val hash : t -> int

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`.

val equal : t -> t -> bool

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`.

val compare : t -> t -> int

The types of @trigger1 and @trigger2 are `gconstpointer` only to allow use of this function as a `GCompareFunc`.

They must each be a `GtkShortcutTrigger`.