git.sesse.net Git - casparcg/blob - dependencies64/cef/windows/include/cef_focus_handler.h

   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_FOCUS_HANDLER_H_
  38 #define CEF_INCLUDE_CEF_FOCUS_HANDLER_H_
  39 #pragma once
  40
  41 #include "include/cef_base.h"
  42 #include "include/cef_browser.h"
  43 #include "include/cef_dom.h"
  44 #include "include/cef_frame.h"
  45
  46 ///
  47 // Implement this interface to handle events related to focus. The methods of
  48 // this class will be called on the UI thread.
  49 ///
  50 /*--cef(source=client)--*/
  51 class CefFocusHandler : public virtual CefBaseRefCounted {
  52  public:
  53   typedef cef_focus_source_t FocusSource;
  54
  55   ///
  56   // Called when the browser component is about to loose focus. For instance, if
  57   // focus was on the last HTML element and the user pressed the TAB key. |next|
  58   // will be true if the browser is giving focus to the next component and false
  59   // if the browser is giving focus to the previous component.
  60   ///
  61   /*--cef()--*/
  62   virtual void OnTakeFocus(CefRefPtr<CefBrowser> browser,
  63                            bool next) {}
  64
  65   ///
  66   // Called when the browser component is requesting focus. |source| indicates
  67   // where the focus request is originating from. Return false to allow the
  68   // focus to be set or true to cancel setting the focus.
  69   ///
  70   /*--cef()--*/
  71   virtual bool OnSetFocus(CefRefPtr<CefBrowser> browser,
  72                           FocusSource source) { return false; }
  73
  74   ///
  75   // Called when the browser component has received focus.
  76   ///
  77   /*--cef()--*/
  78   virtual void OnGotFocus(CefRefPtr<CefBrowser> browser) {}
  79 };
  80
  81 #endif  // CEF_INCLUDE_CEF_FOCUS_HANDLER_H_