org.gnu.gtk

Class BindingSet


public class BindingSet
extends MemStruct

Key bindings for individual widgets. TODO: Complete javadocs.

Constructor Summary

BindingSet(String setName)
Construct a new BindingSet.

Method Summary

boolean
activateBindingSet(int keyval, ModifierType modifier)
boolean
activateBindingSet(KeySymbol keyval, ModifierType modifier)
Deprecated.
boolean
activateBindings(int keyval, ModifierType modifier)
boolean
activateBindings(KeySymbol keyval, ModifierType modifier)
Deprecated.
boolean
activateEvent(EventKey event)
Looks up key bindings for this BindingSet to find one that matches event, and if one was found, activate it.
void
addPath(PathType pathType, String pathPattern, PathPriorityType priority)
void
clearEntry(int keyval, ModifierType modifier)
Clears a BindingSet entry.
void
clearEntry(KeySymbol keyval, ModifierType modifier)
Deprecated.
static BindingSet
findBindingSet(String setName)
Finds a BindingSet object given the name.
void
removeEntry(int keyval, ModifierType modifier)
Removes an entry from the BindingSet
void
removeEntry(KeySymbol keyval, ModifierType modifier)
Deprecated.

Constructor Details

BindingSet

public BindingSet(String setName)
Construct a new BindingSet.
Parameters:
setName - The name of the BindingSet

Method Details

activateBindingSet

public boolean activateBindingSet(int keyval,
                                  ModifierType modifier)
Parameters:
keyval - The key value for the BindingSet.
modifier - The key modifier for the BindingSet
Since:
2.8.1

activateBindingSet

public boolean activateBindingSet(KeySymbol keyval,
                                  ModifierType modifier)

Deprecated.

Parameters:
keyval - The key value for the BindingSet.
modifier - The key modifier for the BindingSet

activateBindings

public boolean activateBindings(int keyval,
                                ModifierType modifier)
Parameters:
keyval - The key value for the BindingSet (from KeyValue).
modifier - The key modifier for the BindingSet
Since:
2.8.1

activateBindings

public boolean activateBindings(KeySymbol keyval,
                                ModifierType modifier)

Deprecated.

Parameters:
keyval - The key value for the BindingSet.
modifier - The key modifier for the BindingSet

activateEvent

public boolean activateEvent(EventKey event)
Looks up key bindings for this BindingSet to find one that matches event, and if one was found, activate it.
Returns:
TRUE if a matching key binding was found.

addPath

public void addPath(PathType pathType,
                    String pathPattern,
                    PathPriorityType priority)
Parameters:
pathType -
pathPattern -
priority -

clearEntry

public void clearEntry(int keyval,
                       ModifierType modifier)
Clears a BindingSet entry.
Parameters:
keyval - The key value for the BindingSet.
modifier - The key modifier for the BindingSet
Since:
2.8.1

clearEntry

public void clearEntry(KeySymbol keyval,
                       ModifierType modifier)

Deprecated.

Clears a BindingSet entry.
Parameters:
keyval - The key value for the BindingSet.
modifier - The key modifier for the BindingSet

findBindingSet

public static BindingSet findBindingSet(String setName)
Finds a BindingSet object given the name.
Parameters:
setName - The name of the BindingSet to find
Returns:
A BindingSet object

removeEntry

public void removeEntry(int keyval,
                        ModifierType modifier)
Removes an entry from the BindingSet
Parameters:
keyval -
modifier -
Since:
2.8.1

removeEntry

public void removeEntry(KeySymbol keyval,
                        ModifierType modifier)

Deprecated.