280 lines
10 KiB
C++
280 lines
10 KiB
C++
// Copyright (c) 2018 GitHub, Inc.
|
|
// Use of this source code is governed by the MIT license that can be
|
|
// found in the LICENSE file.
|
|
|
|
#ifndef ELECTRON_SHELL_BROWSER_API_ELECTRON_API_BASE_WINDOW_H_
|
|
#define ELECTRON_SHELL_BROWSER_API_ELECTRON_API_BASE_WINDOW_H_
|
|
|
|
#include <map>
|
|
#include <memory>
|
|
#include <optional>
|
|
#include <string>
|
|
#include <string_view>
|
|
#include <vector>
|
|
|
|
#include "content/public/browser/browser_task_traits.h"
|
|
#include "content/public/browser/browser_thread.h"
|
|
#include "gin/handle.h"
|
|
#include "shell/browser/native_window.h"
|
|
#include "shell/browser/native_window_observer.h"
|
|
#include "shell/common/api/electron_api_native_image.h"
|
|
#include "shell/common/gin_helper/error_thrower.h"
|
|
#include "shell/common/gin_helper/trackable_object.h"
|
|
|
|
namespace electron::api {
|
|
|
|
class View;
|
|
|
|
class BaseWindow : public gin_helper::TrackableObject<BaseWindow>,
|
|
public NativeWindowObserver {
|
|
public:
|
|
static gin_helper::WrappableBase* New(gin_helper::Arguments* args);
|
|
|
|
static void BuildPrototype(v8::Isolate* isolate,
|
|
v8::Local<v8::FunctionTemplate> prototype);
|
|
|
|
base::WeakPtr<BaseWindow> GetWeakPtr() { return weak_factory_.GetWeakPtr(); }
|
|
|
|
NativeWindow* window() const { return window_.get(); }
|
|
|
|
protected:
|
|
// Common constructor.
|
|
BaseWindow(v8::Isolate* isolate, const gin_helper::Dictionary& options);
|
|
// Creating independent BaseWindow instance.
|
|
BaseWindow(gin_helper::Arguments* args,
|
|
const gin_helper::Dictionary& options);
|
|
~BaseWindow() override;
|
|
|
|
// TrackableObject:
|
|
void InitWith(v8::Isolate* isolate, v8::Local<v8::Object> wrapper) override;
|
|
|
|
// NativeWindowObserver:
|
|
void WillCloseWindow(bool* prevent_default) override;
|
|
void OnWindowClosed() override;
|
|
void OnWindowEndSession() override;
|
|
void OnWindowBlur() override;
|
|
void OnWindowFocus() override;
|
|
void OnWindowShow() override;
|
|
void OnWindowHide() override;
|
|
void OnWindowMaximize() override;
|
|
void OnWindowUnmaximize() override;
|
|
void OnWindowMinimize() override;
|
|
void OnWindowRestore() override;
|
|
void OnWindowWillResize(const gfx::Rect& new_bounds,
|
|
const gfx::ResizeEdge& edge,
|
|
bool* prevent_default) override;
|
|
void OnWindowResize() override;
|
|
void OnWindowResized() override;
|
|
void OnWindowWillMove(const gfx::Rect& new_bounds,
|
|
bool* prevent_default) override;
|
|
void OnWindowMove() override;
|
|
void OnWindowMoved() override;
|
|
void OnWindowSwipe(const std::string& direction) override;
|
|
void OnWindowRotateGesture(float rotation) override;
|
|
void OnWindowSheetBegin() override;
|
|
void OnWindowSheetEnd() override;
|
|
void OnWindowEnterFullScreen() override;
|
|
void OnWindowLeaveFullScreen() override;
|
|
void OnWindowEnterHtmlFullScreen() override;
|
|
void OnWindowLeaveHtmlFullScreen() override;
|
|
void OnWindowAlwaysOnTopChanged() override;
|
|
void OnExecuteAppCommand(const std::string& command_name) override;
|
|
void OnTouchBarItemResult(const std::string& item_id,
|
|
const base::Value::Dict& details) override;
|
|
void OnNewWindowForTab() override;
|
|
void OnSystemContextMenu(int x, int y, bool* prevent_default) override;
|
|
#if BUILDFLAG(IS_WIN)
|
|
void OnWindowMessage(UINT message, WPARAM w_param, LPARAM l_param) override;
|
|
#endif
|
|
|
|
// Public APIs of NativeWindow.
|
|
void SetContentView(gin::Handle<View> view);
|
|
void Close();
|
|
virtual void CloseImmediately();
|
|
virtual void Focus();
|
|
virtual void Blur();
|
|
bool IsFocused() const;
|
|
void Show();
|
|
void ShowInactive();
|
|
void Hide();
|
|
bool IsVisible() const;
|
|
bool IsEnabled() const;
|
|
void SetEnabled(bool enable);
|
|
void Maximize();
|
|
void Unmaximize();
|
|
bool IsMaximized() const;
|
|
void Minimize();
|
|
void Restore();
|
|
bool IsMinimized() const;
|
|
void SetFullScreen(bool fullscreen);
|
|
bool IsFullscreen() const;
|
|
void SetBounds(const gfx::Rect& bounds, gin_helper::Arguments* args);
|
|
gfx::Rect GetBounds() const;
|
|
void SetSize(int width, int height, gin_helper::Arguments* args);
|
|
std::vector<int> GetSize() const;
|
|
void SetContentSize(int width, int height, gin_helper::Arguments* args);
|
|
std::vector<int> GetContentSize() const;
|
|
void SetContentBounds(const gfx::Rect& bounds, gin_helper::Arguments* args);
|
|
gfx::Rect GetContentBounds() const;
|
|
bool IsNormal() const;
|
|
gfx::Rect GetNormalBounds() const;
|
|
void SetMinimumSize(int width, int height);
|
|
std::vector<int> GetMinimumSize() const;
|
|
void SetMaximumSize(int width, int height);
|
|
std::vector<int> GetMaximumSize() const;
|
|
void SetSheetOffset(double offsetY, gin_helper::Arguments* args);
|
|
void SetResizable(bool resizable);
|
|
bool IsResizable() const;
|
|
void SetMovable(bool movable);
|
|
void MoveAbove(const std::string& sourceId, gin_helper::Arguments* args);
|
|
void MoveTop();
|
|
bool IsMovable() const;
|
|
void SetMinimizable(bool minimizable);
|
|
bool IsMinimizable() const;
|
|
void SetMaximizable(bool maximizable);
|
|
bool IsMaximizable() const;
|
|
void SetFullScreenable(bool fullscreenable);
|
|
bool IsFullScreenable() const;
|
|
void SetClosable(bool closable);
|
|
bool IsClosable() const;
|
|
void SetAlwaysOnTop(bool top, gin_helper::Arguments* args);
|
|
bool IsAlwaysOnTop() const;
|
|
void Center();
|
|
void SetPosition(int x, int y, gin_helper::Arguments* args);
|
|
std::vector<int> GetPosition() const;
|
|
void SetTitle(const std::string& title);
|
|
std::string GetTitle() const;
|
|
void SetAccessibleTitle(const std::string& title);
|
|
std::string GetAccessibleTitle() const;
|
|
void FlashFrame(bool flash);
|
|
void SetSkipTaskbar(bool skip);
|
|
void SetExcludedFromShownWindowsMenu(bool excluded);
|
|
bool IsExcludedFromShownWindowsMenu() const;
|
|
void SetSimpleFullScreen(bool simple_fullscreen);
|
|
bool IsSimpleFullScreen() const;
|
|
void SetKiosk(bool kiosk);
|
|
bool IsKiosk() const;
|
|
bool IsTabletMode() const;
|
|
virtual void SetBackgroundColor(const std::string& color_name);
|
|
std::string GetBackgroundColor(gin_helper::Arguments* args) const;
|
|
void InvalidateShadow();
|
|
void SetHasShadow(bool has_shadow);
|
|
bool HasShadow() const;
|
|
void SetOpacity(const double opacity);
|
|
double GetOpacity() const;
|
|
void SetShape(const std::vector<gfx::Rect>& rects);
|
|
void SetRepresentedFilename(const std::string& filename);
|
|
std::string GetRepresentedFilename() const;
|
|
void SetDocumentEdited(bool edited);
|
|
bool IsDocumentEdited() const;
|
|
void SetIgnoreMouseEvents(bool ignore, gin_helper::Arguments* args);
|
|
void SetContentProtection(bool enable);
|
|
void SetFocusable(bool focusable);
|
|
bool IsFocusable() const;
|
|
void SetMenu(v8::Isolate* isolate, v8::Local<v8::Value> menu);
|
|
void RemoveMenu();
|
|
void SetParentWindow(v8::Local<v8::Value> value, gin_helper::Arguments* args);
|
|
std::string GetMediaSourceId() const;
|
|
v8::Local<v8::Value> GetNativeWindowHandle();
|
|
void SetProgressBar(double progress, gin_helper::Arguments* args);
|
|
void SetOverlayIcon(const gfx::Image& overlay,
|
|
const std::string& description);
|
|
void SetVisibleOnAllWorkspaces(bool visible, gin_helper::Arguments* args);
|
|
bool IsVisibleOnAllWorkspaces() const;
|
|
void SetAutoHideCursor(bool auto_hide);
|
|
virtual void SetVibrancy(v8::Isolate* isolate, v8::Local<v8::Value> value);
|
|
void SetBackgroundMaterial(const std::string& vibrancy);
|
|
|
|
#if BUILDFLAG(IS_MAC)
|
|
std::string GetAlwaysOnTopLevel() const;
|
|
void SetWindowButtonVisibility(bool visible);
|
|
bool GetWindowButtonVisibility() const;
|
|
void SetWindowButtonPosition(std::optional<gfx::Point> position);
|
|
std::optional<gfx::Point> GetWindowButtonPosition() const;
|
|
|
|
bool IsHiddenInMissionControl();
|
|
void SetHiddenInMissionControl(bool hidden);
|
|
#endif
|
|
|
|
void SetTouchBar(std::vector<gin_helper::PersistentDictionary> items);
|
|
void RefreshTouchBarItem(const std::string& item_id);
|
|
void SetEscapeTouchBarItem(gin_helper::PersistentDictionary item);
|
|
void SelectPreviousTab();
|
|
void SelectNextTab();
|
|
void ShowAllTabs();
|
|
void MergeAllWindows();
|
|
void MoveTabToNewWindow();
|
|
void ToggleTabBar();
|
|
void AddTabbedWindow(NativeWindow* window, gin_helper::Arguments* args);
|
|
v8::Local<v8::Value> GetTabbingIdentifier();
|
|
void SetAutoHideMenuBar(bool auto_hide);
|
|
bool IsMenuBarAutoHide() const;
|
|
void SetMenuBarVisibility(bool visible);
|
|
bool IsMenuBarVisible() const;
|
|
void SetAspectRatio(double aspect_ratio, gin_helper::Arguments* args);
|
|
void PreviewFile(const std::string& path, gin_helper::Arguments* args);
|
|
void CloseFilePreview();
|
|
void SetGTKDarkThemeEnabled(bool use_dark_theme);
|
|
|
|
// Public getters of NativeWindow.
|
|
v8::Local<v8::Value> GetContentView() const;
|
|
v8::Local<v8::Value> GetParentWindow() const;
|
|
std::vector<v8::Local<v8::Object>> GetChildWindows() const;
|
|
bool IsModal() const;
|
|
|
|
// Extra APIs added in JS.
|
|
bool SetThumbarButtons(gin_helper::Arguments* args);
|
|
#if defined(TOOLKIT_VIEWS)
|
|
void SetIcon(v8::Isolate* isolate, v8::Local<v8::Value> icon);
|
|
void SetIconImpl(v8::Isolate* isolate,
|
|
v8::Local<v8::Value> icon,
|
|
NativeImage::OnConvertError on_error);
|
|
#endif
|
|
#if BUILDFLAG(IS_WIN)
|
|
typedef base::RepeatingCallback<void(v8::Local<v8::Value>,
|
|
v8::Local<v8::Value>)>
|
|
MessageCallback;
|
|
bool HookWindowMessage(UINT message, const MessageCallback& callback);
|
|
bool IsWindowMessageHooked(UINT message);
|
|
void UnhookWindowMessage(UINT message);
|
|
void UnhookAllWindowMessages();
|
|
bool SetThumbnailClip(const gfx::Rect& region);
|
|
bool SetThumbnailToolTip(const std::string& tooltip);
|
|
void SetAppDetails(const gin_helper::Dictionary& options);
|
|
#endif
|
|
int32_t GetID() const;
|
|
|
|
// Helpers.
|
|
|
|
// Remove this window from parent window's |child_windows_|.
|
|
void RemoveFromParentChildWindows();
|
|
|
|
template <typename... Args>
|
|
void EmitEventSoon(std::string_view eventName) {
|
|
content::GetUIThreadTaskRunner({})->PostTask(
|
|
FROM_HERE,
|
|
base::BindOnce(base::IgnoreResult(&BaseWindow::Emit<Args...>),
|
|
weak_factory_.GetWeakPtr(), eventName));
|
|
}
|
|
|
|
#if BUILDFLAG(IS_WIN)
|
|
typedef std::map<UINT, MessageCallback> MessageCallbackMap;
|
|
MessageCallbackMap messages_callback_map_;
|
|
#endif
|
|
|
|
v8::Global<v8::Value> content_view_;
|
|
v8::Global<v8::Value> menu_;
|
|
v8::Global<v8::Value> parent_window_;
|
|
KeyWeakMap<int> child_windows_;
|
|
|
|
std::unique_ptr<NativeWindow> window_;
|
|
|
|
// Reference to JS wrapper to prevent garbage collection.
|
|
v8::Global<v8::Value> self_ref_;
|
|
|
|
base::WeakPtrFactory<BaseWindow> weak_factory_{this};
|
|
};
|
|
|
|
} // namespace electron::api
|
|
|
|
#endif // ELECTRON_SHELL_BROWSER_API_ELECTRON_API_BASE_WINDOW_H_
|