[Sboulema]

Name: keyconfig
GUID: keyconfig@dorando
Author: Dorando
Version: 20080929
Size: 14KB
Date: 2008-09-29
Compatibility: <Toolkit> 1.9a8 - 1.9.0.3 2.0.0.17 - 3.0.3 2.0.0.17 - 2.0.0.17 0.9 - 0.9 1.2.5 - 1.2.5 <ChatZilla> 0.9.83 - 0.9.83
Homepage | mozillaZine | AMI Discussion

keyconfig allows you to change keyboard shortcuts.

keyconfig adds the ability to create new or modify existing shortcuts defined by a <key>, but only changing those which itself call a function (those with a command or oncommand attribute) has an effect (all others fulfill only cosmetic purposes it seems and are grayed out).

The configuration screen can be accessed via Tools->Keyconfig or Ctrl+Shift+F12 (Command+Shift+F12 on MacOS) in the main window. Other windows can be accessed by right-clicking on the key tree.

Currently there is only one list of modified keys per application, so changing a shortcut in one window will also affect other windows if they use the same key name.

In addition to the sources shown above, you'll find more discussion about keyconfig at Extensions Room.

prefs.js:

// Display internal shortcut
user_pref("keyconfig.devmode", true);

// Reverse the order in which submenu names are used, defaults are:
// Thunderbird       "Menu > Menuitem"
// Others            "Menuitem [Menu]"
user_pref("keyconfig.nicenames.reverse_order", true);

// Use another keyconfig profile, can be used to temporary disable all keys
user_pref("keyconfig.profile", "1");

// Disables the warning if you close the window
user_pref("keyconfig.warnOnClose", false);

// Disables the warning if an already used key was entered
user_pref("keyconfig.warnOnDuplicate", false);

// Don't wait for additional key stroke, jump immediately to the Apply butten
user_pref("keyconfig.allowAltCodes", false);

// Code which will be run in every window (only if non empty)
user_pref("keyconfig.global.20080611", "Module('UIHook');");

// Module('UIHook'); adds a key to all windows matching this pref
user_pref("keyconfig.UIHook","");

// Don't try to invalidate the key cache in case this causes problems
user_pref("keyconfig.tryToInvalidateCache", false);

userChrome.css:

/* Style different types of keys differently */
#keyconfig-window treechildren::-moz-tree-cell-text(hardcoded) { color: GrayText; }
#keyconfig-window treechildren::-moz-tree-cell-text(disabled) { text-decoration: line-through; }
#keyconfig-window treechildren::-moz-tree-cell-text(user) { font-weight: bold; }
#keyconfig-window treechildren::-moz-tree-cell-text(duplicate) { background-color: rgb(80%, 80%, 80%); }
#keyconfig-window treechildren::-moz-tree-cell-text(custom) { font-style: italic; }

NOTES
- All shortcuts listed (except Keyconfig...) are provided by the Application and other extensions, not by keyconfig.
- keyconfig should be able to recognize any keys usable by Gecko
- Any '][' in the code of user defined keys will be replaced by '] [' (which should have the same effect in most cases) since the pref separator is ']['.
- Some users might be interested in functions for keyconfig.
- Default modifiers can be set by changing ui.key.* prefs in about:config.
- URL Suffix allows to edit the URL ctrl/shift/ctrl+shift behavior.
- All-In-One Sidebar, FoxyTunes, Click2Tab, and Penelope base some on their code on keyconfig.

KNOWN ISSUES
- Don't think that changing a <key> will always remove the original shortcuts. For Example: You can change the shortcut for key_copy in the Bookmark Manager but the original shortcut will still work (in addition to the new shortcut).
- It is possible that keyconfig handles modifiers wrong.
- Disabled <key>s are removed from the the document under the assumption that this has no drawbacks.
- It is currently not possible to have the same user defined key in multiple windows without making it global.

WHAT'S NEW
20080929:
- Added zh-CN by Cye3s
- Shortcuts disabled as per also appear disabled in keyconfig now
- Minor workaround because Firefox 3.0.2 changed a "~10 year old behavior in a breaking way"
- Added keyconfig.tryToInvalidateCache pref which if enabled (is enabled by default) tries to invalidate the key cache by cloning the <key> and detaching/reattaching the <keyset> to the DOM (This might cause changes to apply
immediately or after a short delay)
20080611:
- Added support for Toolkit 1.9 Applications and dropped support for pre Toolkit 1.8
- Moved one line of code to the Service Constructor since the app-startup observer doesn't seem to be called in Gecko 1.9 if addObserver has not been called before
- Minor change to the component to avoid a possible leak
- If you had the modified version by onemen installed previously, the keyconfig screen shouldn't fail anymore
- Using Alt Codes as shortcuts should now work again. Note that these won't work in text boxes. Set keyconfig.allowAltCodes to false if you want to use Alt+Number shortcuts.
- A global key (and a menuitem if MenuManipulator is installed) will be added to Applications needing it
20060828:
- Shortcuts with more than two modifiers should now display correctly
- If the modifiers are "shift,alt,control,accel" and the keycode is "VK_SCROLL_LOCK", keyconfig will act as if the key was unassigned (this combination is invalid and Buttons! uses this to provide keys which are disabled by default)
- Changed the window selector to a dropdown list to make it more visible
- Removed 'Copy the ID' and added a generic copy which copies the name, id, shortcut, and associated code
- Minor fix to make keyconfig work correctly in ChatZilla! and added support for the unofficial standalone ChatZilla!
- Some changes to make the keyconfig screen navigatable with the keyboard
- The Key Editor can now be accessed by double clicking or context menu (doing this on a non custom key will duplicate it)
- Added a default style for duplicated shortcuts
- Minor update to the es-AR locale
- Added zh-TW locale by rexx26

Install | Download


PREVIOUS VERSION

Quote

Version: 20060828
Size: 14KB
Date: 2007-01-10
Compatibility: 1.5.0.6 - 3.0.0.* 1.5.0.5 - 3.0.0.* 0.3a1+ - 0.3a1+ 1.0 - 1.0 0.7 - 0.7.* <etna> 0.3.1 - 0.3.1 0.7.4.1 - 0.7.4.1 <ChatZilla> 0.9.75 - 0.9.75 8.1 - 8.1

Install | Download

BUMPED VERSION

Quote

A bumped version of Keyconfig 20080929 can be found here:

Original Author: Dorando
* maxVersion bump by: Seamaiden
Version: 20080929
Size: 16KB
Date: 2010-03-22
Compatibility: <Toolkit> 1.9a8 - 1.9.0.3 2.0.0.17 - 3.* 2.0.0.17 - 3.* 0.9 - 1.* 1.2.5 - 3.* <ChatZilla> 0.9.83 - 1.*

Install | Download

ENHANCED VERSION

Quote

An enhanced version of keyconfig 20050313, keyconfig 20050313.1 made by onemen can be found here:
Original Author: Dorando
* Enhanced by: onemen
Version 20050313
Date: 2006-01-06
Compatibility: 0.9 - 1.6a1 0.8 - 1.6a1
Homepage

CHANGES
- Added sort option
- Added filter option (duplicate shortcut, user setting shortcut and user defined shortcut)
- Highlights duplicate shortcut, user setting shortcut and user defined shortcut
- User can add and edit user defined shortcut directly in the Keyconfig dialog window
- Trunk compatibility

WHAT'S NEW
- FF & TB 1.5 compatibility

Install | Download

RELATED PROJECT

Quote

There is a companion to keyconfig called functions for keyconfig. It adds more options and can be found here.

[Mr.Bill]

Ctrl+Shift+F12 doesnt work with the newer versions.

This post has been edited by Seamaiden: 26 May 2010 - 11:38 AM

[Chetan Bhawani]

Does not install for the latest version of Firefox for mac.

[rasmer]

I have the problem that keyconfig handles modifiers wrong, I hope this gets fixed soon.

[warrior]

rasmer, on Oct 4 2008, 5:10, said:

I have the problem that keyconfig handles modifiers wrong, I hope this gets fixed soon.

This is only available for ~ firefox 1.5, i have firefox 3.0 and it doesn't work. It's a very old topic too, if any of you guys noticed.

All the best!

[Etherfast]

It works on 1.5, doesn't work at all in 3.0.
It's very useful anyway, I'm eagerly waiting for the 3.0 release :)