2014-10-31 12:17:05 -06:00
|
|
|
// Copyright (c) 2014 GitHub, Inc.
|
2014-05-30 09:57:54 -06:00
|
|
|
// Use of this source code is governed by the MIT license that can be
|
|
|
|
// found in the LICENSE file.
|
|
|
|
|
2021-11-22 00:34:31 -07:00
|
|
|
#ifndef ELECTRON_SHELL_BROWSER_API_ELECTRON_API_TRAY_H_
|
|
|
|
#define ELECTRON_SHELL_BROWSER_API_ELECTRON_API_TRAY_H_
|
2014-05-30 09:57:54 -06:00
|
|
|
|
2016-07-04 00:08:55 -06:00
|
|
|
#include <memory>
|
2024-01-10 15:23:35 -07:00
|
|
|
#include <optional>
|
2014-05-31 20:20:06 -06:00
|
|
|
#include <string>
|
2015-07-18 22:12:28 -06:00
|
|
|
#include <vector>
|
2014-05-31 20:20:06 -06:00
|
|
|
|
2019-10-21 01:05:40 -06:00
|
|
|
#include "gin/handle.h"
|
2020-03-29 19:32:02 -06:00
|
|
|
#include "gin/wrappable.h"
|
|
|
|
#include "shell/browser/event_emitter_mixin.h"
|
2020-04-27 12:38:43 -06:00
|
|
|
#include "shell/browser/javascript_environment.h"
|
2019-06-19 14:46:59 -06:00
|
|
|
#include "shell/browser/ui/tray_icon.h"
|
|
|
|
#include "shell/browser/ui/tray_icon_observer.h"
|
2020-01-30 22:37:03 -07:00
|
|
|
#include "shell/common/gin_converters/guid_converter.h"
|
2020-03-29 19:32:02 -06:00
|
|
|
#include "shell/common/gin_helper/cleaned_up_at_exit.h"
|
|
|
|
#include "shell/common/gin_helper/constructible.h"
|
2019-10-14 19:15:23 -06:00
|
|
|
#include "shell/common/gin_helper/error_thrower.h"
|
2022-02-24 12:03:59 -07:00
|
|
|
#include "shell/common/gin_helper/pinnable.h"
|
2014-05-30 09:57:54 -06:00
|
|
|
|
|
|
|
namespace gfx {
|
2015-01-02 19:43:56 -07:00
|
|
|
class Image;
|
2014-05-30 09:57:54 -06:00
|
|
|
}
|
|
|
|
|
2019-10-21 01:05:40 -06:00
|
|
|
namespace gin_helper {
|
2014-11-28 03:39:30 -07:00
|
|
|
class Dictionary;
|
2019-10-21 01:05:40 -06:00
|
|
|
}
|
2014-11-28 03:06:51 -07:00
|
|
|
|
2022-06-29 13:55:47 -06:00
|
|
|
namespace electron::api {
|
2014-05-30 09:57:54 -06:00
|
|
|
|
|
|
|
class Menu;
|
|
|
|
|
2020-03-29 19:32:02 -06:00
|
|
|
class Tray : public gin::Wrappable<Tray>,
|
|
|
|
public gin_helper::EventEmitterMixin<Tray>,
|
|
|
|
public gin_helper::Constructible<Tray>,
|
|
|
|
public gin_helper::CleanedUpAtExit,
|
2022-02-24 12:03:59 -07:00
|
|
|
public gin_helper::Pinnable<Tray>,
|
2024-05-29 12:07:02 -06:00
|
|
|
private TrayIconObserver {
|
2014-05-30 09:57:54 -06:00
|
|
|
public:
|
2020-03-29 19:32:02 -06:00
|
|
|
// gin_helper::Constructible
|
|
|
|
static gin::Handle<Tray> New(gin_helper::ErrorThrower thrower,
|
2021-01-04 13:58:31 -07:00
|
|
|
v8::Local<v8::Value> image,
|
2024-01-10 15:23:35 -07:00
|
|
|
std::optional<UUID> guid,
|
2020-03-29 19:32:02 -06:00
|
|
|
gin::Arguments* args);
|
2023-07-10 03:49:20 -06:00
|
|
|
|
2023-02-06 13:59:49 -07:00
|
|
|
static void FillObjectTemplate(v8::Isolate*, v8::Local<v8::ObjectTemplate>);
|
2023-07-10 03:49:20 -06:00
|
|
|
static const char* GetClassName() { return "Tray"; }
|
2020-03-29 19:32:02 -06:00
|
|
|
|
|
|
|
// gin::Wrappable
|
|
|
|
static gin::WrapperInfo kWrapperInfo;
|
2023-07-10 03:49:20 -06:00
|
|
|
const char* GetTypeName() override;
|
2014-05-30 09:57:54 -06:00
|
|
|
|
2021-11-03 05:41:45 -06:00
|
|
|
// disable copy
|
|
|
|
Tray(const Tray&) = delete;
|
|
|
|
Tray& operator=(const Tray&) = delete;
|
|
|
|
|
2020-03-29 19:32:02 -06:00
|
|
|
private:
|
2021-01-04 13:58:31 -07:00
|
|
|
Tray(v8::Isolate* isolate,
|
|
|
|
v8::Local<v8::Value> image,
|
2024-01-10 15:23:35 -07:00
|
|
|
std::optional<UUID> guid);
|
2015-11-04 03:21:03 -07:00
|
|
|
~Tray() override;
|
2014-05-30 09:57:54 -06:00
|
|
|
|
2014-11-28 02:54:38 -07:00
|
|
|
// TrayIconObserver:
|
2017-10-04 20:49:26 -06:00
|
|
|
void OnClicked(const gfx::Rect& bounds,
|
|
|
|
const gfx::Point& location,
|
|
|
|
int modifiers) override;
|
2015-07-27 04:15:51 -06:00
|
|
|
void OnDoubleClicked(const gfx::Rect& bounds, int modifiers) override;
|
2015-07-29 00:25:12 -06:00
|
|
|
void OnRightClicked(const gfx::Rect& bounds, int modifiers) override;
|
2023-09-27 12:21:15 -06:00
|
|
|
void OnMiddleClicked(const gfx::Rect& bounds, int modifiers) override;
|
2014-11-28 04:42:57 -07:00
|
|
|
void OnBalloonShow() override;
|
2014-11-28 03:50:31 -07:00
|
|
|
void OnBalloonClicked() override;
|
2014-11-28 04:42:57 -07:00
|
|
|
void OnBalloonClosed() override;
|
2015-11-10 09:02:50 -07:00
|
|
|
void OnDrop() override;
|
2015-07-18 22:12:28 -06:00
|
|
|
void OnDropFiles(const std::vector<std::string>& files) override;
|
2016-07-14 11:21:39 -06:00
|
|
|
void OnDropText(const std::string& text) override;
|
2015-11-05 17:45:43 -07:00
|
|
|
void OnDragEntered() override;
|
|
|
|
void OnDragExited() override;
|
2015-11-10 09:02:50 -07:00
|
|
|
void OnDragEnded() override;
|
2020-01-17 09:28:34 -07:00
|
|
|
void OnMouseUp(const gfx::Point& location, int modifiers) override;
|
|
|
|
void OnMouseDown(const gfx::Point& location, int modifiers) override;
|
2017-06-28 13:09:12 -06:00
|
|
|
void OnMouseEntered(const gfx::Point& location, int modifiers) override;
|
|
|
|
void OnMouseExited(const gfx::Point& location, int modifiers) override;
|
2017-08-26 12:04:58 -06:00
|
|
|
void OnMouseMoved(const gfx::Point& location, int modifiers) override;
|
2014-06-01 21:08:29 -06:00
|
|
|
|
2020-03-29 19:32:02 -06:00
|
|
|
// JS API:
|
|
|
|
void Destroy();
|
|
|
|
bool IsDestroyed();
|
2021-01-04 13:58:31 -07:00
|
|
|
void SetImage(v8::Isolate* isolate, v8::Local<v8::Value> image);
|
|
|
|
void SetPressedImage(v8::Isolate* isolate, v8::Local<v8::Value> image);
|
2016-05-20 01:14:40 -06:00
|
|
|
void SetToolTip(const std::string& tool_tip);
|
2020-08-23 15:39:29 -06:00
|
|
|
void SetTitle(const std::string& title,
|
2024-01-10 15:23:35 -07:00
|
|
|
const std::optional<gin_helper::Dictionary>& options,
|
2020-08-23 15:39:29 -06:00
|
|
|
gin::Arguments* args);
|
2019-03-18 13:40:34 -06:00
|
|
|
std::string GetTitle();
|
2018-04-01 19:07:26 -06:00
|
|
|
void SetIgnoreDoubleClickEvents(bool ignore);
|
2018-05-03 01:43:46 -06:00
|
|
|
bool GetIgnoreDoubleClickEvents();
|
2019-10-21 01:05:40 -06:00
|
|
|
void DisplayBalloon(gin_helper::ErrorThrower thrower,
|
|
|
|
const gin_helper::Dictionary& options);
|
2019-08-05 09:52:47 -06:00
|
|
|
void RemoveBalloon();
|
2019-08-09 08:43:48 -06:00
|
|
|
void Focus();
|
2020-03-29 19:32:02 -06:00
|
|
|
void PopUpContextMenu(gin::Arguments* args);
|
2020-01-22 16:25:17 -07:00
|
|
|
void CloseContextMenu();
|
2019-10-21 01:05:40 -06:00
|
|
|
void SetContextMenu(gin_helper::ErrorThrower thrower,
|
|
|
|
v8::Local<v8::Value> arg);
|
2016-06-21 00:40:30 -06:00
|
|
|
gfx::Rect GetBounds();
|
2014-05-30 09:57:54 -06:00
|
|
|
|
2020-04-02 18:22:46 -06:00
|
|
|
bool CheckAlive();
|
2020-03-29 19:32:02 -06:00
|
|
|
|
2019-10-21 01:05:40 -06:00
|
|
|
v8::Global<v8::Value> menu_;
|
2016-05-22 19:59:39 -06:00
|
|
|
std::unique_ptr<TrayIcon> tray_icon_;
|
2014-05-30 09:57:54 -06:00
|
|
|
};
|
|
|
|
|
2022-06-29 13:55:47 -06:00
|
|
|
} // namespace electron::api
|
2014-05-30 09:57:54 -06:00
|
|
|
|
2021-11-22 00:34:31 -07:00
|
|
|
#endif // ELECTRON_SHELL_BROWSER_API_ELECTRON_API_TRAY_H_
|