1 // Copyright (c) 2012 Marshall A. Greenblatt. All rights reserved. 2 // 3 // Redistribution and use in source and binary forms, with or without 4 // modification, are permitted provided that the following conditions are 5 // met: 6 // 7 // * Redistributions of source code must retain the above copyright 8 // notice, this list of conditions and the following disclaimer. 9 // * Redistributions in binary form must reproduce the above 10 // copyright notice, this list of conditions and the following disclaimer 11 // in the documentation and/or other materials provided with the 12 // distribution. 13 // * Neither the name of Google Inc. nor the name Chromium Embedded 14 // Framework nor the names of its contributors may be used to endorse 15 // or promote products derived from this software without specific prior 16 // written permission. 17 // 18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 // 30 // --------------------------------------------------------------------------- 31 // 32 // The contents of this file must follow a specific format in order to 33 // support the CEF translator tool. See the translator.README.txt file in the 34 // tools directory for more information. 35 // 36 37 #ifndef CEF_INCLUDE_CEF_KEYBOARD_HANDLER_H_ 38 #define CEF_INCLUDE_CEF_KEYBOARD_HANDLER_H_ 39 #pragma once 40 41 #include "include/cef_base.h" 42 #include "include/cef_browser.h" 43 44 /// 45 // Implement this interface to handle events related to keyboard input. The 46 // methods of this class will be called on the UI thread. 47 /// 48 /*--cef(source=client)--*/ 49 class CefKeyboardHandler : public virtual CefBaseRefCounted { 50 public: 51 /// 52 // Called before a keyboard event is sent to the renderer. |event| contains 53 // information about the keyboard event. |os_event| is the operating system 54 // event message, if any. Return true if the event was handled or false 55 // otherwise. If the event will be handled in OnKeyEvent() as a keyboard 56 // shortcut set |is_keyboard_shortcut| to true and return false. 57 /// 58 /*--cef()--*/ OnPreKeyEvent(CefRefPtr<CefBrowser> browser,const CefKeyEvent & event,CefEventHandle os_event,bool * is_keyboard_shortcut)59 virtual bool OnPreKeyEvent(CefRefPtr<CefBrowser> browser, 60 const CefKeyEvent& event, 61 CefEventHandle os_event, 62 bool* is_keyboard_shortcut) { 63 return false; 64 } 65 66 /// 67 // Called after the renderer and JavaScript in the page has had a chance to 68 // handle the event. |event| contains information about the keyboard event. 69 // |os_event| is the operating system event message, if any. Return true if 70 // the keyboard event was handled or false otherwise. 71 /// 72 /*--cef()--*/ OnKeyEvent(CefRefPtr<CefBrowser> browser,const CefKeyEvent & event,CefEventHandle os_event)73 virtual bool OnKeyEvent(CefRefPtr<CefBrowser> browser, 74 const CefKeyEvent& event, 75 CefEventHandle os_event) { 76 return false; 77 } 78 }; 79 80 #endif // CEF_INCLUDE_CEF_KEYBOARD_HANDLER_H_ 81