Merge branch 'feature/focus-handler-ext' of https://github.com/numbersint/CefSharp

amaitland · amaitland · commit eab35e7306a5 · 2014-11-26T13:32:40.000+10:00
diff --git a/CefSharp.Core/Internals/ClientAdapter.cpp b/CefSharp.Core/Internals/ClientAdapter.cpp
@@ -390,9 +390,41 @@ namespace CefSharp
             }
         }
 
+        void ClientAdapter::OnGotFocus(CefRefPtr<CefBrowser> browser)
+        {
+            IFocusHandler^ handler = _browserControl->FocusHandler;
+
+            if (handler == nullptr)
+            {
+                return;
+            }
+
+            handler->OnGotFocus();
+        }
+
+        bool ClientAdapter::OnSetFocus(CefRefPtr<CefBrowser> browser, FocusSource source)
+        {
+            IFocusHandler^ handler = _browserControl->FocusHandler;
+
+            if (handler == nullptr)
+            {
+                // Allow the focus to be set by default.
+                return false;
+            }
+
+            return handler->OnSetFocus((CefFocusSource)source);
+        }
+
         void ClientAdapter::OnTakeFocus(CefRefPtr<CefBrowser> browser, bool next)
         {
-            _browserControl->OnTakeFocus(next);
+            IFocusHandler^ handler = _browserControl->FocusHandler;
+
+            if (handler == nullptr)
+            {
+                return;
+            }
+
+            handler->OnTakeFocus(next);
         }
 
         bool ClientAdapter::OnJSDialog(CefRefPtr<CefBrowser> browser, const CefString& origin_url, const CefString& accept_lang,
diff --git a/CefSharp.Core/Internals/ClientAdapter.h b/CefSharp.Core/Internals/ClientAdapter.h
@@ -106,6 +106,8 @@ namespace CefSharp
                 CefRefPtr<CefContextMenuParams> params, CefRefPtr<CefMenuModel> model) OVERRIDE;
 
             // CefFocusHandler
+            virtual DECL void OnGotFocus(CefRefPtr<CefBrowser> browser) OVERRIDE;
+            virtual DECL bool OnSetFocus(CefRefPtr<CefBrowser> browser, FocusSource source) OVERRIDE;
             virtual DECL void OnTakeFocus(CefRefPtr<CefBrowser> browser, bool next) OVERRIDE;
 
             // CefKeyboardHandler
diff --git a/CefSharp.OffScreen/ChromiumWebBrowser.cs b/CefSharp.OffScreen/ChromiumWebBrowser.cs
@@ -176,6 +176,7 @@ public Task<Bitmap> ScreenshotAsync()
         public IKeyboardHandler KeyboardHandler { get; set; }
         public ILifeSpanHandler LifeSpanHandler { get; set; }
         public IMenuHandler MenuHandler { get; set; }
+        public IFocusHandler FocusHandler { get; set; }
         public IRequestHandler RequestHandler { get; set; }
 
         public event EventHandler<LoadErrorEventArgs> LoadError;
@@ -452,11 +453,6 @@ void IWebBrowserInternal.OnLoadError(string url, CefErrorCode errorCode, string
             }
         }
 
-        void IWebBrowserInternal.OnTakeFocus(bool next)
-        {
-            throw new NotImplementedException();
-        }
-
         void IWebBrowserInternal.OnStatusMessage(string value)
         {
             var handler = StatusMessage;
diff --git a/CefSharp.WinForms.Example/BrowserTabUserControl.cs b/CefSharp.WinForms.Example/BrowserTabUserControl.cs
@@ -25,6 +25,7 @@ public BrowserTabUserControl(string url)
 
             browser.MenuHandler = new MenuHandler();
             browser.RequestHandler = new RequestHandler();
+            //browser.FocusHandler = new FocusHandler(browser, urlTextBox);
             browser.NavStateChanged += OnBrowserNavStateChanged;
             browser.ConsoleMessage += OnBrowserConsoleMessage;
             browser.TitleChanged += OnBrowserTitleChanged;
diff --git a/CefSharp.WinForms.Example/CefSharp.WinForms.Example.csproj b/CefSharp.WinForms.Example/CefSharp.WinForms.Example.csproj
@@ -70,6 +70,7 @@
     <Compile Include="BrowserTabUserControl.Designer.cs">
       <DependentUpon>BrowserTabUserControl.cs</DependentUpon>
     </Compile>
+    <Compile Include="FocusHandler.cs" />
     <Compile Include="MenuHandler.cs" />
     <Compile Include="Minimal\SimpleBrowserForm.cs">
       <SubType>Form</SubType>
diff --git a/CefSharp.WinForms.Example/FocusHandler.cs b/CefSharp.WinForms.Example/FocusHandler.cs
@@ -0,0 +1,41 @@
+﻿// Copyright © 2010-2014 The CefSharp Authors. All rights reserved.
+//
+// Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.
+
+using System.Windows.Forms;
+namespace CefSharp.WinForms.Example
+{
+    internal class FocusHandler : IFocusHandler
+    {
+        private ChromiumWebBrowser browser;
+        private ToolStripTextBox urlTextBox;
+
+        public FocusHandler(ChromiumWebBrowser browser, ToolStripTextBox urlTextBox)
+        {
+            this.browser = browser;
+            this.urlTextBox = urlTextBox;
+        }
+
+        public void OnGotFocus()
+        {
+            // Fired when Chromium finally receives focus.
+        }
+
+        public bool OnSetFocus(CefFocusSource source)
+        {
+            // Returning false means that we allow Chromium to take the focus away from our WinForms control.
+            // You could also return true to keep focus in the address bar.
+            return false;
+        }
+
+        public void OnTakeFocus(bool next)
+        {
+            // Fired when Chromium is giving up focus because the user
+            // pressed Tab on the last link/field in the HTML document (in which case 'next' is true)
+            // or because they pressed Shift+Tab on the first link/field (in which case 'next' is false).
+            
+            // Here we always focus on the address bar.
+            urlTextBox.Control.BeginInvoke(new MethodInvoker(() => urlTextBox.Focus()));
+        }
+    }
+}
diff --git a/CefSharp.WinForms/ChromiumWebBrowser.cs b/CefSharp.WinForms/ChromiumWebBrowser.cs
@@ -26,6 +26,7 @@ public class ChromiumWebBrowser : Control, IWebBrowserInternal, IWinFormsWebBrow
         public IDownloadHandler DownloadHandler { get; set; }
         public ILifeSpanHandler LifeSpanHandler { get; set; }
         public IMenuHandler MenuHandler { get; set; }
+        public IFocusHandler FocusHandler { get; set; }
 
         public bool CanGoForward { get; private set; }
         public bool CanGoBack { get; private set; }
@@ -54,6 +55,8 @@ public ChromiumWebBrowser(string address)
             Address = address;
 
             Dock = DockStyle.Fill;
+
+            FocusHandler = new DefaultFocusHandler(this);
         }
 
         protected override void Dispose(bool disposing)
@@ -208,11 +211,6 @@ void IWebBrowserInternal.OnFrameLoadEnd(string url, bool isMainFrame, int httpSt
             }
         }
 
-        void IWebBrowserInternal.OnTakeFocus(bool next)
-        {
-            SelectNextControl(this, next, true, true, true);
-        }
-
         void IWebBrowserInternal.OnConsoleMessage(string message, string source, int line)
         {
             var handler = ConsoleMessage;
@@ -358,5 +356,31 @@ private void ResizeBrowser()
                 managedCefBrowserAdapter.Resize(Width, Height);
             }
         }
+
+        #region DefaultFocusHandler
+        private class DefaultFocusHandler : IFocusHandler
+        {
+            private ChromiumWebBrowser browser;
+
+            public DefaultFocusHandler(ChromiumWebBrowser browser)
+            {
+                this.browser = browser;
+            }
+
+            public void OnGotFocus()
+            {
+            }
+
+            public bool OnSetFocus(CefFocusSource source)
+            {
+                return false;
+            }
+
+            public void OnTakeFocus(bool next)
+            {
+                browser.BeginInvoke(new MethodInvoker(() => browser.SelectNextControl(browser, next, true, true, true)));
+            }
+        }
+        #endregion
     }
 }
diff --git a/CefSharp.Wpf/ChromiumWebBrowser.cs b/CefSharp.Wpf/ChromiumWebBrowser.cs
@@ -51,6 +51,7 @@ public class ChromiumWebBrowser : ContentControl, IRenderWebBrowser, IWpfWebBrow
         public IDownloadHandler DownloadHandler { get; set; }
         public ILifeSpanHandler LifeSpanHandler { get; set; }
         public IMenuHandler MenuHandler { get; set; }
+        public IFocusHandler FocusHandler { get; set; }
 
         public event EventHandler<ConsoleMessageEventArgs> ConsoleMessage;
         public event EventHandler<StatusMessageEventArgs> StatusMessage;
@@ -1132,11 +1133,6 @@ void IWebBrowserInternal.OnFrameLoadEnd(string url, bool isMainFrame, int httpSt
             }
         }
 
-        void IWebBrowserInternal.OnTakeFocus(bool next)
-        {
-            throw new NotImplementedException();
-        }
-
         void IWebBrowserInternal.OnConsoleMessage(string message, string source, int line)
         {
             var handler = ConsoleMessage;
diff --git a/CefSharp/CefFocusSource.cs b/CefSharp/CefFocusSource.cs
@@ -0,0 +1,21 @@
+﻿// Copyright © 2010-2014 The CefSharp Authors. All rights reserved.
+//
+// Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.
+
+namespace CefSharp
+{
+	/// <summary>
+	/// Focus Source
+	/// </summary>
+	public enum CefFocusSource
+	{
+		/// <summary>
+        /// The source is explicit navigation via the API (LoadURL(), etc).
+		/// </summary>
+		FocusSourceNavigation = 0,
+		/// <summary>
+        /// The source is a system-generated focus event.
+		/// </summary>
+		FocusSourceSystem
+	}
+}
diff --git a/CefSharp/CefSharp.csproj b/CefSharp/CefSharp.csproj
@@ -89,6 +89,7 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="CefFileDialogMode.cs" />
+    <Compile Include="IFocusHandler.cs" />
     <Compile Include="IsBrowserInitializedChangedEventArgs.cs" />
     <Compile Include="CefTerminationStatus.cs" />
     <Compile Include="IDialogHandler.cs" />
@@ -114,6 +115,7 @@
     <Compile Include="TransitionType.cs" />
     <Compile Include="NavStateChangedEventArgs.cs" />
     <Compile Include="ICompletionHandler.cs" />
+    <Compile Include="CefFocusSource.cs" />
     <Compile Include="Internals\BitmapInfo.cs" />
     <Compile Include="Internals\IBrowserProcess.cs" />
     <Compile Include="Internals\JavascriptMethod.cs" />
diff --git a/CefSharp/IFocusHandler.cs b/CefSharp/IFocusHandler.cs
@@ -0,0 +1,29 @@
+﻿// Copyright © 2010-2014 The CefSharp Authors. All rights reserved.
+//
+// Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.
+
+namespace CefSharp
+{
+    public interface IFocusHandler
+    {
+        /// <summary>
+        /// Called when the browser component has received focus.
+        /// </summary>
+        void OnGotFocus();
+
+        /// <summary>
+        /// Called when the browser component is requesting focus.
+        /// </summary>
+        /// <param name="source">Indicates where the focus request is originating from.</param>
+        /// <returns>Return false to allow the focus to be set or true to cancel setting the focus.</returns>
+        bool OnSetFocus(CefFocusSource source);
+
+        /// <summary>
+        /// Called when the browser component is about to lose focus.
+        /// For instance, if focus was on the last HTML element and the user pressed the TAB key.
+        /// </summary>
+        /// <param name="next">Will be true if the browser is giving focus to the next component
+        /// and false if the browser is giving focus to the previous component.</param>
+        void OnTakeFocus(bool next);
+    }
+}
diff --git a/CefSharp/IWebBrowser.cs b/CefSharp/IWebBrowser.cs
@@ -117,6 +117,11 @@ public interface IWebBrowser : IDisposable
         /// </summary>
         IMenuHandler MenuHandler { get; set; }
 
+        /// <summary>
+        /// Implement <see cref="IFocusHandler"/> and assign to handle events related to the browser component's focus
+        /// </summary>
+        IFocusHandler FocusHandler { get; set; }
+
         /// <summary>
         /// A flag that indicates whether the WebBrowser is initialized (true) or not (false).
         /// </summary>
diff --git a/CefSharp/Internals/IWebBrowserInternal.cs b/CefSharp/Internals/IWebBrowserInternal.cs
@@ -16,7 +16,6 @@ public interface IWebBrowserInternal : IWebBrowser
 
         void OnFrameLoadStart(string url, bool isMainFrame);
         void OnFrameLoadEnd(string url, bool isMainFrame, int httpStatusCode);
-        void OnTakeFocus(bool next);
         void OnConsoleMessage(string message, string source, int line);
         void OnStatusMessage(string value);
         void OnLoadError(string url, CefErrorCode errorCode, string errorText);

Original file line number	Diff line number	Diff line change
`@@ -176,6 +176,7 @@ public Task<Bitmap> ScreenshotAsync()`
`176`	`176`	`public IKeyboardHandler KeyboardHandler { get; set; }`
`177`	`177`	`public ILifeSpanHandler LifeSpanHandler { get; set; }`
`178`	`178`	`public IMenuHandler MenuHandler { get; set; }`
	`179`	`+ public IFocusHandler FocusHandler { get; set; }`
`179`	`180`	`public IRequestHandler RequestHandler { get; set; }`
`180`	`181`
`181`	`182`	`public event EventHandler<LoadErrorEventArgs> LoadError;`
`@@ -452,11 +453,6 @@ void IWebBrowserInternal.OnLoadError(string url, CefErrorCode errorCode, string`
`452`	`453`	`}`
`453`	`454`	`}`
`454`	`455`
`455`		`- void IWebBrowserInternal.OnTakeFocus(bool next)`
`456`		`- {`
`457`		`- throw new NotImplementedException();`
`458`		`- }`
`459`		`-`
`460`	`456`	`void IWebBrowserInternal.OnStatusMessage(string value)`
`461`	`457`	`{`
`462`	`458`	`var handler = StatusMessage;`
Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,7 @@ public class ChromiumWebBrowser : ContentControl, IRenderWebBrowser, IWpfWebBrow`
`51`	`51`	`public IDownloadHandler DownloadHandler { get; set; }`
`52`	`52`	`public ILifeSpanHandler LifeSpanHandler { get; set; }`
`53`	`53`	`public IMenuHandler MenuHandler { get; set; }`
	`54`	`+ public IFocusHandler FocusHandler { get; set; }`
`54`	`55`
`55`	`56`	`public event EventHandler<ConsoleMessageEventArgs> ConsoleMessage;`
`56`	`57`	`public event EventHandler<StatusMessageEventArgs> StatusMessage;`
`@@ -1132,11 +1133,6 @@ void IWebBrowserInternal.OnFrameLoadEnd(string url, bool isMainFrame, int httpSt`
`1132`	`1133`	`}`
`1133`	`1134`	`}`
`1134`	`1135`
`1135`		`- void IWebBrowserInternal.OnTakeFocus(bool next)`
`1136`		`- {`
`1137`		`- throw new NotImplementedException();`
`1138`		`- }`
`1139`		`-`
`1140`	`1136`	`void IWebBrowserInternal.OnConsoleMessage(string message, string source, int line)`
`1141`	`1137`	`{`
`1142`	`1138`	`var handler = ConsoleMessage;`