AccelGroup

A #GtkAccelGroup represents a group of keyboard accelerators, typically attached to a toplevel #GtkWindow (with gtk.window.Window.addAccelGroup). Usually you won’t need to create a #GtkAccelGroup directly; instead, when using #GtkUIManager, GTK+ automatically sets up the accelerators for your menus in the ui manager’s #GtkAccelGroup.

Note that “accelerators” are different from “mnemonics”. Accelerators are shortcuts for activating a menu item; they appear alongside the menu item they’re a shortcut for. For example “Ctrl+Q” might appear alongside the “Quit” menu item. Mnemonics are shortcuts for GUI elements such as text entries or buttons; they appear as underlined characters. See gtk.label.Label.newWithMnemonic. Menu items can have both accelerators and mnemonics, of course.

class AccelGroup : ObjectWrap {

this(void* ptr, Flag!"Take" take);

static GType _getGType();

GType _gType [@property getter];

AccelGroup self();

static AccelGroupGidBuilder builder();

bool isLocked [@property getter];

gdk.types.ModifierType modifierMask [@property getter];

this();

static gtk.accel_group.AccelGroup fromAccelClosure(gobject.closure.Closure closure);

bool activate(glib.types.Quark accelQuark, gobject.object.ObjectWrap acceleratable, uint accelKey, gdk.types.ModifierType accelMods);

void connect(uint accelKey, gdk.types.ModifierType accelMods, gtk.types.AccelFlags accelFlags, gobject.closure.Closure closure);

void connectByPath(string accelPath, gobject.closure.Closure closure);

bool disconnect(gobject.closure.Closure closure);

bool disconnectKey(uint accelKey, gdk.types.ModifierType accelMods);

gtk.types.AccelKey find(gtk.types.AccelGroupFindFunc findFunc);

bool getIsLocked();

gdk.types.ModifierType getModifierMask();

void lock();

void unlock();

gulong connectAccelActivate(string detail, T callback, Flag!"After" after);

gulong connectAccelChanged(string detail, T callback, Flag!"After" after);

}

Constructors

this this(void* ptr, Flag!"Take" take)
this this(): Creates a new #GtkAccelGroup.

Members

Functions

activate bool activate(glib.types.Quark accelQuark, gobject.object.ObjectWrap acceleratable, uint accelKey, gdk.types.ModifierType accelMods): Finds the first accelerator in accel_group that matches accel_key and accel_mods, and activates it.
connect void connect(uint accelKey, gdk.types.ModifierType accelMods, gtk.types.AccelFlags accelFlags, gobject.closure.Closure closure): Installs an accelerator in this group. When accel_group is being activated in response to a call to gtk.global.accelGroupsActivate, closure will be invoked if the accel_key and accel_mods from gtk.global.accelGroupsActivate match those of this connection.
connectAccelActivate gulong connectAccelActivate(string detail, T callback, Flag!"After" after): Connect to AccelActivate signal.
connectAccelChanged gulong connectAccelChanged(string detail, T callback, Flag!"After" after): Connect to AccelChanged signal.
connectByPath void connectByPath(string accelPath, gobject.closure.Closure closure): Installs an accelerator in this group, using an accelerator path to look up the appropriate key and modifiers (see gtk.accel_map.AccelMap.addEntry). When accel_group is being activated in response to a call to gtk.global.accelGroupsActivate, closure will be invoked if the accel_key and accel_mods from gtk.global.accelGroupsActivate match the key and modifiers for the path.
disconnect bool disconnect(gobject.closure.Closure closure): Removes an accelerator previously installed through gtk.accel_group.AccelGroup.connect.
disconnectKey bool disconnectKey(uint accelKey, gdk.types.ModifierType accelMods): Removes an accelerator previously installed through gtk.accel_group.AccelGroup.connect.
find gtk.types.AccelKey find(gtk.types.AccelGroupFindFunc findFunc): Finds the first entry in an accelerator group for which find_func returns true and returns its #GtkAccelKey.
getIsLocked bool getIsLocked(): Locks are added and removed using gtk.accel_group.AccelGroup.lock and gtk.accel_group.AccelGroup.unlock.
getModifierMask gdk.types.ModifierType getModifierMask(): Gets a #GdkModifierType representing the mask for this accel_group. For example, #GDK_CONTROL_MASK, #GDK_SHIFT_MASK, etc.
lock void lock(): Locks the given accelerator group.
self AccelGroup self(): Returns this, for use in with statements.
unlock void unlock(): Undoes the last call to gtk.accel_group.AccelGroup.lock on this accel_group.

Properties

_gType GType _gType [@property getter]
isLocked bool isLocked [@property getter]
modifierMask gdk.types.ModifierType modifierMask [@property getter]

Static functions

_getGType GType _getGType()
builder AccelGroupGidBuilder builder(): Get builder for gtk.accel_group.AccelGroup
fromAccelClosure gtk.accel_group.AccelGroup fromAccelClosure(gobject.closure.Closure closure): Finds the #GtkAccelGroup to which closure is connected; see gtk.accel_group.AccelGroup.connect.

Inherited Members

From ObjectWrap

_setGObject void _setGObject(void* cObj, Flag!"Take" take): Set the GObject of a D ObjectWrap wrapper.
_cPtr void* _cPtr(Flag!"Dup" dup): Get a pointer to the underlying C object.
_ref void* _ref(void* gObj): Calls g_object_ref() on a GObject.
_unref _unref(void* gObj): Calls g_object_unref() on a GObject.
_getGType GType _getGType(): Get the GType of an object.
_gType GType _gType [@property getter]: GObject GType property.
self ObjectWrap self(): Convenience method to return this cast to a type. For use in D with statements.
_getDObject T _getDObject(void* cptr, Flag!"Take" take): Template to get the D object from a C GObject and cast it to the given D object type.
connectSignalClosure gulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after): Connect a D closure to an object signal.
setProperty void setProperty(string propertyName, T val): Template for setting a GObject property.
getProperty T getProperty(string propertyName): Template for getting a GObject property.
compatControl size_t compatControl(size_t what, void* data)
bindProperty gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectWrap target, string targetProperty, gobject.types.BindingFlags flags): Creates a binding between source_property on source and target_property on target.
bindPropertyFull gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectWrap target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom): Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.
forceFloating void forceFloating(): This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectWrap.refSink.
freezeNotify void freezeNotify(): Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.
getData void* getData(string key): Gets a named field from the objects table of associations (see gobject.object.ObjectWrap.setData).
getProperty void getProperty(string propertyName, gobject.value.Value value): Gets a property of an object.
getQdata void* getQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectWrap.setQdata.
getv void getv(string[] names, gobject.value.Value[] values): Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
isFloating bool isFloating(): Checks whether object has a floating[floating-ref] reference.
notify void notify(string propertyName): Emits a "notify" signal for the property property_name on object.
notifyByPspec void notifyByPspec(gobject.param_spec.ParamSpec pspec): Emits a "notify" signal for the property specified by pspec on object.
refSink gobject.object.ObjectWrap refSink(): Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
runDispose void runDispose(): Releases all references to other objects. This can be used to break reference cycles.
setData void setData(string key, void* data): Each object carries around a table of associations from strings to pointers. This function lets you set an association.
setProperty void setProperty(string propertyName, gobject.value.Value value): Sets a property on an object.
stealData void* stealData(string key): Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
stealQdata void* stealQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectWrap.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:
thawNotify void thawNotify(): Reverts the effect of a previous call to gobject.object.ObjectWrap.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
watchClosure void watchClosure(gobject.closure.Closure closure): This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectWrap.ref_ and gobject.object.ObjectWrap.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.
connectNotify gulong connectNotify(string detail, T callback, Flag!"After" after): Connect to Notify signal.

gtk accel_group classes