Back to Seed Clases

Gtk

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Gtk.AccelMap

Class Gtk.AccelMap

Import line:	Gtk = imports.gi.Gtk;
GIR File:	Gtk-3.0.gir
C documentation:	GtkAccelMap
Class :	AccelMap
Extends:	GObject.Object

Accelerator maps are used to define runtime configurable accelerators.
Functions for manipulating them are are usually used by higher level
convenience mechanisms like GtkUIManager and are thus considered
"low-level". You'll want to use them if you're manually creating menus that
should have user-configurable accelerators.
Accelerator is uniquely defined by:

accelerator path
accelerator key
accelerator modifiers

The accelerator path must consist of
"<WINDOWTYPE>/Category1/Category2/.../Action", where WINDOWTYPE
should be a unique application-specific identifier that corresponds to the
kind of window the accelerator is being used in, e.g. "Gimp-Image",
"Abiword-Document" or "Gnumeric-Settings".
The "Category1/.../Action" portion is most appropriately chosen by the action
the accelerator triggers, i.e. for accelerators on menu items, choose the
item's menu path, e.g. "File/Save As", "Image/View/Zoom" or
"Edit/Select All". So a full valid accelerator path may look like:
"<Gimp-Toolbox>/File/Dialogs/Tool Options...".
All accelerators are stored inside one global GtkAccelMap that can be
obtained using gtk_accel_map_get(). See linkend="monitoring-changes">Monitoring changes for additional
details.

Manipulating accelerators

New accelerators can be added using gtk_accel_map_add_entry(). To search for
specific accelerator, use gtk_accel_map_lookup_entry(). Modifications of
existing accelerators should be done using gtk_accel_map_change_entry().
In order to avoid having some accelerators changed, they can be locked using
gtk_accel_map_lock_path(). Unlocking is done using
gtk_accel_map_unlock_path().

Saving and loading accelerator maps

Accelerator maps can be saved to and loaded from some external resource. For
simple saving and loading from file, gtk_accel_map_save() and
gtk_accel_map_load() are provided. Saving and loading can also be done by
providing file descriptor to gtk_accel_map_save_fd() and
gtk_accel_map_load_fd().

Monitoring changes

GtkAccelMap object is only useful for monitoring changes of accelerators. By
connecting to GtkAccelMap::changed signal, one can monitor changes of all
accelerators. It is also possible to monitor only single accelerator path by
using it as a detail of the GtkAccelMap::changed signal.

Properties
None

Methods / Constructors
Method / Constructor		Defined By
	new Gtk.AccelMap () Create a new Gtk.AccelMap Create a new Gtk.AccelMap
	Gtk.AccelMap.add_entry (String *accel_path, guint32 accel_key, ModifierType accel_mods) : none Registers a new accelerator with the global accelerator map. Registers a new accelerator with the global accelerator map. This function should only be called once per accel_path* with the canonical accel_key and accel_mods for this path. To change the accelerator during runtime programatically, use gtk_accel_map_change_entry(). Note that accel_path string will be stored in a GQuark. Therefore, if you pass a static string, you can save some memory by interning it first with g_intern_static_string(). Parameters: String accel_path Required (not null) valid accelerator path guint32 accel_key Required (not null) the accelerator key Gdk.ModifierType accel_mods Required (not null) the accelerator modifiers Returns: none	Gtk.AccelMap
	Gtk.AccelMap.add_filter (String *filter_pattern) : none Adds a filter to the global list of accel path filters. Adds a filter to the global list of accel path filters. Accel map entries whose accel path matches one of the filters are skipped by gtk_accel_map_foreach(). This function is intended for GTK+ modules that create their own menus, but don't want them to be saved into the applications accelerator map dump. Parameters: String filter_pattern* Required (not null) a pattern (see GPatternSpec) Returns: none	Gtk.AccelMap
	Gtk.AccelMap.change_entry (String *accel_path, guint32 accel_key, ModifierType accel_mods, gboolean replace) : gboolean Changes the accel_key* and accel_mods currently associated with accel_path. Changes the accel_key and accel_mods currently associated with accel_path. Due to conflicts with other accelerators, a change may not always be possible, conflicts. A change will only occur if all conflicts could be resolved (which might not be the case if conflicting accelerators are locked). Successful changes are indicated by a TRUE return value. Note that accel_path string will be stored in a GQuark. Therefore, if you pass a static string, you can save some memory by interning it first with g_intern_static_string(). Parameters: String accel_path Required (not null) a valid accelerator path guint32 accel_key Required (not null) the new accelerator key Gdk.ModifierType accel_mods Required (not null) the new accelerator modifiers gboolean replace Required (not null) TRUE if other accelerators may be deleted upon conflicts Returns: gboolean TRUE if the accelerator could be changed, FALSE otherwise	Gtk.AccelMap
	Gtk.AccelMap.foreach (void* *data, Function foreach_func) : none Loops over the entries in the accelerator map whose accel path doesn't match any of the filters added with gtk_accel_map_add_filter(), and execute foreach_func* on each. Loops over the entries in the accelerator map whose accel path doesn't match any of the filters added with gtk_accel_map_add_filter(), and execute foreach_func on each. The signature of foreach_func is that of GtkAccelMapForeach, the changed parameter indicates whether this accelerator was changed during runtime (thus, would need saving during an accelerator map dump). Parameters: void* data Required (not null) data to be passed into foreach_func Function (void* *data, String accel_path, guint32 accel_key, ModifierType accel_mods, gboolean changed*) : none Required (not null) function to be executed for each accel map entry which is not filtered out Returns: none	Gtk.AccelMap
	Gtk.AccelMap.foreach_unfiltered (void* *data, Function foreach_func) : none Loops over all entries in the accelerator map, and execute GtkAccelMapForeach, the changed* parameter indicates whether this accelerator was changed during runtime (thus, would need saving during an accelerator map dump). Loops over all entries in the accelerator map, and execute GtkAccelMapForeach, the changed parameter indicates whether this accelerator was changed during runtime (thus, would need saving during an accelerator map dump). Parameters: void* data Required (not null) data to be passed into foreach_func Function (void* *data, String accel_path, guint32 accel_key, ModifierType accel_mods, gboolean changed*) : none Required (not null) function to be executed for each accel map entry Returns: none	Gtk.AccelMap
	Gtk.AccelMap.get () : Gtk.AccelMap Gets the singleton global GtkAccelMap object. Gets the singleton global GtkAccelMap object. This object is useful only for notification of changes to the accelerator map via the ::changed signal; it isn't a parameter to the other accelerator map functions. Returns: Gtk.AccelMap the global GtkAccelMap object	Gtk.AccelMap
	Gtk.AccelMap.load (String *file_name) : none Parses a file previously saved with gtk_accel_map_save() for accelerator specifications, and propagates them accordingly. Parses a file previously saved with gtk_accel_map_save() for accelerator specifications, and propagates them accordingly. Parameters: String file_name* Required (not null) a file containing accelerator specifications, in the GLib file name encoding Returns: none	Gtk.AccelMap
	Gtk.AccelMap.load_fd (gint32 fd) : none Filedescriptor variant of gtk_accel_map_load(). Filedescriptor variant of gtk_accel_map_load(). Note that the file descriptor will not be closed by this function. Parameters: gint32 fd Required (not null) a valid readable file descriptor Returns: none	Gtk.AccelMap
	Gtk.AccelMap.load_scanner (Scanner *scanner) : none GScanner* variant of gtk_accel_map_load(). GScanner variant of gtk_accel_map_load(). Parameters: GLib.Scanner scanner Required (not null) a GScanner which has already been provided with an input file Returns: none	Gtk.AccelMap
	Gtk.AccelMap.lock_path (String *accel_path) : none Locks the given accelerator path. Locks the given accelerator path. If the accelerator map doesn't yet contain an entry for accel_path, a new one is created. Locking an accelerator path prevents its accelerator from being changed during runtime. A locked accelerator path can be unlocked by gtk_accel_map_unlock_path(). Refer to gtk_accel_map_change_entry() for information about runtime accelerator changes. If called more than once, accel_path* remains locked until gtk_accel_map_unlock_path() has been called an equivalent number of times. Note that locking of individual accelerator paths is independent from locking the GtkAccelGroup containing them. For runtime accelerator changes to be possible both the accelerator path and its GtkAccelGroup have to be unlocked. Parameters: String accel_path Required (not null) a valid accelerator path Returns: none	Gtk.AccelMap
	Gtk.AccelMap.lookup_entry (String *accel_path, Object out_values) : gboolean Looks up the accelerator entry for accel_path* and fills in key. Looks up the accelerator entry for accel_path and fills in key. Parameters: String accel_path Required (not null) a valid accelerator path Object out_values Gtk.AccelKey key Returns: gboolean TRUE if accel_path is known, FALSE otherwise	Gtk.AccelMap
	Gtk.AccelMap.save (String *file_name) : none Saves current accelerator specifications (accelerator path, key and modifiers) to file_name. Saves current accelerator specifications (accelerator path, key and modifiers) to file_name. The file is written in a format suitable to be read back in by gtk_accel_map_load(). Parameters: String file_name* Required (not null) the name of the file to contain accelerator specifications, in the GLib file name encoding Returns: none	Gtk.AccelMap
	Gtk.AccelMap.save_fd (gint32 fd) : none Filedescriptor variant of gtk_accel_map_save(). Filedescriptor variant of gtk_accel_map_save(). Note that the file descriptor will not be closed by this function. Parameters: gint32 fd Required (not null) a valid writable file descriptor Returns: none	Gtk.AccelMap
	Gtk.AccelMap.unlock_path (String *accel_path) : none Undoes the last call to gtk_accel_map_lock_path() on this accel_path. Undoes the last call to gtk_accel_map_lock_path() on this accel_path. Refer to gtk_accel_map_lock_path() for information about accelerator path locking. Parameters: String accel_path* Required (not null) a valid accelerator path Returns: none	Gtk.AccelMap

Events
None