Skip to content

Commit

Permalink
Core - Rename AbstractCefSettings to CefSettingsBase
Browse files Browse the repository at this point in the history
This is a somewhat cosmetic change so the API Doc looks better, the
classes appear next to each other (CefSettings, CefSettingsBase)
when sorted alphabetically.

Resolves #3093
  • Loading branch information
amaitland committed Apr 6, 2020
1 parent defc2c3 commit 73e7c5d
Show file tree
Hide file tree
Showing 10 changed files with 24 additions and 25 deletions.
8 changes: 4 additions & 4 deletions CefSharp.Core/Cef.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
#include "Internals/CefTaskScheduler.h"
#include "Internals/CefRegisterCdmCallbackAdapter.h"
#include "CookieManager.h"
#include "AbstractCefSettings.h"
#include "CefSettingsBase.h"
#include "RequestContext.h"

using namespace System::Collections::Generic;
Expand Down Expand Up @@ -144,7 +144,7 @@ namespace CefSharp
/// </summary>
/// <param name="cefSettings">CefSharp configuration settings.</param>
/// <returns>true if successful; otherwise, false.</returns>
static bool Initialize(AbstractCefSettings^ cefSettings)
static bool Initialize(CefSettingsBase^ cefSettings)
{
auto cefApp = gcnew DefaultApp(nullptr, cefSettings->CefCustomSchemes);

Expand All @@ -161,7 +161,7 @@ namespace CefSharp
/// <param name="performDependencyCheck">Check that all relevant dependencies avaliable, throws exception if any are missing</param>
/// <param name="browserProcessHandler">The handler for functionality specific to the browser process. Null if you don't wish to handle these events</param>
/// <returns>true if successful; otherwise, false.</returns>
static bool Initialize(AbstractCefSettings^ cefSettings, bool performDependencyCheck, IBrowserProcessHandler^ browserProcessHandler)
static bool Initialize(CefSettingsBase^ cefSettings, bool performDependencyCheck, IBrowserProcessHandler^ browserProcessHandler)
{
auto cefApp = gcnew DefaultApp(browserProcessHandler, cefSettings->CefCustomSchemes);

Expand All @@ -178,7 +178,7 @@ namespace CefSharp
/// <param name="performDependencyCheck">Check that all relevant dependencies avaliable, throws exception if any are missing</param>
/// <param name="cefApp">Implement this interface to provide handler implementations. Null if you don't wish to handle these events</param>
/// <returns>true if successful; otherwise, false.</returns>
static bool Initialize(AbstractCefSettings^ cefSettings, bool performDependencyCheck, IApp^ cefApp)
static bool Initialize(CefSettingsBase^ cefSettings, bool performDependencyCheck, IApp^ cefApp)
{
if (IsInitialized)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,10 @@ namespace CefSharp
{
/// <summary>
/// Initialization settings. Many of these and other settings can also configured using command-line switches.
/// WPF/WinForms/OffScreen each have their own CefSettings implementation that sets
/// relevant settings e.g. OffScreen starts with audio muted.
/// </summary>
public ref class AbstractCefSettings abstract
public ref class CefSettingsBase abstract
{
private:
/// <summary>
Expand All @@ -40,11 +42,11 @@ namespace CefSharp
/// <summary>
/// Default Constructor.
/// </summary>
AbstractCefSettings() : _cefSettings(new ::CefSettings())
CefSettingsBase() : _cefSettings(new ::CefSettings())
{
_cefSettings->multi_threaded_message_loop = true;
_cefSettings->no_sandbox = true;
BrowserSubprocessPath = Path::Combine(Path::GetDirectoryName(AbstractCefSettings::typeid->Assembly->Location), "CefSharp.BrowserSubprocess.exe");
BrowserSubprocessPath = Path::Combine(Path::GetDirectoryName(CefSettingsBase::typeid->Assembly->Location), "CefSharp.BrowserSubprocess.exe");
_cefCustomSchemes = gcnew List<CefCustomScheme^>();
_cefExtensions = gcnew List<V8Extension^>();
_cefCommandLineArgs = gcnew CommandLineArgDictionary();
Expand All @@ -58,17 +60,17 @@ namespace CefSharp
/// <summary>
/// Finalizer.
/// </summary>
!AbstractCefSettings()
!CefSettingsBase()
{
delete _cefSettings;
}

/// <summary>
/// Destructor.
/// </summary>
~AbstractCefSettings()
~CefSettingsBase()
{
this->!AbstractCefSettings();
this->!CefSettingsBase();
}

/// <summary>
Expand Down
2 changes: 1 addition & 1 deletion CefSharp.Core/CefSharp.Core.vcxproj
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@
<ClInclude Include="NativeMethodWrapper.h" />
<ClInclude Include="Internals\Serialization\V8Serialization.h" />
<ClInclude Include="ManagedCefBrowserAdapter.h" />
<ClInclude Include="AbstractCefSettings.h" />
<ClInclude Include="CefSettingsBase.h" />
<ClInclude Include="Internals\Serialization\Primitives.h" />
<ClInclude Include="RequestContext.h" />
<ClInclude Include="RequestContextSettings.h" />
Expand Down
9 changes: 3 additions & 6 deletions CefSharp.Core/CefSharp.Core.vcxproj.filters
Original file line number Diff line number Diff line change
Expand Up @@ -256,9 +256,6 @@
<ClInclude Include="Internals\CefRequestContextHandlerAdapter.h">
<Filter>Header Files</Filter>
</ClInclude>
<ClInclude Include="AbstractCefSettings.h">
<Filter>Header Files</Filter>
</ClInclude>
<ClInclude Include="Internals\CefValueWrapper.h">
<Filter>Header Files</Filter>
</ClInclude>
Expand Down Expand Up @@ -322,14 +319,14 @@
<ClInclude Include="Internals\CefResourceHandlerAdapter.h">
<Filter>Header Files</Filter>
</ClInclude>
<ClInclude Include="CefSettingsBase.h">
<Filter>Header Files</Filter>
</ClInclude>
</ItemGroup>
<ItemGroup>
<ClInclude Include="Internals\CefFrameWrapper.h">
<Filter>Header Files</Filter>
</ClInclude>
<ClInclude Include="Internals\CefSharpBrowserWrapper.h">
<Filter>Header Files</Filter>
</ClInclude>
</ItemGroup>
<ItemGroup>
<ResourceCompile Include="Resource.rc" />
Expand Down
6 changes: 3 additions & 3 deletions CefSharp.Core/Internals/CefSharpApp.h
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
#include "include\cef_app.h"
#include "include\cef_scheme.h"

#include "AbstractCefSettings.h"
#include "CefSettingsBase.h"
#include "CefSchemeHandlerFactoryAdapter.h"
#include "Internals\CefSchemeRegistrarWrapper.h"

Expand All @@ -20,11 +20,11 @@ namespace CefSharp
private class CefSharpApp : public CefApp,
public CefBrowserProcessHandler
{
gcroot<AbstractCefSettings^> _cefSettings;
gcroot<CefSettingsBase^> _cefSettings;
gcroot<IApp^> _app;

public:
CefSharpApp(AbstractCefSettings^ cefSettings, IApp^ app) :
CefSharpApp(CefSettingsBase^ cefSettings, IApp^ app) :
_cefSettings(cefSettings),
_app(app)
{
Expand Down
2 changes: 1 addition & 1 deletion CefSharp.Example/CefExample.cs
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ public static class CefExample
private static readonly bool DebuggingSubProcess = Debugger.IsAttached;
private static string PluginInformation = "";

public static void Init(AbstractCefSettings settings, IBrowserProcessHandler browserProcessHandler)
public static void Init(CefSettingsBase settings, IBrowserProcessHandler browserProcessHandler)
{
// Set Google API keys, used for Geolocation requests sans GPS. See http://www.chromium.org/developers/how-tos/api-keys
// Environment.SetEnvironmentVariable("GOOGLE_API_KEY", "");
Expand Down
2 changes: 1 addition & 1 deletion CefSharp.OffScreen/CefSettings.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ namespace CefSharp.OffScreen
/// Initialization settings. Many of these and other settings can also configured
/// using command-line switches.
/// </summary>
public class CefSettings : AbstractCefSettings
public class CefSettings : CefSettingsBase
{
/// <summary>
/// Intialize with default values
Expand Down
2 changes: 1 addition & 1 deletion CefSharp.WinForms/CefSettings.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ namespace CefSharp.WinForms
/// Initialization settings. Many of these and other settings can also configured
/// using command-line switches.
/// </summary>
public class CefSettings : AbstractCefSettings
public class CefSettings : CefSettingsBase
{
}
}
2 changes: 1 addition & 1 deletion CefSharp.WinForms/ChromiumWebBrowser.cs
Original file line number Diff line number Diff line change
Expand Up @@ -401,7 +401,7 @@ public IRequestContext RequestContext
/// <summary>
/// ParentFormMessageInterceptor hooks the Form handle and forwards
/// the move/active messages to the browser, the default is true
/// and should only be required when using <see cref="AbstractCefSettings.MultiThreadedMessageLoop"/>
/// and should only be required when using <see cref="CefSettingsBase.MultiThreadedMessageLoop"/>
/// set to true.
/// </summary>
[Browsable(false), DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden), DefaultValue(true)]
Expand Down
2 changes: 1 addition & 1 deletion CefSharp.Wpf/CefSettings.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ namespace CefSharp.Wpf
/// Initialization settings. Many of these and other settings can also configured
/// using command-line switches.
/// </summary>
public class CefSettings : AbstractCefSettings
public class CefSettings : CefSettingsBase
{
/// <summary>
/// Intialize with default values
Expand Down

0 comments on commit 73e7c5d

Please sign in to comment.