electron/atom/browser/native_window.h

322 lines
9.7 KiB
C
Raw Normal View History

// Copyright (c) 2013 GitHub, Inc.
2014-04-25 09:49:37 +00:00
// Use of this source code is governed by the MIT license that can be
2013-04-12 07:04:46 +00:00
// found in the LICENSE file.
#ifndef ATOM_BROWSER_NATIVE_WINDOW_H_
#define ATOM_BROWSER_NATIVE_WINDOW_H_
#include <map>
#include <string>
#include <vector>
2014-08-11 02:01:05 +00:00
#include "atom/browser/native_window_observer.h"
#include "atom/browser/ui/accelerator_util.h"
#include "base/cancelable_callback.h"
2013-04-12 07:04:46 +00:00
#include "base/memory/scoped_ptr.h"
#include "base/memory/weak_ptr.h"
2013-04-18 12:50:58 +00:00
#include "base/observer_list.h"
2015-06-25 04:30:04 +00:00
#include "brightray/browser/inspectable_web_contents_view_delegate.h"
#include "content/public/browser/readback_types.h"
#include "content/public/browser/web_contents_observer.h"
#include "content/public/browser/web_contents_user_data.h"
#include "native_mate/persistent_dictionary.h"
2015-02-07 01:00:26 +00:00
#include "ui/gfx/image/image.h"
#include "ui/gfx/image/image_skia.h"
2013-04-12 07:04:46 +00:00
namespace base {
class CommandLine;
}
namespace brightray {
class InspectableWebContents;
}
2013-04-12 07:04:46 +00:00
namespace content {
struct NativeWebKeyboardEvent;
2014-10-11 11:11:34 +00:00
struct WebPreferences;
2013-04-12 07:04:46 +00:00
}
namespace gfx {
class Point;
class Rect;
class Size;
}
namespace mate {
class Dictionary;
}
2014-07-04 08:54:10 +00:00
namespace ui {
class MenuModel;
}
2013-04-12 07:04:46 +00:00
namespace atom {
struct DraggableRegion;
2015-06-25 04:30:04 +00:00
class NativeWindow : public content::WebContentsObserver,
public brightray::InspectableWebContentsViewDelegate {
2013-04-12 07:04:46 +00:00
public:
typedef base::Callback<void(const SkBitmap& bitmap)> CapturePageCallback;
class DialogScope {
public:
2014-02-17 08:33:26 +00:00
explicit DialogScope(NativeWindow* window)
: window_(window) {
if (window_ != NULL)
window_->set_has_dialog_attached(true);
}
~DialogScope() {
if (window_ != NULL)
window_->set_has_dialog_attached(false);
}
private:
NativeWindow* window_;
DISALLOW_COPY_AND_ASSIGN(DialogScope);
};
2013-04-12 07:04:46 +00:00
virtual ~NativeWindow();
// Create window with existing WebContents, the caller is responsible for
// managing the window's live.
static NativeWindow* Create(
brightray::InspectableWebContents* inspectable_web_contents,
const mate::Dictionary& options);
// Find a window from its WebContents
static NativeWindow* FromWebContents(content::WebContents* web_contents);
void InitFromOptions(const mate::Dictionary& options);
2013-04-12 07:04:46 +00:00
virtual void Close() = 0;
2013-05-01 08:12:00 +00:00
virtual void CloseImmediately() = 0;
2013-04-12 07:04:46 +00:00
virtual void Focus(bool focus) = 0;
2013-05-16 14:56:52 +00:00
virtual bool IsFocused() = 0;
2013-04-12 07:04:46 +00:00
virtual void Show() = 0;
2014-10-17 14:51:20 +00:00
virtual void ShowInactive() = 0;
2013-04-12 07:04:46 +00:00
virtual void Hide() = 0;
2013-10-03 00:27:59 +00:00
virtual bool IsVisible() = 0;
2013-04-12 07:04:46 +00:00
virtual void Maximize() = 0;
virtual void Unmaximize() = 0;
2014-05-14 21:58:49 +00:00
virtual bool IsMaximized() = 0;
2013-04-12 07:04:46 +00:00
virtual void Minimize() = 0;
virtual void Restore() = 0;
2014-07-26 05:58:26 +00:00
virtual bool IsMinimized() = 0;
2014-11-25 06:34:14 +00:00
virtual void SetFullScreen(bool fullscreen) = 0;
2015-04-21 13:35:36 +00:00
virtual bool IsFullscreen() const = 0;
double GetAspectRatio();
virtual gfx::Size GetAspectRatioExtraSize();
virtual void SetAspectRatio(double aspectRatio, const gfx::Size& extraSize);
virtual void SetBounds(const gfx::Rect& bounds) = 0;
virtual gfx::Rect GetBounds() = 0;
virtual void SetSize(const gfx::Size& size);
virtual gfx::Size GetSize();
virtual void SetPosition(const gfx::Point& position);
virtual gfx::Point GetPosition();
2014-05-15 08:05:35 +00:00
virtual void SetContentSize(const gfx::Size& size) = 0;
2014-05-15 07:30:04 +00:00
virtual gfx::Size GetContentSize() = 0;
virtual void SetMinimumSize(const gfx::Size& size) = 0;
2013-04-18 07:38:04 +00:00
virtual gfx::Size GetMinimumSize() = 0;
virtual void SetMaximumSize(const gfx::Size& size) = 0;
2013-04-18 07:38:04 +00:00
virtual gfx::Size GetMaximumSize() = 0;
2013-04-12 07:04:46 +00:00
virtual void SetResizable(bool resizable) = 0;
2013-04-18 07:38:04 +00:00
virtual bool IsResizable() = 0;
2013-04-12 07:04:46 +00:00
virtual void SetAlwaysOnTop(bool top) = 0;
2013-04-18 07:38:04 +00:00
virtual bool IsAlwaysOnTop() = 0;
virtual void Center() = 0;
2013-04-12 07:04:46 +00:00
virtual void SetTitle(const std::string& title) = 0;
2013-04-18 06:30:05 +00:00
virtual std::string GetTitle() = 0;
2013-04-12 07:04:46 +00:00
virtual void FlashFrame(bool flash) = 0;
virtual void SetSkipTaskbar(bool skip) = 0;
2013-04-12 07:04:46 +00:00
virtual void SetKiosk(bool kiosk) = 0;
virtual bool IsKiosk() = 0;
virtual void SetRepresentedFilename(const std::string& filename);
virtual std::string GetRepresentedFilename();
virtual void SetDocumentEdited(bool edited);
virtual bool IsDocumentEdited();
2014-08-21 13:00:49 +00:00
virtual void SetMenu(ui::MenuModel* menu);
virtual bool HasModalDialog();
virtual gfx::NativeWindow GetNativeWindow() = 0;
2014-09-17 01:42:47 +00:00
virtual void SetProgressBar(double progress) = 0;
2015-02-07 01:00:26 +00:00
virtual void SetOverlayIcon(const gfx::Image& overlay,
const std::string& description) = 0;
2015-03-27 11:41:07 +00:00
virtual void SetVisibleOnAllWorkspaces(bool visible) = 0;
virtual bool IsVisibleOnAllWorkspaces() = 0;
virtual bool IsClosed() const { return is_closed_; }
2014-02-24 04:08:33 +00:00
virtual void FocusOnWebView();
virtual void BlurWebView();
virtual bool IsWebViewFocused();
// Captures the page with |rect|, |callback| would be called when capturing is
// done.
2013-11-21 13:50:06 +00:00
virtual void CapturePage(const gfx::Rect& rect,
const CapturePageCallback& callback);
// Show popup dictionary.
virtual void ShowDefinitionForSelection();
2014-11-12 09:36:20 +00:00
// Toggle the menu bar.
virtual void SetAutoHideMenuBar(bool auto_hide);
virtual bool IsMenuBarAutoHide();
virtual void SetMenuBarVisibility(bool visible);
virtual bool IsMenuBarVisible();
base::WeakPtr<NativeWindow> GetWeakPtr() {
return weak_factory_.GetWeakPtr();
}
// Requests the WebContents to close, can be cancelled by the page.
virtual void RequestToClosePage();
// Methods called by the WebContents.
virtual void CloseContents(content::WebContents* source);
virtual void RendererUnresponsive(content::WebContents* source);
virtual void RendererResponsive(content::WebContents* source);
virtual void HandleKeyboardEvent(
content::WebContents*,
const content::NativeWebKeyboardEvent& event) {}
// Called when renderer process is going to be started.
void AppendExtraCommandLineSwitches(base::CommandLine* command_line);
2015-04-21 10:56:08 +00:00
void OverrideWebkitPrefs(content::WebPreferences* prefs);
// Public API used by platform-dependent delegates and observers to send UI
// related notifications.
void NotifyWindowClosed();
void NotifyWindowBlur();
void NotifyWindowFocus();
2014-11-25 04:43:25 +00:00
void NotifyWindowMaximize();
void NotifyWindowUnmaximize();
void NotifyWindowMinimize();
void NotifyWindowRestore();
2015-05-09 15:55:10 +00:00
void NotifyWindowMove();
void NotifyWindowResize();
2015-05-20 08:37:13 +00:00
void NotifyWindowMoved();
2014-11-25 04:43:25 +00:00
void NotifyWindowEnterFullScreen();
void NotifyWindowLeaveFullScreen();
void NotifyWindowEnterHtmlFullScreen();
void NotifyWindowLeaveHtmlFullScreen();
2013-04-18 12:50:58 +00:00
void AddObserver(NativeWindowObserver* obs) {
observers_.AddObserver(obs);
}
void RemoveObserver(NativeWindowObserver* obs) {
observers_.RemoveObserver(obs);
}
brightray::InspectableWebContents* inspectable_web_contents() const {
return inspectable_web_contents_;
}
bool has_frame() const { return has_frame_; }
void set_has_dialog_attached(bool has_dialog_attached) {
has_dialog_attached_ = has_dialog_attached;
}
2013-04-12 07:04:46 +00:00
protected:
NativeWindow(brightray::InspectableWebContents* inspectable_web_contents,
const mate::Dictionary& options);
2013-04-12 07:04:46 +00:00
// Called when the window needs to update its draggable region.
virtual void UpdateDraggableRegions(
const std::vector<DraggableRegion>& regions) = 0;
2015-06-25 04:30:04 +00:00
// brightray::InspectableWebContentsViewDelegate:
void DevToolsFocused() override;
void DevToolsOpened() override;
void DevToolsClosed() override;
// content::WebContentsObserver:
void RenderViewCreated(content::RenderViewHost* render_view_host) override;
void BeforeUnloadDialogCancelled() override;
2015-06-24 12:16:51 +00:00
void TitleWasSet(content::NavigationEntry* entry, bool explicit_set) override;
bool OnMessageReceived(const IPC::Message& message) override;
2014-03-04 09:08:30 +00:00
// Whether window has standard frame.
bool has_frame_;
// Whether window is transparent.
bool transparent_;
// Whether window can be resized larger than screen.
bool enable_larger_than_screen_;
// Window icon.
2014-08-11 02:06:46 +00:00
gfx::ImageSkia icon_;
2015-06-26 04:04:15 +00:00
// Observers of this window.
ObserverList<NativeWindowObserver> observers_;
2013-04-12 07:04:46 +00:00
private:
// Schedule a notification unresponsive event.
void ScheduleUnresponsiveEvent(int ms);
// Dispatch unresponsive event to observers.
void NotifyWindowUnresponsive();
2013-11-21 13:50:06 +00:00
// Called when CapturePage has done.
void OnCapturePageDone(const CapturePageCallback& callback,
const SkBitmap& bitmap,
content::ReadbackResponse response);
2013-11-21 13:50:06 +00:00
// The windows has been closed.
bool is_closed_;
// Whether node integration is enabled.
bool node_integration_;
// There is a dialog that has been attached to window.
bool has_dialog_attached_;
// Closure that would be called when window is unresponsive when closing,
// it should be cancelled when we can prove that the window is responsive.
base::CancelableClosure window_unresposive_closure_;
2014-06-16 10:52:04 +00:00
// Web preferences.
mate::PersistentDictionary web_preferences_;
2014-11-12 07:04:03 +00:00
// The script to load before page's JavaScript starts to run.
base::FilePath preload_script_;
2014-06-16 10:52:04 +00:00
// Page's default zoom factor.
double zoom_factor_;
2015-07-16 18:26:48 +00:00
// Used to maintain the aspect ratio of a view which is inside of the
// content view.
double aspectRatio_ = 0.0;
gfx::Size aspectRatioExtraSize_;
// The page this window is viewing.
brightray::InspectableWebContents* inspectable_web_contents_;
base::WeakPtrFactory<NativeWindow> weak_factory_;
2013-04-12 07:04:46 +00:00
DISALLOW_COPY_AND_ASSIGN(NativeWindow);
};
// This class provides a hook to get a NativeWindow from a WebContents.
class NativeWindowRelay :
public content::WebContentsUserData<NativeWindowRelay> {
public:
explicit NativeWindowRelay(base::WeakPtr<NativeWindow> window)
: key(UserDataKey()), window(window) {}
void* key;
base::WeakPtr<NativeWindow> window;
private:
friend class content::WebContentsUserData<NativeWindow>;
};
2013-04-12 07:04:46 +00:00
} // namespace atom
#endif // ATOM_BROWSER_NATIVE_WINDOW_H_