org.gnu.gtk
Class AccelMap
public
class
AccelMap
extends GObject
Method Summary |
static boolean | changeEntry(String accelPath, int key, ModifierType mods, boolean replace)
Changes the key (from {@link KeyValue}) and {@link ModifierType}
currently associated with accelPath. |
static AccelMap | getAccelMap(Handle handle)
Internal static factory method to be used by Java-Gnome only. |
static AccelMap | getAccelMap() |
static void | load(String filename)
Loads a file previously saved with the same method, parses the file for
accelerator specifications, and propagates them accordingly.
|
static void | lockPath(String path)
Locks the given accelerator path. |
static AccelKey | lookupEntry(String accelPath)
Looks up the accelerator entry for accelPath and returns the AccelKey
|
static void | save(String filename)
Saves the current accelerator specification (accelerator path, key, and
modifiers) to the filename specified.
|
static void | unlockPath(String path)
Undoes the last call to {@link #lockPath(String)} on this accel_path.
|
public static boolean changeEntry(String accelPath, int key,
ModifierType mods, boolean replace)
Changes the key (from {@link KeyValue}) and {@link ModifierType}
currently associated with accelPath. Due to conflicts with other
accelerators, a change may not always be possible, replace indicates
whether other accelerators may be deleted to resolve such 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.
Parameters: accelPath
The path to change key
The new KeySymbol for the path mods
The new modifiers to the path replace
If true, removes conflicting accelerators
Returns: true if the change succeeded, false, otherwise
Since: 2.8.1
public static
AccelMap getAccelMap(Handle handle)
Internal static factory method to be used by Java-Gnome only.
public static void load(String filename)
Loads a file previously saved with the same method, parses the file for
accelerator specifications, and propagates them accordingly.
Parameters: filename
The name of the file to read.
public static void lockPath(String 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
{@link #unlockPath(String)} Refer to
{@link #changeEntry(String, int, ModifierType, boolean)} for information
about runtime accelerator changes. If called more than once, accel_path
remains locked until {@link #unlockPath(String)} has been called an
equivalent number of times. Note that locking of individual accelerator
paths is independent from locking the {@link AccelGroup} containing them.
For runtime accelerator changes to be possible both the accelerator path
and its AccelGroup have to be unlocked.
Parameters: path
The path to lock
public static
AccelKey lookupEntry(String accelPath)
Looks up the accelerator entry for accelPath and returns the AccelKey
Parameters: accelPath
The path to get the accelerator entry for
Returns: The AccelKey representing the accelerator
Since: 2.8.1
public static void save(String filename)
Saves the current accelerator specification (accelerator path, key, and
modifiers) to the filename specified.
Parameters: filename
The name of the file to write.
public static void unlockPath(String path)
Undoes the last call to {@link #lockPath(String)} on this accel_path.
Refer to {@link #lockPath(String)} for information about accelerator path
locking.
Parameters: path
The path to unlock