• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // Copyright (c) 2022 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 // This file was generated by the CEF translator tool and should not edited
33 // by hand. See the translator.README.txt file in the tools directory for
34 // more information.
35 //
36 // $hash=140d3a3ce78f5e8ab50a24a2fd6377e7a8ea3256$
37 //
38 
39 #ifndef CEF_INCLUDE_CAPI_CEF_KEYBOARD_HANDLER_CAPI_H_
40 #define CEF_INCLUDE_CAPI_CEF_KEYBOARD_HANDLER_CAPI_H_
41 #pragma once
42 
43 #include "include/capi/cef_base_capi.h"
44 #include "include/capi/cef_browser_capi.h"
45 
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49 
50 ///
51 // Implement this structure to handle events related to keyboard input. The
52 // functions of this structure will be called on the UI thread.
53 ///
54 typedef struct _cef_keyboard_handler_t {
55   ///
56   // Base structure.
57   ///
58   cef_base_ref_counted_t base;
59 
60   ///
61   // Called before a keyboard event is sent to the renderer. |event| contains
62   // information about the keyboard event. |os_event| is the operating system
63   // event message, if any. Return true (1) if the event was handled or false
64   // (0) otherwise. If the event will be handled in on_key_event() as a keyboard
65   // shortcut set |is_keyboard_shortcut| to true (1) and return false (0).
66   ///
67   int(CEF_CALLBACK* on_pre_key_event)(struct _cef_keyboard_handler_t* self,
68                                       struct _cef_browser_t* browser,
69                                       const struct _cef_key_event_t* event,
70                                       cef_event_handle_t os_event,
71                                       int* is_keyboard_shortcut);
72 
73   ///
74   // Called after the renderer and JavaScript in the page has had a chance to
75   // handle the event. |event| contains information about the keyboard event.
76   // |os_event| is the operating system event message, if any. Return true (1)
77   // if the keyboard event was handled or false (0) otherwise.
78   ///
79   int(CEF_CALLBACK* on_key_event)(struct _cef_keyboard_handler_t* self,
80                                   struct _cef_browser_t* browser,
81                                   const struct _cef_key_event_t* event,
82                                   cef_event_handle_t os_event);
83 } cef_keyboard_handler_t;
84 
85 #ifdef __cplusplus
86 }
87 #endif
88 
89 #endif  // CEF_INCLUDE_CAPI_CEF_KEYBOARD_HANDLER_CAPI_H_
90