1 // Copyright (c) 2009 The Chromium Authors. All rights reserved. 2 // Use of this source code is governed by a BSD-style license that can be 3 // found in the LICENSE file. 4 5 #ifndef CHROME_BROWSER_GLOBAL_KEYBOARD_SHORTCUTS_MAC_H_ 6 #define CHROME_BROWSER_GLOBAL_KEYBOARD_SHORTCUTS_MAC_H_ 7 8 #include "base/basictypes.h" 9 10 struct KeyboardShortcutData { 11 bool command_key; 12 bool shift_key; 13 bool cntrl_key; 14 bool opt_key; 15 // Either one of vkey_code or key_char must be specified. For keys 16 // whose virtual key code is hardware-dependent (kVK_ANSI_*) key_char 17 // should be specified instead. 18 // Set 0 for the one you do not want to specify. 19 int vkey_code; // Virtual Key code for the command. 20 unichar key_char; // Key event characters for the command as reported by 21 // [NSEvent charactersIgnoringModifiers]. 22 int chrome_command; // The chrome command # to execute for this shortcut. 23 }; 24 25 // Check if a given keycode + modifiers (or keychar + modifiers if the 26 // |key_char| is specified) correspond to a given Chrome command. 27 // returns: Command number (as passed to 28 // BrowserCommandController::ExecuteCommand) or -1 if there was no match. 29 // 30 // |performKeyEquivalent:| bubbles events up from the window to the views. If 31 // we let it bubble up to the Omnibox, then the Omnibox handles cmd-left/right 32 // just fine, but it swallows cmd-1 and doesn't give us a chance to intercept 33 // this. Hence, we need three types of keyboard shortcuts: shortcuts that are 34 // intercepted before the Omnibox handles events, shortcuts that are 35 // intercepted after the Omnibox had a chance but did not handle them, and 36 // shortcuts that are only handled when tab contents is focused. 37 // 38 // This means cmd-left doesn't work if you hit cmd-l tab, which focusses 39 // something that's neither omnibox nor tab contents. This behavior is 40 // consistent with safari and camino, and I think it's the best we can do 41 // without rewriting event dispatching ( http://crbug.com/251069 ). 42 43 // This returns shortcuts that should work no matter what component of the 44 // browser is focused. They are executed by the window, before any view has the 45 // opportunity to override the shortcut (with the exception of the tab contents, 46 // which first checks if the current web page wants to handle the shortcut). 47 int CommandForWindowKeyboardShortcut( 48 bool command_key, bool shift_key, bool cntrl_key, bool opt_key, 49 int vkey_code, unichar key_char); 50 51 // This returns shortcuts that should work no matter what component of the 52 // browser is focused. They are executed by the window, after any view has the 53 // opportunity to override the shortcut 54 int CommandForDelayedWindowKeyboardShortcut( 55 bool command_key, bool shift_key, bool cntrl_key, bool opt_key, 56 int vkey_code, unichar key_char); 57 58 // This returns shortcuts that should work only if the tab contents have focus 59 // (e.g. cmd-left, which shouldn't do history navigation if e.g. the omnibox has 60 // focus). 61 int CommandForBrowserKeyboardShortcut( 62 bool command_key, bool shift_key, bool cntrl_key, bool opt_key, 63 int vkey_code, unichar key_char); 64 65 // Returns a keyboard event character for the given |event|. In most cases 66 // this returns the first character of [NSEvent charactersIgnoringModifiers], 67 // but when [NSEvent character] has different printable ascii character 68 // we may return the first character of [NSEvent characters] instead. 69 // (E.g. for dvorak-qwerty layout we want [NSEvent characters] rather than 70 // [charactersIgnoringModifiers] for command keys. Similarly, on german 71 // layout we want '{' character rather than '8' for opt-8.) 72 unichar KeyCharacterForEvent(NSEvent* event); 73 74 // For testing purposes. 75 const KeyboardShortcutData* GetWindowKeyboardShortcutTable(size_t* num_entries); 76 const KeyboardShortcutData* 77 GetDelayedWindowKeyboardShortcutTable(size_t* num_entries); 78 const KeyboardShortcutData* 79 GetBrowserKeyboardShortcutTable(size_t* num_entries); 80 81 #endif // #ifndef CHROME_BROWSER_GLOBAL_KEYBOARD_SHORTCUTS_MAC_H_ 82