Skip to content

Commit 8d98043

Browse files
campersaucampersau
authored
Core - Add IFrameHandler (#3757)
* Core - Add IFrameHandler/FrameHandler * Update comments
1 parent cf00a45 commit 8d98043

File tree

7 files changed

+246
-1
lines changed

7 files changed

+246
-1
lines changed

‎CefSharp.Core.Runtime/Internals/ClientAdapter.cpp‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1119,6 +1119,65 @@ namespace CefSharp
11191119
}
11201120
}
11211121

1122+
void ClientAdapter::OnFrameCreated(CefRefPtr<CefBrowser> browser, CefRefPtr<CefFrame> frame)
1123+
{
1124+
auto handler = _browserControl->FrameHandler;
1125+
1126+
if (handler != nullptr)
1127+
{
1128+
auto browserWrapper = GetBrowserWrapper(browser->GetIdentifier(), browser->IsPopup());
1129+
CefFrameWrapper frameWrapper(frame);
1130+
1131+
handler->OnFrameCreated(_browserControl, browserWrapper, %frameWrapper);
1132+
}
1133+
}
1134+
1135+
void ClientAdapter::OnFrameAttached(CefRefPtr<CefBrowser> browser, CefRefPtr<CefFrame> frame)
1136+
{
1137+
auto handler = _browserControl->FrameHandler;
1138+
1139+
if (handler != nullptr)
1140+
{
1141+
auto browserWrapper = GetBrowserWrapper(browser->GetIdentifier(), browser->IsPopup());
1142+
CefFrameWrapper frameWrapper(frame);
1143+
1144+
handler->OnFrameAttached(_browserControl, browserWrapper, %frameWrapper);
1145+
}
1146+
}
1147+
1148+
void ClientAdapter::OnFrameDetached(CefRefPtr<CefBrowser> browser, CefRefPtr<CefFrame> frame)
1149+
{
1150+
auto handler = _browserControl->FrameHandler;
1151+
1152+
if (handler != nullptr)
1153+
{
1154+
auto browserWrapper = GetBrowserWrapper(browser->GetIdentifier(), browser->IsPopup());
1155+
CefFrameWrapper frameWrapper(frame);
1156+
1157+
handler->OnFrameDetached(_browserControl, browserWrapper, %frameWrapper);
1158+
}
1159+
}
1160+
1161+
void ClientAdapter::OnMainFrameChanged(CefRefPtr<CefBrowser> browser, CefRefPtr<CefFrame> old_frame, CefRefPtr<CefFrame> new_frame)
1162+
{
1163+
auto handler = _browserControl->FrameHandler;
1164+
1165+
if (handler != nullptr)
1166+
{
1167+
auto browserWrapper = GetBrowserWrapper(browser->GetIdentifier(), browser->IsPopup());
1168+
CefFrameWrapper^ oldFrameWrapper = nullptr;
1169+
if (old_frame.get()) {
1170+
oldFrameWrapper = gcnew CefFrameWrapper(old_frame);
1171+
}
1172+
CefFrameWrapper^ newFrameWrapper = nullptr;
1173+
if (new_frame.get()) {
1174+
newFrameWrapper = gcnew CefFrameWrapper(new_frame);
1175+
}
1176+
1177+
handler->OnMainFrameChanged(_browserControl, browserWrapper, oldFrameWrapper, newFrameWrapper);
1178+
}
1179+
}
1180+
11221181
bool ClientAdapter::OnProcessMessageReceived(CefRefPtr<CefBrowser> browser, CefRefPtr<CefFrame> frame, CefProcessId source_process, CefRefPtr<CefProcessMessage> message)
11231182
{
11241183
if (_disposed)

‎CefSharp.Core.Runtime/Internals/ClientAdapter.h‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ namespace CefSharp
3333
public CefDragHandler,
3434
public CefDownloadHandler,
3535
public CefFindHandler,
36-
public CefAudioHandler
36+
public CefAudioHandler,
37+
public CefFrameHandler
3738
{
3839
private:
3940
gcroot<IWebBrowserInternal^> _browserControl;
@@ -100,6 +101,7 @@ namespace CefSharp
100101
virtual DECL CefRefPtr<CefDragHandler> GetDragHandler() override { return this; }
101102
virtual DECL CefRefPtr<CefFindHandler> GetFindHandler() override { return this; }
102103
virtual DECL CefRefPtr<CefAudioHandler> GetAudioHandler() override { return this; }
104+
virtual DECL CefRefPtr<CefFrameHandler> GetFrameHandler() override { return this; }
103105
virtual DECL bool OnProcessMessageReceived(CefRefPtr<CefBrowser> browser, CefRefPtr<CefFrame> frame, CefProcessId source_process, CefRefPtr<CefProcessMessage> message) override;
104106

105107

@@ -201,6 +203,12 @@ namespace CefSharp
201203
virtual DECL void OnAudioStreamStopped(CefRefPtr<CefBrowser> browser) override;
202204
virtual DECL void OnAudioStreamError(CefRefPtr<CefBrowser> browser, const CefString& message) override;
203205

206+
//CefFrameHandler
207+
virtual DECL void OnFrameCreated(CefRefPtr<CefBrowser> browser, CefRefPtr<CefFrame> frame) override;
208+
virtual DECL void OnFrameAttached(CefRefPtr<CefBrowser> browser, CefRefPtr<CefFrame> frame) override;
209+
virtual DECL void OnFrameDetached(CefRefPtr<CefBrowser> browser, CefRefPtr<CefFrame> frame) override;
210+
virtual DECL void OnMainFrameChanged(CefRefPtr<CefBrowser> browser, CefRefPtr<CefFrame> old_frame, CefRefPtr<CefFrame> new_frame) override;
211+
204212
IMPLEMENT_REFCOUNTINGM(ClientAdapter);
205213
};
206214
}

‎CefSharp/CefSharp.csproj‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,8 @@
117117
<Compile Include="Handler\ExtensionHandler .cs" />
118118
<Compile Include="Handler\FindHandler.cs" />
119119
<Compile Include="Handler\FocusHandler.cs" />
120+
<Compile Include="Handler\FrameHandler.cs" />
121+
<Compile Include="Handler\IFrameHandler.cs" />
120122
<Compile Include="Handler\LoadHandler.cs" />
121123
<Compile Include="Handler\KeyboardHandler.cs" />
122124
<Compile Include="Handler\JsDialogHandler.cs" />

‎CefSharp/Handler/FrameHandler.cs‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
// Copyright © 2021 The CefSharp Authors. All rights reserved.
2+
//
3+
// Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.
4+
5+
namespace CefSharp.Handler
6+
{
7+
/// <summary>
8+
/// Inherit from this class to handle frame events
9+
/// All methods will be called on the CEF UI thread
10+
/// </summary>
11+
public class FrameHandler : IFrameHandler
12+
{
13+
/// <inheritdoc/>
14+
void IFrameHandler.OnFrameAttached(IWebBrowser chromiumWebBrowser, IBrowser browser, IFrame frame)
15+
{
16+
OnFrameAttached(chromiumWebBrowser, browser, frame);
17+
}
18+
19+
/// <summary>
20+
/// Called when a new frame is created. This will be the first notification
21+
/// that references <paramref name="frame"/>. Any commands that require transport to the
22+
/// associated renderer process (LoadRequest, SendProcessMessage, GetSource,
23+
/// etc.) will be queued until OnFrameAttached is called for <paramref name="frame"/>.
24+
/// </summary>
25+
/// <param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
26+
/// <param name="browser">the browser object</param>
27+
/// <param name="frame">the frame object</param>
28+
protected virtual void OnFrameAttached(IWebBrowser chromiumWebBrowser, IBrowser browser, IFrame frame)
29+
{
30+
31+
}
32+
33+
/// <inheritdoc/>
34+
void IFrameHandler.OnFrameCreated(IWebBrowser chromiumWebBrowser, IBrowser browser, IFrame frame)
35+
{
36+
OnFrameCreated(chromiumWebBrowser, browser, frame);
37+
}
38+
39+
/// <summary>
40+
/// Called when a frame can begin routing commands to/from the associated
41+
/// renderer process. Any commands that were queued have now been dispatched.
42+
/// </summary>
43+
/// <param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
44+
/// <param name="browser">the browser object</param>
45+
/// <param name="frame">the frame object</param>
46+
protected virtual void OnFrameCreated(IWebBrowser chromiumWebBrowser, IBrowser browser, IFrame frame)
47+
{
48+
49+
}
50+
51+
/// <inheritdoc/>
52+
void IFrameHandler.OnFrameDetached(IWebBrowser chromiumWebBrowser, IBrowser browser, IFrame frame)
53+
{
54+
OnFrameDetached(chromiumWebBrowser, browser, frame);
55+
}
56+
57+
/// <summary>
58+
/// Called when a frame loses its connection to the renderer process and will
59+
/// be destroyed. Any pending or future commands will be discarded and
60+
/// <see cref="IFrame.IsValid"/> will now return <c>false</c> for <paramref name="frame"/>. If called after
61+
/// <see cref="ILifeSpanHandler.OnBeforeClose(IWebBrowser, IBrowser)"/> during browser destruction then
62+
/// <see cref="IBrowser.IsValid"/> will return <c>false</c> for <paramref name="browser"/>.
63+
/// </summary>
64+
/// <param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
65+
/// <param name="browser">the browser object</param>
66+
/// <param name="frame">the frame object</param>
67+
protected virtual void OnFrameDetached(IWebBrowser chromiumWebBrowser, IBrowser browser, IFrame frame)
68+
{
69+
70+
}
71+
72+
/// <inheritdoc/>
73+
void IFrameHandler.OnMainFrameChanged(IWebBrowser chromiumWebBrowser, IBrowser browser, IFrame oldFrame, IFrame newFrame)
74+
{
75+
OnMainFrameChanged(chromiumWebBrowser, browser, oldFrame, newFrame);
76+
}
77+
78+
/// <summary>
79+
/// Called when the main frame changes due to (a) initial browser creation, (b)
80+
/// final browser destruction, (c) cross-origin navigation or (d) re-navigation
81+
/// after renderer process termination (due to crashes, etc). <paramref name="oldFrame"/> will
82+
/// be <c>null</c> and <paramref name="newFrame"/> will be non-<c>null</c> when a main frame is assigned to
83+
/// <paramref name="browser"/> for the first time. <paramref name="oldFrame"/> will be non-<c>null</c> and <paramref name="newFrame"/>
84+
/// will be <c>null</c> and when a main frame is removed from <paramref name="browser"/> for the last
85+
/// time. Both <paramref name="oldFrame"/> and <paramref name="newFrame"/> will be non-<c>null</c>for cross-origin
86+
/// navigations or re-navigation after renderer process termination. This
87+
/// method will be called after <see cref="OnFrameCreated(IWebBrowser, IBrowser, IFrame)"/> for <paramref name="newFrame"/> and/or after
88+
/// <see cref="OnFrameDetached(IWebBrowser, IBrowser, IFrame)"/> for <paramref name="oldFrame"/>. If called after
89+
/// <see cref="ILifeSpanHandler.OnBeforeClose(IWebBrowser, IBrowser)"/> during browser destruction then
90+
/// <see cref="IBrowser.IsValid"/> will return <c>false</c> for <paramref name="browser"/>.
91+
/// </summary>
92+
/// <param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
93+
/// <param name="browser">the browser object</param>
94+
/// <param name="oldFrame">the new frame object</param>
95+
/// <param name="newFrame">the old frame object</param>
96+
protected virtual void OnMainFrameChanged(IWebBrowser chromiumWebBrowser, IBrowser browser, IFrame oldFrame, IFrame newFrame)
97+
{
98+
99+
}
100+
}
101+
}

‎CefSharp/Handler/IFrameHandler.cs‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
// Copyright © 2021 The CefSharp Authors. All rights reserved.
2+
//
3+
// Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.
4+
5+
namespace CefSharp
6+
{
7+
/// <summary>
8+
/// Implement this interface to handle frame events
9+
/// All methods will be called on the CEF UI thread
10+
/// </summary>
11+
public interface IFrameHandler
12+
{
13+
/// <summary>
14+
/// Called when a new frame is created. This will be the first notification
15+
/// that references <paramref name="frame"/>. Any commands that require transport to the
16+
/// associated renderer process (LoadRequest, SendProcessMessage, GetSource,
17+
/// etc.) will be queued until OnFrameAttached is called for <paramref name="frame"/>.
18+
/// </summary>
19+
/// <param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
20+
/// <param name="browser">the browser object</param>
21+
/// <param name="frame">the frame object</param>
22+
void OnFrameCreated(IWebBrowser chromiumWebBrowser, IBrowser browser, IFrame frame);
23+
24+
/// <summary>
25+
/// Called when a frame can begin routing commands to/from the associated
26+
/// renderer process. Any commands that were queued have now been dispatched.
27+
/// </summary>
28+
/// <param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
29+
/// <param name="browser">the browser object</param>
30+
/// <param name="frame">the frame object</param>
31+
void OnFrameAttached(IWebBrowser chromiumWebBrowser, IBrowser browser, IFrame frame);
32+
33+
/// <summary>
34+
/// Called when a frame loses its connection to the renderer process and will
35+
/// be destroyed. Any pending or future commands will be discarded and
36+
/// <see cref="IFrame.IsValid"/> will now return <c>false</c> for <paramref name="frame"/>. If called after
37+
/// <see cref="ILifeSpanHandler.OnBeforeClose(IWebBrowser, IBrowser)"/> during browser destruction then
38+
/// <see cref="IBrowser.IsValid"/> will return <c>false</c> for <paramref name="browser"/>.
39+
/// </summary>
40+
/// <param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
41+
/// <param name="browser">the browser object</param>
42+
/// <param name="frame">the frame object</param>
43+
void OnFrameDetached(IWebBrowser chromiumWebBrowser, IBrowser browser, IFrame frame);
44+
45+
/// <summary>
46+
/// Called when the main frame changes due to (a) initial browser creation, (b)
47+
/// final browser destruction, (c) cross-origin navigation or (d) re-navigation
48+
/// after renderer process termination (due to crashes, etc). <paramref name="oldFrame"/> will
49+
/// be <c>null</c> and <paramref name="newFrame"/> will be non-<c>null</c> when a main frame is assigned to
50+
/// <paramref name="browser"/> for the first time. <paramref name="oldFrame"/> will be non-<c>null</c> and <paramref name="newFrame"/>
51+
/// will be <c>null</c> and when a main frame is removed from <paramref name="browser"/> for the last
52+
/// time. Both <paramref name="oldFrame"/> and <paramref name="newFrame"/> will be non-<c>null</c>for cross-origin
53+
/// navigations or re-navigation after renderer process termination. This
54+
/// method will be called after <see cref="OnFrameCreated(IWebBrowser, IBrowser, IFrame)"/> for <paramref name="newFrame"/> and/or after
55+
/// <see cref="OnFrameDetached(IWebBrowser, IBrowser, IFrame)"/> for <paramref name="oldFrame"/>. If called after
56+
/// <see cref="ILifeSpanHandler.OnBeforeClose(IWebBrowser, IBrowser)"/> during browser destruction then
57+
/// <see cref="IBrowser.IsValid"/> will return <c>false</c> for <paramref name="browser"/>.
58+
/// </summary>
59+
/// <param name="chromiumWebBrowser">the ChromiumWebBrowser control</param>
60+
/// <param name="browser">the browser object</param>
61+
/// <param name="oldFrame">the new frame object</param>
62+
/// <param name="newFrame">the old frame object</param>
63+
void OnMainFrameChanged(IWebBrowser chromiumWebBrowser, IBrowser browser, IFrame oldFrame, IFrame newFrame);
64+
}
65+
}

‎CefSharp/IWebBrowser.cs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,11 @@ public interface IWebBrowser : IDisposable
191191
/// </summary>
192192
IAudioHandler AudioHandler { get; set; }
193193

194+
/// <summary>
195+
/// Implement <see cref="IFrameHandler" /> to handle frame events.
196+
/// </summary>
197+
IFrameHandler FrameHandler { get; set; }
198+
194199
/// <summary>
195200
/// A flag that indicates whether the WebBrowser is initialized (true) or not (false).
196201
/// </summary>

‎CefSharp/Internals/Partial/ChromiumWebBrowser.Partial.cs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,11 @@ public partial class ChromiumWebBrowser
127127
[Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden), DefaultValue(null)]
128128
public IAudioHandler AudioHandler { get; set; }
129129
/// <summary>
130+
/// Implement <see cref="IFrameHandler" /> to handle frame events.
131+
/// </summary>
132+
[Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden), DefaultValue(null)]
133+
public IFrameHandler FrameHandler { get; set; }
134+
/// <summary>
130135
/// The <see cref="IFocusHandler" /> for this ChromiumWebBrowser.
131136
/// </summary>
132137
/// <value>The focus handler.</value>

0 commit comments

Comments
 (0)