BindingSet

A binding set maintains a list of activatable key bindings. A single binding set can match multiple types of widgets. Similar to style contexts, can be matched by any information contained in a widgets #GtkWidgetPath. When a binding within a set is matched upon activation, an action signal is emitted on the target widget to carry out the actual activation.

final

class BindingSet {

protected

GtkBindingSet* gtkBindingSet;

protected

bool ownedRef;

GtkBindingSet* getBindingSetStruct(bool transferOwnership);

void* getStruct();

this(GtkBindingSet* gtkBindingSet, bool ownedRef);

~this();

string setName [@property getter];

string setName [@property setter];

int priority [@property getter];

int priority [@property setter];

ListSG widgetPathPspecs [@property getter];

ListSG widgetPathPspecs [@property setter];

ListSG widgetClassPspecs [@property getter];

ListSG widgetClassPspecs [@property setter];

ListSG classBranchPspecs [@property getter];

ListSG classBranchPspecs [@property setter];

GtkBindingEntry* entries [@property getter];

GtkBindingEntry* entries [@property setter];

GtkBindingEntry* current [@property getter];

GtkBindingEntry* current [@property setter];

uint parsed [@property getter];

uint parsed [@property setter];

bool activate(uint keyval, GdkModifierType modifiers, ObjectG object);

void addPath(GtkPathType pathType, string pathPattern, GtkPathPriorityType priority);

static BindingSet byClass(void* objectClass);

static BindingSet find(string setName);

this(string setName);

static bool bindingsActivate(ObjectG object, uint keyval, GdkModifierType modifiers);

static bool bindingsActivateEvent(ObjectG object, GdkEventKey* event);

}

Constructors

this this(GtkBindingSet* gtkBindingSet, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(string setName): GTK+ maintains a global list of binding sets. Each binding set has a unique name which needs to be specified upon creation.

Destructor

~this ~this(): Undocumented in source.

Members

Functions

activate bool activate(uint keyval, GdkModifierType modifiers, ObjectG object): Find a key binding matching @keyval and @modifiers within @binding_set and activate the binding on @object.
addPath void addPath(GtkPathType pathType, string pathPattern, GtkPathPriorityType priority): This function was used internally by the GtkRC parsing mechanism to assign match patterns to #GtkBindingSet structures.
getBindingSetStruct GtkBindingSet* getBindingSetStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*

Properties

classBranchPspecs ListSG classBranchPspecs [@property getter]
ListSG classBranchPspecs [@property setter]: unused
current GtkBindingEntry* current [@property getter]
GtkBindingEntry* current [@property setter]: implementation detail
entries GtkBindingEntry* entries [@property getter]
GtkBindingEntry* entries [@property setter]: the key binding entries in this binding set
parsed uint parsed [@property getter]
uint parsed [@property setter]: whether this binding set stems from a CSS file and is reset upon theme changes
priority int priority [@property getter]
int priority [@property setter]: unused
setName string setName [@property getter]
string setName [@property setter]: unique name of this binding set
widgetClassPspecs ListSG widgetClassPspecs [@property getter]
ListSG widgetClassPspecs [@property setter]: unused
widgetPathPspecs ListSG widgetPathPspecs [@property getter]
ListSG widgetPathPspecs [@property setter]: unused

Static functions

bindingsActivate bool bindingsActivate(ObjectG object, uint keyval, GdkModifierType modifiers): Find a key binding matching @keyval and @modifiers and activate the binding on @object.
bindingsActivateEvent bool bindingsActivateEvent(ObjectG object, GdkEventKey* event): Looks up key bindings for @object to find one matching @event, and if one was found, activate it.
byClass BindingSet byClass(void* objectClass): This function returns the binding set named after the type name of the passed in class structure. New binding sets are created on demand by this function.
find BindingSet find(string setName): Find a binding set by its globally unique name.

Variables

gtkBindingSet GtkBindingSet* gtkBindingSet;: the main Gtk struct
ownedRef bool ownedRef;: Undocumented in source.