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