248 lines
8.8 KiB
C++
248 lines
8.8 KiB
C++
// Copyright (c) 2014 GitHub, Inc.
|
|
// Use of this source code is governed by the MIT license that can be
|
|
// found in the LICENSE file.
|
|
|
|
#ifndef ATOM_BROWSER_API_ATOM_API_WEB_CONTENTS_H_
|
|
#define ATOM_BROWSER_API_ATOM_API_WEB_CONTENTS_H_
|
|
|
|
#include <string>
|
|
|
|
#include "atom/browser/api/event_emitter.h"
|
|
#include "brightray/browser/default_web_contents_delegate.h"
|
|
#include "content/public/browser/browser_plugin_guest_delegate.h"
|
|
#include "content/public/browser/web_contents_delegate.h"
|
|
#include "content/public/browser/web_contents_observer.h"
|
|
#include "native_mate/handle.h"
|
|
|
|
namespace brightray {
|
|
class InspectableWebContents;
|
|
}
|
|
|
|
namespace mate {
|
|
class Dictionary;
|
|
}
|
|
|
|
namespace atom {
|
|
|
|
class WebDialogHelper;
|
|
|
|
namespace api {
|
|
|
|
class WebContents : public mate::EventEmitter,
|
|
public content::BrowserPluginGuestDelegate,
|
|
public content::WebContentsDelegate,
|
|
public content::WebContentsObserver {
|
|
public:
|
|
// Create from an existing WebContents.
|
|
static mate::Handle<WebContents> CreateFrom(
|
|
v8::Isolate* isolate, content::WebContents* web_contents);
|
|
|
|
// Create a new WebContents.
|
|
static mate::Handle<WebContents> Create(
|
|
v8::Isolate* isolate, const mate::Dictionary& options);
|
|
|
|
void Destroy();
|
|
bool IsAlive() const;
|
|
void LoadURL(const GURL& url, const mate::Dictionary& options);
|
|
GURL GetURL() const;
|
|
base::string16 GetTitle() const;
|
|
bool IsLoading() const;
|
|
bool IsWaitingForResponse() const;
|
|
void Stop();
|
|
void Reload(const mate::Dictionary& options);
|
|
void ReloadIgnoringCache(const mate::Dictionary& options);
|
|
bool CanGoBack() const;
|
|
bool CanGoForward() const;
|
|
bool CanGoToOffset(int offset) const;
|
|
void GoBack();
|
|
void GoForward();
|
|
void GoToIndex(int index);
|
|
void GoToOffset(int offset);
|
|
int GetRoutingID() const;
|
|
int GetProcessID() const;
|
|
bool IsCrashed() const;
|
|
void SetUserAgent(const std::string& user_agent);
|
|
void InsertCSS(const std::string& css);
|
|
void ExecuteJavaScript(const base::string16& code);
|
|
void OpenDevTools();
|
|
void CloseDevTools();
|
|
bool IsDevToolsOpened();
|
|
|
|
// Editing commands.
|
|
void Undo();
|
|
void Redo();
|
|
void Cut();
|
|
void Copy();
|
|
void Paste();
|
|
void Delete();
|
|
void SelectAll();
|
|
void Unselect();
|
|
void Replace(const base::string16& word);
|
|
void ReplaceMisspelling(const base::string16& word);
|
|
|
|
// Sending messages to browser.
|
|
bool SendIPCMessage(const base::string16& channel,
|
|
const base::ListValue& args);
|
|
|
|
// Toggles autosize mode for corresponding <webview>.
|
|
void SetAutoSize(bool enabled,
|
|
const gfx::Size& min_size,
|
|
const gfx::Size& max_size);
|
|
|
|
// Sets the transparency of the guest.
|
|
void SetAllowTransparency(bool allow);
|
|
|
|
// Returns whether this is a guest view.
|
|
bool is_guest() const { return guest_instance_id_ != -1; }
|
|
|
|
// Returns whether this guest has an associated embedder.
|
|
bool attached() const { return !!embedder_web_contents_; }
|
|
|
|
content::WebContents* web_contents() const {
|
|
return content::WebContentsObserver::web_contents();
|
|
}
|
|
|
|
protected:
|
|
explicit WebContents(content::WebContents* web_contents);
|
|
explicit WebContents(const mate::Dictionary& options);
|
|
~WebContents();
|
|
|
|
// mate::Wrappable:
|
|
mate::ObjectTemplateBuilder GetObjectTemplateBuilder(
|
|
v8::Isolate* isolate) override;
|
|
|
|
// content::WebContentsDelegate:
|
|
bool AddMessageToConsole(content::WebContents* source,
|
|
int32 level,
|
|
const base::string16& message,
|
|
int32 line_no,
|
|
const base::string16& source_id) override;
|
|
bool ShouldCreateWebContents(
|
|
content::WebContents* web_contents,
|
|
int route_id,
|
|
int main_frame_route_id,
|
|
WindowContainerType window_container_type,
|
|
const base::string16& frame_name,
|
|
const GURL& target_url,
|
|
const std::string& partition_id,
|
|
content::SessionStorageNamespace* session_storage_namespace) override;
|
|
void CloseContents(content::WebContents* source) override;
|
|
content::WebContents* OpenURLFromTab(
|
|
content::WebContents* source,
|
|
const content::OpenURLParams& params) override;
|
|
void RunFileChooser(content::WebContents* web_contents,
|
|
const content::FileChooserParams& params) override;
|
|
void EnumerateDirectory(content::WebContents* web_contents,
|
|
int request_id,
|
|
const base::FilePath& path) override;
|
|
bool CheckMediaAccessPermission(content::WebContents* web_contents,
|
|
const GURL& security_origin,
|
|
content::MediaStreamType type) override;
|
|
void RequestMediaAccessPermission(
|
|
content::WebContents*,
|
|
const content::MediaStreamRequest&,
|
|
const content::MediaResponseCallback&) override;
|
|
void HandleKeyboardEvent(
|
|
content::WebContents* source,
|
|
const content::NativeWebKeyboardEvent& event) override;
|
|
|
|
// content::WebContentsObserver:
|
|
void RenderViewDeleted(content::RenderViewHost*) override;
|
|
void RenderProcessGone(base::TerminationStatus status) override;
|
|
void DidFinishLoad(content::RenderFrameHost* render_frame_host,
|
|
const GURL& validated_url) override;
|
|
void DidFailLoad(content::RenderFrameHost* render_frame_host,
|
|
const GURL& validated_url,
|
|
int error_code,
|
|
const base::string16& error_description) override;
|
|
void DidFailProvisionalLoad(content::RenderFrameHost* render_frame_host,
|
|
const GURL& validated_url,
|
|
int error_code,
|
|
const base::string16& error_description) override;
|
|
void DidStartLoading(content::RenderViewHost* render_view_host) override;
|
|
void DidStopLoading(content::RenderViewHost* render_view_host) override;
|
|
void DidGetRedirectForResourceRequest(
|
|
content::RenderFrameHost* render_frame_host,
|
|
const content::ResourceRedirectDetails& details) override;
|
|
void DidNavigateMainFrame(
|
|
const content::LoadCommittedDetails& details,
|
|
const content::FrameNavigateParams& params) override;
|
|
bool OnMessageReceived(const IPC::Message& message) override;
|
|
void RenderViewReady() override;
|
|
void WebContentsDestroyed() override;
|
|
void NavigationEntryCommitted(
|
|
const content::LoadCommittedDetails& load_details) override;
|
|
void TitleWasSet(content::NavigationEntry* entry, bool explicit_set) override;
|
|
|
|
// content::BrowserPluginGuestDelegate:
|
|
void DidAttach(int guest_proxy_routing_id) final;
|
|
void ElementSizeChanged(const gfx::Size& size) final;
|
|
content::WebContents* GetOwnerWebContents() const final;
|
|
void GuestSizeChanged(const gfx::Size& old_size,
|
|
const gfx::Size& new_size) final;
|
|
void RegisterDestructionCallback(const DestructionCallback& callback) final;
|
|
void SetGuestSizer(content::GuestSizer* guest_sizer) final;
|
|
void WillAttach(content::WebContents* embedder_web_contents,
|
|
int element_instance_id,
|
|
bool is_full_page_plugin) final;
|
|
|
|
private:
|
|
// Called when received a message from renderer.
|
|
void OnRendererMessage(const base::string16& channel,
|
|
const base::ListValue& args);
|
|
|
|
// Called when received a synchronous message from renderer.
|
|
void OnRendererMessageSync(const base::string16& channel,
|
|
const base::ListValue& args,
|
|
IPC::Message* message);
|
|
|
|
void GuestSizeChangedDueToAutoSize(const gfx::Size& old_size,
|
|
const gfx::Size& new_size);
|
|
|
|
scoped_ptr<WebDialogHelper> web_dialog_helper_;
|
|
|
|
// Unique ID for a guest WebContents.
|
|
int guest_instance_id_;
|
|
|
|
// |element_instance_id_| is an identifer that's unique to a particular
|
|
// element.
|
|
int element_instance_id_;
|
|
|
|
DestructionCallback destruction_callback_;
|
|
|
|
// Stores whether the contents of the guest can be transparent.
|
|
bool guest_opaque_;
|
|
|
|
// Stores the WebContents that managed by this class.
|
|
scoped_ptr<brightray::InspectableWebContents> storage_;
|
|
|
|
// The WebContents that attaches this guest view.
|
|
content::WebContents* embedder_web_contents_;
|
|
|
|
// The size of the container element.
|
|
gfx::Size element_size_;
|
|
|
|
// The size of the guest content. Note: In autosize mode, the container
|
|
// element may not match the size of the guest.
|
|
gfx::Size guest_size_;
|
|
|
|
// A pointer to the guest_sizer.
|
|
content::GuestSizer* guest_sizer_;
|
|
|
|
// Indicates whether autosize mode is enabled or not.
|
|
bool auto_size_enabled_;
|
|
|
|
// The maximum size constraints of the container element in autosize mode.
|
|
gfx::Size max_auto_size_;
|
|
|
|
// The minimum size constraints of the container element in autosize mode.
|
|
gfx::Size min_auto_size_;
|
|
|
|
DISALLOW_COPY_AND_ASSIGN(WebContents);
|
|
};
|
|
|
|
} // namespace api
|
|
|
|
} // namespace atom
|
|
|
|
#endif // ATOM_BROWSER_API_ATOM_API_WEB_CONTENTS_H_
|